Update a delivery note

patch

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

Update an existing delivery note. All fields are optional - only provided fields will be updated. If order lines are provided, they will replace all existing order lines in the delivery note. Note: The created_by field cannot be updated as it represents the original creator.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

outlet_id

string

required

The ID of the outlet

delivery_note_id

string

required

The ID of the delivery note to update

Body Params

purchase_order

The purchase order reference. If changed, the supplier will be updated accordingly.

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

Customer number

delivery_fee

float

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

Delivered quantity

package_type

string

package_quantity

float

base_quantity

float

base_unit

string

gtin_ean_sales_unit

string

gtin_ean_consumer_unit

string

portioning

boolean

Defaults to false

portioning_weight

float

portioning_unit

string

portioning_description

string

price

float

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

vat_code

string

VAT-code (can be used for (external) VAT mapping later on)

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!