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 | object
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 | object
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
string
Delivery type. Allowed: “asn”, “rma”, “other”.
object
Delivery data. See Delivery Properties.
null | array
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
string
Delivery increment id
null | array
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
string
The delivery increment ID.
string | null
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
string
Increment ID.
object
Delivery data. See Delivery Properties.
null | array
null- Update delivery without adding items.array- Array of objects with two properties: “sku” and “qty”.
null | array
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
string
The “Increment ID” property.
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
string
The “Increment ID” property.
boolean
true to close the delivery.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
string
The “Increment ID” property.
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
string
The “Increment ID” property.
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
integer
The internal delivery ID.
integer
The internal warehouse ID.
string
The “Increment ID” property.
string
The “Delivery Type” property. Allowed: “asn”, “rma”, “other”.
string
The “State” property. Allowed: “new”, “processing”, “putting_away”, “pending_commit”, “complete”, “canceled”.
string
The “Status” property. Allowed: “new”, “accepting”, “accepted”, “ready_to_process”, “processing”, “processing_exception”, “processed”, “putting_away”, “put_away”, “complete”, “canceled”, “void”.
integer
The “Progress” property. Number from 0 to 100.
integer
Total amount of SKUs.
string
The “Sender Name” property.
string
The “Carrier Name” property.
string
The “Expected Delivery” property.
string
The “Delivered At” property.
string
The “Delivered At” property.
string
The “Processed At” property.
string
The “Put-Away At” property.
string
The “Completed At” property.
string
The “Comments” property.
string
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.
string
The “Merchant Status” property.
string
The “Sender Reference” property. Do not use this field for RMAs.
string
The “Sender Reference Alt” property.
array
The “Tracking Numbers” property.
integer
Number of containers expected to arrive with the delivery. Used to track reconciliation against
num_containers as the warehouse accepts them.integer
Number of containers.
integer
Number of labels.
number
The “Total Container Weight” property.
string
The unit of measure used for
total_container_weight. See: Weight Units.number
The “Total Product Weight” property.
string
The unit of measure used for
total_product_weight. See: Weight Units.string
The “Special Requirements” property.
integer
Determines whether inventory will be commited automatically upon put-away completion. 0 - Disabled, 1 - Enabled, 2 - Use default from config
integer
Determines whether the delivery will be closed automatically upon acceptance of the last container. 0 - Disabled, 1 - Enabled, 2 - Use default from config
string
The “Created At” property in ISO 8601 format. If not available,
null is returned.string
The “Updated At” property in ISO 8601 format. If not available,
null is returned.array
Array of delivery items. See Delivery Item Properties.
array
Array of containers. See Container Properties.
array
Array of exceptions. See Exception Properties.
Delivery Item Properties
integer
The internal delivery item ID.
integer
The internal delivery ID.
integer
The internal product ID.
integer
The quantity that was set when the delivery was created or edited.
integer
The quantity that is expected to be received in the future.
integer
The “Received” quantity.
integer
The “Shortage” quantity.
integer
The “Overage” quantity.
integer
The “Processed” quantity.
integer
The “Put-Away” quantity.
integer
The “Committed” quantity.
string
The “SKU” property.
string
An external item reference which may be up to 1024 characters.
array
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.
integer
The lot ID.
number
The “Received” quantity attributable to this lot.
number
The “Shortage” quantity attributable to this lot.
number
The “Overage” quantity attributable to this lot.
number
The “Processed” quantity attributable to this lot.
number
The “Put-Away” quantity attributable to this lot.
number
The “Committed” quantity attributable to this lot.
Delivery Label Properties
integer
The internal delivery label ID.
integer
The internal delivery ID.
integer
The internal warehouse ID.
string
The “Status” property. Allowed: “valid”, “void”.
string
See the Shipping Methods document for a reference. Is not optional.
string
The “Created At” property in ISO 8601 format.
string
The “Updated At” property in ISO 8601 format.
array
Array of delivery label packages. See Delivery Label Package Properties.
object
Destination Address. See Delivery Label Address Properties.
object
Origination Address. See Delivery Label Address Properties.
Delivery Label Package Properties
string
The ID of the warehouse associated with the package.
integer
The internal delivery label ID.
string
Carrier code.
string
The weight of the package.
string
The unit of measure used for
weight. See: Weight Units.object
The
length, width, and height of the package.string
The unit of measure used for
length, width, and height in dimensions. See: Length Units.array
An array of tracking objects. The “number” property contains the tracking number. The “description” property contains the shipping method name.
array
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
string
The “First Name” property.
string
The “Last Name” property.
string
The “Company” property.
string
The street address. Multi-line street addresses will be separated by a newline (
\n) character. Only two address lines are supported.string
The “City” property.
string
The “Region” property.
string
The “Postal Code” property. Pass as a string to prevent leading 0s from being dropped.
string
The “Country” property.
string
The “Classification” property. Allowed: “res” - residential, “com” - commercial, “po” - post office, “mil” - military, “unk” - unknown.
integer
Flag whether address is valid.
string
The “Telephone” property.
string
The “Email” property.
Container Properties
integer
The internal container ID.
integer
The internal delivery ID.
integer
The “Container Type ID” property.
string
The “Damage Type” property. Allowed: “none”, “noted”, “unnoted”.
string
The “Weight Discrepancy” property. Allowed: “none”, “shortage_noted”, “shortage_unnoted”, “overage”, “unknown”.
number
The “Tare Weight” property.
string
The unit of measure used for
tare_weight. See: Weight Units.number
The “Weight” property.
string
The unit of measure used for
weight. See: Weight Units.string
The “Weighed At” property.
integer
The “Weighed By” property.
array
Array of “content” objects. See Container Content Properties.
string
The “Notes” property.
Container Content Properties
integer
The internal delivery item ID.
integer
The “Quantity Counted” property.
integer
The “Quantity Shortage” property.
array
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.integer
The lot ID.
number
The “Quantity Counted” attributable to this lot within this container content.
number
The “Quantity Shortage” attributable to this lot within this container content.
Exception Properties
integer
The internal delivery exception ID.
integer
The internal delivery ID.
integer
The internal delivery item ID.
integer
The internal container ID.
integer
The internal lot ID the exception is scoped to, or
null for exceptions that are not lot-specific.string
The “Status” property. Allowed: “new”, “pending”, “approved”, “rejected”, “void”.
integer
The “Sign” property. Allowed: “-1” - shortage, “1” - overage.
string
The “Reason” property. Allowed: “overage_counted”, “overage_unexpected”, “shortage_damaged”, “shortage_missing”.
string
The “Comment” property.
integer
The “Quantity” property.
Gallery Properties
number
The internal gallery ID.
0 indicates no gallery exists for this entity.string
The type of entity this gallery belongs to. Allowed: “delivery”, “delivery_container”, “container_item”, “delivery_exception”.
number
The internal ID of the entity this gallery belongs to.
number
The total number of photos in this gallery.
string
The timestamp when this gallery was last updated.
null if no photos have been added.array
Array of child galleries. See Gallery Properties.
array
Array of photos in this gallery. See Photo Properties.
Photo Properties
string
The URL to the original full-size photo.
string
The URL to the thumbnail version of the photo, resized to fit 250px × 250px.
string | null
Optional caption text for the photo.
string | null
Time and date in ISO 8601 format when the photo was taken. If not available,
null is returned.object | null
Information about the device used to take the photo. See Device Info Properties.
null if not available.object
Technical information about the photo file. See Media Info Properties.
string
The timestamp when the photo was uploaded to the system.
Device Info Properties
string
Information about the camera lens used.
string
The device model that took the photo.
string
The aperture setting used when taking the photo.
string
The focal length setting used when taking the photo.
object
Additional camera settings used when taking the photo.
string
The ISO setting used when taking the photo.
string
Information about flash usage when taking the photo.
string
The shutter speed used when taking the photo.
Media Info Properties
number
The processed file size in bytes.
number
The width of the processed image in pixels.
number
The height of the processed image in pixels.
number
The original file size in bytes.
boolean
Whether the original file was converted to a different format.
number
The width of the original image in pixels.
string
The processed file size formatted as a human-readable string (e.g., “502.3KB”, “2.4MB”).
number
The height of the original image in pixels.
string
The original filename when the photo was uploaded.
string
The filename after processing.
string
The original file size formatted as a human-readable string (e.g., “2.4MB”).