Skip to main content
GET
/
v2
/
salesOrders
Query Sales Orders
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/salesOrders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "number": "<string>",
      "externalNumber": "<string>",
      "billingNumber": "<string>",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "departureCountry": {
        "countryISO": "<string>",
        "state": "<string>",
        "currencyIso": "<string>",
        "currencyFactor": 123
      },
      "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerVatID": "<string>",
      "merchantVatID": "<string>",
      "billingAddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "company": "<string>",
        "company2": "<string>",
        "formOfAddress": "<string>",
        "title": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "street": "<string>",
        "address2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "countryIso": "<string>",
        "vatID": "<string>",
        "phoneNumber": "<string>",
        "mobilePhoneNumber": "<string>",
        "emailAddress": "<string>",
        "fax": "<string>"
      },
      "shipmentaddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "company": "<string>",
        "company2": "<string>",
        "formOfAddress": "<string>",
        "title": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "street": "<string>",
        "address2": "<string>",
        "postalCode": "<string>",
        "city": "<string>",
        "state": "<string>",
        "countryIso": "<string>",
        "vatID": "<string>",
        "phoneNumber": "<string>",
        "mobilePhoneNumber": "<string>",
        "emailAddress": "<string>",
        "fax": "<string>"
      },
      "salesOrderDate": "2023-11-07T05:31:56Z",
      "salesOrderPaymentDetails": {
        "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "totalGrossAmount": 123,
        "currencyIso": "<string>",
        "currencyFactor": 123,
        "dateOfPayment": "2023-11-07T05:31:56Z",
        "stillToPay": 123,
        "paymentTarget": 123,
        "cashDiscount": 123,
        "cashDiscountDays": 123
      },
      "salesOrderShippingDetail": {
        "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "shippingPriority": 123,
        "shippingDate": "2023-11-07T05:31:56Z",
        "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
        "deliveredDate": "2023-11-07T05:31:56Z",
        "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "extraWeight": 123
      },
      "colorcodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "isExternalInvoice": true,
      "comment": "<string>",
      "customerComment": "<string>",
      "isCancelled": true,
      "languageIso": "<string>",
      "cancellationDetails": {
        "cancellationReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "cancellationComment": "<string>",
        "date": "2023-11-07T05:31:56Z"
      },
      "salesChannelId": "<string>",
      "userCreatedId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "transactionStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Query Parameters

​
salesOrderNumber
string

Search for a specific sales order number.

​
externalOrderNumber
string

Search for a specific external order number.

​
billingNumber
string

Search for a specific billing number.

​
itemId
string<uuid>
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
customerId
string<uuid>

Gets the unique identifier for the customer. Represents a unique key for identifying a customer in the JTL system.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
IsExisting
boolean

Gets a value indicating whether the customer key represents an existing customer.

​
paymentStatus
enum<integer>

Search for a specific payment status. 0 = UnPayed, 1 = PartialPayed, 2 = Payed

Available options:
0,
1,
2
​
paymentMethodId
string<uuid>
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
deliveryCompleteStatus
enum<integer>

Search for a specific payment status. 0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote

Available options:
0,
1,
2
​
createdUserId
string<uuid>
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
companyId
string<uuid>

Gets the unique identifier for the firm. Represents a key for identifying a firm within the application.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
salesChannelId
string

Search for a specific sales channel Id.

​
createdSince
string<date-time>

Search for sales orders created after this date.

​
createdUntil
string<date-time>

Search for sales orders created before this date.

​
colorId
string<uuid>

Gets the unique identifier for the color. Represents a key for identifying a color entity in the system.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
ebayUsername
string

Search for sales orders with a specific eBay username.

​
shippingMethodId
string<uuid>
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
deliveredDate
string<date-time>

Search for sales orders delivered on this date.

​
isCancelled
boolean

Determines if the sales order is cancelled.

​
onHoldReasonId
string<uuid>
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
isExternalInvoice
boolean

Determines if the sales order is an external invoice.

​
pageNumber
integer<int32>

Number of the page of items to fetch.

​
pageSize
integer<int32>

Size of the page that is specified by pageNumber.

Response

Returns all non-pending sales orders.

Represents a paginated list of items

​
totalItems
integer<int32>

Gets or sets the total number of items available in the data source.

​
pageNumber
integer<int32>

Gets or sets the current page number in the paginated list.

​
pageSize
integer<int32>

Gets or sets the number of items per page in the paginated list.

​
items
object[]

Gets or sets the collection of items contained in the paged list.

​
totalPages
integer<int32>

Gets the total number of pages based on the total number of items and the page size.

​
hasPreviousPage
boolean

Gets a value indicating whether there is a previous page available in the paginated list.

​
hasNextPage
boolean

Gets a value indicating whether there is a next page available.

​
nextPageNumber
integer<int32>

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

​
previousPageNumber
integer<int32>

Gets the number of the previous page. If there is no previous page, it returns 1.