Skip to main content
WEBHOOK
Label
{
  "topic": "<string>",
  "shop_id": 123,
  "id": 123,
  "order_id": 123,
  "provider_order_id": 123,
  "carrier": "<string>",
  "tracking_number": "<string>",
  "label_updated_at": "<string>",
  "shipment_id": "<string>"
}

Body

application/json
​
topic
string

Webhook type

Example:

"label"

​
trigger
enum<string>

Event that triggered the webhook

Available options:
label.created,
label.updated
​
shop_id
integer

The unique identifier of the shop that created the webhook

Example:

9876

​
id
integer

Loop return ID

Example:

12345

​
order_id
integer

Loop order ID

Example:

1234567890

​
provider_order_id
integer

Order ID from the commerce provider (e.g. Shopify)

Example:

1029384756

​
carrier
string

Name of carrier. Emits the literal string "N/A" when no carrier is set.

Example:

"USPS"

​
tracking_number
string

The tracking number for the shipment. Emits the literal string "N/A" when no tracking number is set.

Example:

"28735625627856237856287"

​
label_status
enum<string>

Status of the shipment according to EasyPost. Emits the literal string "N/A" when the return has no shipment status.

Available options:
queueable,
queued,
queued_for_purchase,
purchase_failed,
new,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
cancelled,
unknown,
return_to_sender,
failure,
error,
refund_requested
Example:

"in_transit"

​
label_updated_at
string

Date and time (ISO 8601 format) when the last status update occurred. Emits the literal string "N/A" when no status update has occurred.

Example:

"2019-04-01T12:00:00.000Z"

​
shipment_id
string

The unique identifier associated with the shipment, assigned by Loop. Emits the literal string "N/A" when no shipment ID is set.

Example:

"6789998212"

Response

200

Return a 200 status to indicate that the data was received successfully