Create Multi Store Deliveries

POST/api/v2/public/orders/deliveries

Same as the single-store delivery endpoint, but each order names its own destination store. Use it to announce a delivery run for several stores in one call.

Header ParametersExpand Collapse

container_override: optional boolean

Body ParametersJSONExpand Collapse

orders: optional array of object { no_of_containers, order_number, store_number, 11 more }

The list of multi-store delivery orders to create.

no_of_containers: number

The number of containers.

formatint32

order_number: string

The unique order number.

minLength1

store_number: string

The target store number.

minLength1

supplier_name: string

The name of the supplier.

minLength1

datetime_created: optional string

The datetime the order was created.

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 { quantity, barcode, container_barcode, 11 more }

The order lines in this delivery.

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

product_number: optional string

The product number.

reference: optional string

The reference for the delivery 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.

target_stock_pool: optional number

The target stock pool for the delivered goods.

formatint32

order_type: optional number

The order type identifier.

formatint32

reason_code: optional number

The reason code for the delivery.

formatint32

recommended_location: optional object { location_code, location_tags_json, stock_pool }

location_code: optional string

location_tags_json: optional string

stock_pool: optional number

formatint32

reference: optional string

The reference for the delivery order.

supplier_code: optional string

The unique supplier code.

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.

Create Multi Store Deliveries

curl https://api.colleqtive.net/api/v2/public/orders/deliveries \
    -X POST \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

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

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

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

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}