v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

salesorder

Query Sales Orders

Query all sales orders

get/v2/salesOrders

Query parameters

salesOrderNumberstring

Search for a specific sales order number.

externalOrderNumberstring

Search for a specific external order number.

billingNumberstring

Search for a specific billing number.

itemIdstring uuid

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

customerIdstring uuid

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

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

Gets the unique identifier for the customer.

IsExistingboolean

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

paymentStatus0 | 1 | 2

0 = UnPayed, 1 = PartialPayed, 2 = Payed

Search for a specific payment status.

paymentMethodIdstring uuid

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

deliveryCompleteStatus0 | 1 | 2

0 = DeliveryNotComplete, 1 = DeliveryComplete, 2 = DeliveryCompleteWithoutNote

Search for a specific payment status.

createdUserIdstring uuid

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

companyIdstring uuid

Represents a key for identifying a firm within the application.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

Gets the unique identifier for the firm.

salesChannelIdstring

Search for a specific sales channel Id.

createdSincestring date-time

Search for sales orders created after this date.

createdUntilstring date-time

Search for sales orders created before this date.

colorIdstring uuid

Represents a key for identifying a color entity in the system.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

Gets the unique identifier for the color.

ebayUsernamestring

Search for sales orders with a specific eBay username.

shippingMethodIdstring uuid

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

deliveredDatestring date-time

Search for sales orders delivered on this date.

isCancelledboolean

Determines if the sales order is cancelled.

onHoldReasonIdstring uuid

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

isExternalInvoiceboolean

Determines if the sales order is an external invoice.

pageNumberinteger

Number of the page of items to fetch.

pageSizeinteger

Size of the page that is specified by pageNumber.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

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

x-companyidstring

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

Response

Returns all non-pending sales orders.

totalItemsinteger

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

pageNumberinteger

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

pageSizeinteger

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

totalPagesinteger

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

hasPreviousPageboolean

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

hasNextPageboolean

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

nextPageNumberinteger

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

previousPageNumberinteger

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

Example response

{
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "billingAddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "shipmentaddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "salesOrderPaymentDetails": {
        "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "salesOrderShippingDetail": {
        "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "colorcodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "cancellationDetails": {
        "cancellationReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      },
      "userCreatedId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "userId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "transactionStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ]
}