Create Sales Order - JTL Developer Documentation

Create Sales Order

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/salesOrders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "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>",
  "salesOrderDate": "2023-11-07T05:31:56Z",
  "salesOrderPaymentDetails": {
    "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "currencyIso": "<string>",
    "currencyFactor": 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",
    "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "extraWeight": 123
  },
  "colorcodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "comment": "<string>",
  "customerComment": "<string>",
  "languageIso": "<string>"
}
'

{
  "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"
}

POST

salesOrders

Create Sales Order

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/salesOrders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "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>",
  "salesOrderDate": "2023-11-07T05:31:56Z",
  "salesOrderPaymentDetails": {
    "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "currencyIso": "<string>",
    "currencyFactor": 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",
    "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "extraWeight": 123
  },
  "colorcodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "comment": "<string>",
  "customerComment": "<string>",
  "languageIso": "<string>"
}
'

{
  "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"
}

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

renameSalesOrderNumberWhenAlreadyExists

boolean

If true, the sales order number will be renamed if it already exists.

disableAutomaticWorkflows

boolean

If true, the workflows do not trigger automatic.

Body

application/json

The sales order to create.

Model Class: CreateSalesOrder

number

string

The number of the sales order.

externalNumber

string

The external number of the sales order.

billingNumber

string

The number of the invoice.

companyId

string<uuid>

The company of the sales order.

Example:

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

departureCountry

object

The departure country information of the sales order. If none is indicated, it will be determined from the company's information.

Show child attributes

customerId

string<uuid>

The customer ID.

Example:

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

customerVatID

string

The VAT ID of the customer.

billingAddress

object

The billing address of the sales order.

Show child attributes

shipmentaddress

object

The shipping address of the sales order.

Show child attributes

salesOrderDate

string<date-time>

The date when the order was created.

salesOrderPaymentDetails

object

Payment specific information of the sales order.

Show child attributes

salesOrderShippingDetail

object

Shipping specific information of the sales order.

Show child attributes

colorcodeId

string<uuid>

The colour code of the sales order.

Example:

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

comment

string

A comment on the sales order.

customerComment

string

A customer comment on the sales order.

languageIso

string

The language of the order.

Response

The created sales order.

Model Class: SalesOrder

string<uuid>

Unique ID to identify a sales order file.

Example:

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

number

string

The number of the sales order.

externalNumber

string

The external number of the sales order.

billingNumber

string

The number of the invoice.

companyId

string<uuid>

The company of the sales order.

Example:

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

departureCountry

object

The departure country information of the sales order. If none is indicated, it will be determined from the company's information.

Show child attributes

customerId

string<uuid>

The customer ID.

Example:

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

customerVatID

string

The VAT ID of the customer.

merchantVatID

string

The VAT ID of the merchant.

billingAddress

object

The billing address of the sales order.

Show child attributes

shipmentaddress

object

The shipping address of the sales order.

Show child attributes

salesOrderDate

string<date-time>

The date when the order was created.

salesOrderPaymentDetails

object

Payment specific information of the sales order.

Show child attributes

salesOrderShippingDetail

object

Shipping specific information of the sales order.

Show child attributes

colorcodeId

string<uuid>

The colour code of the sales order.

Example:

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

isExternalInvoice

boolean

Indicates if the invoice of the order was created in an external system, like Amazon VCS.

comment

string

A comment on the sales order.

customerComment

string

A customer comment on the sales order.

isCancelled

boolean

Indicates if the order has been cancelled. There is a special endpoint for cancelling sales orders.

languageIso

string

The language of the order.

cancellationDetails

object

The cancellation details in case the sales order has been cancelled.

Show child attributes

salesChannelId

string

The sales channel of the sales order.

userCreatedId

string<uuid>

The user who created the sales order.

Example:

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

userId

string<uuid>

The user who is responsible for the sales order.

Example:

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

transactionStatusId

string<uuid>

Unique ID to identify a transaction's status.

Example:

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

Query Sales Orders Get Sales Order

⌘I