Deliveries

List Deliveries

GET/api/v2/public/orders/deliveries

Create Store Deliveries

POST/api/v2/public/stores/{store_number}/orders/deliveries

Create Multi Store Deliveries

POST/api/v2/public/orders/deliveries

ModelsExpand Collapse

DeliveryListDeliveriesResponse object { page_size, page_start, total_count, 11 more }

Generic paginated response wrapper.

page_size: number

Maximum number of items returned per page.

formatint32

page_start: number

Current page number (1-based).

formatint32

total_count: number

Total number of records matching the query across all pages.

formatint64

list: optional array of object { datetime_created, datetime_expected, import_id, 17 more }

Collection of items for the current page.

datetime_created: string

When the order was created.

formatdate-time

datetime_expected: string

When the goods are expected to arrive.

formatdate-time

import_id: number

Identifier of the import the order arrived in.

formatint64

is_downloaded: boolean

true when the store has pulled the order down.

type: number

Type code for the order.

formatint32

updated_on: string

When the order was last changed.

formatdate-time

external_reference_number: optional string

Reference from the system the order came from.

no_of_containers: optional number

How many containers the goods arrive in.

formatint32

order_lines: optional array of object { line_number, quantity, received_quantity, 17 more }

The lines on this order.

line_number: number

Position of the line within the order.

formatint32

quantity: number

Quantity ordered.

formatdouble

received_quantity: number

Quantity actually received so far.

formatdouble

target_stock_pool: number

Stock pool the goods should be booked into.

formatint32

barcode: optional string

Barcode for the product.

base_unit: optional string

Unit the quantity is expressed in.

category_code: optional string

Category the product belongs to.

container_barcode: optional string

Barcode of the container the line arrives in.

customer_order_number: optional string

Customer order this line is reserved for.

customer_order_shipment_number: optional string

Shipment this line belongs to.

customer_order_shipment_number_line_number: optional number

Position of the line within that shipment.

formatint32

description: optional string

Product name on the line.

group_code: optional string

Group the product is ordered in.

product_number: optional string

Product on the line.

purchase_unit_barcode: optional string

Barcode of the purchase unit.

purchase_unit_product_number: optional string

Product number of the purchase unit.

purchase_unit_quantity: optional number

How many base units are in one purchase unit.

formatdouble

reference: optional string

Your own reference for the order.

rounded_quantity: optional number

Quantity after rounding to a whole purchase unit.

formatdouble

secondary_order_number: optional string

Alternate order number, when the source system uses one.

order_number: optional string

Order number in the source system.

order_type: optional string

Type of order, such as a delivery or a transfer.

recommended_location: optional object { location_code, location_tags_json, stock_pool }

location_code: optional string

location_tags_json: optional string

stock_pool: optional number

formatint32

reference: optional string

Your own reference for the order.

status: optional string

Current status of the order.

store_gln: optional string

Global Location Number of the destination store.

store_number: optional string

Store the order is for.

store_origin: optional string

Store the goods come from, for a transfer.

supplier_code: optional string

Supplier the order is placed with. Matches supplier_code on the suppliers endpoint.

supplier_name: optional string

Supplier name.

tracing_url: optional string

Link to track the shipment.

list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

Active filter criteria applied to the result set, keyed by field name.

next_page: optional number

Next page number, or null when on the last page.

formatint32

previous_page: optional number

Previous page number, or null when on the first page.

formatint64

project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

DeliveryCreateStoreDeliveriesResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

DeliveryCreateMultiStoreDeliveriesResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.