Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Creates delivery orders across multiple stores.

deliveries.create_multi_store_deliveries(DeliveryCreateMultiStoreDeliveriesParams**kwargs) -> DeliveryCreateMultiStoreDeliveriesResponse
POST/api/v2/public/orders/deliveries

Creates delivery orders across multiple stores.

ParametersExpand Collapse
orders: Optional[Iterable[Order]]

The list of multi-store delivery orders to create.

no_of_containers: Optional[int]

The number of containers.

formatint32
order_number: str

The unique order number.

store_number: str

The target store number.

supplier_name: str

The name of the supplier.

datetime_created: Optional[Union[str, datetime, null]]

The datetime the order was created.

formatdate-time
datetime_expected: Optional[Union[str, datetime]]

The expected delivery datetime.

formatdate-time
description: Optional[str]

A description of the delivery order.

order_lines: Optional[Iterable[OrderOrderLine]]

The order lines in this delivery.

quantity: float

The quantity being delivered.

formatdouble
barcode: Optional[str]

The product barcode.

container_barcode: Optional[str]

The barcode of the container this line belongs to.

customer_order_line_number: Optional[int]

The line number on the customer order.

formatint32
customer_order_number: Optional[str]

The customer order number this line fulfills.

customer_order_shipment_number: Optional[str]

The customer order shipment number.

customer_order_shipment_number_line_number: Optional[int]

The line number on the customer order shipment.

formatint32
description: Optional[str]

A description of the order line.

line_number: Optional[int]

The order line number.

formatint32
product_number: Optional[str]

The product number.

secondary_order_line_number: Optional[int]

The line number on the secondary order.

formatint32
secondary_order_number: Optional[str]

A secondary/external order number.

target_stock_pool: Optional[int]

The target stock pool for the delivered goods.

formatint32
order_type: Optional[int]

The order type identifier.

formatint32
reason_code: Optional[int]

The reason code for the delivery.

formatint32
supplier_code: Optional[str]

The unique supplier code.

tracing_url: Optional[str]

URL for tracking the delivery shipment.

container_override: Optional[bool]
ReturnsExpand Collapse
class DeliveryCreateMultiStoreDeliveriesResponse: …

Standard success response returned by mutation endpoints.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

success: Optional[bool]

Indicates whether the operation completed successfully.

Creates delivery orders across multiple stores.

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.deliveries.create_multi_store_deliveries()
print(response.data)
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}
Returns Examples
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}