Skip to content
Colleqtive Developer
Get started
API Reference

Deliveries

Retrieves a paginated list of delivery orders.
deliveries.list_deliveries(DeliveryListDeliveriesParams**kwargs) -> DeliveryListDeliveriesResponse
GET/api/v2/public/orders/deliveries
Creates delivery orders for a specific store.
deliveries.create_store_deliveries(strstore_number, DeliveryCreateStoreDeliveriesParams**kwargs) -> DeliveryCreateStoreDeliveriesResponse
POST/api/v2/public/stores/{store_number}/orders/deliveries
Creates delivery orders across multiple stores.
deliveries.create_multi_store_deliveries(DeliveryCreateMultiStoreDeliveriesParams**kwargs) -> 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
formatdate-time
datetime_expected: datetime
formatdate-time
import_id: int
formatint64
is_downloaded: bool
updated_on: datetime
formatdate-time
external_reference_number: Optional[str]
no_of_containers: Optional[int]
formatint32
order_lines: Optional[List[ListOrderLine]]
line_number: int
formatint32
quantity: float
formatdouble
received_quantity: float
formatdouble
target_stock_pool: int
formatint32
barcode: Optional[str]
base_unit: Optional[str]
category_code: Optional[str]
container_barcode: Optional[str]
customer_order_number: Optional[str]
customer_order_shipment_number: Optional[str]
customer_order_shipment_number_line_number: Optional[int]
formatint32
description: Optional[str]
group_code: Optional[str]
product_number: Optional[str]
purchase_unit_barcode: Optional[str]
purchase_unit_product_number: Optional[str]
purchase_unit_quantity: Optional[float]
formatdouble
rounded_quantity: Optional[float]
formatdouble
secondary_order_number: Optional[str]
order_number: Optional[str]
order_type: Optional[str]
status: Optional[str]
store_gln: Optional[str]
store_number: Optional[str]
store_origin: Optional[str]
supplier_code: Optional[str]
supplier_name: Optional[str]
tracing_url: Optional[str]
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.