Using the Webhooks API a client may subscribe to multiple, atomic events.
Most of them involve return status has been updated so there is a full description of return life cycle here.
| Event | Description |
|---|---|
| return.updated.in_progress | Occurs whenever the status of a Return is updated to in_progress. |
| return.updated.shipped | Occurs whenever the status of a Return is updated to shipped. |
| return.updated.received | Occurs whenever the status of a Return is updated to received. |
| return.updated.for_review | Occurs whenever the status of a Return is updated to for_review. |
| return.updated.accepted | Occurs whenever the status of a Return is updated to accepted. |
| return.updated.rejected | Occurs whenever the status of a Return is updated to rejected. |
| return.updated.partially_accepted | Occurs whenever the status of a Return is updated to partially_accepted. |
| return.updated.cancelled | Occurs whenever the status of a Return is updated to cancelled. |
| return.exchange.created | Occurs whenever the exchange order has been created in the eCommerce platform. |
| return.exchange.updated | Occurs whenever the exchange order status changes from pending payment to paid. |
| return.tracking.created | Occurs whenever a tracking number is attached to a Return. |
| return.tracking.updated | Occurs whenever the tracking number of a Return is updated |
Event Data
return.updated.*
Occurs whenever the status of a Return request is updated:
{
"id": "cb30ecb31de94d98b35467dfe0ee3534",
"event": "return.updated",
"created": 1652806654,
"data": {
"resource": "return",
"resource_id": "8abd84507f6242bbb6e4deb844315706",
"status": "in_progress",
"amount": "38.0000",
"currency": "EUR",
"store": {
"id": "82162b6d55524595ad3f4e953ad3d501"
},
"object": {
"id": "8abd84507f6242bbb6e4deb844315706",
"external_id": "161461361",
"type": "instant_refund",
"refund_method": "bank_transfer",
"status": "in_progress",
"created_at": "2022-09-12T15:47:53.651848+00:00",
"updated_at": "2022-09-12T16:03:47.869756+00:00",
"order": {
"id": "8552c9dfe6244b30babef0e5a9475263",
"external_id": "1513515",
"number": "15314"
},
"exchange_order": null,
"customer": {
"id": "ae8a33a41d5f4f9aa8c9afba153b15d2",
"external_id": "561561425615"
},
"amount": "48.0000",
"shipping_amount": "6.0000",
"currency": "EUR",
"return_items": [
{
"id": "1ee132df1a4e4d119c4cd12099626f87",
"external_id": "6246246246245",
"status": "in_progress",
"sku": "SHIRTWK",
"price": "42.0000",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "4b9970795067419986307c2a4719cbc9",
"external_id": "1614676867"
},
"variant": {
"id": "4f161be48119410eb16b97e23aabf15a",
"external_id": "7857856849"
},
"return_reason": {
"reason": "No me gusta.",
"reason_key": "dislike"
},
"transaction_type": "refund",
"exchange": {
"exchange_info": null,
"exchange_item": null
}
}
],
"delivery_option": {
"name": "Standard shipment 0.5-1.0kg",
"carrier_name": "DHL",
"method": "custom",
"amount": "10.0000",
"currency": "EUR",
"tracking_number": null,
"tracking_url": null,
"address": {
"line_1": "Calle Madrid 121",
"line_2": "",
"postcode": "28901",
"locality": "Madrid",
"province": "Madrid",
"country": {
"code": "ES",
"name": "Spain",
"phone_code": "34"
},
"phone": "+34666555444"
}
},
"expired_at": null,
"cancelled_at": null,
"pending_at": null,
"shipped_at": null,
"received_at": null,
"for_review_at": null,
"accepted_at": null,
"rejected_at": null,
"completed_at": "2022-09-13T15:54:53.651848+00:00",
"expires_at": null,
"success_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"reject_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"dismiss_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"summary": {
"fees": {
"rule_fee_amount": "0.0000",
"instant_fee_amount": "0.0000",
"carbon_offset_fee_amount": "0.0000",
"delivery_option_fee_amount": "0.0000"
},
"amount": "19.7900",
"bonuses": {
"shipping_amount": "0.0000",
"store_credit_extra_amount": "0.0000"
},
"fee_amount": "0.0000",
"exchange_items_amount": "19.7900",
"original_items_amount": "19.7900",
"rejected_items_amount": "0.0000",
"exchange_adjustment_amount": "0.0000"
},
"reference": "R1-15314"
}
}
}
return.tracking.created
Occurs whenever a tracking number is attached to a Return:
{
"id": "cb30ecb31de94d98b35467dfe0ee3534",
"event": "return.tracking.created",
"created": 1652806828,
"data": {
"resource": "return",
"resource_id": "8abd84507f6242bbb6e4deb844315706",
"status": "in_progress",
"amount": "38.0000",
"currency": "EUR",
"store": {
"id": "82162b6d55524595ad3f4e953ad3d501"
},
"object": {
"id": "8abd84507f6242bbb6e4deb844315706",
"external_id": "161461361",
"type": "instant_refund",
"refund_method": "bank_transfer",
"status": "in_progress",
"created_at": "2022-09-12T15:47:53.651848+00:00",
"updated_at": "2022-09-13T16: 13:47.869756+00:00",
"order": {
"id": "8552c9dfe6244b30babef0e5a9475263",
"external_id": "1513515",
"number": "15314"
},
"exchange_order": null,
"customer": {
"id": "ae8a33a41d5f4f9aa8c9afba153b15d2",
"external_id": "561561425615"
},
"amount": "48.0000",
"shipping_amount": "6.0000",
"currency": "EUR",
"return_items": [
{
"id": "1ee132df1a4e4d119c4cd12099626f87",
"external_id": "6246246246245",
"status": "in_progress",
"sku": "SHIRTWK",
"price": "42.0000",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "4b9970795067419986307c2a4719cbc9",
"external_id": "1614676867"
},
"variant": {
"id": "4f161be48119410eb16b97e23aabf15a",
"external_id": "7857856849"
},
"return_reason": {
"reason": "No me gusta.",
"reason_key": "dislike"
},
"transaction_type": "refund",
"exchange": {
"exchange_info": null,
"exchange_item": null
}
}
],
"delivery_option": {
"name": "Standard shipment 0.5-1.0kg",
"carrier_name": "DHL",
"method": "custom",
"amount": "10.0000",
"currency": "EUR",
"tracking_number": "85449728",
"tracking_url": "https//foo.es/tracking/85449728",
"address": {
"line_1": "Calle Madrid 121",
"line_2": "",
"postcode": "28901",
"locality": "Madrid",
"province": "Madrid",
"country": {
"code": "ES",
"name": "Spain",
"phone_code": "34"
},
"phone": "+34666555444"
}
},
"expired_at": null,
"cancelled_at": null,
"pending_at": null,
"shipped_at": null,
"received_at": null,
"for_review_at": null,
"accepted_at": null,
"rejected_at": null,
"completed_at": "2022-09-13T15:54:53.651848+00:00",
"expires_at": null,
"success_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"reject_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"dismiss_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"summary": {
"fees": {
"rule_fee_amount": "0.0000",
"instant_fee_amount": "0.0000",
"carbon_offset_fee_amount": "0.0000",
"delivery_option_fee_amount": "0.0000"
},
"amount": "19.7900",
"bonuses": {
"shipping_amount": "0.0000",
"store_credit_extra_amount": "0.0000"
},
"fee_amount": "0.0000",
"exchange_items_amount": "19.7900",
"original_items_amount": "19.7900",
"rejected_items_amount": "0.0000",
"exchange_adjustment_amount": "0.0000"
},
"reference": "R1-15314"
}
}
}
return.tracking.updated
Occurs whenever the tracking number of a Return is updated:
{
"id": "cb30ecb31de94d98b35467dfe0ee3534",
"event": "return.tracking.updated",
"created": 1652806927,
"data": {
"resource": "return",
"resource_id": "8abd84507f6242bbb6e4deb844315706",
"status": "in_progress",
"amount": "38.0000",
"currency": "EUR",
"store": {
"id": "82162b6d55524595ad3f4e953ad3d501"
},
"object": {
"id": "8abd84507f6242bbb6e4deb844315706",
"external_id": "161461361",
"type": "instant_refund",
"refund_method": "bank_transfer",
"status": "in_progress",
"created_at": "2022-09-12T15:47:53.651848+00:00",
"updated_at": "2022-09-13T16:24: 19.856756+00:00",
"order": {
"id": "8552c9dfe6244b30babef0e5a9475263",
"external_id": "1513515",
"number": "15314"
},
"exchange_order": null,
"customer": {
"id": "ae8a33a41d5f4f9aa8c9afba153b15d2",
"external_id": "561561425615"
},
"amount": "48.0000",
"shipping_amount": "6.0000",
"currency": "EUR",
"return_items": [
{
"id": "1ee132df1a4e4d119c4cd12099626f87",
"external_id": "6246246246245",
"status": "in_progress",
"sku": "SHIRTWK",
"price": "42.0000",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "4b9970795067419986307c2a4719cbc9",
"external_id": "1614676867"
},
"variant": {
"id": "4f161be48119410eb16b97e23aabf15a",
"external_id": "7857856849"
},
"return_reason": {
"reason": "No me gusta.",
"reason_key": "dislike"
},
"transaction_type": "refund",
"exchange": {
"exchange_info": null,
"exchange_item": null
}
}
],
"delivery_option": {
"name": "Standard shipment 0.5-1.0kg",
"carrier_name": "DHL",
"method": "custom",
"amount": "10.0000",
"currency": "EUR",
"tracking_number": "85449728-A",
"tracking_url": "https//foo.es/tracking/85449728-A",
"address": {
"line_1": "Calle Madrid 121",
"line_2": "",
"postcode": "28901",
"locality": "Madrid",
"province": "Madrid",
"country": {
"code": "ES",
"name": "Spain",
"phone_code": "34"
},
"phone": "+34666555444"
}
},
"expired_at": null,
"cancelled_at": null,
"pending_at": null,
"shipped_at": null,
"received_at": null,
"for_review_at": null,
"accepted_at": null,
"rejected_at": null,
"completed_at": "2022-09-13T15:54:53.651848+00:00",
"expires_at": null,
"success_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"reject_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"dismiss_url": "https://foo.es?id=16773ee6fbf142cfa9d04b8d11d48e00",
"summary": {
"fees": {
"rule_fee_amount": "0.0000",
"instant_fee_amount": "0.0000",
"carbon_offset_fee_amount": "0.0000",
"delivery_option_fee_amount": "0.0000"
},
"amount": "19.7900",
"bonuses": {
"shipping_amount": "0.0000",
"store_credit_extra_amount": "0.0000"
},
"fee_amount": "0.0000",
"exchange_items_amount": "19.7900",
"original_items_amount": "19.7900",
"rejected_items_amount": "0.0000",
"exchange_adjustment_amount": "0.0000"
},
"reference": "R1-15314"
}
}
}
return.exchange.created
Occurs whenever the exchange order has been created in the eCommerce platform:
{
"id": "373c242b26b44cd8b1183f8e5fdb6e06",
"event": "update",
"created": 1687885677,
"data": {
"resource": "return",
"resource_id": "e78e0e6296f54de0ae102af76b56cbc3",
"status": "in_progress",
"amount": "19.7900",
"currency": "EUR",
"store": {
"id": "82162b6d55524595ad3f4e953ad3d501"
},
"object": {
"id": "e78e0e6296f54de0ae102af76b56cbc3",
"external_id": "161484321",
"type": "instant_exchange",
"refund_method": null,
"status": "in_progress",
"created_at": "2023-06-27T15:01: 11.395451+00:00",
"updated_at": "2023-06-27T15:01: 18.036681+00:00",
"order": {
"id": "50618c96f13847219208b36258b51529",
"external_id": "239438942892",
"number": "5829372"
},
"exchange_order": {
"id": "179d5bd2bbd144d9afd8sa99611fdcc6",
"external_id": "943289432947",
"number": "5829387"
},
"customer": {
"id": "897vm43jif7324daa8b7aeeb7522f10e1",
"external_id": "5648294362766789"
},
"amount": "19.7900",
"shipping_amount": "0.0000",
"currency": "EUR",
"return_items": [
{
"id": "6c107fjs9271g2116e88d739df05875a92",
"external_id": "8329031643261",
"status": "in_progress",
"sku": "SHIRTXX",
"price": "19.7900",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "0c387251f8s9att632b15b0ad966c",
"external_id": "4732819346261"
},
"variant": {
"id": "56726a9dcf5f433cccsudo6db8584a5bd",
"external_id": "48932412774"
},
"return_reason": {
"reason": "Change size",
"reason_key": "too_big"
},
"transaction_type": "exchange",
"exchange": {
"exchange_info": null,
"exchange_item": {
"id": "c0634754732823gf21df572013a3bf8",
"external_id": "4328943274326",
"sku": "SHIRTXY",
"price": "19.7900",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "0c3872513fds89af676866b15b0ad966c",
"external_id": "1567941616949"
},
"variant": {
"id": "56d7bc7d1ef34cf789wqf4f52165d727",
"external_id": "1657946156489"
}
}
}
}
],
"delivery_option": {
"name": "Standard shipment 0.5-1.0kg",
"carrier_name": "DHL",
"method": "home_pickup",
"amount": "0.0000",
"currency": "EUR",
"tracking_number": null,
"tracking_url": null,
"address": {
"line_1": "Calle Alcalá 121",
"line_2": "",
"postcode": "28901",
"locality": "Madrid",
"province": "Madrid",
"country": {
"code": "ES",
"name": "Spain",
"phone_code": "34"
},
"phone": "+34666555444"
}
},
"expired_at": null,
"cancelled_at": null,
"pending_at": null,
"shipped_at": null,
"received_at": null,
"for_review_at": null,
"accepted_at": null,
"rejected_at": null,
"completed_at": "2022-09-13T15:54:53.651848+00:00",
"expires_at": null,
"success_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"reject_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"dismiss_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"summary": {
"fees": {
"rule_fee_amount": "0.0000",
"instant_fee_amount": "0.0000",
"carbon_offset_fee_amount": "0.0000",
"delivery_option_fee_amount": "0.0000"
},
"amount": "19.7900",
"bonuses": {
"shipping_amount": "0.0000",
"store_credit_extra_amount": "0.0000"
},
"fee_amount": "0.0000",
"exchange_items_amount": "19.7900",
"original_items_amount": "19.7900",
"rejected_items_amount": "0.0000",
"exchange_adjustment_amount": "0.0000"
},
"reference": "R1-15314"
}
}
}
return.exchange.updated
Occurs whenever the exchange order status changes from pending payment to paid:
{
"id": "373c242b26b44cd8b1183f8e5fdb6e06",
"event": "update",
"created": 1687885677,
"data": {
"resource": "return",
"resource_id": "e78e0e6296f54de0ae102af76b56cbc3",
"status": "in_progress",
"amount": "19.7900",
"currency": "EUR",
"store": {
"id": "82162b6d55524595ad3f4e953ad3d501"
},
"object": {
"id": "e78e0e6296f54de0ae102af76b56cbc3",
"external_id": "161484321",
"type": "instant_exchange",
"refund_method": null,
"status": "in_progress",
"created_at": "2023-06-27T15:01: 11.395451+00:00",
"updated_at": "2023-06-27T15:01: 18.036681+00:00",
"order": {
"id": "50618c96f13847219208b36258b51529",
"external_id": "239438942892",
"number": "5829372"
},
"exchange_order": {
"id": "179d5bd2bbd144d9afd8sa99611fdcc6",
"external_id": "943289432947",
"number": "5829387"
},
"customer": {
"id": "897vm43jif7324daa8b7aeeb7522f10e1",
"external_id": "5648294362766789"
},
"amount": "19.7900",
"shipping_amount": "0.0000",
"currency": "EUR",
"return_items": [
{
"id": "6c107fjs9271g2116e88d739df05875a92",
"external_id": "8329031643261",
"status": "in_progress",
"sku": "SHIRTXX",
"price": "19.7900",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "0c387251f8s9att632b15b0ad966c",
"external_id": "4732819346261"
},
"variant": {
"id": "56726a9dcf5f433cccsudo6db8584a5bd",
"external_id": "48932412774"
},
"return_reason": {
"reason": "Change size",
"reason_key": "too_big"
},
"transaction_type": "exchange",
"exchange": {
"exchange_info": null,
"exchange_item": {
"id": "c0634754732823gf21df572013a3bf8",
"external_id": "4328943274326",
"sku": "SHIRTXY",
"price": "19.7900",
"currency": "EUR",
"quantity": 1,
"product": {
"id": "0c3872513fds89af676866b15b0ad966c",
"external_id": "1567941616949"
},
"variant": {
"id": "56d7bc7d1ef34cf789wqf4f52165d727",
"external_id": "1657946156489"
}
}
}
}
],
"delivery_option": {
"name": "Standard shipment 0.5-1.0kg",
"carrier_name": "DHL",
"method": "home_pickup",
"amount": "0.0000",
"currency": "EUR",
"tracking_number": null,
"tracking_url": null,
"address": {
"line_1": "Calle Alcalá 121",
"line_2": "",
"postcode": "28901",
"locality": "Madrid",
"province": "Madrid",
"country": {
"code": "ES",
"name": "Spain",
"phone_code": "34"
},
"phone": "+34666555444"
}
},
"expired_at": null,
"cancelled_at": null,
"pending_at": null,
"shipped_at": null,
"received_at": null,
"for_review_at": null,
"accepted_at": null,
"rejected_at": null,
"completed_at": "2022-09-13T15:54:53.651848+00:00",
"expires_at": null,
"success_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"reject_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"dismiss_url": "https://foo.es?id=e78e0e6296f54de0ae102af76b56cbc3",
"summary": {
"fees": {
"rule_fee_amount": "0.0000",
"instant_fee_amount": "0.0000",
"carbon_offset_fee_amount": "0.0000",
"delivery_option_fee_amount": "0.0000"
},
"amount": "19.7900",
"bonuses": {
"shipping_amount": "0.0000",
"store_credit_extra_amount": "0.0000"
},
"fee_amount": "0.0000",
"exchange_items_amount": "19.7900",
"original_items_amount": "19.7900",
"rejected_items_amount": "0.0000",
"exchange_adjustment_amount": "0.0000"
},
"reference": "R1-15314"
}
}
}