Creates delivery orders for a specific store.

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

Path ParametersExpand Collapse

store_number: string

Header ParametersExpand Collapse

container_override: optional boolean

Body ParametersJSONExpand Collapse

orders: optional array of object { datetime_expected, no_of_containers, order_number, 10 more }

The list of delivery orders to create.

datetime_expected: string

The expected delivery datetime.

formatdate-time

no_of_containers: number

The number of containers in the delivery.

formatint32

order_number: string

The unique order number.

minLength1

order_type: number

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

formatint32

datetime_created: optional string

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

formatdate-time

description: optional string

A description of the delivery order.

order_lines: optional array of object { line_number, product_number, quantity, 14 more }

The order lines in this delivery.

line_number: number

The order line number.

formatint32

product_number: string

The product number.

minLength1

quantity: number

The quantity being delivered.

formatdouble

target_stock_pool: number

The target stock pool for the delivered goods.

formatint32

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.

ordered_quantity: optional number

The originally ordered quantity.

formatdouble

product_description: optional string

A description of the product.

purchase_price: optional number

The purchase price per unit.

formatdouble

reference: optional string

An external reference for the order line.

secondary_order_line_number: optional number

The line number on the secondary order.

formatint32

secondary_order_number: optional string

A secondary/external order number.

reason_code: optional number

The reason code for the delivery.

formatint32

reference: optional string

An external reference for the delivery order.

store_origin: optional string

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

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

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.

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"

{
  "success": true,
  "data": "data",
  "message": "message"
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}