🔒 Update delivery note line item V3

patch

https://{xentralId}.xentral.biz/api/v3/deliveryNotes/{id}/lineItems/{lineItemId}

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: deliveryNote:update.

Update a line item in a delivery note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

lineItemId

string

required

Body Params

name

string

Name of the line item.

description

string | null

Description of the line item.

quantity

float

Quantity of the line item.

deliveryDate

date | null

Delivery date of the line item.

deliveryDateAsCalendarWeek

boolean

Defaults to false

Whether to show the delivery date as calendar week or explicit.

internalComment

string | null

Internal comment for the line item.

sort

integer

Sort order of the line item.

unit

string | null

Unit of the line item (e.g., "kg", "pcs").

countryOfOrigin

string | null

Country of origin for the product. The legacy empty value "0" is returned as null.

hsCode

string | null

Harmonized System (HS) code for the product.

customerProductNumber

string | null

Customer product number for the line item.

packagingUnit

string | null

Packaging unit (VPE) of the line item — how many units one package contains. On purchase orders a numeric value greater than 1 makes the generated PDF present the line in packages: the price is printed per package, the quantity in packages, and the unit as "VPE". On all other document types the value is stored and carried over on document conversion, but nothing reads it — in particular, the stored quantity, the stored unit price, and the values returned by the API are never derived from it.

project

Project of the line item. Pass null to remove the project assignment.

customFields

array of objects

Custom field values for the line item. Accepts the customField1 to customField40 keys as well as any custom field configured for this line item in your Xentral instance. Listed keys are written, keys that are not listed are left untouched. Pass value: null to clear a single field.

customFields

printSettings

object

Print settings for this line item

desiredQualityControlAttributes

object

Desired quality control attributes for the line item.

deliveredQuantity

float

Delivered quantity of the line item

freeOfCharge

boolean

If true, this line item is delivered free of charge (not billable).

customs

object

Customs information for the line item. Both customs values are stored with one shared currency, so the currency sent with either of them applies to both.

sscc

string | null

The SSCC (Serial Shipping Container Code) for this line item.

package

string | null

The package identifier for this line item.

packagingUnitQuantity

float

≥ 0

The quantity of packaging units for this line item.

individualPieceQuantity

float

≥ 0

The quantity of individual pieces for this line item.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Update a line item in a delivery note.

400Failed validation

409Problem occurred

429Too Many Requests