Methods
- delivery.search
- delivery.create
- delivery.labels
- delivery.gallery
- delivery.update
- delivery.close
- delivery.commit
- delivery.cancel
- delivery.void
Entity Properties
- Delivery
- Delivery Item
- Delivery Item Lot
- Delivery Label
- Delivery Label Package
- Delivery Label Address
- Container
- Container Content
- Container Content Lot
- Exception
- Gallery
- Photo
- Device Info
- Media Info
delivery.search
delivery.search(null|object $filters, array $options = [])
Retrieve list of deliveries. Filtration could be applied.
Parameters
null- Retrieve list of all deliveries.object- Retrieve list of deliveries using specified Search Filters. Allowed properties for filtering: “delivery_id”, “increment_id”, “warehouse_id”, “merchant_ref”, “merchant_status”, “total_skus”, “delivery_type”, “status”, “sender_name”, “expected_delivery”, “expected_containers”, “sender_ref”, “sender_ref_alt”, “created_at”, “updated_at”, “comments”, “tracking_numbers”.
null- No options will be applied.object- Apply specified Search Options.
Return Value
An array of objects. Each object will contain Delivery Properties.Example Request
Get delivery for one delivery id:Request
Example Response
Response
Error Codes
delivery.create
delivery.create(number $deliveryType, object $data, null|array $items = null)
Create delivery.
Parameters
Delivery data. See Delivery Properties.
null- Create delivery without items.array- Array of objects with two properties: “sku” and “qty”.
Return Value
Delivery information.Example Request
Request
Example Response
Response
Error Codes
delivery.labels
delivery.labels(string $incrementId, null|array $fields = [])
Retrieve list of labels for the given delivery.
Parameters
null- Basic label data.array- Array of fields. Allowed: “packages”, “destination_address”, “origin_address”
Return Value
An array of objects. Each object will contain Delivery Label Properties.Example Request
Get labels for the delivery:Request
Example Response
Response
Error Codes
delivery.gallery
delivery.gallery(string $incrementId, string|null $updatedSince = null)
Retrieve the gallery structure and photos for a delivery, including all child galleries for containers, container items, exceptions.
Parameters
Optional. Filter galleries by update date. Only galleries updated since this date will be returned. Format: “YYYY-MM-DD HH:MM:SS”.
Return Value
An object containing Gallery Properties for the delivery gallery, with nested children galleries and associated photos.Example Request
Get complete gallery structure for a delivery:Request
Example Response
Response
Example Request with Date Filter
Filter galleries by date to get only galleries updated since a specific date:Request
Example Response with Date Filter
Response
Example Request for Empty Gallery
Get gallery structure for a delivery without any photos:Request
Example Response for Empty Gallery
Response
Error Codes
delivery.update
delivery.update(string $incrementId, array|null $data = null, array|null $addItems = null, array|null $removeItems = null)
Update delivery attributes. Add products. Remove products.
Parameters
Delivery data. See Delivery Properties.
null- Update delivery without adding items.array- Array of objects with two properties: “sku” and “qty”.
null- Update delivery without removing items.array- Array of objects with two properties: “sku” and “qty”.
Return Value
true if delivery was successfully updated.
Example Request
Request
Example Response
Response
delivery.close
delivery.close(string $incrementId)
Close a delivery.
Parameters
Return Value
true if delivery inventory was successfully closed.
Example Request
Request
Example Response
Response
Error Codes
delivery.commit
delivery.commit(string $incrementId, boolean $close = FALSE)
Commit delivery inventory.
Parameters
Return Value
true if delivery inventory was successfully committed.
Example Request
Request
Example Response
Response
Error Codes
delivery.cancel
delivery.cancel(string $incrementId)
Cancel delivery.
Parameters
Return Value
true if delivery was successfully canceled.
Example Request
Request
Example Response
Response
Error Codes
delivery.void
delivery.void(string $incrementId)
Cancel delivery.
Parameters
Return Value
true if delivery was successfully voided.
Example Request
Request
Example Response
Response
Error Codes
Entity Properties
Delivery Properties
Property Translations: API to UI
The “State” property. Allowed: “new”, “processing”, “putting_away”, “pending_commit”, “complete”, “canceled”.
The “Status” property. Allowed: “new”, “accepting”, “accepted”, “ready_to_process”, “processing”, “processing_exception”, “processed”, “putting_away”, “put_away”, “complete”, “canceled”, “void”.
The “Merchant Reference” property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.
Number of containers expected to arrive with the delivery. Used to track reconciliation against
num_containers as the warehouse accepts them.The unit of measure used for
total_container_weight. See: Weight Units.The unit of measure used for
total_product_weight. See: Weight Units.Determines whether inventory will be commited automatically upon put-away completion. 0 - Disabled, 1 - Enabled, 2 - Use default from config
Determines whether the delivery will be closed automatically upon acceptance of the last container. 0 - Disabled, 1 - Enabled, 2 - Use default from config
Array of delivery items. See Delivery Item Properties.
Array of containers. See Container Properties.
Array of exceptions. See Exception Properties.
Delivery Item Properties
Array of per-lot quantity breakdowns for this item. See Delivery Item Lot Properties. Present only for lot-tracked products; units received without a lot are not decomposed.
Delivery Item Lot Properties
Each entry breaks down the Delivery Item quantities by lot. Lot metadata (lot number, expiration date, etc.) is not included here — resolvelot_id via inventory.lots when needed.
Delivery Label Properties
See the Shipping Methods document for a reference. Is not optional.
Array of delivery label packages. See Delivery Label Package Properties.
Destination Address. See Delivery Label Address Properties.
Origination Address. See Delivery Label Address Properties.
Delivery Label Package Properties
The unit of measure used for
weight. See: Weight Units.The unit of measure used for
length, width, and height in dimensions. See: Length Units.An array of tracking objects. The “number” property contains the tracking number. The “description” property contains the shipping method name.
An array of items contained in the package.
delivery_item_id is the unqiue identifier of the related delivery item. sku is the package item’s SKU. quantity is the quantity of the item in the package.Delivery Label Address Properties
The street address. Multi-line street addresses will be separated by a newline (
\n) character. Only two address lines are supported.The “Classification” property. Allowed: “res” - residential, “com” - commercial, “po” - post office, “mil” - military, “unk” - unknown.
Container Properties
The “Weight Discrepancy” property. Allowed: “none”, “shortage_noted”, “shortage_unnoted”, “overage”, “unknown”.
The unit of measure used for
tare_weight. See: Weight Units.The unit of measure used for
weight. See: Weight Units.Array of “content” objects. See Container Content Properties.
Container Content Properties
Array of per-lot counted/shortage breakdowns for this container content. See Container Content Lot Properties. Present only for lot-tracked products.
Container Content Lot Properties
Each entry breaks down the parent Container Content quantities by lot.Exception Properties
The internal lot ID the exception is scoped to, or
null for exceptions that are not lot-specific.The “Reason” property. Allowed: “overage_counted”, “overage_unexpected”, “shortage_damaged”, “shortage_missing”.
Gallery Properties
The type of entity this gallery belongs to. Allowed: “delivery”, “delivery_container”, “container_item”, “delivery_exception”.
Array of child galleries. See Gallery Properties.
Array of photos in this gallery. See Photo Properties.
Photo Properties
Time and date in ISO 8601 format when the photo was taken. If not available,
null is returned.Information about the device used to take the photo. See Device Info Properties.
null if not available.Technical information about the photo file. See Media Info Properties.