Get simple list of orders.
Example URL for filters and sort: <code>/rest/api/orders/?orderStatus=7&createdAfter=2022-03-01T14%3A40%3A33%2B0200&order&sort=updatedAtDesc</code><br><br> The fields orderItems and addressCustomer will be returned conditionally from end of 2022
Query parameters
The date of order creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Date of order creation from customer, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Date of order to customer, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Update date to in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. 2022-03-01T14:40:33+0200
Determines whether a document exists for the order, takes the value of 1 or 0
Order number in Apilo system, e.g. AL0012345
External order number, e.g. 5200669628624
Order status according to the order status map
Array of Order Status according to the order status map, example: <code>/rest/api/orders/?orderStatusIds[]=1&orderStatusIds[]=2</code>
Order Payment Status <a href='#tag/Order/operation/get_rest_orders_status_map'>Order payment Status </a>
Order Payment type <a href='#tag/Order/operation/get_rest_orders_payment_map'> Order Payment Type </a>
Platform account Id <a href='#tag/Order/operation/get_rest_orders_platform_map'> Platform account Id </a>
Carrier account Id <a href='#tag/Order/operation/get_rest_orders_carrier_map'> Carrier account Id </a>
Client E-mail
Customer phone number in E.164 format e.g. +48123456789. The phone number must start with + sign which is coded in query as %2B e.g. %2B48123456789
Sort options
Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)
Limit of returned results, max 512 records
Response
Order array
Example response
{
"orders": [
{
"id": "AL231100017",
"status": 3,
"idExternal": "WWW/341/2023",
"isInvoice": true,
"paymentType": 2,
"originalCurrency": "PLN",
"createdAt": "2022-06-09T10:59:12Z",
"updatedAt": "2022-06-09T10:59:12Z",
"orderItems": [
{
"id": 1,
"idExternal": "359",
"ean": "400638133393",
"sku": "P44/3-T1.2",
"originalName": "Samsung Galaxy S20 Plus Black 128GB 5G",
"originalCode": "PHONE-S20-128GB-B",
"originalPriceWithTax": "2799.99",
"originalPriceWithoutTax": "2799.99",
"media": null,
"quantity": 2,
"tax": "23.00",
"productSet": null,
"status": 1,
"unit": "Szt.",
"type": 1,
"productId": 12345
},
{
"id": 2,
"idExternal": null,
"ean": null,
"sku": "ship-pp",
"originalName": "Wysyłka - Poczta Polska - Pocztex",
"originalCode": null,
"originalPriceWithTax": "10.00",
"originalPriceWithoutTax": "10.00",
"media": null,
"quantity": 1,
"tax": null,
"productSet": null,
"status": 1,
"unit": null,
"type": 2,
"productId": null
}
],
"addressCustomer": {
"id": 123,
"name": "Jan Kowalski",
"phone": "+48 500 000 000",
"email": "jan.kowalski@apilo.com",
"streetName": "Testowa",
"streetNumber": "4b/12",
"city": "Kraków",
"zipCode": "31-154",
"country": "PL",
"class": "company"
},
"platformId": 1,
"carrierId": 1,
"platformAccountId": 1
}
],
"totalCount": 7398,
"pageResultCount": 64
}Changes
No recorded changes to this endpoint across all 1 revision of this API.