Event payloads

Every delivery uses the envelope described in Receiving deliveries. This page shows the data object for each event.

Supplier order events

supplier_order.created, supplier_order.opened and supplier_order.shipped share the same shape. A supplier order is the part of an order that was forwarded to one supplier, so an order with products from two suppliers produces two supplier orders, each with its own events.

Field	Type	Description
supplier_order_id	Number	The ID of the supplier order.
supplier_id	Number	The ID of the supplier.
supplier_name	String	The name of the supplier.
forwarded_at	String	supplier_order.created only. When the order was forwarded to the supplier.
opened_at	String	supplier_order.opened only. When the supplier first opened the order.
shipped_at	String	supplier_order.shipped only. When the supplier marked the order as shipped.
tracking_code	String|null	supplier_order.shipped only. The tracking code, if the supplier provided one.
tracking_url	String|null	supplier_order.shipped only. The tracking URL, if the supplier provided one.
carrier	Object|null	supplier_order.shipped only. The carrier recognised from the tracking URL, with a code (e.g. postnl, dhl, royal-mail) and name. null if the carrier is unknown.
order	Object|null	The order, in the same format as GET orders/{reference}, except that order_lines only contains the lines on this supplier order, quantity is the quantity sent to this supplier, and there are no suppliers, logs or current_status fields.

supplier_order.createdsupplier_order.openedsupplier_order.shipped

{
    "id": "9b1d3c4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
    "event": "supplier_order.created",
    "created_at": "2026-10-20T12:00:05+00:00",
    "data": {
        "supplier_order_id": 8812,
        "supplier_id": 5,
        "supplier_name": "TechSupply Co.",
        "forwarded_at": "2026-10-20T12:00:05+00:00",
        "order": {
            "id": 1542,
            "external_id": "ORD-2026-00142",
            "reference": "123",
            "source": "Example Shop",
            "test": false,
            "blocked": false,
            "total": 156.45,
            "shipping_address": {
                "email": "[email protected]",
                "first_name": "Jane",
                "last_name": "Smith",
                "company_name": null,
                "phone": "+1 555 123 4567",
                "address1": "123 Main Street",
                "address2": "Apt 4B",
                "city": "New York",
                "postcode": "10001",
                "state": "NY",
                "country": "United States",
                "country_iso": "US"
            },
            "shipping": {
                "cost": 5.95,
                "name": "DHL Express",
                "description": "Next day delivery",
                "note": "Leave at front door",
                "delivery_date": "2026-10-25"
            },
            "custom": {
                "gift_wrap": true
            },
            "order_lines": [
                {
                    "id": 3201,
                    "external_id": "PROD-001",
                    "ean13": "8712345678901",
                    "reference": "WH-PRO-BLK",
                    "name": "Wireless Headphones",
                    "quantity": 1,
                    "brand": "AudioTech",
                    "category": "Electronics",
                    "labels": ["fragile"],
                    "stock_quantity": 150,
                    "supplier": "AudioTech Wholesale",
                    "price": 89.99,
                    "purchase_price": 45,
                    "height": "8.50",
                    "width": "18.00",
                    "length": "20.00",
                    "weight": "0.25",
                    "image_url": "https://example.org/images/headphones.jpg",
                    "custom": {
                        "color": "Black"
                    }
                }
            ],
            "created_at": "2026-10-20T12:00:00+00:00",
            "updated_at": "2026-10-20T12:00:05+00:00",
            "finalized_at": null
        }
    }
}

{
    "id": "1f0e2d3c-4b5a-4968-8776-5a4b3c2d1e0f",
    "event": "supplier_order.opened",
    "created_at": "2026-10-20T13:12:40+00:00",
    "data": {
        "supplier_order_id": 8812,
        "supplier_id": 5,
        "supplier_name": "TechSupply Co.",
        "opened_at": "2026-10-20T13:12:40+00:00",
        "order": {
            "id": 1542,
            "external_id": "ORD-2026-00142",
            "reference": "123",
            "...": "same as supplier_order.created"
        }
    }
}

{
    "id": "7c6b5a49-3827-4165-9f4e-3d2c1b0a9f8e",
    "event": "supplier_order.shipped",
    "created_at": "2026-10-21T09:30:00+00:00",
    "data": {
        "supplier_order_id": 8812,
        "supplier_id": 5,
        "supplier_name": "TechSupply Co.",
        "shipped_at": "2026-10-21T09:30:00+00:00",
        "tracking_code": "3SDEVC1234567",
        "tracking_url": "https://www.dhl.com/track?id=3SDEVC1234567",
        "carrier": {
            "code": "dhl",
            "name": "DHL"
        },
        "order": {
            "id": 1542,
            "external_id": "ORD-2026-00142",
            "reference": "123",
            "...": "same as supplier_order.created"
        }
    }
}

products.updated

Sent when a product feed finished importing. Fetch the changed products with GET products/new.

Field	Type	Description
product_feed_id	Number	The ID of the product feed that was imported.
account_id	Number	Your account ID.
updated_at	String	When the import finished.

{
    "id": "2a3b4c5d-6e7f-4801-9a2b-3c4d5e6f7a8b",
    "event": "products.updated",
    "created_at": "2026-10-20T04:00:12+00:00",
    "data": {
        "product_feed_id": 17,
        "account_id": 101,
        "updated_at": "2026-10-20T04:00:12+00:00"
    }
}