This endpoint is in active development and may change.
Label Requests Webhook
This notification is sent when the label-request topic is requested. For those who subscribe to this topic for more than one trigger event, the "trigger" property is included in the payload for reference.
Response Header | Description |
---|---|
X-Loop-Signature | Hashed Webhook Secret Key |
The X-Loop-Signature is a base-64, HMAC hash of body payload using the Webhook Secret provided by Loop.
Note: Before attempting to create your hash of the POST request body, make sure slashes have been escaped & newlines have been removed from the JSON.
Field | Type | Description |
---|---|---|
topic | string | The webhook topic (label.request) |
trigger | string | The event that triggered the webhook (created, updated, requested, closed) |
shop_id | integer | The unique identifier of the shop that created the webhook |
id | string | The Loop label request ID |
return_id | integer | The Loop return ID |
addresses.origin.name | string | The origin address name |
addresses.origin.company | string | The origin address company |
addresses.origin.address1 | string | The origin address address1 |
addresses.origin.address2 | string | The origin address address2 |
addresses.origin.city | string | The origin address city |
addresses.origin.state | string | The origin address state |
addresses.origin.zip | string | The origin address zip |
addresses.origin.country | string | The origin address country |
addresses.origin.country_code | string | The origin address country_code (ISO 3166-1 alpha-2 format) |
addresses.origin.phone | string | The origin address phone (Numerical characters only) |
addresses.destination.name | string | The destination address name |
addresses.destination.company | string | The destination address company |
addresses.destination.address1 | string | The destination address address1 |
addresses.destination.address2 | string | The destination address address2 |
addresses.destination.city | string | The destination address city |
addresses.destination.state | string | The destination address state |
addresses.destination.zip | string | The destination address zip |
addresses.destination.country | string | The destination address country |
addresses.destination.country_code | string | The destination address country_code |
addresses.destination.phone | string | The destination address phone |
parcel.height | double | The height of the parcel |
parcel.length | double | The length of the parcel |
parcel.width | double | The width of the parcel |
parcel.weight | double | The weight of the parcel |
parcel.line_items | array | An array of line item ids contained int he parcel. The ids should be represented as integers |
created_at | string | The Date and time (ISO 8601 format) when the request was created |
Response
{
"topic": "label.request",
"trigger": "label.request.created",
"id": "5fc3126e-68c5-45f8-81b5-35e3d67027c2",
"addresses": {
"origin": {
"name": "Alice Returns",
"company": "",
"address1": "123 Example Rd",
"address2": "Apt A",
"city": "Columbus",
"state": "Ohio",
"zip": "43215",
"country": "United States",
"country_code": "US",
"phone": "12345678901",
},
"destination": {
"name": "My Domestic Warehouse",
"company": "",
"address1": "123 Commerce St",
"address2": "Ste 100",
"city": "Columbus",
"state": "Ohio",
"zip": "43215",
"country": "United States",
"country_code": "US",
"phone": "12345678901",
}
},
"parcel": {
"height": 5.0,
"length": 20.2,
"width": 10.9,
"weight": 65.9,
"line_items": [
100,
101
],
},
"shop_id": 50,
"return_id": 1001,
"created_at": "2024-11-05T19:21:29.348Z",
}