---
title: "List sales orders"
method: GET
path: "/api/v1/salesOrders"
tags: ["Sales Order"]
---

# List sales orders

`GET /api/v1/salesOrders`

Returns a collection with all sales orders.

## Query parameters

- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'documentNumber'
  - `dir` 'asc' | 'desc'
- `filter` object[]
  - `key` 'orderDate' | 'status' | 'documentNumber' | 'transactionNumber' | 'externalOrderNumber' | 'customerOrderNumber' | 'externalOrderId' | 'customerId' | 'customerNumber' | 'email' | 'zipCode' | 'shippingEmail' | 'shippingZip' | 'isBeingEdited' | 'subsequentDelivery' | 'shippingDateOk' | 'creditLimitOk' | 'shippingLockOk' | 'prepaidOk' | 'postageOk' | 'customerCheckOk' | 'vatOk' | 'stockOk' | 'internalComment' | 'shippingMethod' | 'autoShipping' | 'fastLane' | 'gln' | 'shippingGln' | 'project' | 'paymentMethod' | 'country' | 'phoneNumber' | 'shippingCountry' | 'desiredDeliveryDate' | 'earliestFulfillmentDate' | 'createdAt' | 'updatedAt'
  - `op` 'greaterThan' | 'lessThan' | 'greaterThanOrEquals' | 'lessThanOrEquals' | 'equals' | 'notEquals' | 'in' | 'notIn'
  - `value` union
    - string — For dates use format: 2023-01-26T10:42:42+01:00 and encode as url. Valid statuses are created,released,canceled,completed.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.

## Response `200`

Operation completed successfully.

- object
  - `data` object[] — Response data containing list of Sales Orders
    - `id` string — Resource identifier.
    - `documentNumber` string — Internal identification associated with a Sales Order
    - `isBeingEdited` boolean — Indicates if the Sales Order is currently being edited
    - `shippingDateOk` boolean — Indicates if the shipping date is ok
    - `creditLimitOk` boolean — Indicates if the credit limit is ok
    - `subsequentDelivery` boolean — Indicates if the Sales Order is a subsequent delivery
    - `shippingLockOk` boolean — Indicates if the shipping lock is ok
    - `postageOk` boolean — Indicates if the postage is ok
    - `customerCheckOk` boolean — Indicates if the customer check is ok
    - `vatOk` boolean — Indicates if the VAT is ok
    - `stockOk` boolean — Indicates if the stock is ok
    - `prepaidOk` boolean — Indicates if the prepaid status is ok
    - `externalOrderNumber` string — External identification associated with a Sales Order
    - `transactionNumber` string — Transaction number associated with a Sales Order
    - `customerOrderNumber` string — Customer order associated with a Sales Order
    - `externalOrderId` string — External ID associated with a Sales Order
    - `bodyOutroduction` string — Ending description message for Sales Order
    - `date` string, date — a yyyy-mm-dd formatted date
    - `netSales` number, float — Net sales amount of the Sales Order
    - `total` number, float — Total amount of the Sales Order
    - `desiredDeliveryDate` string, date, nullable — Desired Delivery Date for the Sales Order
    - `earliestFulfillmentDate` string, date, nullable — Earliest Fulfillment Date
    - `reservationDate` string, date, nullable — Reservation Date for the Sales Order
    - `desiredDeliveryDateAsCalendarWeek` boolean — Indicating whether a calendar week should be printed on documents or the actual date) is readable and editable via API
    - `editor` string — Creator of the Sales Order
    - `sales` object — Represents a sales representative with associated attributes.
      - `id` number, nullable
      - `name` string, nullable
    - `status` 'completed' | 'created' | 'released' | 'canceled' | 'unknown' — Status of the Sales Order
    - `customer` object — Customer linked to a Sales Order
      - `id` string — Resource identifier.
      - `number` string, nullable
    - `comment` string — Comment included in the Sales Order
    - `project` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `language` object — Language information for a Sales Order
      - `iso2` string, nullable, required — ISO 639-1 Code
    - `log` object — Logging information for the Sales Order
      - `createdAt` string, date-time — a atom formatted date time
      - `createdBy` object
        - `id` string — Resource identifier.
        - `name` string
    - `financials` object — Financial information for a Sales Order
      - `paymentMethod` object, required — Reference to another resource
        - `id` string, required — Resource identifier.
      - `currency` string, required
      - `costCenter` object, nullable
        - `id` string, required — Resource identifier.
        - `number` string, nullable, required
      - `billingAddress` object
        - `type` 'mr' | 'mrs' | 'company' | 'other'
        - `name` string, required
        - `title` string
        - `contactPerson` string
        - `department` string
        - `subDepartment` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `fax` string
        - `state` string
        - `country` string, required
        - `addressSupplement` string
        - `gln` string
        - `phoneNumber` string
        - `mobile` string
        - `salutation` string
        - `email` string, email
      - `tax` object
        - `taxation` 'domestic' | 'eu' | 'export' | 'taxfreedomestic'
        - `vatId` string
        - `taxDisplay` 'gross' | 'net' | 'auto'
        - `noTaxInfoText` boolean
        - `normalTaxRate` number, float
        - `reducedTaxRate` number, float
      - `paymentTerms` object
        - `paymentTargetDiscount` number, float
        - `paymentTargetDays` integer
        - `paymentTargetDiscountDays` integer
        - `directDebitDate` string, date, nullable — Earliest date for direct debit
    - `delivery` object — Delivery information for the Sales Order
      - `autoShipping` boolean
      - `fastLane` boolean
      - `shippingCosts` object[]
        - `id` string — Resource identifier.
        - `quantity` number, double, required
        - `comment` string
        - `shippingCostProduct` object, required
          - `id` string, required — Resource identifier.
          - `name` string
          - `description` string
          - `freeFields` object[], nullable
            - `id` string, required — Resource identifier.
            - `value` string, required
          - `number` string, nullable
        - `tax` object
          - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When importing a position only one of `rate` or `vatCategory` must be used.
          - `rate` number, float, nullable — VAT rate. When importing a position only one of `rate` or `vatCategory` must be used.
          - `taxText` string, nullable, required — Tax Text
        - `price` object — Money object with amount and currency
          - `amount` string, float — A string representing the amount
          - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217.
        - `discount` number, float — percentage discount to be applied to the position, expressed as a decimal value (<code>0.15</code> = 15% discount)
        - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform
      - `storageCountry` string, nullable — Only use preferredWarehouse OR storageCountry. You cannot use both at the same time. Use storageCountry for external fulfillment without delivery notes to set the country of fulfillment. If using delivery notes, do not use storageCountry.
      - `preferredWarehouse` object, nullable — Only use preferredWarehouse OR storageCountry. You cannot use both at the same time. Use preferredWarehouse for fulfillment with delivery notes to define which warehouse should be used.
        - `id` string
      - `shippingAddress` object
        - `type` 'mr' | 'mrs' | 'company' | 'other'
        - `name` string, required
        - `department` string
        - `contactPerson` string
        - `subDepartment` string
        - `street` string
        - `zipCode` string
        - `city` string
        - `state` string
        - `country` string, required
        - `addressSupplement` string
        - `gln` string
        - `title` string
        - `email` string, email
      - `email` string, email
      - `conditions` string
    - `createdAt` string, date-time — a atom formatted date time
    - `updatedAt` string, date-time — a atom formatted date time
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)