Skip to content

List of all orders

Request

Using this endpoint, you can get list of all orders with detailed info of each order (like in Order Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal.

The list may be filtered by date of creation and order code. The code is the order identifier. Although this is usually a number, it is necessary to take into account that this might also include letters, dash, etc.

Response will be in jsonlines format with each order taking one line of output file.

One order in response has the same format as order detail response. See Order snapshot schema for more details.

This endpoint has several sections, which are exported only when requested in the include parameter (see Section on demand).

Include parameterMeaning
notesOrder remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names.
imagesOrder images
shippingDetailsTransport details
stockLocationPosition in the stock
surchargeParametersItem surcharge parameters
productFlagsItem product flags

Use orderCodes request parameter to get the list of specific orders. Order codes are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular orders is returned. Please note that this parameter accepts max. 50 order codes in request parameter.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
includestring

Optional parts of response. Available values are notes,images,shippingDetails,stockLocation,surchargeParameters.

orderCodesstring

Define the output set of orders. Use max. 50 order codes separated by a comma. No additional filters take effect.

Example:orderCodes=2025000004,2025000002,2017000038,2017000025,2015000248
statusIdinteger

Purchase order filtering, according to order status id.

Example:statusId=-1
shippingGuidstring

Purchase order filtering, according to forwarder GUID.

Example:shippingGuid=ecb3e399-2f57-11eb-8853-0800275177b9
shippingCompanyCodestring

Purchase order filtering, according to forwarder company code.

Example:shippingCompanyCode=zasilkovna
paymentMethodGuidstring

Purchase order filtering, according to payment method.

Example:paymentMethodGuid=b57f91bb-e920-11e0-baa3-7dc668b75ca8
creationTimeFromstring

Purchase order filtering, according to date of creation. ISO 8601 format ("2017-12-12T22:08:01+0100").

Example:creationTimeFrom=2014-09-05T00:00:00%2B0000
creationTimeTostring

Purchase order filtering, according to date of creation. ISO 8601 format ("2017-12-12T22:08:01+0100").

Example:creationTimeTo=2014-09-05T00:00:00%2B0000
codeFromstring

Purchase order filtering, according to order code.

Example:codeFrom=0000000006
codeTostring

Purchase order filtering, according to order code.

Example:codeTo=0000000006
customerGuidstring

Purchase order filtering, according to customer number.

Example:customerGuid=443cad54-73bc-11e8-8216-002590dad85e
emailstring

Purchase order filtering, according to customer e-mail. The accurate match is searched for, regardless of capitalization.

Example:email=john.doe@example.com
phonestring

Purchase order filtering, according to customer phone. International format only (+420123456789)

Example:phone=+420123456789
productCodestring

Order filter by product's code that is in order.

Example:productCode=15/ZLU
changeTimeFromstring

Purchase order filtering, according to date of last update. ISO 8601 format ("2017-12-12T22:08:01+0100").

Example:changeTimeFrom=2014-09-05T00:00:00%2B0000
changeTimeTostring

Purchase order filtering, according to date of last update. ISO 8601 format ("2017-12-12T22:08:01+0100").

Example:changeTimeTo=2014-09-05T00:00:00%2B0000
sourceIdinteger

Order source filtering according to source id. For more information, see List of order sources endpoint.

Example:sourceId=-1
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/snapshot?include=string&orderCodes=2025000004%2C2025000002%2C2017000038%2C2017000025%2C2015000248&statusId=-1&shippingGuid=ecb3e399-2f57-11eb-8853-0800275177b9&shippingCompanyCode=zasilkovna&paymentMethodGuid=b57f91bb-e920-11e0-baa3-7dc668b75ca8&creationTimeFrom=2014-09-05T00%3A00%3A00%252B0000&creationTimeTo=2014-09-05T00%3A00%3A00%252B0000&codeFrom=0000000006&codeTo=0000000006&customerGuid=443cad54-73bc-11e8-8216-002590dad85e&email=john.doe%40example.com&phone=%2B420123456789&productCode=15%2FZLU&changeTimeFrom=2014-09-05T00%3A00%3A00%252B0000&changeTimeTo=2014-09-05T00%3A00%3A00%252B0000&sourceId=-1' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json
dataobject
errorsArray of objects or null(Errors)
metadataobject(Metadata)
Response
{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}