Webhook Notification - In Transit and Delivered Status Example
POSThttps://your.endpoint.hereData
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
Note__: Some international shipping orders may not return a webhook with a “delivered” status
Request
Body Params application/json
event
object
required
uuid
string
required
UUID of the event.
name
enum<string>
required
Allowed value:
shipment_notify
tracking
object
required
timestamp
string
required
When the event occurred.
data
object
required
The latest data of the order. This data matches the same format as the GET requests.
id
integer
required
order_id
string
required
test_order
boolean
required
created_at
string
required
updated_at
string
required
status
string
required
rejected_at
null
required
cancelled_at
null
required
address
object
required
line_items
array [object {6}]
required
trackings
array [object {8}]
required
shipping_method
string
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,
"created_at": "2022-01-07T14:11:50.000000Z",
"updated_at": "2022-07-08T03:16:08.000000Z",
"status": "shipped",
"rejected_at": null,
"cancelled_at": null,
"address": {
"name": "John Smith",
"company": "DEMO",
"phone": "(330) 638-1331",
"street1": "4736 Phillips Rice Rd",
"street2": null,
"city": "Cortland",
"state": "OH",
"country": "US",
"zip": "44410"
},
"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"
}
}Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
object {0}
Example
{}Last modified: 2 months ago