Skip to content

Orders

Basic endpoints for managing orders. See the sections below for other specific actions.

Operations

List of orders

Request

List of orders in e-shop and cash desks. Endpoint supports Paging. For default calls, it returns 50 orders,

using the parameter ?itemsPerPage=100, you can request up to 100 orders at a time. Temporarily disabled, only 50 orders per page is supported. We apologize for the inconvenience.

The list can be filtered according to status, transport, payment, date of creation, order number and customer number.

The code (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.

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.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
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
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
itemsPerPageinteger

Returned items per page. Default and max value is 50.

Example:itemsPerPage=44
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders?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&orderCodes=2025000004%2C2025000002%2C2017000038%2C2017000025%2C2015000248&itemsPerPage=44&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

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