Webhook Notification - Tracking Number Example
POST
https://your.endpoint.here
The data will be sent as a POST call to your webhook url. The data will be formatted as JSON and sent over in the following format
Request
Body Params application/json
event
object
required
uuid
string
required
name
enum<string>
required
Allowed value:
shipment_notify
tracking
object
required
timestamp
string
required
data
object
required
id
integer
required
order_id
string
required
test_order
boolean
required
sample_order
boolean
required
reprint_order
boolean
required
created_at
string
required
updated_at
string
required
status
string
required
rejected_at
null
required
rejected_status
null
required
cancelled_at
null
required
line_items
array [object {6}]
required
trackings
array [object {8}]
required
shipping_method
string
required
ioss_number
null
required
tax_id
null
required
tax_id_type
null
required
address
object
required
return_address
null
required
total_cost
null
required
Example
{
"event": {
"uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
"tracking": {
"tracking_number": "9400100109361129278357",
"tracking_status": "delivered",
"carrier_code": "USPS",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"shipped_items": [
{
"order_item_id": "28002-A-001",
"quantity": 3
}
]
},
"name": "shipment_notify",
"timestamp": "2022-07-08T13:24:00.128774Z"
},
"data": {
"id": 2,
"order_id": "28002-A",
"test_order": false,
"sample_order": false,
"reprint_order": false,
"created_at": "2022-01-07T14:11:50.000000Z",
"updated_at": "2022-07-08T03:16:08.000000Z",
"status": "shipped",
"rejected_at": null,
"rejected_status": null,
"cancelled_at": null,
"line_items": [
{
"id": 2,
"sku": "UNPT1B00M",
"quantity": 1,
"order_item_id": "196953049",
"print_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
],
"preview_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
]
}
],
"trackings": [
{
"tracking_number": "9400100109361129278357",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"carrier": "USPS",
"created_at": "2022-07-21T10:53:46.000000+00:00",
"status": "delivered",
"label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
"shipped_items": [
{
"order_item_id": "28002-A-001",
"quantity": 3
}
],
"primary": true
},
{
"tracking_number": "9400100109361129278358",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"carrier": "USPS",
"created_at": "2022-07-21T10:55:46.000000+00:00",
"status": "delivered",
"label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
"shipped_items": [
{
"order_item_id": "28002-A-002",
"quantity": 1
},
{
"order_item_id": "28002-A-003",
"quantity": 2
}
],
"primary": false
}
],
"shipping_method": "standard",
"ioss_number": null,
"tax_id": null,
"tax_id_type": null,
"address": {
"name": "John Smith",
"email": null,
"company": "DEMO",
"phone": "(330) 638-1331",
"street1": "4736 Phillips Rice Rd",
"street2": null,
"city": "Cortland",
"state": "OH",
"country": "US",
"zip": "44410"
},
"return_address": null,
"total_cost": null
}
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your.endpoint.here' \
--header 'Content-Type: application/json' \
--data-raw '{
"event": {
"uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
"tracking": {
"tracking_number": "9400100109361129278357",
"tracking_status": "delivered",
"carrier_code": "USPS",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"shipped_items": [
{
"order_item_id": "28002-A-001",
"quantity": 3
}
]
},
"name": "shipment_notify",
"timestamp": "2022-07-08T13:24:00.128774Z"
},
"data": {
"id": 2,
"order_id": "28002-A",
"test_order": false,
"sample_order": false,
"reprint_order": false,
"created_at": "2022-01-07T14:11:50.000000Z",
"updated_at": "2022-07-08T03:16:08.000000Z",
"status": "shipped",
"rejected_at": null,
"rejected_status": null,
"cancelled_at": null,
"line_items": [
{
"id": 2,
"sku": "UNPT1B00M",
"quantity": 1,
"order_item_id": "196953049",
"print_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
],
"preview_files": [
{
"key": "front",
"url": "https://via.placeholder.com/2400/09f/fff.png"
}
]
}
],
"trackings": [
{
"tracking_number": "9400100109361129278357",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"carrier": "USPS",
"created_at": "2022-07-21T10:53:46.000000+00:00",
"status": "delivered",
"label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
"shipped_items": [
{
"order_item_id": "28002-A-001",
"quantity": 3
}
],
"primary": true
},
{
"tracking_number": "9400100109361129278358",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=9400100109361129278357",
"carrier": "USPS",
"created_at": "2022-07-21T10:55:46.000000+00:00",
"status": "delivered",
"label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240312/e8ab4953a913e64c769e8bd3857943029af9.png",
"shipped_items": [
{
"order_item_id": "28002-A-002",
"quantity": 1
},
{
"order_item_id": "28002-A-003",
"quantity": 2
}
],
"primary": false
}
],
"shipping_method": "standard",
"ioss_number": null,
"tax_id": null,
"tax_id_type": null,
"address": {
"name": "John Smith",
"email": null,
"company": "DEMO",
"phone": "(330) 638-1331",
"street1": "4736 Phillips Rice Rd",
"street2": null,
"city": "Cortland",
"state": "OH",
"country": "US",
"zip": "44410"
},
"return_address": null,
"total_cost": null
}
}'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2024-10-03 07:54:20