Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Creates delivery orders for a specific store.

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

Creates delivery orders for a specific store.

Path ParametersExpand Collapse
store_number: string
Header ParametersExpand Collapse
container_override: optional boolean
Body ParametersJSONExpand Collapse
orders: optional array of object { no_of_containers, order_number, datetime_created, 9 more }

The list of delivery orders to create.

no_of_containers: number

The number of containers in the delivery.

formatint32
order_number: string

The unique order number.

datetime_created: optional string

The datetime the order was created. Defaults to UTC now if omitted.

formatdate-time
datetime_expected: optional string

The expected delivery datetime.

formatdate-time
description: optional string

A description of the delivery order.

order_lines: optional array of object { product_number, quantity, barcode, 11 more }

The order lines in this delivery.

product_number: string

The product number.

quantity: number

The quantity being delivered.

formatdouble
barcode: optional string

The product barcode.

container_barcode: optional string

The barcode of the container this line belongs to.

customer_order_line_number: optional number

The line number on the customer order.

formatint32
customer_order_number: optional string

The customer order number this line fulfills.

customer_order_shipment_number: optional string

The customer order shipment number.

customer_order_shipment_number_line_number: optional number

The line number on the customer order shipment.

formatint32
description: optional string

A description of the order line.

line_number: optional number

The order line number.

formatint32
purchase_price: optional number

The purchase price per unit.

formatdouble
secondary_order_line_number: optional number

The line number on the secondary order.

formatint32
secondary_order_number: optional string

A secondary/external order number.

target_stock_pool: optional number

The target stock pool for the delivered goods.

formatint32
order_type: optional number

The order type identifier (e.g. 1 = purchase, 2 = transfer).

formatint32
reason_code: optional number

The reason code for the delivery.

formatint32
store_origin: optional number

The origin store number (for inter-store transfers).

formatint64
supplier_code: optional string

The unique supplier code.

supplier_name: optional string

The name of the supplier.

tracing_url: optional string

URL for tracking the delivery shipment.

ReturnsExpand Collapse
data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

success: optional boolean

Indicates whether the operation completed successfully.

Creates delivery orders for a specific store.

curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/orders/deliveries \
    -X POST \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}
Returns Examples
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}