Patch Package Data - JTL Developer Documentation

curl --request PATCH \ --url https://api.jtl-cloud.com/erp/deliveryNotes/packages/{packageId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'x-tenant-id: <x-tenant-id>' \ --data ' { "TrackingID": "<string>", "ShippedDate": "2023-11-07T05:31:56Z", "Comment": "<string>" } '

{ "Id": 123, "PackageDate": "2023-11-07T05:31:56Z", "TrackingID": "<string>", "Weights": 123, "ShippingMethodId": 123, "ShippedDate": "2023-11-07T05:31:56Z", "TrackingUrl": "<string>", "Comment": "<string>" }

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.

Path Parameters

packageId

integer<int32>

required

The id of the package.

Body

application/json

The Package to update

Model Class: UpdateDeliveryNotePackagePosting

TrackingID

string

required

The tracking Id of the package.

ShippedDate

string<date-time>

The date when the package was shipped.

Comment

string

The comment of the package.

Response

Returns the package that are created for the delivery note.

Model Class: DeliveryNotePackage

integer<int32>

required

The id of the package.

PackageDate

string<date-time>

required

The date when the package was created.

TrackingID

string

required

The tracking Id of the package.

Weights

number<decimal>

required

The weight of the package.

ShippingMethodId

integer<int32>

required

The shipping method of the package.

ShippedDate

string<date-time>

required

The date when the package was shipped.

TrackingUrl

string

required

The tracking url of the package.

Comment

string

required

The comment of the package.