Inventory delivery models

Delivery models for lists, details and creation. Inspect delivery items, tracking data and the fields required by a new delivery.

Data schemas

Get an inventory delivery — Response

ApiResponse_DeliveryDetailData_ · Fields, types and constraints of data accepted or returned by the API.

dataDeliveryDetailData Required: Response example · DeliveryDetailData.

Example: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"request_id":"example"}

Additional fields: No

List inventory deliveries — Response

ApiResponse_list_DeliveryData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <DeliveryData > Required: Response example · ApiResponse_list_DeliveryData__.

Example: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Additional fields: No

Create an inventory delivery — Request body

DeliveryCreate · Fields, types and constraints of data accepted or returned by the API.

delivered_atStringRequired

Delivery date and time.

format: "date-time"

Example: "2026-01-01T00:00:00Z"

increases_stockBooleanOptional

Whether receipt of the delivery increases stock.

Default: true

location_idStringRequired

Warehouse location identifier.

Constraints

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Example: "example"

notesStringOptional

Additional notes.

maxLength: 2000

Default: ""

quantityIntegerRequired

Number of units.

minimum: 1maximum: 2147483647

Example: 1

reasonStringOptional

Reason recorded for the change.

maxLength: 500

Default: ""

statusStringRequired

Status accepted by this specific operation.

Constraints

enum: ["planned", "received"]

Example: "planned"

target_idStringRequired

Identifier of the product or variant affected by the operation.

Constraints

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Example: "example"

target_typeStringRequired

Whether the operation concerns a product or a variant.

Constraints

enum: ["product", "variant"]

Example: "product"

warehouse_idStringRequired

Warehouse identifier.

Constraints

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Example: "example"

Additional fields: No

List inventory deliveries — Response

DeliveryData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired

Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

deleted_atString nullRequired

Deletion time, if present.

String:format: "date-time"

Example: null

delivered_atStringRequired

Delivery date and time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

idStringRequired

Resource identifier; preserve it as returned. (DeliveryData).

Example: "example"

increases_stockBooleanRequired

Whether receipt of the delivery increases stock.

Example: true

location_idStringRequired

Warehouse location identifier.

Example: "example"

quantityIntegerRequired

Number of units.

Example: 1

received_atString nullRequired

Date and time the delivery was received.

String:format: "date-time"

Example: null

record_statusStringRequired

Stored record status.

Constraints

enum: ["active", "deleted"]

Example: "active"

statusStringRequired

Status accepted by this specific operation.

Constraints

enum: ["planned", "received"]

Example: "planned"

stock_applied_atString nullRequired

Date and time the delivery's stock change was applied.

String:format: "date-time"

Example: null

target_idStringRequired

Identifier of the product or variant affected by the operation.

Example: "example"

target_typeStringRequired

Whether the operation concerns a product or a variant.

Constraints

enum: ["product", "variant"]

Example: "product"

updated_atString nullRequired

Most recent update time.

String:format: "date-time"

Example: "2026-01-01T12:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 1

warehouse_idStringRequired

Warehouse identifier.

Example: "example"

Additional fields: No

Get an inventory delivery — Response

DeliveryDetailData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired

Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

deleted_atString nullRequired

Deletion time, if present.

String:format: "date-time"

Example: null

delivered_atStringRequired

Delivery date and time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

idStringRequired

Resource identifier; preserve it as returned. (DeliveryDetailData).

Example: "example"

increases_stockBooleanRequired

Whether receipt of the delivery increases stock.

Example: true

location_idStringRequired

Warehouse location identifier.

Example: "example"

notesString nullRequired

Additional notes.

Example: "example"

quantityIntegerRequired

Number of units.

Example: 1

received_atString nullRequired

Date and time the delivery was received.

String:format: "date-time"

Example: null

record_statusStringRequired

Stored record status.

Constraints

enum: ["active", "deleted"]

Example: "active"

statusStringRequired

Status accepted by this specific operation.

Constraints

enum: ["planned", "received"]

Example: "planned"

stock_applied_atString nullRequired

Date and time the delivery's stock change was applied.

String:format: "date-time"

Example: null

target_idStringRequired

Identifier of the product or variant affected by the operation.

Example: "example"

target_typeStringRequired

Whether the operation concerns a product or a variant.

Constraints

enum: ["product", "variant"]

Example: "product"

updated_atString nullRequired

Most recent update time.

String:format: "date-time"

Example: "2026-01-01T12:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 1

warehouse_idStringRequired

Warehouse identifier.

Example: "example"

Additional fields: No