# List of orders

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

using the parameter , 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 () 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  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 .

Endpoint: GET /api/orders
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `statusId` (number)
    Purchase order filtering, according to order status id.
    Example: -1

  - `shippingGuid` (string)
    Purchase order filtering, according to forwarder GUID.
    Example: "ecb3e399-2f57-11eb-8853-0800275177b9"

  - `shippingCompanyCode` (string)
    Purchase order filtering, according to forwarder [company
code](#tag/shipping-methods/getlistofshippingmethods).
    Example: "zasilkovna"

  - `paymentMethodGuid` (string)
    Purchase order filtering, according to payment method.
    Example: "b57f91bb-e920-11e0-baa3-7dc668b75ca8"

  - `creationTimeFrom` (string)
    Purchase order filtering, according to date of creation. ISO 8601
format ("2017-12-12T22:08:01+0100").
    Example: "2014-09-05T00:00:00%2B0000"

  - `creationTimeTo` (string)
    Purchase order filtering, according to date of creation. ISO 8601
format ("2017-12-12T22:08:01+0100").
    Example: "2014-09-05T00:00:00%2B0000"

  - `codeFrom` (string)
    Purchase order filtering, according to order code.
    Example: 6

  - `codeTo` (string)
    Purchase order filtering, according to order code.
    Example: 6

  - `customerGuid` (string)
    Purchase order filtering, according to customer number.
    Example: "443cad54-73bc-11e8-8216-002590dad85e"

  - `email` (string)
    Purchase order filtering, according to customer e-mail. The accurate
match is searched for, regardless of capitalization.
    Example: "john.doe@example.com"

  - `phone` (string)
    Purchase order filtering, according to customer phone. International
format only (+420123456789)
    Example: 420123456789

  - `productCode` (string)
    Order filter by product's code that is in order.
    Example: "15/ZLU"

  - `changeTimeFrom` (string)
    Purchase order filtering, according to date of last update. ISO 8601
format ("2017-12-12T22:08:01+0100").
    Example: "2014-09-05T00:00:00%2B0000"

  - `changeTimeTo` (string)
    Purchase order filtering, according to date of last update. ISO 8601
format ("2017-12-12T22:08:01+0100").
    Example: "2014-09-05T00:00:00%2B0000"

  - `sourceId` (number)
    Order source filtering according to source id. For more information,
see List of order sources endpoint.
    Example: -1

  - `orderCodes` (string)
    Define the output set of orders. Use max. 50 order codes separated by a comma. No additional filters take
effect.
    Example: "2025000004,2025000002,2017000038,2017000025,2015000248"

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.orders` (array, required)

  - `data.orders.code` (string, required)
    order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.

  - `data.orders.guid` (string, required)
    global unique permanent order identifier (can be  for old orders)

  - `data.orders.creationTime` (string,null, required)
    date and time, when the order was created. ISO 8601 format.

  - `data.orders.changeTime` (string,null, required)
    date and time of the order's last change. ISO 8601 format.

  - `data.orders.fullName` (string,null, required)
    customer full name (can be )

  - `data.orders.company` (string,null, required)
    company name (can be )

  - `data.orders.email` (string,null, required)
    purchaser e-mail (can be )

  - `data.orders.phone` (string,null)
    purchaser phone number (can be )

  - `data.orders.remark` (string,null, required)
    customer remark  (can be ).

  - `data.orders.customerGuid` (any, required)
    customer identifier, if the customer is registered in the e-shop (can be )

  - `data.orders.cashDeskOrder` (boolean, required)
    flag, whether the order is from the cash desk (as opposed to the e-shop)

  - `data.orders.adminUrl` (string, required)
    URL to administration leading to order detail. URL keeps the administration language settings.

  - `data.orders.status` (object,null, required)

  - `data.orders.status.name` (string,null, required)
    status name

  - `data.orders.status.id` (number, required)
    status identifier

  - `data.orders.source` (object,null)

  - `data.orders.source.name` (string,null, required)
    source name

  - `data.orders.source.id` (number, required)
    source identifier

  - `data.orders.shipping` (object,null, required)

  - `data.orders.shipping.guid` (string, required)
    transport type identifier

  - `data.orders.shipping.name` (string, required)
    description of transport method (Czech post, PPL, in person..)

  - `data.orders.paymentMethod` (any, required)

  - `data.orders.price` (object, required)
    price of the order

  - `data.orders.price.vat` (string,null, required)
    VAT value, two decimal places

  - `data.orders.price.toPay` (string,null, required)
    total price to pay

  - `data.orders.price.currencyCode` (string, required)
    currency code. List of available currencies within the e-shop can be found in endpoint .

  - `data.orders.price.withoutVat` (string,null, required)
    price excluding tax

  - `data.orders.price.withVat` (string,null, required)
    price including tax

  - `data.orders.price.exchangeRate` (string, required)
    currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!

  - `data.orders.price.invoicingExchangeRate` (string)
    currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!

  - `data.orders.price.partialPaymentAmount` (string,null)
    can be value expressed in percents or as exact money value expression (with up to two decimal places) - depends on partialPaymentType value

  - `data.orders.price.partialPaymentType` (string)
    'percents' = partial payment as percentage from total price | 'absolute' = exact expression of partial payment in money

  - `data.orders.paid` (boolean,null, required)
    flag, whether the order was paid. In addition to  a , can also be , if the payment status is unknown.

  - `data.orders.preAuthorization` (object)

  - `data.orders.preAuthorization.hasPendingPreAuthorization` (boolean, required)

  - `data.orders.preAuthorization.preAuthorizationAmount` (string, required)
    pre-authorization amount of the order. If null, the order is not pre-authorized. If not present, pre-authorization is not supported.

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

## Response 400 fields (application/json):

  - `data` (object,null)

  - `errors` (array,null)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced