Skip to main content
POST
/
v2
/
package
/
deliver
Delivers an existing Package
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/package/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "packageId": "<string>",
  "trackingCode": "<string>",
  "shippingDate": "2023-11-07T05:31:56Z"
}
'

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.

Body

application/json

Request parameters

Delivers an existing Package - Request

​
packageId
string

ID of the Package to be modified

​
trackingCode
string

The Tracking Code of the Package. Only required if configured in the Shipping Method

​
shippingDate
string<date-time>

The Shipping Date of the Package. Only required if configured in the Shipping Method

Response

200 - application/json

Package was successfully Delivered.