Deliveries

List Deliveries

deliveries.list_deliveries() -> DeliveryListDeliveriesResponse

GET/api/v2/public/orders/deliveries

Create Store Deliveries

deliveries.create_store_deliveries(, ) -> DeliveryCreateStoreDeliveriesResponse

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

Create Multi Store Deliveries

deliveries.create_multi_store_deliveries() -> DeliveryCreateMultiStoreDeliveriesResponse

POST/api/v2/public/orders/deliveries

ModelsExpand Collapse

class DeliveryListDeliveriesResponse: …

Generic paginated response wrapper.

page_size: int

Maximum number of items returned per page.

formatint32

page_start: int

Current page number (1-based).

formatint32

total_count: int

Total number of records matching the query across all pages.

formatint64

list: Optional[List[List]]

Collection of items for the current page.

datetime_created: datetime

When the order was created.

formatdate-time

datetime_expected: datetime

When the goods are expected to arrive.

formatdate-time

import_id: int

Identifier of the import the order arrived in.

formatint64

is_downloaded: bool

true when the store has pulled the order down.

type: int

Type code for the order.

formatint32

updated_on: datetime

When the order was last changed.

formatdate-time

external_reference_number: Optional[str]

Reference from the system the order came from.

no_of_containers: Optional[int]

How many containers the goods arrive in.

formatint32

order_lines: Optional[List[ListOrderLine]]

The lines on this order.

line_number: int

Position of the line within the order.

formatint32

quantity: float

Quantity ordered.

formatdouble

received_quantity: float

Quantity actually received so far.

formatdouble

target_stock_pool: int

Stock pool the goods should be booked into.

formatint32

barcode: Optional[str]

Barcode for the product.

base_unit: Optional[str]

Unit the quantity is expressed in.

category_code: Optional[str]

Category the product belongs to.

container_barcode: Optional[str]

Barcode of the container the line arrives in.

customer_order_number: Optional[str]

Customer order this line is reserved for.

customer_order_shipment_number: Optional[str]

Shipment this line belongs to.

customer_order_shipment_number_line_number: Optional[int]

Position of the line within that shipment.

formatint32

description: Optional[str]

Product name on the line.

group_code: Optional[str]

Group the product is ordered in.

product_number: Optional[str]

Product on the line.

purchase_unit_barcode: Optional[str]

Barcode of the purchase unit.

purchase_unit_product_number: Optional[str]

Product number of the purchase unit.

purchase_unit_quantity: Optional[float]

How many base units are in one purchase unit.

formatdouble

reference: Optional[str]

Your own reference for the order.

rounded_quantity: Optional[float]

Quantity after rounding to a whole purchase unit.

formatdouble

secondary_order_number: Optional[str]

Alternate order number, when the source system uses one.

order_number: Optional[str]

Order number in the source system.

order_type: Optional[str]

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

recommended_location: Optional[ListRecommendedLocation]

location_code: Optional[str]

location_tags_json: Optional[str]

stock_pool: Optional[int]

formatint32

reference: Optional[str]

Your own reference for the order.

status: Optional[str]

Current status of the order.

store_gln: Optional[str]

Global Location Number of the destination store.

store_number: Optional[str]

Store the order is for.

store_origin: Optional[str]

Store the goods come from, for a transfer.

supplier_code: Optional[str]

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

supplier_name: Optional[str]

Supplier name.

tracing_url: Optional[str]

Link to track the shipment.

list_body: Optional[Dict[str, Optional[object]]]

Additional body-level metadata for the list.

list_filters: Optional[Dict[str, Optional[List[str]]]]

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

next_page: Optional[int]

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

formatint32

previous_page: Optional[int]

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

formatint64

project_last_modified_date: Optional[str]

Last modified date/time of the project.

scroll_id: Optional[str]

Opaque scroll identifier for deep-pagination scenarios.

server_time: Optional[str]

Server UTC date/time when the response was generated.

sort_column: Optional[str]

Column name the results are sorted by.

sort_order: Optional[str]

Sort direction (asc or desc).

task_last_modified_date: Optional[str]

Last modified date/time of the task.

class DeliveryCreateStoreDeliveriesResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

class DeliveryCreateMultiStoreDeliveriesResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.