Queries all sales orders.

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-orders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-orders"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-orders")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "accountsReceivableNumber": 123,
      "assignedUserId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyName": "<string>",
      "createdByUserId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "currencyFactor": 123,
      "currencyIso": "<string>",
      "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerNumber": "<string>",
      "departureCountryIso": "<string>",
      "departureCountryCurrencyFactor": 123,
      "departureCountryCurrencyIso": "<string>",
      "ebayUsername": "<string>",
      "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
      "externalSalesOrderNumber": "<string>",
      "extraWeight": 123,
      "isIntraCommunityDelivery": true,
      "isCancelled": true,
      "isPending": true,
      "languageIso": "<string>",
      "lastShippingDate": "2023-11-07T05:31:56Z",
      "needsOnlineSynchronisation": true,
      "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentDueDateInDays": 123,
      "processColourCode": 123,
      "processColourName": "<string>",
      "processStatusName": "<string>",
      "salesChannelId": "<string>",
      "platformId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shopId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderDate": "2023-11-07T05:31:56Z",
      "salesOrderNumber": "<string>",
      "salesOrderStatus": 123,
      "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shippingPriority": 123,
      "shopPaymentModule": "<string>",
      "totalGrossAmount": 123,
      "isExemptFromVat": true,
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "onlineSalesOrderId": 123,
      "comment": "<string>",
      "printDate": "2023-11-07T05:31:56Z",
      "mailDate": "2023-11-07T05:31:56Z",
      "paymentMailDate": "2023-11-07T05:31:56Z",
      "dateOfPayment": "2023-11-07T05:31:56Z",
      "paymentDate": "2023-11-07T05:31:56Z",
      "onHoldReasonName": "<string>",
      "billingAddressCompany": "<string>",
      "billingAddressAdditionalCompanyLine": "<string>",
      "billingAddressSalutation": "<string>",
      "billingAddressTitle": "<string>",
      "billingAddressFirstName": "<string>",
      "billingAddressLastName": "<string>",
      "billingAddressStreet": "<string>",
      "billingAddressAdditionalAddressLine": "<string>",
      "billingAddressPostalCode": "<string>",
      "billingAddressCity": "<string>",
      "billingAddressCountryName": "<string>",
      "billingAddressPhoneNumber": "<string>",
      "billingAddressMobilePhoneNumber": "<string>",
      "billingAddressFax": "<string>",
      "billingAddressEmailAddress": "<string>",
      "billingAddressPostId": "<string>",
      "billingAddressState": "<string>",
      "billingAddressCountryIso": "<string>",
      "shipmentAddressCompany": "<string>",
      "shipmentAddressAdditionalCompanyLine": "<string>",
      "shipmentAddressSalutation": "<string>",
      "shipmentAddressTitle": "<string>",
      "shipmentAddressFirstName": "<string>",
      "shipmentAddressLastName": "<string>",
      "shipmentAddressStreet": "<string>",
      "shipmentAddressAdditionalAddressLine": "<string>",
      "shipmentAddressPostalCode": "<string>",
      "shipmentAddressCity": "<string>",
      "shipmentAddressCountryName": "<string>",
      "shipmentAddressPhoneNumber": "<string>",
      "shipmentAddressMobilePhoneNumber": "<string>",
      "shipmentAddressFax": "<string>",
      "shipmentAddressEmailAddress": "<string>",
      "shipmentAddressPostId": "<string>",
      "shipmentAddressState": "<string>",
      "shipmentAddressCountryIso": "<string>",
      "assignedUserName": "<string>",
      "salesChannelName": "<string>",
      "customerGroupName": "<string>",
      "paymentMethodName": "<string>",
      "shippingMethodName": "<string>",
      "shippingCountryTotalGrossAmount": 123,
      "customerComment": "<string>",
      "paymentReference": "<string>",
      "salesInvoiceCorrectionTotalGrossAmount": 123,
      "alreadyPaidAmount": 123,
      "stillToPay": 123,
      "totalNetAmount": 123,
      "wMSLocked": 123,
      "wMSPartialShipment": 123,
      "wMSPrePicking": 123,
      "platformType": 123,
      "salesInvoiceNumbers": "<string>",
      "cancelledDate": "2023-11-07T05:31:56Z",
      "cancellationComment": "<string>",
      "cancellationUserName": "<string>",
      "cancellationReason": "<string>",
      "amazonUserId": 123,
      "createdByUserName": "<string>"
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

GET

sales-orders

Queries all sales orders.

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-orders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-orders"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/v2/sales-orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-orders")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "accountsReceivableNumber": 123,
      "assignedUserId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "companyName": "<string>",
      "createdByUserId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "currencyFactor": 123,
      "currencyIso": "<string>",
      "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerNumber": "<string>",
      "departureCountryIso": "<string>",
      "departureCountryCurrencyFactor": 123,
      "departureCountryCurrencyIso": "<string>",
      "ebayUsername": "<string>",
      "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
      "externalSalesOrderNumber": "<string>",
      "extraWeight": 123,
      "isIntraCommunityDelivery": true,
      "isCancelled": true,
      "isPending": true,
      "languageIso": "<string>",
      "lastShippingDate": "2023-11-07T05:31:56Z",
      "needsOnlineSynchronisation": true,
      "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "paymentDueDateInDays": 123,
      "processColourCode": 123,
      "processColourName": "<string>",
      "processStatusName": "<string>",
      "salesChannelId": "<string>",
      "platformId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shopId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderDate": "2023-11-07T05:31:56Z",
      "salesOrderNumber": "<string>",
      "salesOrderStatus": 123,
      "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "shippingPriority": 123,
      "shopPaymentModule": "<string>",
      "totalGrossAmount": 123,
      "isExemptFromVat": true,
      "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "onlineSalesOrderId": 123,
      "comment": "<string>",
      "printDate": "2023-11-07T05:31:56Z",
      "mailDate": "2023-11-07T05:31:56Z",
      "paymentMailDate": "2023-11-07T05:31:56Z",
      "dateOfPayment": "2023-11-07T05:31:56Z",
      "paymentDate": "2023-11-07T05:31:56Z",
      "onHoldReasonName": "<string>",
      "billingAddressCompany": "<string>",
      "billingAddressAdditionalCompanyLine": "<string>",
      "billingAddressSalutation": "<string>",
      "billingAddressTitle": "<string>",
      "billingAddressFirstName": "<string>",
      "billingAddressLastName": "<string>",
      "billingAddressStreet": "<string>",
      "billingAddressAdditionalAddressLine": "<string>",
      "billingAddressPostalCode": "<string>",
      "billingAddressCity": "<string>",
      "billingAddressCountryName": "<string>",
      "billingAddressPhoneNumber": "<string>",
      "billingAddressMobilePhoneNumber": "<string>",
      "billingAddressFax": "<string>",
      "billingAddressEmailAddress": "<string>",
      "billingAddressPostId": "<string>",
      "billingAddressState": "<string>",
      "billingAddressCountryIso": "<string>",
      "shipmentAddressCompany": "<string>",
      "shipmentAddressAdditionalCompanyLine": "<string>",
      "shipmentAddressSalutation": "<string>",
      "shipmentAddressTitle": "<string>",
      "shipmentAddressFirstName": "<string>",
      "shipmentAddressLastName": "<string>",
      "shipmentAddressStreet": "<string>",
      "shipmentAddressAdditionalAddressLine": "<string>",
      "shipmentAddressPostalCode": "<string>",
      "shipmentAddressCity": "<string>",
      "shipmentAddressCountryName": "<string>",
      "shipmentAddressPhoneNumber": "<string>",
      "shipmentAddressMobilePhoneNumber": "<string>",
      "shipmentAddressFax": "<string>",
      "shipmentAddressEmailAddress": "<string>",
      "shipmentAddressPostId": "<string>",
      "shipmentAddressState": "<string>",
      "shipmentAddressCountryIso": "<string>",
      "assignedUserName": "<string>",
      "salesChannelName": "<string>",
      "customerGroupName": "<string>",
      "paymentMethodName": "<string>",
      "shippingMethodName": "<string>",
      "shippingCountryTotalGrossAmount": 123,
      "customerComment": "<string>",
      "paymentReference": "<string>",
      "salesInvoiceCorrectionTotalGrossAmount": 123,
      "alreadyPaidAmount": 123,
      "stillToPay": 123,
      "totalNetAmount": 123,
      "wMSLocked": 123,
      "wMSPartialShipment": 123,
      "wMSPrePicking": 123,
      "platformType": 123,
      "salesInvoiceNumbers": "<string>",
      "cancelledDate": "2023-11-07T05:31:56Z",
      "cancellationComment": "<string>",
      "cancellationUserName": "<string>",
      "cancellationReason": "<string>",
      "amazonUserId": 123,
      "createdByUserName": "<string>"
    }
  ],
  "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.

Query Parameters

pageNumber

integer<int32>

Number of the page of items to fetch. Defaults to 1 when omitted.

pageSize

integer<int32>

Size of the page specified by PageNumber. Defaults to 100 when omitted.

sortBy

string

Property to sort by. Multiple comma-separated fields are applied in order (OrderBy, then ThenBy).

sortDescending

boolean

Sort in descending order. Defaults to ascending when omitted.

estimatedDeliveryDateAfter

string<date-time>

Only include items whose EstimatedDeliveryDate is after (greater than) this value.

estimatedDeliveryDateBefore

string<date-time>

Only include items whose EstimatedDeliveryDate is before (less than) this value.

lastShippingDateAfter

string<date-time>

Only include items whose LastShippingDate is after (greater than) this value.

lastShippingDateBefore

string<date-time>

Only include items whose LastShippingDate is before (less than) this value.

salesOrderDateAfter

string<date-time>

Only include items whose SalesOrderDate is after (greater than) this value.

salesOrderDateBefore

string<date-time>

Only include items whose SalesOrderDate is before (less than) this value.

printDateAfter

string<date-time>

Only include items whose PrintDate is after (greater than) this value.

printDateBefore

string<date-time>

Only include items whose PrintDate is before (less than) this value.

mailDateAfter

string<date-time>

Only include items whose MailDate is after (greater than) this value.

mailDateBefore

string<date-time>

Only include items whose MailDate is before (less than) this value.

paymentMailDateAfter

string<date-time>

Only include items whose PaymentMailDate is after (greater than) this value.

paymentMailDateBefore

string<date-time>

Only include items whose PaymentMailDate is before (less than) this value.

dateOfPaymentAfter

string<date-time>

Only include items whose DateOfPayment is after (greater than) this value.

dateOfPaymentBefore

string<date-time>

Only include items whose DateOfPayment is before (less than) this value.

paymentDateAfter

string<date-time>

Only include items whose PaymentDate is after (greater than) this value.

paymentDateBefore

string<date-time>

Only include items whose PaymentDate is before (less than) this value.

cancelledDateAfter

string<date-time>

Only include items whose CancelledDate is after (greater than) this value.

cancelledDateBefore

string<date-time>

Only include items whose CancelledDate is before (less than) this value.

Response

Paged result.

totalItems

integer<int32>

pageNumber

integer<int32>

pageSize

integer<int32>

items

object[]

Show child attributes

totalPages

integer<int32>

hasPreviousPage

boolean

hasNextPage

boolean

nextPageNumber

integer<int32>

previousPageNumber

integer<int32>

Query Invoice Workflows Creates a new sales order.

⌘I

Overview

GraphQL

REST API

Queries all sales orders.

Authorizations

Headers

Query Parameters

Response