Skip to main content
POST
/
delivery
/
deliver
Deliver Sales Order
curl --request POST \
  --url https://api.jtl-cloud.com/erp/delivery/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "PicklistIds": [
    123
  ],
  "DeliveryPackage": [
    {
      "SalesOrderId": 123,
      "ShippingMethodId": 123,
      "Weight": 123,
      "ShippingDate": "2023-11-07T05:31:56Z",
      "TrackingId": "<string>",
      "EnclosedReturnIdentCode": "<string>",
      "Note": "<string>"
    }
  ],
  "IsPartialDelivery": true,
  "DeliverOptions": {
    "IsDelilveryNotePerWarehouse": true,
    "IsSetDispatch": true,
    "IsCreateInvoice": true,
    "IsInvoiceForOnlySendItems": true
  },
  "DeliveryPositionNotes": [
    {
      "SalesOrderPositionId": 123,
      "Note": "<string>"
    }
  ],
  "DeliverySerialNumbers": [
    {
      "SerialNumber": "<string>",
      "PickpositionId": 123,
      "Description1": "<string>",
      "Description2": "<string>"
    }
  ]
}
'
{
  "SplitOrders": [
    123
  ],
  "NewOrders": [
    123
  ],
  "NewPicklists": [
    123
  ],
  "NewDeliveryNotes": [
    123
  ],
  "ProcessedPicklists": [
    123
  ],
  "DeliveredOrders": [
    123
  ],
  "NewSupplierOrders": [
    123
  ],
  "NewFulfillmentOrders": [
    123
  ]
}

Authorizations

Authorization
string
header
required

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

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

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

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Deliver input model

Model Class: CreateDeliverRequest

PicklistIds
integer<int32>[]
required

Picklist IDs

DeliveryPackage
object[]
required

List of Packages

IsPartialDelivery
boolean
required

deliver the sales order partially

DeliverOptions
object

Options for the delivery

DeliveryPositionNotes
object[]

the note for the delivery position

DeliverySerialNumbers
object[]

the serialNumbers of the items

Response

Successfully delivered the Sales Orders

Model Class: DeliverResponse

SplitOrders
integer<int32>[]
required

Orders that has been splitted

NewOrders
integer<int32>[]
required

Newly created orders

NewPicklists
integer<int32>[]
required

Newly created orders

NewDeliveryNotes
integer<int32>[]
required

Newly created orders

ProcessedPicklists
integer<int32>[]
required

Newly created orders

DeliveredOrders
integer<int32>[]
required

Newly created orders

NewSupplierOrders
integer<int32>[]
required

Newly created orders

NewFulfillmentOrders
integer<int32>[]
required

Newly created orders