Event Payloads
delivery:created
Payload
{
"topic" : "delivery:created",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 15,
"delivery_type" : "rma",
"increment_id" : "1000029",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:canceled
Payload
{
"topic" : "delivery:canceled",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 16,
"delivery_type" : "rma",
"increment_id" : "1000030",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:accepted
Payload
{
"topic" : "delivery:accepted",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 17,
"delivery_type" : "rma",
"increment_id" : "1000031",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:processed
Payload
{
"topic" : "delivery:processed",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 18,
"delivery_type" : "rma",
"increment_id" : "1000032",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:exception
Payload
{
"topic" : "delivery:exception",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 19,
"delivery_type" : "rma",
"increment_id" : "1000033",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:putaway
Payload
{
"topic" : "delivery:putaway",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 20,
"delivery_type" : "rma",
"increment_id" : "1000034",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:committed
Payload
{
"topic" : "delivery:committed",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 21,
"delivery_type" : "rma",
"increment_id" : "1000035",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"stock_adjustments" : {
"sku123" : {
"sku" : "sku123",
"external_id" : null,
"product_id" : 7,
"qty_adjust" : 5,
"qty_available": 95,
"qty_advertised": 95
}
},
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery:status_changed
Payload
{
"topic" : "delivery:status_changed",
"message" : {
"merchant_code" : "acme",
"delivery_id" : 22,
"delivery_type" : "rma",
"increment_id" : "1000036",
"sender_name" : "Microsoft",
"sender_ref" : "00123456",
"sender_ref_alt" : "abc123",
"merchant_ref" : "xyz456",
"merchant_status" : null,
"old_status" : "putting_away",
"new_status" : "put_away",
"old_state" : "putting_away",
"new_state" : "complete",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
sender_name contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has Include PCD enabled.delivery_label:created
Payload
{
"topic" : "delivery_label:created",
"message" : {
"merchant_code" : "acme",
"unique_id" : 5,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
delivery_label:voided
Payload
{
"topic" : "delivery_label:voided",
"message" : {
"merchant_code" : "acme",
"unique_id" : 7,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
import:created
Payload
{
"topic" : "import:created",
"message" : {
"merchant_code" : "acme",
"unique_id" : 4,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
import:completed
Payload
{
"topic" : "import:completed",
"message" : {
"merchant_code" : "acme",
"unique_id" : 5,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
inventory:adjusted
Payload
{
"topic" : "inventory:adjusted",
"message" : {
"merchant_code" : "acme",
"stock_adjustments" : {
"sku123" : {
"sku" : "sku123",
"external_id" : null,
"product_id" : 7,
"qty_adjust" : 5,
"qty_available": 95,
"qty_advertised": 95
}
},
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
qty_adjust key, but rather only the absolute values.
order:created
Payload
{
"topic" : "order:created",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000015",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"stock_adjustments" : {
"sku123" : {
"sku" : "sku123",
"external_id" : null,
"product_id" : 7,
"qty_adjust" : -5,
"qty_available": 95,
"qty_advertised": 95
}
},
"items" : [
{
"sku" : "product1",
"name" : "product1",
"qty_ordered" : "2.0000",
"qty_backordered" : "0.0000",
"qty_canceled" : "0.0000",
"qty_processing" : "0.0000",
"qty_shipped" : "0.0000",
"unit_declared_value" : null,
"unit_declared_value_currency" : "USD",
"unit_customs_value" : null,
"unit_customs_value_currency" : "USD",
"gift_message" : null,
"weight" : "5.800000",
"row_weight" : "11.600000",
"allocation_data" : [
{
"warehouse_id" : "2",
"qty_allocated" : "2.0000"
}
],
"order_item_id" : "230",
"order_item_ref" : null,
"weight_unit" : "lb",
"row_weight_unit" : "lb"
},
{
"sku" : "product3",
"name" : "product3",
"qty_ordered" : "7.0000",
"qty_backordered" : "1.0000",
"qty_canceled" : "0.0000",
"qty_processing" : "0.0000",
"qty_shipped" : "0.0000",
"unit_declared_value" : null,
"unit_declared_value_currency" : "USD",
"gift_message" : null,
"unit_customs_value" : null,
"unit_customs_value_currency" : "USD",
"weight" : "0.200000",
"row_weight" : "1.400000",
"allocation_data" : [
{
"warehouse_id" : "1",
"qty_allocated" : "2.0000"
},
{
"warehouse_id" : "2",
"qty_allocated" : "4.0000"
}
],
"order_item_id" : "232",
"order_item_ref" : null,
"weight_unit" : "lb",
"row_weight_unit" : "lb"
}
],
"webhook_increment_id" : 2,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:canceled
Payload
{
"topic" : "order:canceled",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000016",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"stock_adjustments" : {
"sku123" : {
"sku" : "sku123",
"external_id" : null,
"product_id" : 7,
"qty_adjust" : 5,
"qty_available": 95,
"qty_advertised": 95
}
},
"shipments": [ {"unique_id" : "100000026"} ],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:items_updated
Payload
{
"topic": "order:items_updated",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "100000022",
"order_ref": "9099",
"source": null,
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"items_canceled": [
{
"sku": "product1",
"order_item_id": "215",
"qty_canceled": "1.0000"
}
],
"items_remaining": [
{
"sku": "product2",
"name": "product2",
"qty_ordered": "1.0000",
"qty_backordered": "0.0000",
"qty_canceled": "0.0000",
"qty_processing": "0.0000",
"qty_shipped": "1.0000",
"unit_declared_value": null,
"unit_declared_value_currency": "USD",
"unit_customs_value": null,
"unit_customs_value_currency": "USD",
"weight": "5.800000",
"row_weight": "5.800000",
"package_data": [
{
"label": "Serial Number - 8 Characters",
"value": "12345ABC"
}
],
"allocation_data": [
{
"warehouse_id": "2",
"qty_allocated": "0.0000"
}
],
"order_item_id": "214",
"order_item_ref": null,
"weight_unit": "lb",
"row_weight_unit": "lb"
}
],
"webhook_increment_id": 1,
"event_timestamp": "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:holded
Payload
{
"topic" : "order:holded",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000017",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"webhook_increment_id" : 3,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:completed
Payload
{
"topic" : "order:completed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000020",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"webhook_increment_id" : 5,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:shipped
Payload
{
"topic" : "order:shipped",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000022",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"shipments" : [
{
"unique_id" : "100000033",
"warehouse_id": 1,
"carrier": "fedex",
"status" : "shipped",
"service": "GROUND_HOME_DELIVERY",
"trackers" : [{
"tracker_id" : 4,
"status" : "in_transit",
"carrier" : "fedex",
"tracking_number" : "794657040105",
"carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_est_delivery_at_date" : true,
"original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_original_est_delivery_at_date" : true,
"delivered_at" : null,
"signed_by" : null
}]
}
],
"webhook_increment_id" : 1,
"event_timestamp": "2023-05-15T17:28:28+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:delivered
Payload
{
"topic" : "order:delivered",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000022",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"shipments" : [
{
"unique_id" : "100000033",
"warehouse_id": 1,
"carrier": "fedex",
"status" : "delivered",
"service": "GROUND_HOME_DELIVERY",
"trackers" : [{
"tracker_id" : 4,
"status" : "delivered",
"carrier" : "fedex",
"tracking_number" : "794657040105",
"carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"est_delivery_at" : "2021-10-07T00:00:00-04:00",
"is_est_delivery_at_date" : true,
"original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_original_est_delivery_at_date" : true,
"delivered_at" : "2021-12-07T12:08:15-04:00",
"signed_by" : "J. Smith"
}]
}
],
"webhook_increment_id" : 1,
"event_timestamp": "2023-05-15T17:28:28+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:address_validation_failed
Payload
{
"topic" : "order:address_validation_failed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000021",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : false,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:address_changed
Payload
{
"topic" : "order:address_changed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000021",
"order_ref" : "9099",
"source" : null,
"old_status" : "new",
"status" : "new",
"old_state" : "new",
"state" : "new",
"old_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "321 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "98765",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@gmail.com"
},
"update_method" : "manual",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
old_address and address contain Protected Customer Data (PCD) and are only included when the webhook subscription has Include PCD enabled.order:status_changed
Payload
{
"topic" : "order:status_changed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000022",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"old_status" : null,
"status" : "new",
"old_state" : null,
"state" : "new",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:shipments_updated
Payload
{
"topic" : "order:shipments_updated",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000022",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"shipments" : [
{
"unique_id" : "100000033",
"warehouse_id": 1,
"carrier": "fedex",
"service": "GROUND_HOME_DELIVERY"
}
],
"webhook_increment_id" : 1,
"event_timestamp": "2023-05-15T17:28:28+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.order:shipping_options_changed
Payload
{
"topic" : "order:shipping_options_changed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"unique_id" : "100000022",
"order_ref" : "9099",
"source" : null,
"shipping_address" : {
"firstname" : "John",
"lastname" : "Doe",
"company" : "ACME",
"street" : "123 ACME BIG STREET",
"city" : "New York",
"region" : "NY",
"postcode" : "99999",
"country" : "US",
"classification" : "com",
"is_valid" : true,
"telephone" : "865999999",
"email" : "john.doe@example.com"
},
"status" : "partial_backorder",
"state" : "processing",
"shipping_options" : {
"saturday_delivery" : true
},
"old_shipping_options" : {
"saturday_delivery" : false
},
"webhook_increment_id" : 1,
"event_timestamp": "2023-05-15T17:28:28+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.product:created
Payload
{
"topic" : "product:created",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product:updated
Payload
{
"topic" : "product:updated",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product:sku_changed
Payload
{
"topic" : "product:sku_changed",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"old_sku": "344828-22",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product:deleted
Payload
{
"topic" : "product:deleted",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product_media:created
Payload
{
"topic" : "product_media:created",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 3,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product_media:updated
Payload
{
"topic" : "product_media:updated",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 3,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
product_media:deleted
Payload
{
"topic" : "product_media:deleted",
"message" : {
"merchant_code" : "acme",
"sku" : "product1",
"external_id" : null,
"webhook_increment_id" : 5,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
serial_number:created
Payload
{
"topic" : "serial_number:created",
"message" : {
"merchant_code" : "acme",
"serial_id" : 234,
"identifier" : "123456123456",
"product_id" : 7,
"sku" : "sku123",
"created_at" : "2024-10-22T16:08:15+00:00",
"warehouse_id" : 1,
"old_status" : "unknown",
"new_status" : "received",
"old_availability" : "checked_out",
"new_availability" : "pending",
"old_location" : null,
"old_location_id" : null,
"new_location" : null,
"new_location_id" : null,
"target_type" : "asn",
"target_id" : 15,
"target_description" : "1000029",
"target_child_type" : "container",
"target_child_id" : 16,
"target_child_description" : "Pallet 1",
"package_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2024-10-22T16:08:15+00:00"
}
}
serial_number:updated
Payload
{
"topic" : "serial_number:updated",
"message" : {
"merchant_code" : "acme",
"serial_id" : 234,
"identifier" : "123456123456",
"product_id" : 7,
"sku" : "sku123",
"created_at" : "2024-10-22T16:08:15+00:00",
"warehouse_id" : 1,
"old_status" : "received",
"new_status" : "located",
"old_availability" : "pending",
"new_availability" : "available",
"old_location" : null,
"old_location_id" : null,
"new_location" : "A-2",
"new_location_id" : 224,
"target_type" : "asn",
"target_id" : 15,
"target_description" : "1000029",
"target_child_type" : "container",
"target_child_id" : 16,
"target_child_description" : "Pallet 1",
"package_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2024-10-22T16:45:13+00:00"
}
}
serial_number:checkin
Payload
{
"topic" : "serial_number:checkin",
"message" : {
"merchant_code" : "acme",
"serial_id" : 234,
"identifier" : "123456123456",
"product_id" : 7,
"sku" : "sku123",
"created_at" : "2024-10-22T16:08:15+00:00",
"warehouse_id" : 1,
"old_status" : "unknown",
"new_status" : "received",
"old_availability" : "checked_out",
"new_availability" : "pending",
"old_location" : null,
"old_location_id" : null,
"new_location" : null,
"new_location_id" : null,
"target_type" : "asn",
"target_id" : 15,
"target_description" : "1000029",
"target_child_type" : "container",
"target_child_id" : 16,
"target_child_description" : "Pallet 1",
"package_id" : null,
"webhook_increment_id" : 1,
"event_timestamp" : "2024-10-22T16:08:15+00:00"
}
}
serial_number:checkout
Payload
{
"topic" : "serial_number:checkout",
"message" : {
"merchant_code" : "acme",
"serial_id" : 234,
"identifier" : "123456123456",
"product_id" : 7,
"sku" : "sku123",
"created_at" : "2024-10-22T16:08:15+00:00",
"warehouse_id" : 1,
"old_status" : "packed",
"new_status" : "shipped",
"old_availability" : "pending",
"new_availability" : "checked_out",
"old_location" : null,
"old_location_id" : null,
"new_location" : null,
"new_location_id" : null,
"target_type" : "order",
"target_id" : 15,
"target_description" : "1000029",
"target_child_type" : "shipment",
"target_child_id" : 16,
"target_child_description" : "1000042",
"package_id" : 48,
"webhook_increment_id" : 1,
"event_timestamp" : "2024-10-23T09:22:26+00:00"
}
}
The
packages[] payload in the shipment:* and tracker:* events mirrors the package shape returned by shipment.info — see Package Properties for the full reference. For items[].lot_data[], see the Lot Data fields under Shipment Item Properties. manifest_courier_code is included only when the shipment has a manifest code.shipment:packed
Payload
{
"topic": "shipment:packed",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "100000595",
"warehouse_id": "1",
"status": "packed",
"external_id": null,
"order_ref": null,
"order_unique_id": "100000540",
"source": null,
"order_status": "complete",
"carrier": "ups",
"service": "03",
"service_description": "UPS Ground",
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"items": [
{
"order_item_id": "2954",
"order_item_ref": null,
"order_item_sku": "556x45mm62FMJM855Fed-500",
"sku": "556x45mm62FMJM855Fed-500",
"quantity": "1.0000",
"lot_data": [
{
"lot_id": 456,
"sku": "556x45mm62FMJM855Fed-500",
"lot_number": "2021-01-01",
"expiration_date": "2021-01-01",
"origination_date": "2023-10-27",
"quantity": "1.0000"
}
]
},
{
"order_item_id": "2955",
"order_item_ref": null,
"order_item_sku": "10mm200TMJCCI-1000",
"sku": "10mm200TMJCCI-1000",
"quantity": "1.0000",
"lot_data": []
}
],
"packages": [
{
"package_id": "234",
"status": "packed",
"weight": "1.7500",
"weight_unit": "lb",
"tracker_id": "229",
"created_at": "2023-10-27T11:59:08+00:00",
"tracking_added_at": "2023-10-27T11:59:09+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2954",
"order_item_ref": null,
"order_item_sku": "556x45mm62FMJM855Fed-500",
"sku": "556x45mm62FMJM855Fed-500",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2954",
"label": "Serial Number",
"value": "123456-3"
}
],
"tracking_numbers": [
"TT234"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT234"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "556x45mm62FMJM855Fed-500",
"product_id": "7"
}
]
},
{
"package_id": "235",
"status": "packed",
"weight": "0.5000",
"weight_unit": "lb",
"tracker_id": "230",
"created_at": "2023-10-27T11:59:08+00:00",
"tracking_added_at": "2023-10-27T11:59:09+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2955",
"order_item_ref": null,
"order_item_sku": "10mm200TMJCCI-1000",
"sku": "10mm200TMJCCI-1000",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2955",
"label": "Serial Number",
"value": "123456-5"
}
],
"tracking_numbers": [
"TT235"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT235"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "10mm200TMJCCI-1000",
"product_id": "7"
}
]
}
],
"trackers": [
{
"tracker_id": "229",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT234",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT234"
},
{
"tracker_id": "230",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT235",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT235"
}
],
"updated_at": "2023-10-27T11:59:09+00:00",
"shipping_method": "ups_03",
"tpb_group_id": null,
"total_weight": 2.25,
"total_qty": "2.0000",
"order_id": "2542",
"shipped_weight": null,
"created_at": "2023-10-27T11:59:08+00:00",
"target_ship_date": "2023-10-27",
"packed_at": "2023-10-27T11:59:09+00:00",
"total_item_weight": "2.2500",
"scac": null,
"shipped_at": null,
"delivered_at": null,
"store_code": "default",
"total_weight_unit": "lb",
"shipped_weight_unit": null,
"webhook_increment_id": 3,
"event_timestamp": "2023-10-27T11:59:09+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.shipment:shipped
Payload
{
"topic": "shipment:shipped",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "300000008",
"warehouse_id": "1",
"status": "shipped",
"external_id": "123456",
"order_ref": "456789",
"order_unique_id": "400111867",
"source": null,
"order_status": "complete",
"carrier": "ups",
"service": "03",
"service_description": "UPS Ground",
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"items": [
{
"order_item_id": "21",
"order_item_ref": null,
"order_item_sku": "12ga2-34buck00FederalPrem-250",
"sku": "12ga2-34buck00FederalPrem-250",
"quantity": "1.0000",
"lot_data": []
}
],
"packages": [
{
"package_id": "1",
"status": "shipped",
"weight": "28.5000",
"weight_unit": "lb",
"tracker_id": "2",
"created_at": "2013-02-28T20:18:04+00:00",
"tracking_added_at": "2023-05-10T15:36:44+00:00",
"shipped_at": "2023-05-10T15:36:44+00:00",
"delivered_at": null,
"items": [
{
"order_item_id": "21",
"order_item_ref": null,
"order_item_sku": "12ga2-34buck00FederalPrem-250",
"sku": "12ga2-34buck00FederalPrem-250",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [],
"tracking_numbers": [
"1Z999AA10123456784"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "12ga2-34buck00FederalPrem-250",
"product_id": "7"
}
]
}
],
"trackers": [
{
"tracker_id": "2",
"status": "unknown",
"carrier": "ups",
"tracking_number": "1Z999AA10123456784",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
}
],
"updated_at": "2023-10-27T12:06:10+00:00",
"shipping_method": "ups_03",
"tpb_group_id": null,
"total_weight": 26.7,
"total_qty": "1.0000",
"order_id": "17",
"shipped_weight": 26.7,
"created_at": "2013-02-28T20:18:04+00:00",
"target_ship_date": null,
"packed_at": null,
"total_item_weight": "26.7000",
"scac": null,
"shipped_at": "2023-05-10T15:36:44+00:00",
"delivered_at": null,
"store_code": "default",
"total_weight_unit": "lb",
"shipped_weight_unit": "lb",
"webhook_increment_id": 1,
"event_timestamp": "2023-10-27T12:06:10+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.shipment:delivered
Payload
{
"topic": "shipment:delivered",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "300000008",
"warehouse_id": "1",
"status": "shipped",
"external_id": "123456",
"order_ref": "456789",
"order_unique_id": "400111867",
"source": null,
"order_status": "complete",
"carrier": "ups",
"service": "03",
"service_description": "UPS Ground",
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"items": [
{
"order_item_id": "21",
"order_item_ref": null,
"order_item_sku": "12ga2-34buck00FederalPrem-250",
"sku": "12ga2-34buck00FederalPrem-250",
"quantity": "1.0000",
"lot_data": []
}
],
"packages": [
{
"package_id": "1",
"status": "delivered",
"weight": "28.5000",
"weight_unit": "lb",
"tracker_id": "3",
"created_at": "2013-02-28T20:18:04+00:00",
"tracking_added_at": "2023-05-10T21:42:17+00:00",
"shipped_at": "2023-05-10T21:42:17+00:00",
"delivered_at": "2023-05-13T14:53:14+00:00",
"items": [
{
"order_item_id": "21",
"order_item_ref": null,
"order_item_sku": "12ga2-34buck00FederalPrem-250",
"sku": "12ga2-34buck00FederalPrem-250",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [],
"tracking_numbers": [
"1Z999AA10123456784"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "12ga2-34buck00FederalPrem-250",
"product_id": "7"
}
]
}
],
"trackers": [
{
"tracker_id": "3",
"status": "delivered",
"carrier": "ups",
"tracking_number": "1Z999AA10123456784",
"est_delivery_at": "2023-05-13T12:00:00-04:00",
"is_est_delivery_at_date": false,
"original_est_delivery_at": "2023-05-12T00:00:00-04:00",
"is_original_est_delivery_at_date": true,
"delivered_at": "2023-05-13T10:53:14-04:00",
"signed_by": "J. Smith",
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
}
],
"updated_at": "2023-10-27T12:09:45+00:00",
"shipping_method": "ups_03",
"tpb_group_id": null,
"total_weight": 26.7,
"total_qty": "1.0000",
"order_id": "17",
"shipped_weight": 26.7,
"created_at": "2013-02-28T20:18:04+00:00",
"target_ship_date": null,
"packed_at": null,
"total_item_weight": "26.7000",
"scac": null,
"shipped_at": "2023-05-10T21:42:17+00:00",
"delivered_at": "2023-05-13T14:53:14+00:00",
"store_code": "default",
"total_weight_unit": "lb",
"shipped_weight_unit": "lb",
"webhook_increment_id": 1,
"event_timestamp": "2023-10-27T12:09:45+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.shipment:reverted
Payload
{
"topic": "shipment:reverted",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "100000596",
"warehouse_id": "1",
"status": "voided",
"external_id": null,
"order_ref": null,
"order_unique_id": "100000541",
"source": null,
"order_status": "backordered",
"carrier": "ups",
"service": "03",
"service_description": "UPS Ground",
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"items": [
{
"order_item_id": "2956",
"order_item_ref": null,
"order_item_sku": "556x45mm62FMJM855Fed-500",
"sku": "556x45mm62FMJM855Fed-500",
"quantity": "1.0000",
"lot_data": [
{
"lot_id": 456,
"sku": "556x45mm62FMJM855Fed-500",
"lot_number": "2021-01-01",
"expiration_date": "2021-01-01",
"origination_date": "2023-10-27",
"quantity": "1.0000"
}
]
},
{
"order_item_id": "2957",
"order_item_ref": null,
"order_item_sku": "10mm200TMJCCI-1000",
"sku": "10mm200TMJCCI-1000",
"quantity": "1.0000",
"lot_data": []
}
],
"packages": [
{
"package_id": "236",
"status": "packed",
"weight": "1.7500",
"weight_unit": "lb",
"tracker_id": "231",
"created_at": "2023-10-27T12:12:50+00:00",
"tracking_added_at": "2023-10-27T12:12:51+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2956",
"order_item_ref": null,
"order_item_sku": "556x45mm62FMJM855Fed-500",
"sku": "556x45mm62FMJM855Fed-500",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2956",
"label": "Serial Number",
"value": "123456-3"
}
],
"tracking_numbers": [
"TT236"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT236"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "556x45mm62FMJM855Fed-500",
"product_id": "7"
}
]
},
{
"package_id": "237",
"status": "packed",
"weight": "0.5000",
"weight_unit": "lb",
"tracker_id": "232",
"created_at": "2023-10-27T12:12:50+00:00",
"tracking_added_at": "2023-10-27T12:12:51+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2957",
"order_item_ref": null,
"order_item_sku": "10mm200TMJCCI-1000",
"sku": "10mm200TMJCCI-1000",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2957",
"label": "Serial Number",
"value": "123456-5"
}
],
"tracking_numbers": [
"TT237"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT237"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "10mm200TMJCCI-1000",
"product_id": "7"
}
]
}
],
"trackers": [
{
"tracker_id": "231",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT236",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT236"
},
{
"tracker_id": "232",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT237",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT237"
}
],
"updated_at": "2023-10-27T12:12:53+00:00",
"shipping_method": "ups_03",
"tpb_group_id": null,
"total_weight": 2.25,
"total_qty": "2.0000",
"order_id": "2543",
"shipped_weight": null,
"created_at": "2023-10-27T12:12:50+00:00",
"target_ship_date": "2023-10-27",
"packed_at": "2023-10-27T12:12:51+00:00",
"total_item_weight": "2.2500",
"scac": null,
"shipped_at": null,
"delivered_at": null,
"store_code": "default",
"total_weight_unit": "lb",
"shipped_weight_unit": null,
"webhook_increment_id": 4,
"event_timestamp": "2023-10-27T12:12:53+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.shipment:labels_voided
Payload
{
"topic": "shipment:labels_voided",
"message": {
"merchant_code": "acme",
"brand_code": "default",
"unique_id": "100000597",
"warehouse_id": "1",
"status": "picked",
"external_id": null,
"order_ref": null,
"order_unique_id": "100000542",
"source": null,
"order_status": "processing",
"carrier": "ups",
"service": "03",
"service_description": "UPS Ground",
"shipping_address": {
"firstname": "John",
"lastname": "Doe",
"company": "ACME",
"street": "123 ACME BIG STREET",
"city": "New York",
"region": "NY",
"postcode": "99999",
"country": "US",
"classification": "com",
"is_valid": true,
"telephone": "865999999",
"email": "john.doe@example.com"
},
"packages": [
{
"package_id": "238",
"status": "packed",
"weight": "1.7500",
"weight_unit": "lb",
"tracker_id": "233",
"created_at": "2023-10-27T12:18:04+00:00",
"tracking_added_at": "2023-10-27T12:18:04+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2958",
"order_item_ref": null,
"order_item_sku": "556x45mm62FMJM855Fed-500",
"sku": "556x45mm62FMJM855Fed-500",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2958",
"label": "Serial Number",
"value": "123456-3"
}
],
"tracking_numbers": [
"TT238"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT238"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "556x45mm62FMJM855Fed-500",
"product_id": "7"
}
]
},
{
"package_id": "239",
"status": "packed",
"weight": "0.5000",
"weight_unit": "lb",
"tracker_id": "234",
"created_at": "2023-10-27T12:18:04+00:00",
"tracking_added_at": "2023-10-27T12:18:04+00:00",
"shipped_at": null,
"delivered_at": null,
"items": [
{
"order_item_id": "2959",
"order_item_ref": null,
"order_item_sku": "10mm200TMJCCI-1000",
"sku": "10mm200TMJCCI-1000",
"quantity": "1.0000",
"order_item_qty": 1
}
],
"package_data": [
{
"order_item_id": "2959",
"label": "Serial Number",
"value": "123456-5"
}
],
"tracking_numbers": [
"TT239"
],
"tracking_urls": [
"https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT239"
],
"packaging": [],
"manifest_courier": "UPS",
"carrier": "ups",
"manifest_courier_code": "ups",
"billable_weight": "14",
"billable_weight_unit": "lb",
"dimensional_weight_divisor": "139",
"dimensional_weight_divisor_unit": "in^3/lb",
"dimensional_weight": "14",
"rating_weight_unit": "lb",
"dimensions": {
"length": "16.000",
"width": "12.000",
"height": "8.000"
},
"dimension_unit": "in",
"sscc": "00508101336500131005",
"serial_number_data": [
{
"serial_id": "1",
"identifier": "123456123456",
"sku": "10mm200TMJCCI-1000",
"product_id": "7"
}
]
}
],
"trackers": [
{
"tracker_id": "233",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT238",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT238"
},
{
"tracker_id": "234",
"status": "unknown",
"carrier": "ups",
"tracking_number": "TT239",
"est_delivery_at": null,
"is_est_delivery_at_date": null,
"original_est_delivery_at": null,
"is_original_est_delivery_at_date": null,
"delivered_at": null,
"signed_by": null,
"carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT239"
}
],
"updated_at": "2023-10-27T12:18:06+00:00",
"shipping_method": "ups_03",
"tpb_group_id": null,
"total_weight": 2.25,
"total_qty": "2.0000",
"order_id": "2544",
"shipped_weight": null,
"created_at": "2023-10-27T12:18:04+00:00",
"target_ship_date": "2023-10-27",
"packed_at": null,
"total_item_weight": "2.2500",
"scac": null,
"shipped_at": null,
"delivered_at": null,
"store_code": "default",
"total_weight_unit": "lb",
"shipped_weight_unit": null,
"webhook_increment_id": 2,
"event_timestamp": "2023-10-27T12:18:06+00:00"
}
}
shipping_address contains Protected Customer Data (PCD) and is only included when the webhook subscription has Include PCD enabled.package:packed
Payload
{
"topic" : "package:packed",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"package_id" : 22,
"status" : "packed",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
package:manifested
Payload
{
"topic" : "package:manifested",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"package_id" : 22,
"status" : "manifested",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
package:shipped
Payload
{
"topic" : "package:shipped",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"package_id" : 22,
"status" : "shipped",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
package:delivered
Payload
{
"topic" : "package:delivered",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"package_id" : 22,
"status" : "delivered",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
track:created
This topic is deprecated. Please use shipment:packed instead.
Payload
{
"topic" : "track:created",
"message" : {
"merchant_code" : "acme",
"brand_code" : "default",
"order_ref" : "9099",
"order_unique_id" : "100000018",
"shipment_unique_id" : "100000007",
"warehouse_id": 1,
"package_id" : 99,
"source" : "shopify",
"carrier" : "fedex",
"service" : "FEDEX_2_DAY",
"number" : "794657040105",
"url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
tracker:updated
Payload
{
"topic" : "tracker:updated",
"message" : {
"merchant_code" : "acme",
"tracker_id" : 23,
"order_unique_id" : "100000018",
"order_ref" : "9099",
"order_source" : "shopify",
"shipment_unique_id" : "100000007",
"warehouse_id" : 1,
"carrier" : "fedex",
"tracking_number" : "794657040105",
"carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"old_status" : "unknown",
"new_status" : "pre_transit",
"new_details" : [{
"status" : "pre_transit",
"timestamp" : "2021-12-03T12:08:15-04:00",
"is_timestamp_date" : false,
"message" : "Label created.",
"source" : "carrier_api",
"location" : {
"city" : "Amsterdam",
"country" : "US",
"postcode" : "12010-6269",
"region" : "NY",
"timezone" : "America/New_York",
"lat" : 42.9387,
"lng" : -74.1882
}
}],
"est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_est_delivery_at_date" : true,
"original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_original_est_delivery_at_date" : true,
"delivered_at" : null,
"signed_by" : null,
"packages" : [{
"package_id" : 99,
"weight" : 10.2,
"weight_unit" : "lb",
"tracker_id" : 3,
"created_at" : "2021-12-03T16:08:15+00:00",
"tracking_added_at" : "2021-12-03T16:08:15+00:00",
"shipped_at" : null,
"delivered_at" : null,
"items" : [
{"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
],
"package_data" : [
{"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
],
"tracking_numbers" : [
"794657040105"
],
"tracking_urls" : [
"https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
],
"packaging" : [],
"manifest_courier" : "FedEx",
"carrier" : "fedex",
"manifest_courier_code" : "fedex",
"billable_weight" : "14",
"billable_weight_unit" : "lb",
"dimensional_weight_divisor" : "139",
"dimensional_weight_divisor_unit" : "in^3/lb",
"dimensional_weight" : "14",
"rating_weight_unit" : "lb",
"dimensions" : {
"length" : "16.000",
"width" : "12.000",
"height" : "8.000"
},
"dimension_unit" : "in",
"sscc" : "00508101336500131005",
"serial_number_data" : [
{
"serial_id" : "1",
"identifier" : "123456123456",
"sku" : "sku123",
"product_id" : "7"
}
]
}],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-03T16:08:15+00:00"
}
}
tracker:delivered
Payload
{
"topic" : "tracker:delivered",
"message" : {
"merchant_code" : "acme",
"tracker_id" : 23,
"order_unique_id" : "100000018",
"order_ref" : "9099",
"order_source" : "shopify",
"shipment_unique_id" : "100000007",
"warehouse_id" : 1,
"carrier" : "fedex",
"tracking_number" : "794657040105",
"carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"old_status" : "out_for_delivery",
"new_status" : "delivered",
"new_details" : [{
"status" : "delivered",
"message" : "Delivered at front door.",
"timestamp" : "2021-12-07T12:08:15-04:00",
"is_timestamp_date" : false,
"source" : "carrier_api",
"location" : {
"city" : "Amsterdam",
"country" : "US",
"postcode" : "12010-6269",
"region" : "NY",
"timezone" : "America/New_York",
"lat" : 42.9387,
"lng" : -74.1882
}
}],
"est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_est_delivery_at_date" : true,
"original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
"is_original_est_delivery_at_date" : true,
"delivered_at" : "2021-12-07T12:08:15-04:00",
"signed_by" : "J. Smith",
"packages" : [{
"package_id" : 99,
"weight" : 10.2,
"weight_unit" : "lb",
"tracker_id" : 3,
"created_at" : "2021-12-03T16:08:15+00:00",
"tracking_added_at" : "2021-12-03T16:08:15+00:00",
"shipped_at" : "2021-12-06T16:08:15+00:00",
"delivered_at" : "2021-12-07T12:08:15-04:00",
"items" : [
{"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
],
"package_data" : [
{"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
],
"tracking_numbers" : [
"794657040105"
],
"tracking_urls" : [
"https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
],
"packaging" : [],
"manifest_courier" : "FedEx",
"carrier" : "fedex",
"manifest_courier_code" : "fedex",
"billable_weight" : "14",
"billable_weight_unit" : "lb",
"dimensional_weight_divisor" : "139",
"dimensional_weight_divisor_unit" : "in^3/lb",
"dimensional_weight" : "14",
"rating_weight_unit" : "lb",
"dimensions" : {
"length" : "16.000",
"width" : "12.000",
"height" : "8.000"
},
"dimension_unit" : "in",
"sscc" : "00508101336500131005",
"serial_number_data" : [
{
"serial_id" : "1",
"identifier" : "123456123456",
"sku" : "sku123",
"product_id" : "7"
}
]
}],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
tracker:exception
Payload
{
"topic" : "tracker:exception",
"message" : {
"merchant_code" : "acme",
"tracker_id" : 23,
"order_unique_id" : "100000018",
"order_ref" : "9099",
"order_source" : "shopify",
"shipment_unique_id" : "100000007",
"warehouse_id" : 1,
"carrier" : "fedex",
"tracking_number" : "794657040105",
"carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
"old_status" : "out_for_delivery",
"new_status" : "return_to_sender",
"new_details" : [{
"status" : "return_to_sender",
"message" : "Refused by customer.",
"timestamp" : "2021-12-07T12:08:15-04:00",
"is_timestamp_date" : false,
"source" : "carrier_api",
"location" : {
"city" : "Amsterdam",
"country" : "US",
"postcode" : "12010-6269",
"region" : "NY",
"timezone" : "America/New_York",
"lat" : 42.9387,
"lng" : -74.1882
}
}],
"packages" : [{
"package_id" : 99,
"weight" : 10.2,
"weight_unit" : "lb",
"tracker_id" : 3,
"created_at" : "2021-12-03T16:08:15+00:00",
"tracking_added_at" : "2021-12-03T16:08:15+00:00",
"shipped_at" : null,
"delivered_at" : null,
"items" : [
{"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
],
"package_data" : [
{"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
],
"tracking_numbers" : [
"794657040105"
],
"tracking_urls" : [
"https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
],
"packaging" : [],
"manifest_courier" : "FedEx",
"carrier" : "fedex",
"manifest_courier_code" : "fedex",
"billable_weight" : "14",
"billable_weight_unit" : "lb",
"dimensional_weight_divisor" : "139",
"dimensional_weight_divisor_unit" : "in^3/lb",
"dimensional_weight" : "14",
"rating_weight_unit" : "lb",
"dimensions" : {
"length" : "16.000",
"width" : "12.000",
"height" : "8.000"
},
"dimension_unit" : "in",
"sscc" : "00508101336500131005",
"serial_number_data" : [
{
"serial_id" : "1",
"identifier" : "123456123456",
"sku" : "sku123",
"product_id" : "7"
}
]
}],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
manifest:sealed
Payload
{
"topic" : "manifest:sealed",
"message" : {
"manifest_id" : 3,
"warehouse_id" : 1,
"carrier" : "ups",
"weight" : 45,
"weight_unit" : "lb",
"orders" : [{
"unique_id" : "100000021",
"order_ref" : null,
"state" : "complete",
"source" : "sps:test:123:8ZC3:544",
"tracking_numbers" : [
"794657040105"
]
}],
"shipments" : [{
"unique_id" : "100000035",
"order_ref" : null,
"order_unique_id" : "100000021",
"source" : "123456",
"status" : "packed"
}],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}
manifest:loaded
Payload
{
"topic" : "manifest:loaded",
"message" : {
"manifest_id" : 3,
"warehouse_id" : 1,
"carrier" : "ups",
"weight" : 45,
"weight_unit" : "lb",
"orders" : [{
"unique_id" : "100000021",
"order_ref" : null,
"state" : "complete",
"source" : "sps:test:123:8ZC3:544",
"tracking_numbers" : [
"794657040105"
]
}],
"shipments" : [{
"unique_id" : "100000035",
"order_ref" : null,
"order_unique_id" : "100000021",
"source" : "123456",
"status" : "packed"
}],
"webhook_increment_id" : 1,
"event_timestamp" : "2021-12-07T16:08:15+00:00"
}
}