JTjtl-software
salesorder

Create Sales Order

Create a new sales order

post/v2/salesOrders

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessalesorders.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopessalesorders.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

renameSalesOrderNumberWhenAlreadyExistsboolean

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

disableAutomaticWorkflowsboolean

If true, the workflows do not trigger automatic.

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.

Request body

numberstring

The number of the sales order.

externalNumberstring

The external number of the sales order.

billingNumberstring

The number of the invoice.

companyIdstring uuid

Represents a key for identifying a firm within the application.

customerIdstring uuid

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

customerVatIDstring

The VAT ID of the customer.

salesOrderDatestring date-time

The date when the order was created.

colorcodeIdstring uuid

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

commentstring

A comment on the sales order.

customerCommentstring

A customer comment on the sales order.

languageIsostring

The language of the order.

Example request

{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "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"
}

Response

The created sales order.

idstring uuid
numberstring

The number of the sales order.

externalNumberstring

The external number of the sales order.

billingNumberstring

The number of the invoice.

companyIdstring uuid

Represents a key for identifying a firm within the application.

customerIdstring uuid

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

customerVatIDstring

The VAT ID of the customer.

merchantVatIDstring

The VAT ID of the merchant.

salesOrderDatestring date-time

The date when the order was created.

colorcodeIdstring uuid

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

isExternalInvoiceboolean

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

commentstring

A comment on the sales order.

customerCommentstring

A customer comment on the sales order.

isCancelledboolean

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

languageIsostring

The language of the order.

salesChannelIdstring

The sales channel of the sales order.

userCreatedIdstring uuid
userIdstring uuid
transactionStatusIdstring uuid

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.