Retrieves a single sales order by its ID.

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

import requests

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

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/{id}', 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/{id}",
  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/{id}"

	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/{id}")
  .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/{id}")

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

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentInfo": {
    "accountHolder": "<string>",
    "bankName": "<string>",
    "bIC": "<string>",
    "creditorId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "endToEndId": "<string>",
    "iBAN": "<string>",
    "mandateReference": "<string>",
    "paymentInfo": "<string>",
    "paymentInfoType": 123,
    "paymentReference": "<string>",
    "referenceEmail": "<string>"
  },
  "text": {
    "comment": "<string>",
    "customerComment": "<string>",
    "printText": "<string>",
    "processStatus": "<string>"
  },
  "salesOrderDate": "2023-11-07T05:31:56Z",
  "isCancelled": true,
  "isPending": true,
  "salesOrderStatus": 123,
  "salesOrderNumber": "<string>",
  "departureCountry": {
    "countryIso": "<string>",
    "currencyIso": "<string>",
    "currencyFactor": 123,
    "state": "<string>"
  },
  "externalDetails": {
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalSalesOrderNumber": "<string>"
  },
  "paymentDetails": {
    "cashDiscount": 123,
    "cashDiscountDays": 123,
    "financingCosts": 123,
    "paymentDueDateInDays": 123,
    "currencyIso": "<string>",
    "currencyFactor": 123
  },
  "shippingDetails": {
    "deliveryFromDate": "2023-11-07T05:31:56Z",
    "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
    "extraWeight": 123,
    "maxDeliveryDays": 123,
    "shippingDate": "2023-11-07T05:31:56Z",
    "shippingPriority": 123
  },
  "taxDetails": {},
  "processColourId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "cartonItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "languageIso": "<string>",
  "customerSalesOrderNumber": "<string>",
  "vatId": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shipmentAddress": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "billingAddress": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "lineItems": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sku": "<string>",
      "isReserved": true,
      "name": "<string>",
      "fnSku": "<string>",
      "quantity": 123,
      "salesUnit": "<string>",
      "salesPriceNet": 123,
      "salesPriceGross": 123,
      "discountPercent": 123,
      "purchasePriceNet": 123,
      "taxRate": 123,
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "note": "<string>",
      "totalSalesPriceNet": 123,
      "totalSalesPriceGross": 123,
      "sortOrder": 123,
      "standardName": "<string>",
      "hasUpload": true,
      "parentSalesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "keyFigures": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "alreadyPaidAmount": 123,
    "creditsTotalGrossAmount": 123,
    "dateOfPayment": "2023-11-07T05:31:56Z",
    "emailedDate": "2023-11-07T05:31:56Z",
    "invoiceNumbers": "<string>",
    "invoicesTotalGrossAmount": 123,
    "invoicesTotalNetAmount": 123,
    "isCashOnDelivery": true,
    "isFullyReturned": true,
    "isLockedForDelivery": true,
    "lastShippingDate": "2023-11-07T05:31:56Z",
    "packageCount": 123,
    "paymentMailDate": "2023-11-07T05:31:56Z",
    "printedDate": "2023-11-07T05:31:56Z",
    "shippedPackageCount": 123,
    "shippingMailDate": "2023-11-07T05:31:56Z",
    "stillToPay": 123,
    "stillToPayWithoutCancellation": 123,
    "totalGrossAmount": 123,
    "totalNetAmount": 123,
    "totalGrossAmountExcludingShipping": 123,
    "totalNetAmountExcludingShipping": 123,
    "shippingCostNet": 123,
    "shippingCostGross": 123,
    "vatAmounts": [
      {
        "taxRate": 123,
        "vatAmount": 123
      }
    ]
  },
  "invoices": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesInvoiceNumber": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "isCancelled": true,
      "isDraft": true
    }
  ]
}

GET

sales-orders

{id}

Retrieves a single sales order by its ID.

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

import requests

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

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/{id}', 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/{id}",
  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/{id}"

	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/{id}")
  .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/{id}")

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

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentInfo": {
    "accountHolder": "<string>",
    "bankName": "<string>",
    "bIC": "<string>",
    "creditorId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "endToEndId": "<string>",
    "iBAN": "<string>",
    "mandateReference": "<string>",
    "paymentInfo": "<string>",
    "paymentInfoType": 123,
    "paymentReference": "<string>",
    "referenceEmail": "<string>"
  },
  "text": {
    "comment": "<string>",
    "customerComment": "<string>",
    "printText": "<string>",
    "processStatus": "<string>"
  },
  "salesOrderDate": "2023-11-07T05:31:56Z",
  "isCancelled": true,
  "isPending": true,
  "salesOrderStatus": 123,
  "salesOrderNumber": "<string>",
  "departureCountry": {
    "countryIso": "<string>",
    "currencyIso": "<string>",
    "currencyFactor": 123,
    "state": "<string>"
  },
  "externalDetails": {
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalSalesOrderNumber": "<string>"
  },
  "paymentDetails": {
    "cashDiscount": 123,
    "cashDiscountDays": 123,
    "financingCosts": 123,
    "paymentDueDateInDays": 123,
    "currencyIso": "<string>",
    "currencyFactor": 123
  },
  "shippingDetails": {
    "deliveryFromDate": "2023-11-07T05:31:56Z",
    "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
    "extraWeight": 123,
    "maxDeliveryDays": 123,
    "shippingDate": "2023-11-07T05:31:56Z",
    "shippingPriority": 123
  },
  "taxDetails": {},
  "processColourId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "cartonItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "languageIso": "<string>",
  "customerSalesOrderNumber": "<string>",
  "vatId": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shipmentAddress": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "billingAddress": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "lineItems": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sku": "<string>",
      "isReserved": true,
      "name": "<string>",
      "fnSku": "<string>",
      "quantity": 123,
      "salesUnit": "<string>",
      "salesPriceNet": 123,
      "salesPriceGross": 123,
      "discountPercent": 123,
      "purchasePriceNet": 123,
      "taxRate": 123,
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "note": "<string>",
      "totalSalesPriceNet": 123,
      "totalSalesPriceGross": 123,
      "sortOrder": 123,
      "standardName": "<string>",
      "hasUpload": true,
      "parentSalesOrderLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "keyFigures": {
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "alreadyPaidAmount": 123,
    "creditsTotalGrossAmount": 123,
    "dateOfPayment": "2023-11-07T05:31:56Z",
    "emailedDate": "2023-11-07T05:31:56Z",
    "invoiceNumbers": "<string>",
    "invoicesTotalGrossAmount": 123,
    "invoicesTotalNetAmount": 123,
    "isCashOnDelivery": true,
    "isFullyReturned": true,
    "isLockedForDelivery": true,
    "lastShippingDate": "2023-11-07T05:31:56Z",
    "packageCount": 123,
    "paymentMailDate": "2023-11-07T05:31:56Z",
    "printedDate": "2023-11-07T05:31:56Z",
    "shippedPackageCount": 123,
    "shippingMailDate": "2023-11-07T05:31:56Z",
    "stillToPay": 123,
    "stillToPayWithoutCancellation": 123,
    "totalGrossAmount": 123,
    "totalNetAmount": 123,
    "totalGrossAmountExcludingShipping": 123,
    "totalNetAmountExcludingShipping": 123,
    "shippingCostNet": 123,
    "shippingCostGross": 123,
    "vatAmounts": [
      {
        "taxRate": 123,
        "vatAmount": 123
      }
    ]
  },
  "invoices": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesInvoiceNumber": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "isCancelled": true,
      "isDraft": true
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Headers

x-companyid

string

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

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

string<uuid>

required

Example:

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

Response

A single sales order.

string<uuid>

Unique ID to identify a sales order.

Example:

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

customerId

string<uuid>

Customer this SalesOrder belongs to.

Example:

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

paymentInfo

object

SalesOrderPaymentInfo

Show child attributes

text

object

SalesOrderText

Show child attributes

salesOrderDate

string<date-time>

The SalesOrder Date

isCancelled

boolean

Indicates if the order has been cancelled.

isPending

boolean

The SalesOrder IsPending

itemDescriptionType

enum<integer>

The SalesOrder ItemDescriptionType

Available options:

0,

1,

2

readOnlyType

enum<integer>

The SalesOrder ReadOnlyType

Available options:

0,

1,

2

salesOrderStatus

integer<int32>

The SalesOrder SalesOrderStatus

salesOrderNumber

string

The SalesOrder SalesOrderNumber

departureCountry

object

DepartureCountry

Show child attributes

externalDetails

object

ExternalDetails

Show child attributes

paymentDetails

object

PaymentDetails

Show child attributes

shippingDetails

object

ShippingDetails

Show child attributes

taxDetails

object

TaxDetails

Show child attributes

processColourId

string<uuid>

The SalesOrder Process colour id

Example:

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

onHoldReasonId

string<uuid>

The SalesOrder OnHold reason id

Example:

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

cartonItemId

string<uuid>

The SalesOrder Carton item id

Example:

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

paymentMethodId

string<uuid>

The SalesOrder Payment method id

Example:

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

shippingMethodId

string<uuid>

The SalesOrder Shipping method id

Example:

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

processStatusId

string<uuid>

The SalesOrder Process status id

Example:

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

languageIso

string

The SalesOrder Language iso code

customerSalesOrderNumber

string

The SalesOrder Customer sales order number

vatId

string

The SalesOrder Vat Id

companyId

string<uuid>

The SalesOrder Company Id

Example:

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

shipmentAddress

object

SalesOrderShipmentAddress

Show child attributes

billingAddress

object

SalesOrderBillingAddress

Show child attributes

lineItems

object[]

List of SalesOrderLineItem

Show child attributes

keyFigures

object

Key figures of the sales order.

Show child attributes

invoices

object[]

List of invoices associated with this sales order

Show child attributes

Creates a new sales order.Marks a given sales order as completely paid by creating a payment with the open amount of the sales order.

⌘I

Overview

GraphQL

REST API

Retrieves a single sales order by its ID.

Authorizations

Headers

Path Parameters

Response