Retrieving a List of Sales | Controlata API Documentation

Returns the company's sales, from newest to oldest: by sale date, and within one date by number. Sale lines are not included in the list; they are returned by v1/orders/get_entry.

v1/orders/get_list.php

Parameters

Field	Type	Required	Description
date_from	string	No	Sales from this sale date inclusive
date_to	string	No	Sales up to this sale date inclusive
limit	int	No	Page size, from 1 to 1000
offset	int	No	How many records to skip

The filters work on date_placed. Without parameters, all the company's sales are returned. See Common Rules for pagination.

Response

An array orders. Each object holds the sale's fields:

Field	Type	Description
id	int	Sale ID
num	string	Sale number with the prefix
status	int	Status, a code from Changing the Sale Status
payment	int	Payment status, a code from Changing the Payment Status
date_placed	string	Sale date
date_shipped	string	Shipping date. Empty string if not set
subtotal	float	Sum of the lines
delivery_price	float	Delivery cost
discount	float	Discount
total	float	Total: subtotal plus delivery_price minus discount
cost	float	Sale cost
amount	float	Total quantity if all lines share one unit, otherwise null
lines	int	Number of lines
production	int	1 if the sale is fulfilled by made-to-order production
production_num	string	Linked production number, null without production
source	string	Where the sale came from: "manual", "api", "shopify"
notes	string	Notes
products_storage_id	int	Products storage location
products_storage_name	string	Products storage location name
materials_storage_id	int	Materials storage location
materials_storage_name	string	Materials storage location name
customer_id	int	Customer ID
customer_name	string	Name
customer_email	string	Email
customer_phone	string	Phone
customer_address_real	string	Delivery address
customer_address_legal	string	Legal address
customer_agreement	string	Agreement
customer_manager_name	string	Manager
customer_manager_post	string	Manager's position
customer_notes	string	Customer notes

The total field in the response root holds the total number of sales matching the filters.

Example request

{
    "date_from": "2026-10-01",
    "date_to": "2026-10-31",
    "limit": 100,
    "offset": 0
}

Example response

{
    "success": true,
    "orders": [
        {
        "id": 43727,
        "num": "A-1001",
        "status": 3,
        "payment": 2,
        "date_placed": "2026-10-06",
        "date_shipped": "2026-10-08",
        "subtotal": 30500,
        "delivery_price": 500,
        "discount": 1000,
        "total": 30000,
        "cost": 17800,
        "amount": 3,
        "lines": 2,
        "production": 0,
        "production_num": null,
        "source": "api",
        "notes": "Order from the website",
        "products_storage_id": 3998,
        "products_storage_name": "Main location",
        "materials_storage_id": 3998,
        "materials_storage_name": "Main location",
        "customer_id": 512,
        "customer_name": "John Smith",
        "customer_email": "john@example.com",
        "customer_phone": "+1 917 555-0145",
        "customer_address_real": "5 Forest St, Apt 12, New York",
        "customer_address_legal": "",
        "customer_agreement": "",
        "customer_manager_name": "",
        "customer_manager_post": "",
        "customer_notes": ""
        }
    ],
    "total": 1
}

Errors

Error	Reason
Date is not a valid date in format YYYY-MM-DD	Invalid date_from or date_to
Invalid limit value. Must be between 1 and 1000	Invalid limit
Invalid offset value. Must be 0 or greater	Invalid offset
Offset requires limit	offset passed without limit