Deliveries

Retrieves a paginated list of delivery orders.

GET/api/v2/public/orders/deliveries

Creates delivery orders for a specific store.

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

Creates delivery orders across multiple stores.

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, 14 more }

Collection of items for the current page.

datetime_created: string

formatdate-time

datetime_expected: string

formatdate-time

import_id: number

formatint64

is_downloaded: boolean

updated_on: string

formatdate-time

external_reference_number: optional string

no_of_containers: optional number

formatint32

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

line_number: number

formatint32

quantity: number

formatdouble

received_quantity: number

formatdouble

target_stock_pool: number

formatint32

barcode: optional string

base_unit: optional string

category_code: optional string

container_barcode: optional string

customer_order_number: optional string

customer_order_shipment_number: optional string

customer_order_shipment_number_line_number: optional number

formatint32

description: optional string

group_code: optional string

product_number: optional string

purchase_unit_barcode: optional string

purchase_unit_product_number: optional string

purchase_unit_quantity: optional number

formatdouble

rounded_quantity: optional number

formatdouble

secondary_order_number: optional string

order_number: optional string

order_type: optional string

status: optional string

store_gln: optional string

store_number: optional string

store_origin: optional string

supplier_code: optional string

supplier_name: optional string

tracing_url: optional string

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.