Webhooks
Webhooks are events calling your apps. The payload your apps’ webhooks will receive are defined in the Return Types section.
Example payload:
{
"id": 1049789,
"status": "cancelled",
"date_placed": "2019-11-25T14:52:56.000Z",
"source": "How the order was created.",
"order": {
"id": 1234567,
"reference": "#154254",
"status": "open",
"order_channel_id": 321,
"brand_id": 5,
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
},
"channel": {
"id": 1,
"organisation_id": 1,
"name": "Artplants",
"outbound_email": "sales.example@i-fulfilment.co.uk"
}
},
"warehouse": {
"id": 1,
"name": "Christchurch",
"short_code": "CHR",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"shipping_address": {
"first_name": "Support",
"last_name": "Team",
"company": "ACME LTD",
"email": "support.team@i-fulfilment.co.uk",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"attributes": [
{
"name": "Marketplace",
"value": "222-99999999-9999999"
}
],
"tags": [
{
"id": 1,
"name": "Processed",
"shortcode": "PROCESSED"
}
]
}Example payload:
{
"id": 1049789,
"status": "despatched",
"substatus": "collected",
"date_placed": "2019-11-25T14:52:56.000Z",
"despatch_date": "2019-11-25T14:52:56.000Z",
"collection_date": "2019-11-26T14:52:56.000Z",
"source": "How the order was created.",
"order": {
"id": 1234567,
"reference": "#154254",
"status": "open",
"order_channel_id": 321,
"brand_id": 5,
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
},
"channel": {
"id": 1,
"organisation_id": 1,
"name": "Artplants",
"outbound_email": "GBP"
}
},
"warehouse": {
"id": 1,
"name": "Christchurch",
"short_code": "CHR",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"shipping_address": {
"first_name": "Support",
"last_name": "Team",
"company": "ACME LTD",
"email": "support.team@i-fulfilment.co.uk",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"attributes": [
{
"name": "Marketplace",
"value": "222-99999999-9999999"
}
],
"despatch_attributes": [
{
"sku": "DEMO-SKU-01",
"attribute_name": "Colour",
"attribute_value": "Red",
"order_goodsout_line_id": 12234,
"order_goodsout_line_item_id": 12234
}
],
"tags": [
{
"id": 1,
"name": "Processed",
"shortcode": "PROCESSED"
}
],
"shipping": [
{
"courier_name": "Royal Mail",
"service_name": "ExPak1",
"tracking": [
{
"tracking_number": "46513135648745",
"tracking_url": "http://www.royalmail.com/trackdetails?trackNumber=46513135648745"
}
]
}
]
}Example payload:
{
"id": 1049789,
"status": "awaiting_picking",
"date_placed": "2019-11-25T14:52:56.000Z",
"source": "How the order was created.",
"order": {
"id": 1234567,
"reference": "#154254",
"status": "open",
"order_channel_id": 321,
"brand_id": 5,
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
}
},
"warehouse": {
"id": 1,
"name": "Christchurch",
"short_code": "CHR",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"shipping_address": {
"first_name": "Support",
"last_name": "Team",
"company": "ACME LTD",
"email": "support.team@i-fulfilment.co.uk",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"attributes": [
{
"name": "Marketplace",
"value": "222-99999999-9999999"
}
],
"tags": [
{
"id": 1,
"name": "Processed",
"shortcode": "PROCESSED"
}
]
}Example payload:
{
"id": 1049789,
"status": "awaiting_despatch",
"date_placed": "2019-11-25T14:52:56.000Z",
"source": "How the order was created.",
"order": {
"id": 1234567,
"reference": "#154254",
"status": "open",
"channel": {
"id": 321,
"name": "Demo Channel",
"short_code": "DEMO"
},
"brand": {
"id": 5,
"name": "Demo Brand"
},
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
}
},
"warehouse": {
"id": 1,
"name": "Christchurch",
"short_code": "CHR",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"shipping_address": {
"first_name": "Support",
"last_name": "Team",
"company": "ACME LTD",
"email": "support.team@i-fulfilment.co.uk",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"lines": [
{
"id": 3450345,
"transaction_sku": "GREEN-BALL",
"quantity": 4,
"net_unit_principal": 7.25,
"net_unit_commission": 0.15,
"status": "active",
"created": "2019-11-25T14:52:56.000Z",
"modified": "2019-11-25T14:52:56.000Z",
"variation": {
"id": 1,
"product_id": 1,
"sku": "DEMO-SKU-01"
}
}
],
"attributes": [
{
"name": "Marketplace",
"value": "222-99999999-9999999"
}
],
"tags": [
{
"id": 1,
"name": "Processed",
"shortcode": "PROCESSED"
}
]
}Example payload:
{
"id": 1049789,
"status": "despatched",
"date_placed": "2019-11-25T14:52:56.000Z",
"despatch_date": "2019-11-25T14:52:56.000Z",
"source": "How the order was created.",
"order": {
"id": 1234567,
"reference": "#154254",
"status": "open",
"order_channel_id": 321,
"brand_id": 5,
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
},
"channel": {
"id": 1,
"organisation_id": 1,
"name": "Artplants",
"outbound_email": "GBP"
}
},
"warehouse": {
"id": 1,
"name": "Christchurch",
"short_code": "CHR",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"shipping_address": {
"first_name": "Support",
"last_name": "Team",
"company": "ACME LTD",
"email": "support.team@i-fulfilment.co.uk",
"country": {
"id": 1,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"attributes": [
{
"name": "Marketplace",
"value": "222-99999999-9999999"
}
],
"despatch_attributes": [
{
"sku": "DEMO-SKU-01",
"attribute_name": "Colour",
"attribute_value": "Red",
"order_goodsout_line_id": 12234,
"order_goodsout_line_item_id": 12234
}
],
"tags": [
{
"id": 1,
"name": "Processed",
"shortcode": "PROCESSED"
}
],
"shipping": [
{
"courier_name": "Royal Mail",
"service_name": "ExPak1",
"tracking": [
{
"tracking_number": "46513135648745",
"tracking_url": "http://www.royalmail.com/trackdetails?trackNumber=46513135648745"
}
]
}
]
}Example payload:
{
"return_id": 1049789,
"order_id": 346745845,
"order_reference": "#2323523",
"order_channel_id": 3634633,
"return_created": "2025-07-25T14:52:56.000Z",
"carrier": "Royal Mail",
"service": "Returns 48h",
"tracking_number": "abc123",
"warehouse_id": 23426246,
"received_date": "2025-07-25T14:52:56.000Z",
"completed_date": "2025-07-25T14:52:56.000Z",
"return_items": [
{
"sku": "SKU123456",
"product_component_id": 321,
"return_quantity": 2,
"return_reason": "Damaged item",
"exchange_or_refund": "refund",
"exchange_product_component_id": 4321,
"expected_quantity": 1,
"received_quantity": 1,
"correct_item": "yes",
"resellable": "yes"
}
]
}Example payload:
{
"return_id": 1049789,
"order_id": 346745845,
"order_reference": "#2323523",
"order_channel_id": 3634633,
"return_created": "2025-07-25T14:52:56.000Z",
"carrier": "Royal Mail",
"service": "Returns 48h",
"tracking_number": "abc123",
"warehouse_id": 23426246,
"return_items": [
{
"sku": "SKU123456",
"product_component_id": 321,
"return_quantity": 2,
"return_reason": "Damaged item",
"exchange_or_refund": "refund"
}
]
}Example payload:
{
"return_id": 1049789,
"order_id": 1049789,
"order_reference": "#154254",
"order_channel_id": 1049789,
"return_created": "2019-11-25T14:52:56.000Z",
"carrier": "Royal Mail",
"service": "Returns 48h",
"tracking_number": "abc123",
"warehouse_id": 1049789,
"received_date": "2019-11-25T14:52:56.000Z"
}Example payload:
{
"id": 123,
"code": "QWER123ASD",
"vendor": "VEN-01",
"status": "confirmed",
"delivery_party": null,
"address_first_name": "Amazon",
"address_last_name": "Inc.",
"address_company": null,
"address_line_one": "1 Amazon Rd",
"address_line_two": null,
"address_line_three": null,
"address_postcode": "BH23 4FL",
"address_town": "Christchurch",
"address_county": "Dorset",
"finalised": "2019-11-25T14:52:56.000Z",
"order_channel": {
"id": 321,
"name": "Demo Channel"
},
"country": {
"id": 231,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
},
"selected_warehouse": {
"id": 1,
"name": "Christchurch",
"country": {
"id": 231,
"name": "United Kingdom",
"iso_2": "GB",
"iso_3": "GBR"
}
},
"currency": {
"id": 1,
"name": "British Pound",
"code": "GBP",
"symbol": "£"
},
"items": [
{
"id": 4567,
"product_variation_id": 687,
"sku": "MODEL_309845",
"submitted_quantity": 1000,
"accepted_quantity": 850,
"unit_cost": 12.34,
"status": "accepted_in_stock",
"expected_delivery_date": "2019-11-25"
}
]
}