Edit Delivery Note

patch

https://api.apicbase.com/api/v2/integrations/delivery_notes/{delivery_note_id}/

Modifies an existing delivery note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

All fields are optional, only the provided fields will be updated. Fields not specified in the request will keep their original values.

If the order_lines attribute is provided, the list of order lines informed will replace all existing order lines in the delivery note.

The created_by field cannot be updated, as it represents the original creator of the delivery note.

Path Params

delivery_note_id

string

required

The ID of the delivery note to update

Body Params

Used for updating a delivery note. All fields are optional - only provided fields will be updated.

purchase_order

The purchase order reference.

delivery_note_number

string

Delivery Note Number

document_date_time

date-time

Document Date/time

delivery_date_time

date-time

Delivery Date/time

customer_number

string | null

Customer number

delivery_fee

float | null

Delivery fee

order_lines

array of objects

length ≥ 1

List of delivery note order lines. If provided, will replace all existing order lines.

order_lines

line_number

integer

required

Line number of the item in the document

supplier_article_number

string

required

Supplier Article number

article_name

string

required

Article name

delivery_note_quantity

float

required

The primary delivered quantity (required). This is the authoritative count of what was delivered.

package_type

string | null

package_quantity

float | null

Optional. The quantity expressed in package units (e.g., number of boxes or crates).

base_quantity

float | null

Optional. The quantity expressed in base measurement units (e.g., kilograms, liters).

base_unit

string | null

gtin_ean_sales_unit

string | null

gtin_ean_consumer_unit

string | null

portioning

boolean

Defaults to false

portioning_weight

float | null

portioning_unit

string | null

portioning_description

string | null

price

float | null

Total line price (as stated on Delivery Note - if any)

vat_code

string | null

VAT-code

returnables

array of objects

List of returnable items. If provided, replaces all existing returnables. If omitted, existing returnables are preserved.

returnables

Responses

204

Delivery note updated successfully

400

Bad request - validation error

404

Delivery note not found

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here!