Create Store Deliveries

deliveries.create_store_deliveries(, ) -> DeliveryCreateStoreDeliveriesResponse

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.

ParametersExpand Collapse

store_number: str

orders: Optional[Iterable[Order]]

The list of delivery orders to create.

no_of_containers: int

The number of containers in the delivery.

formatint32

order_number: str

The unique order number.

minLength1

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

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

formatdate-time

datetime_expected: Optional[Union[str, datetime]]

The expected delivery datetime.

formatdate-time

delivery_type: Optional[str]

The delivery type value stored on the delivery header.

description: Optional[str]

A description of the delivery order.

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

The source file or message datetime for the delivery.

formatdate-time

order_lines: Optional[Iterable[OrderOrderLine]]

The order lines in this delivery.

product_number: str

The product number.

minLength1

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

ordered_quantity: Optional[float]

The originally ordered quantity.

formatdouble

product_description: Optional[str]

A description of the product.

purchase_price: Optional[float]

The purchase price per unit.

formatdouble

quantity: Optional[float]

The quantity being delivered.

formatdouble

reference: Optional[str]

An external reference for the order line.

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 (e.g. 1 = purchase, 2 = transfer).

formatint32

reason_code: Optional[int]

The reason code for the delivery.

formatint32

receipt_sampling_type: Optional[int]

The receipt sampling type to apply to the delivery.

formatint32

recommended_location: Optional[OrderRecommendedLocation]

location_code: Optional[str]

location_tags_json: Optional[str]

stock_pool: Optional[int]

formatint32

reference: Optional[str]

An external reference for the delivery order.

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

The datetime the delivery was shipped.

formatdate-time

store_origin: Optional[str]

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

supplier_code: Optional[str]

The unique supplier code.

supplier_name: Optional[str]

The name of the supplier.

tracing_url: Optional[str]

URL for tracking the delivery shipment.

container_override: Optional[bool]

is_auto_receipt_and_sampling_allow: Optional[bool]

ReturnsExpand Collapse

class DeliveryCreateStoreDeliveriesResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

Create Store Deliveries

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_store_deliveries(
    store_number="store_number",
)
print(response.success)

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