Label

WEBHOOK Label

Example

{
  "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, label.requested, label.closed

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

Shopify order ID

Example:

1029384756

carrier · string

Name of carrier

Example:

"USPS"

tracking_number · string

The tracking number for the shipment

Example:

"28735625627856237856287"

label_status · enum<string>

Status of the shipment according to EasyPost.

Available options: N/A (no shipment status), pre_transit, in_transit, out_for_delivery, delivered, error, failure

Example:

"in_transit"

label_updated_at · string

Date and time (ISO 8601 format) when the last status update occurred

Example:

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

shipment_id · string

The unique identifier associated with the shipment, assigned by Loop

Example:

"6789998212"

Response

200

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