Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Create Store Deliveries

DeliveryCreateStoreDeliveriesResponse Deliveries.CreateStoreDeliveries(DeliveryCreateStoreDeliveriesParamsparameters, CancellationTokencancellationToken = default)
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
DeliveryCreateStoreDeliveriesParams parameters
required string storeNumber

Path param: The store number.

IReadOnlyList<Order>? orders

Body param: The list of delivery orders to create.

required Int NoOfContainers

The number of containers in the delivery.

formatint32
required string OrderNumber

The unique order number.

minLength1
DateTimeOffset? DatetimeCreated

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

formatdate-time
DateTimeOffset DatetimeExpected

The expected delivery datetime.

formatdate-time
string? DeliveryType

The delivery type value stored on the delivery header.

string? Description

A description of the delivery order.

DateTimeOffset? FileDatetime

The source file or message datetime for the delivery.

formatdate-time
IReadOnlyList<OrderLine>? OrderLines

The order lines in this delivery.

required string ProductNumber

The product number.

minLength1
string? Barcode

The product barcode.

string? ContainerBarcode

The barcode of the container this line belongs to.

Int? CustomerOrderLineNumber

The line number on the customer order.

formatint32
string? CustomerOrderNumber

The customer order number this line fulfills.

string? CustomerOrderShipmentNumber

The customer order shipment number.

Int? CustomerOrderShipmentNumberLineNumber

The line number on the customer order shipment.

formatint32
string? Description

A description of the order line.

Int LineNumber

The order line number.

formatint32
Double? OrderedQuantity

The originally ordered quantity.

formatdouble
string? ProductDescription

A description of the product.

Double? PurchasePrice

The purchase price per unit.

formatdouble
Double Quantity

The quantity being delivered.

formatdouble
string? Reference

An external reference for the order line.

Int? SecondaryOrderLineNumber

The line number on the secondary order.

formatint32
string? SecondaryOrderNumber

A secondary/external order number.

Int TargetStockPool

The target stock pool for the delivered goods.

formatint32
Int OrderType

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

formatint32
Int? ReasonCode

The reason code for the delivery.

formatint32
Int? ReceiptSamplingType

The receipt sampling type to apply to the delivery.

formatint32
string? Reference

An external reference for the delivery order.

DateTimeOffset? ShippedDatetime

The datetime the delivery was shipped.

formatdate-time
string? StoreOrigin

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

string? SupplierCode

The unique supplier code.

string? SupplierName

The name of the supplier.

string? TracingUrl

URL for tracking the delivery shipment.

Boolean containerOverride

Header param: When true, overrides container validation.

Boolean isAutoReceiptAndSamplingAllow

Header param: When false, skips automatic receipt and sampling processing.

ReturnsExpand Collapse
class DeliveryCreateStoreDeliveriesResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create Store Deliveries

DeliveryCreateStoreDeliveriesParams parameters = new()
{
    StoreNumber = "store_number"
};

var response = await client.Deliveries.CreateStoreDeliveries(parameters);

Console.WriteLine(response);
{
  "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."
}