Create Store Deliveries

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

Announces inbound deliveries for one store so goods can be received against an expected order. Each order carries its lines and optionally the containers the goods arrive in.

Path ParametersExpand Collapse

store_number: string

Header ParametersExpand Collapse

container_override: optional boolean

is_auto_receipt_and_sampling_allow: optional boolean

Body ParametersJSONExpand Collapse

orders: optional array of object { no_of_containers, order_number, datetime_created, 15 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.

minLength1

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

delivery_type: optional string

The delivery type value stored on the delivery header.

description: optional string

A description of the delivery order.

file_datetime: optional string

The source file or message datetime for the delivery.

formatdate-time

order_lines: optional array of object { product_number, barcode, container_barcode, 14 more }

The order lines in this delivery.

product_number: string

The product number.

minLength1

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

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

quantity: optional number

The quantity being delivered.

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.

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

receipt_sampling_type: optional number

The receipt sampling type to apply to 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

An external reference for the delivery order.

shipped_datetime: optional string

The datetime the delivery was shipped.

formatdate-time

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.

Create Store Deliveries

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"
}

{
  "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."
}