Delivery - ShipStream Developer Center

A delivery is an inbound shipment of your product to RSF. It could be an “ASN” (Advanced Shipment Notification), an “RMA” (Return Merchandise Authorization) or an “Other Delivery” (anything other than an ASN or RMA). They are all processed similarly regardless of which type of delivery is specified. Processing involves the general stages of “Accepting” the container from the carrier and weighing it, “Processing” the containers to align what was expected with what was actually received, “Putting Away” the processed inventory and “Committing” the put-away inventory to the available inventory. “Accepting” stage results with “Accepted” or “Ready To Process” delivery status. If the delivery has items on it before it is accepted, “Ready To Process” status is set and “Accepted” status skipped. Most of these steps happen automatically depending on the merchant’s configuration and whether or not there are any exceptions (discrepancies between expected and received).

Entity Properties

Delivery
Delivery Item
Delivery Label
Delivery Label Package
Delivery Label Address
Container
Container Content
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

filters

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”, “sender_ref”, “sender_ref_alt”, “created_at”, “updated_at”, “comments”, “tracking_numbers”.

options

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

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.search",
        [
            {
                "delivery_id" : {
                    "eq" : 1
                }
            },
            []
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "results" : [
            {
                "delivery_id" : 1,
                "warehouse_id" : 1,
                "increment_id" : "1000036",
                "delivery_type" : "asn",
                "state" : "complete",
                "status" : "put_away",
                "progress" : 100,
                "total_skus" : 2,
                "sender_name" : "Microsoft",
                "carrier_name" : "FedEx",
                "expected_delivery" : "2014-06-26",
                "delivered_at" : "2014-07-21T08:52:56+00:00",
                "ready_to_process_at" : "2014-07-21T08:52:56+00:00",
                "processed_at" : "2014-07-21T09:22:36+00:00",
                "putaway_at" : "2014-07-21T11:24:05+00:00",
                "completed_at" : null,
                "comments" : null,
                "merchant_ref" : null,
                "merchant_status" : null,
                "sender_ref" : null,
                "sender_ref_alt" : null,
                "num_containers" : 2,
                "num_labels" : 1,
                "total_container_weight" : null,
                "total_container_weight_unit" : null,
                "total_product_weight" : null,
                "total_product_weight_unit" : null,
                "special_requirements" : null,
                "auto_commit" : 2,
                "auto_close" : 2,
                "created_at" : "2014-06-26T13:47:47+00:00",
                "updated_at" : "2014-06-26T14:09:30+00:00",
                "items" : [
                    {
                        "delivery_item_id" : 1,
                        "delivery_id" : 1,
                        "product_id" : 214,
                        "qty" : 1,
                        "qty_expected" : 0,
                        "qty_received" : 1,
                        "qty_shortage" : 0,
                        "qty_overage" : 5,
                        "qty_processed" : 1,
                        "qty_putaway" : 1,
                        "qty_committed" : 0,
                        "sku" : "product2",
                        "item_ref" : "ref_123456"
                    },
                    {
                        "delivery_item_id" : 2,
                        "delivery_id" : 1,
                        "product_id" : 213,
                        "qty" : 1,
                        "qty_expected" : 0,
                        "qty_received" : 1,
                        "qty_shortage" : 0,
                        "qty_overage" : 0,
                        "qty_processed" : 1,
                        "qty_putaway" : 1,
                        "qty_committed" : 0,
                        "sku" : "product1",
                        "item_ref" : null
                    }
                ],
                "containers" : [
                    {
                        "container_id" : 1,
                        "delivery_id" : 1,
                        "container_type_id" : 1,
                        "damage_type" : "none",
                        "weight_discrepancy" : "none",
                        "tare_weight" : 1,
                        "tare_weight_unit" : "lb",
                        "weight" : 8,
                        "weight_unit" : "lb",
                        "weighed_at" : "2014-06-26T13:49:04+00:00",
                        "weighed_by" : 1,
                        "contents" : [
                            {
                                "delivery_item_id": 1,
                                "qty_counted": 6,
                                "qty_shortage": 0
                            }
                        ],
                        "notes" : null
                    },
                    {
                        "container_id" : 2,
                        "delivery_id" : 1,
                        "container_type_id" : 1,
                        "damage_type" : "none",
                        "weight_discrepancy" : "none",
                        "tare_weight" : 1,
                        "tare_weight_unit" : "lb",
                        "weight" : 3,
                        "weight_unit" : "lb",
                        "weighed_at" : "2014-06-26T13:49:15+00:00",
                        "weighed_by" : 1,
                        "contents" : [
                            {
                                "delivery_item_id": 2,
                                "qty_counted": 1,
                                "qty_shortage": 0
                            }
                        ],
                        "notes" : null
                    }
                ],
                "exceptions" : [
                    {
                        "delivery_exception_id" : 1,
                        "delivery_id" : 1,
                        "delivery_item_id" : 1,
                        "container_id" : 2,
                        "status" : "pending",
                        "sign" : 1,
                        "reason" : "overage_counted",
                        "comment" : null,
                        "qty" : 5
                    }
                ]
            }
        ],
        "totalCount" : 1,
        "numPages" : 1
    }
}

Error Codes

code	message
101	Invalid filters given. Details in error message.

`delivery.create`

delivery.create(number $deliveryType, object $data, null|array $items = null) Create delivery.

Parameters

deliveryType

string

Delivery type. Allowed: “asn”, “rma”, “other”.

data

object

Delivery data. See Delivery Properties.

items

null | array

null - Create delivery without items.
array - Array of objects with two properties: “sku” and “qty”.

Return Value

Delivery information.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.create",
        [
            "asn",
            {
                "warehouse_id" : 1,
                "auto_commit" : 2,
                "auto_close" : 2,
                "sender_name" : "Bill Gates",
                "carrier_name" : "FedEx",
                "expected_delivery" : "2014-07-31",
                "merchant_ref" : "Inv 12345"
            },
            [
                {
                    "sku" : "product1",
                    "qty" : 5,
                    "item_ref" : "ref_123456"
                },
                {
                    "sku" : "product2",
                    "qty" : 1
                }
            ]
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "delivery_id" : 4,
        "increment_id" : "1000039",
        "delivery_type" : "asn",
        "state": "new",
        "status": "new",
        "progress": 0,
        "total_skus": 1,
        "sender_name" : "Bill Gates",
        "carrier_name" : "FedEx",
        "expected_delivery" : "2014-07-31",
        "delivered_at": null,
        "ready_to_process_at": null,
        "processed_at": null,
        "putaway_at": null,
        "completed_at": null,
        "comments": null,
        "merchant_ref" : 12345,
        "merchant_status": null,
        "sender_ref": null,
        "sender_ref_alt": null,
        "num_containers": null,
        "num_labels": 0,
        "total_container_weight": null,
        "total_container_weight_unit": null,
        "total_product_weight": null,
        "total_product_weight_unit": null,
        "special_requirements": null,
        "auto_commit": 2,
        "auto_close": 2,
        "created_at" : "2014-07-31T14:10:00+00:00",
        "updated_at" : "2014-07-31T14:10:00+00:00",
        "warehouse_id" : 1
    }
}

Error Codes

code	message
107	Error creating the delivery. Details in error message.

`delivery.labels`

delivery.labels(string $incrementId, null|array $fields = []) Retrieve list of labels for the given delivery.

Parameters

incrementId

string

Delivery increment id

fields

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

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "delivery.labels",
        [
            "1000055",
            [
                "packages",
                "destination_address",
                "origin_address"
            ]
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result": [
        {
            "label_id": "8",
            "delivery_id": "26",
            "warehouse_id": "1",
            "status": "valid",
            "shipping_label": "ups_03",
            "created_at": "2021-01-20T10:03:55+00:00",
            "updated_at": "2021-01-20T10:04:01+00:00",
            "packages": [
                {
                    "warehouse_id": "1",
                    "label_id": "8",
                    "carrier": "ups",
                    "weight": "18.000",
                    "weight_unit": "lb",
                    "dimensions": {
                        "length": "10.000",
                        "width": "11.000",
                        "height": "12.000"
                    },
                    "dimension_unit": "in",
                    "tracking": [
                        {
                            "number": "1Z49R7V89024431506",
                            "description": "UPS Ground"
                        }
                    ],
                    "package_items": [
                        {
                            "delivery_item_id": 2,
                            "sku": "O-VS-Oregano-p3",
                            "quantity": "4.000"
                        },
                        {
                            "delivery_item_id": 3,
                            "sku": "O-VS-Mint-p2",
                            "quantity": "4.000"
                        },
                        {
                            "delivery_item_id": 5,
                            "sku": "VS-Bags-p1",
                            "quantity": "4.000"
                        }
                    ]
                }
            ],
            "destination_address": {
                "region": "New York",
                "postcode": "13088",
                "lastname": "Marquez",
                "street": "4616 Crossroads Park Dr",
                "city": "Liverpool",
                "email": null,
                "telephone": "865-971-4663",
                "firstname": "Sherlock",
                "company": null,
                "classification": "com",
                "is_valid": null,
                "country": "US"
            },
            "origin_address": {
                "region": "New York",
                "postcode": "10036",
                "lastname": "Gates",
                "street": "11 Times Square",
                "city": "New York",
                "email": null,
                "telephone": "212.245.2100",
                "firstname": "Bill",
                "company": "Microsoft",
                "classification": null,
                "is_valid": null,
                "country": "US"
            }
        },
        {
            "label_id": "9",
            "delivery_id": "26",
            "warehouse_id": "1",
            "status": "valid",
            "carrier": "ups",
            "created_at": "2021-01-20T10:04:23+00:00",
            "updated_at": "2021-01-20T10:04:26+00:00",
            "packages": [
                {
                    "warehouse_id": "1",
                    "label_id": "9",
                    "carrier": "ups",
                    "weight": "27.000",
                    "weight_unit": "lb",
                    "dimensions": {
                        "length": "10.000",
                        "width": "11.000",
                        "height": "12.000"
                    },
                    "dimension_unit": "in",
                    "tracking": [
                        {
                            "number": "1Z49R7V89021837511",
                            "description": "UPS Ground"
                        }
                    ],
                    "package_items": [
                        {
                            "delivery_item_id": 2,
                            "sku": "O-VS-Oregano-p3",
                            "quantity": "6.000"
                        },
                        {
                            "delivery_item_id": 3,
                            "sku": "O-VS-Mint-p2",
                            "quantity": "6.000"
                        },
                        {
                            "delivery_item_id": 5,
                            "sku": "VS-Bags-p1",
                            "quantity": "6.000"
                        }
                    ]
                }
            ],
            "destination_address": {
                "region": "New York",
                "postcode": "13088",
                "lastname": "Marquez",
                "street": "4616 Crossroads Park Dr",
                "city": "Liverpool",
                "email": null,
                "telephone": "865-971-4663",
                "firstname": "Sherlock",
                "company": null,
                "classification": "com",
                "is_valid": null,
                "country": "US"
            },
            "origin_address": {
                "region": "New York",
                "postcode": "10036",
                "lastname": "Gates",
                "street": "11 Times Square",
                "city": "New York",
                "email": null,
                "telephone": "212.245.2100",
                "firstname": "Bill",
                "company": "Microsoft",
                "classification": null,
                "is_valid": null,
                "country": "US"
            }
        }
    ]
}

Error Codes

code	message
100	Requested delivery does not exist.

`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

incrementId

string

The delivery increment ID.

updatedSince

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

{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "95847bf590ea11c6a67d3a429ab14c61",
        "delivery.gallery",
        [
            "11000008"
        ]
    ]
}

Example Response

Response

{
    "result": {
        "gallery_id": 205,
        "entity_type": "delivery",
        "entity_id": 8,
        "photo_count": 0,
        "updated_at": "2025-09-25T10:32:51+00:00",
        "photos": [],
        "children": [
            {
                "gallery_id": 227,
                "entity_type": "delivery_container",
                "entity_id": 22,
                "photo_count": 1,
                "updated_at": "2025-09-25T10:32:51+00:00",
                "photos": [
                    {
                        "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/delivery_container/22/45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                        "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/delivery_container/22/45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                        "caption": null,
                        "taken_at": null,
                        "device_info": null,
                        "media_info": {
                            "size": 77702,
                            "width": 2133,
                            "height": 1200,
                            "original_size": 159551,
                            "was_converted": false,
                            "original_width": 2560,
                            "size_formatted": "75.9KB",
                            "original_height": 1440,
                            "original_filename": "photo_12_1755888907743.png",
                            "processed_filename": "45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                            "original_size_formatted": "155.8KB"
                        },
                        "created_at": "2025-09-25T10:32:51+00:00"
                    }
                ],
                "children": [
                    {
                        "gallery_id": 0,
                        "entity_type": "container_item",
                        "entity_id": 36,
                        "photo_count": 0,
                        "updated_at": null,
                        "photos": [],
                        "children": []
                    }
                ]
            },
            {
                "gallery_id": 225,
                "entity_type": "delivery_container",
                "entity_id": 23,
                "photo_count": 0,
                "updated_at": "2025-09-25T10:31:20+00:00",
                "photos": [],
                "children": [
                    {
                        "gallery_id": 226,
                        "entity_type": "container_item",
                        "entity_id": 37,
                        "photo_count": 1,
                        "updated_at": "2025-09-25T10:31:20+00:00",
                        "photos": [
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/37/5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/37/5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                "caption": null,
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 92574,
                                    "width": 1280,
                                    "height": 960,
                                    "original_size": 162469,
                                    "was_converted": false,
                                    "original_width": 1280,
                                    "size_formatted": "90.4KB",
                                    "original_height": 960,
                                    "original_filename": "photo_2025-08-08_17-06-51.jpg",
                                    "processed_filename": "5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                    "original_size_formatted": "158.7KB"
                                },
                                "created_at": "2025-09-25T10:31:20+00:00"
                            }
                        ],
                        "children": []
                    }
                ]
            },
            {
                "gallery_id": 206,
                "entity_type": "delivery_container",
                "entity_id": 24,
                "photo_count": 0,
                "updated_at": "2025-09-25T07:59:22+00:00",
                "photos": [],
                "children": [
                    {
                        "gallery_id": 207,
                        "entity_type": "container_item",
                        "entity_id": 38,
                        "photo_count": 0,
                        "updated_at": "2025-09-25T07:59:15+00:00",
                        "photos": [],
                        "children": []
                    }
                ]
            },
            {
                "gallery_id": 219,
                "entity_type": "delivery_container",
                "entity_id": 25,
                "photo_count": 0,
                "updated_at": "2025-09-25T07:59:35+00:00",
                "photos": [],
                "children": [
                    {
                        "gallery_id": 220,
                        "entity_type": "container_item",
                        "entity_id": 39,
                        "photo_count": 2,
                        "updated_at": "2025-09-25T07:59:35+00:00",
                        "photos": [
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/39/b6a6a99adb62aa99ef6171e10d1d7eb4293af006.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/39/b6a6a99adb62aa99ef6171e10d1d7eb4293af006.webp",
                                "caption": null,
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 185868,
                                    "width": 675,
                                    "height": 1200,
                                    "original_size": 225381,
                                    "was_converted": false,
                                    "original_width": 720,
                                    "size_formatted": "181.5KB",
                                    "original_height": 1280,
                                    "original_filename": "photo_2024-04-25_17-25-28.jpg",
                                    "processed_filename": "b6a6a99adb62aa99ef6171e10d1d7eb4293af006.webp",
                                    "original_size_formatted": "220.1KB"
                                },
                                "created_at": "2025-09-25T07:58:57+00:00"
                            },
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/39/b0864b04d9e8ae07cda17ef84d0296a3d1cf3822.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/39/b0864b04d9e8ae07cda17ef84d0296a3d1cf3822.webp",
                                "caption": null,
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 180020,
                                    "width": 1920,
                                    "height": 1080,
                                    "original_size": 185862,
                                    "was_converted": false,
                                    "original_width": 1920,
                                    "size_formatted": "175.8KB",
                                    "original_height": 1080,
                                    "original_filename": "photo_12_17510867594.jpg",
                                    "processed_filename": "b0864b04d9e8ae07cda17ef84d0296a3d1cf3822.webp",
                                    "original_size_formatted": "181.5KB"
                                },
                                "created_at": "2025-09-25T07:58:57+00:00"
                            }
                        ],
                        "children": []
                    }
                ]
            },
            {
                "gallery_id": 208,
                "entity_type": "delivery_container",
                "entity_id": 26,
                "photo_count": 0,
                "updated_at": "2025-09-25T07:59:54+00:00",
                "photos": [],
                "children": [
                    {
                        "gallery_id": 209,
                        "entity_type": "container_item",
                        "entity_id": 40,
                        "photo_count": 2,
                        "updated_at": "2025-09-25T07:59:54+00:00",
                        "photos": [
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/40/3adce614977d8ca84579d75ce47a6dddf7b5875a.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/40/3adce614977d8ca84579d75ce47a6dddf7b5875a.webp",
                                "caption": "ddd",
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 85110,
                                    "width": 1065,
                                    "height": 600,
                                    "original_size": 769040,
                                    "was_converted": false,
                                    "original_width": 1065,
                                    "size_formatted": "83.1KB",
                                    "original_height": 600,
                                    "original_filename": "photo_5_1754929459408.png",
                                    "processed_filename": "3adce614977d8ca84579d75ce47a6dddf7b5875a.webp",
                                    "original_size_formatted": "751.0KB"
                                },
                                "created_at": "2025-09-25T07:48:08+00:00"
                            },
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/40/c50b84705620840166b8aa20e9b84ab4cd127ed0.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/40/c50b84705620840166b8aa20e9b84ab4cd127ed0.webp",
                                "caption": null,
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 71640,
                                    "width": 1065,
                                    "height": 600,
                                    "original_size": 778219,
                                    "was_converted": false,
                                    "original_width": 1065,
                                    "size_formatted": "70.0KB",
                                    "original_height": 600,
                                    "original_filename": "photo_16_1754397289147.png",
                                    "processed_filename": "c50b84705620840166b8aa20e9b84ab4cd127ed0.webp",
                                    "original_size_formatted": "760.0KB"
                                },
                                "created_at": "2025-09-25T07:48:08+00:00"
                            }
                        ],
                        "children": []
                    }
                ]
            }
        ]
    },
    "id": "1234",
    "jsonrpc": "2.0"
}

Example Request with Date Filter

Filter galleries by date to get only galleries updated since a specific date:

Request

{
    "jsonrpc": 2.0,
    "id": 1234,
    "method": "call",
    "params": [
        "95847bf590ea11c6a67d3a429ab14c61",
        "delivery.gallery",
        [
            "11000008",
            "2025-09-25 10:30:00"
        ]
    ]
}

Example Response with Date Filter

Response

{
    "result": {
        "gallery_id": 205,
        "entity_type": "delivery",
        "entity_id": 8,
        "photo_count": 0,
        "updated_at": "2025-09-25T10:32:51+00:00",
        "photos": [],
        "children": [
            {
                "gallery_id": 227,
                "entity_type": "delivery_container",
                "entity_id": 22,
                "photo_count": 1,
                "updated_at": "2025-09-25T10:32:51+00:00",
                "photos": [
                    {
                        "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/delivery_container/22/45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                        "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/delivery_container/22/45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                        "caption": null,
                        "taken_at": null,
                        "device_info": null,
                        "media_info": {
                            "size": 77702,
                            "width": 2133,
                            "height": 1200,
                            "original_size": 159551,
                            "was_converted": false,
                            "original_width": 2560,
                            "size_formatted": "75.9KB",
                            "original_height": 1440,
                            "original_filename": "photo_12_1755888907743.png",
                            "processed_filename": "45784f473e9f3375f2e3fb1430cb8863f03a32bf.webp",
                            "original_size_formatted": "155.8KB"
                        },
                        "created_at": "2025-09-25T10:32:51+00:00"
                    }
                ],
                "children": []
            },
            {
                "gallery_id": 225,
                "entity_type": "delivery_container",
                "entity_id": 23,
                "photo_count": 0,
                "updated_at": "2025-09-25T10:31:20+00:00",
                "photos": [],
                "children": [
                    {
                        "gallery_id": 226,
                        "entity_type": "container_item",
                        "entity_id": 37,
                        "photo_count": 1,
                        "updated_at": "2025-09-25T10:31:20+00:00",
                        "photos": [
                            {
                                "original_url": "http://magentohost/cdn-cgi/image/original/development/gallery/container_item/37/5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                "thumbnail_url": "http://magentohost/cdn-cgi/image/fit=inside,width=250/development/gallery/container_item/37/5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                "caption": null,
                                "taken_at": null,
                                "device_info": null,
                                "media_info": {
                                    "size": 92574,
                                    "width": 1280,
                                    "height": 960,
                                    "original_size": 162469,
                                    "was_converted": false,
                                    "original_width": 1280,
                                    "size_formatted": "90.4KB",
                                    "original_height": 960,
                                    "original_filename": "photo_2025-08-08_17-06-51.jpg",
                                    "processed_filename": "5aab80b2ea8d4d9cdfa0eb2b5fd1c4d57805e923.webp",
                                    "original_size_formatted": "158.7KB"
                                },
                                "created_at": "2025-09-25T10:31:20+00:00"
                            }
                        ],
                        "children": []
                    }
                ]
            }
        ]
    },
    "id": "1234",
    "jsonrpc": "2.0"
}

Example Request for Empty Gallery

Get gallery structure for a delivery without any photos:

Request

{
    "jsonrpc": 2.0,
    "id": 1234,
    "method" : "call",
    "params" : [
        "95847bf590ea11c6a67d3a429ab14c61",
        "delivery.gallery",
        [
            "11000013"
        ]
    ]
}

Example Response for Empty Gallery

Response

{
    "jsonrpc": 2.0,
    "id": 1234,
    "result": {
        "gallery_id": 0,
        "entity_type": "delivery",
        "entity_id": 19,
        "photo_count": 0,
        "updated_at": null,
        "children": [
            {
                "gallery_id": 0,
                "entity_type": "delivery_container",
                "entity_id": 41,
                "photo_count": 0,
                "updated_at": null,
                "children": [
                    {
                        "gallery_id": 0,
                        "entity_type": "container_item",
                        "entity_id": 49,
                        "photo_count": 0,
                        "updated_at": null,
                        "children": [],
                        "photos": []
                    }
                ],
                "photos": []
            }
        ],
        "photos": []
    }
}

Error Codes

code	message
-32100	Requested delivery does not exist.

`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

incrementId

string

Increment ID.

data

object

Delivery data. See Delivery Properties.

addItems

null | array

null - Update delivery without adding items.
array - Array of objects with two properties: “sku” and “qty”.

removeItems

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

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.update",
        [
            "10000011",
            {
                "merchant_ref" : "Inv 12345",
                "merchant_status": "new",
                "sender_name" : "Bill Gates",
                "sender_ref": "100000004",
                "sender_ref_alt": "100000001",
                "expected_delivery" : "2014-07-31",
                "carrier_name": "FedEx",
                "auto_commit": 1,
                "auto_close": 1,
                "comments": "This delivery was updated via API"                
            },
            [
                {
                    "sku": "O-VS-Oregano-p3",
                    "qty": "6.000",
                    "item_ref": "ref_456"
                }
            ],
            [
                {
                    "sku": "O-VS-Oregano-p3",
                    "qty": "3.000"
                }
            ]
        ]
    ]
}

Example Response

Response

{
    "result": true,
    "id": "1234",
    "jsonrpc": "2.0"
}

`delivery.close`

delivery.close(string $incrementId) Close a delivery.

Parameters

incrementId

string

The “Increment ID” property.

Return Value

true if delivery inventory was successfully closed.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.close",
        [
            "11000011"
        ]
    ]
}

Example Response

Response

{
    "result": true,
    "id": "1234",
    "jsonrpc": "2.0"
}

Error Codes

code	message
115	Delivery with the specified ID cannot be closed. Details in the error message.

`delivery.commit`

delivery.commit(string $incrementId, boolean $close = FALSE) Commit delivery inventory.

Parameters

incrementId

string

The “Increment ID” property.

boolean

true to close the delivery.

Return Value

true if delivery inventory was successfully committed.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.commit",
        [
            "11000011"
        ]
    ]
}

Example Response

Response

{
    "result": true,
    "id": "1234",
    "jsonrpc": "2.0"
}

Error Codes

code	message
113	Delivery with the specified ID cannot be committed. Details in the error message.

`delivery.cancel`

delivery.cancel(string $incrementId) Cancel delivery.

Parameters

incrementId

string

The “Increment ID” property.

Return Value

true if delivery was successfully canceled.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.cancel",
        [
            "11000017"
        ]
    ]
}

Example Response

Response

{
    "result": true,
    "id": "1234",
    "jsonrpc": "2.0"
}

Error Codes

code	message
112	Delivery with the specified ID cannot be canceled. Details in the error message.

`delivery.void`

delivery.void(string $incrementId) Cancel delivery.

Parameters

incrementId

string

The “Increment ID” property.

Return Value

true if delivery was successfully voided.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "aebdb4cc6f861c79428768923f0eb6a2",
        "delivery.void",
        [
            "11000018"
        ]
    ]
}

Example Response

Response

{
    "result": true,
    "id": "1234",
    "jsonrpc": "2.0"
}

Error Codes

code	message
114	Delivery with the specified ID cannot be voided. Details in the error message.

Entity Properties

Delivery Properties

Property Translations: API to UI

API	ASN	RMA	Other
sender_name	Supplier	Customer Name	Sender
sender_ref	Supplier Invoice Ref	(deprecated, use `tracking_numbers` )	Sender Ref 1
sender_ref_alt	Supplier Order Ref	Merchant Order #	Sender Ref 2
tracking_numbers	Tracking Numbers	Tracking Numbers	Tracking Numbers
merchant_ref	Merchant Ref	Merchant RMA #	Merchant Ref
merchant_status	Merchant Status	Merchant Status	Merchant Status
expected_delivery	Expected Delivery Date	Authorization Date	Expected Delivery Date

delivery_id

integer

The internal delivery ID.

warehouse_id

integer

The internal warehouse ID.

increment_id

string

The “Increment ID” property.

delivery_type

string

The “Delivery Type” property. Allowed: “asn”, “rma”, “other”.

state

string

The “State” property. Allowed: “new”, “processing”, “putting_away”, “pending_commit”, “complete”, “canceled”.

status

string

The “Status” property. Allowed: “new”, “accepting”, “accepted”, “ready_to_process”, “processing”, “processing_exception”, “processed”, “putting_away”, “put_away”, “complete”, “canceled”, “void”.

progress

integer

The “Progress” property. Number from 0 to 100.

total_skus

integer

Total amount of SKUs.

sender_name

string

The “Sender Name” property.

carrier_name

string

The “Carrier Name” property.

expected_delivery

string

The “Expected Delivery” property.

delivered_at

string

The “Delivered At” property.

ready_to_process_at

string

The “Delivered At” property.

processed_at

string

The “Processed At” property.

putaway_at

string

The “Put-Away At” property.

completed_at

string

The “Completed At” property.

comments

string

The “Comments” property.

merchant_ref

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.

merchant_status

string

The “Merchant Status” property.

sender_ref

string

The “Sender Reference” property. Do not use this field for RMAs.

sender_ref_alt

string

The “Sender Reference Alt” property.

tracking_numbers

array

The “Tracking Numbers” property.

num_containers

integer

Number of containers.

num_labels

integer

Number of labels.

total_container_weight

number

The “Total Container Weight” property.

total_container_weight_unit

string

The unit of measure used for total_container_weight. See: Weight Units.

total_product_weight

number

The “Total Product Weight” property.

total_product_weight_unit

string

The unit of measure used for total_product_weight. See: Weight Units.

special_requirements

string

The “Special Requirements” property.

auto_commit

integer

Determines whether inventory will be commited automatically upon put-away completion. 0 - Disabled, 1 - Enabled, 2 - Use default from config

auto_close

integer

Determines whether the delivery will be closed automatically upon acceptance of the last container. 0 - Disabled, 1 - Enabled, 2 - Use default from config

created_at

string

The “Created At” property in ISO 8601 format. If not available, null is returned.

updated_at

string

The “Updated At” property in ISO 8601 format. If not available, null is returned.

items

array

Array of delivery items. See Delivery Item Properties.

containers

array

Array of containers. See Container Properties.

exceptions

array

Array of exceptions. See Exception Properties.

Delivery Item Properties

delivery_item_id

integer

The internal delivery item ID.

delivery_id

integer

The internal delivery ID.

product_id

integer

The internal product ID.

qty

integer

The quantity that was set when the delivery was created or edited.

qty_expected

integer

The quantity that is expected to be received in the future.

qty_received

integer

The “Received” quantity.

qty_shortage

integer

The “Shortage” quantity.

qty_overage

integer

The “Overage” quantity.

qty_processed

integer

The “Processed” quantity.

qty_putaway

integer

The “Put-Away” quantity.

qty_committed

integer

The “Committed” quantity.

sku

string

The “SKU” property.

item_ref

string

An external item reference which may be up to 32 characters.

Delivery Label Properties

label_id

integer

The internal delivery label ID.

delivery_id

integer

The internal delivery ID.

warehouse_id

integer

The internal warehouse ID.

status

string

The “Status” property. Allowed: “valid”, “void”.

shipping_method

string

See the Shipping Methods document for a reference. Is not optional.

created_at

string

The “Created At” property in ISO 8601 format.

updated_at

string

The “Updated At” property in ISO 8601 format.

packages

array

Array of delivery label packages. See Delivery Label Package Properties.

destination_address

object

Destination Address. See Delivery Label Address Properties.

origin_address

object

Origination Address. See Delivery Label Address Properties.

Delivery Label Package Properties

warehouse_id

string

The ID of the warehouse associated with the package.

label_id

integer

The internal delivery label ID.

carrier

string

Carrier code.

weight

string

The weight of the package.

weight_unit

string

The unit of measure used for weight. See: Weight Units.

dimensions

object

The length, width, and height of the package.

dimension_unit

string

The unit of measure used for length, width, and height in dimensions. See: Length Units.

tracking

array

An array of tracking objects. The “number” property contains the tracking number. The “description” property contains the shipping method name.

package_items

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

firstname

string

The “First Name” property.

lastname

string

The “Last Name” property.

company

string

The “Company” property.

street

string

The street address. Multi-line street addresses will be separated by a newline (\n) character. Only two address lines are supported.

city

string

The “City” property.

region

string

The “Region” property.

postcode

string

The “Postal Code” property. Pass as a string to prevent leading 0s from being dropped.

country

string

The “Country” property.

classification

string

The “Classification” property. Allowed: “res” - residential, “com” - commercial, “po” - post office, “mil” - military, “unk” - unknown.

is_valid

integer

Flag whether address is valid.

telephone

string

The “Telephone” property.

string

The “Email” property.

Container Properties

container_id

integer

The internal container ID.

delivery_id

integer

The internal delivery ID.

container_type_id

integer

The “Container Type ID” property.

damage_type

string

The “Damage Type” property. Allowed: “none”, “noted”, “unnoted”.

weight_discrepancy

string

The “Weight Discrepancy” property. Allowed: “none”, “shortage_noted”, “shortage_unnoted”, “overage”, “unknown”.

tare_weight

number

The “Tare Weight” property.

tare_weight_unit

string

The unit of measure used for tare_weight. See: Weight Units.

weight

number

The “Weight” property.

weight_unit

string

The unit of measure used for weight. See: Weight Units.

weighed_at

string

The “Weighed At” property.

weighed_by

integer

The “Weighed By” property.

contents

array

Array of “content” objects. See Container Content Properties.

notes

string

The “Notes” property.

Container Content Properties

delivery_item_id

integer

The internal delivery item ID.

qty_counted

integer

The “Quantity Counted” property.

qty_shortage

integer

The “Quantity Shortage” property.

Exception Properties

delivery_exception_id

integer

The internal delivery exception ID.

delivery_id

integer

The internal delivery ID.

delivery_item_id

integer

The internal delivery item ID.

container_id

integer

The internal container ID.

status

string

The “Status” property. Allowed: “new”, “pending”, “approved”, “rejected”, “void”.

sign

integer

The “Sign” property. Allowed: “-1” - shortage, “1” - overage.

reason

string

The “Reason” property. Allowed: “overage_counted”, “overage_unexpected”, “shortage_damaged”, “shortage_missing”.

comment

string

The “Comment” property.

qty

integer

The “Quantity” property.

Gallery Properties

gallery_id

number

The internal gallery ID. 0 indicates no gallery exists for this entity.

entity_type

string

The type of entity this gallery belongs to. Allowed: “delivery”, “delivery_container”, “container_item”, “delivery_exception”.

entity_id

number

The internal ID of the entity this gallery belongs to.

photo_count

number

The total number of photos in this gallery.

updated_at

string

The timestamp when this gallery was last updated. null if no photos have been added.

children

array

Array of child galleries. See Gallery Properties.

photos

array

Array of photos in this gallery. See Photo Properties.

Photo Properties

original_url

string

The URL to the original full-size photo.

thumbnail_url

string

The URL to the thumbnail version of the photo, resized to fit 250px × 250px.

caption

string | null

Optional caption text for the photo.

taken_at

string | null

Time and date in ISO 8601 format when the photo was taken. If not available, null is returned.

device_info

object | null

Information about the device used to take the photo. See Device Info Properties. null if not available.

media_info

object

Technical information about the photo file. See Media Info Properties.

created_at

string

The timestamp when the photo was uploaded to the system.

Device Info Properties

lens

string

Information about the camera lens used.

device

string

The device model that took the photo.

aperture

string

The aperture setting used when taking the photo.

focal_length

string

The focal length setting used when taking the photo.

camera_settings

object

Additional camera settings used when taking the photo.

camera_settings.iso

string

The ISO setting used when taking the photo.

camera_settings.flash

string

Information about flash usage when taking the photo.

camera_settings.shutter_speed

string

The shutter speed used when taking the photo.

Media Info Properties

size

number

The processed file size in bytes.

width

number

The width of the processed image in pixels.

height

number

The height of the processed image in pixels.

original_size

number

The original file size in bytes.

was_converted

boolean

Whether the original file was converted to a different format.

original_width

number

The width of the original image in pixels.

size_formatted

string

The processed file size formatted as a human-readable string (e.g., “502.3KB”, “2.4MB”).

original_height

number

The height of the original image in pixels.

original_filename

string

The original filename when the photo was uploaded.

processed_filename

string

The filename after processing.

original_size_formatted

string

The original file size formatted as a human-readable string (e.g., “2.4MB”).

Get Started

Common Features

Shipping

Receiving

Inventory

System

​Methods

​Entity Properties

​delivery.search

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.create

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.labels

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.gallery

​Parameters

​Return Value

​Example Request

​Example Response

​Example Request with Date Filter

​Example Response with Date Filter

​Example Request for Empty Gallery

​Example Response for Empty Gallery

​Error Codes

​delivery.update

​Parameters

​Return Value

​Example Request

​Example Response

​delivery.close

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.commit

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.cancel

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​delivery.void

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​Entity Properties

​Delivery Properties

​Property Translations: API to UI

​Delivery Item Properties

​Delivery Label Properties

​Delivery Label Package Properties

​Delivery Label Address Properties

​Container Properties

​Container Content Properties

​Exception Properties

​Gallery Properties

​Photo Properties

​Device Info Properties

​Media Info Properties

Methods

Entity Properties

`delivery.search`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.create`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.labels`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.gallery`

Parameters

Return Value

Example Request

Example Response

Example Request with Date Filter

Example Response with Date Filter

Example Request for Empty Gallery

Example Response for Empty Gallery

Error Codes

`delivery.update`

Parameters

Return Value

Example Request

Example Response

`delivery.close`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.commit`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.cancel`

Parameters

Return Value

Example Request

Example Response

Error Codes

`delivery.void`

Parameters

Return Value

Example Request

Example Response

Error Codes

Entity Properties

Delivery Properties

Property Translations: API to UI

Delivery Item Properties

Delivery Label Properties

Delivery Label Package Properties

Delivery Label Address Properties

Container Properties

Container Content Properties

Exception Properties

Gallery Properties

Photo Properties

Device Info Properties

Media Info Properties