WEBHOOK
LabelRequests
{
  "topic": "label.request",
  "trigger": "label.request.issued",
  "id": "5fc3126e-68c5-45f8-81b5-35e3d67027c2",
  "return_id": 1001,
  "shop_id": 50,
  "created_at": "2023-11-07T05:31:56Z",
  "addresses": {
    "origin": {
      "name": "Alice Returns",
      "address1": "123 Example Rd",
      "company": "Example Co.",
      "address2": "Apt A",
      "city": "Columbus",
      "state": "Ohio",
      "zip": "43215",
      "country": "United States",
      "country_code": "US",
      "phone": "12345678901"
    },
    "destination": {
      "name": "My Domestic Warehouse",
      "address1": "123 Commerce St",
      "company": "Ecommerce Inc.",
      "address2": "Ste 100",
      "city": "Columbus",
      "state": "Ohio",
      "zip": "43215",
      "country": "United States",
      "country_code": "US",
      "phone": "12345678901"
    }
  },
  "parcel": {
    "height": 5,
    "width": 10.9,
    "length": 20.2,
    "weight": 65.9
  },
  "products": [
    {
      "name": "Green T-Shirt",
      "sku": "tshirt-g-2314-L",
      "hs_code": "61051000",
      "country_of_origin": "US",
      "price": {
        "amount": 100,
        "currency": "USD"
      }
    }
  ]
}

Body

application/json
​
topic
string

The webhook topic.

Example:

"label.request"

​
trigger
enum<string>

The event that triggered the webhook.

Available options:
label.request.issued,
label.request.cancelled
​
id
string

The Loop label request ID.

Example:

"5fc3126e-68c5-45f8-81b5-35e3d67027c2"

​
return_id
integer

The Loop return ID.

Example:

1001

​
shop_id
integer

The unique identifier of the shop that created the webhook.

Example:

50

​
created_at
string

The date and time at which the request was created, using the ISO 8601 date format.

​
addresses
object

The origin and destination addresses of the label.

​
parcel
object

The dimensions, weight, and contents of the parcel.

​
products
object[]

Details about the products returned in the parcel.

Response

200

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

LabelHappy Returns Shipment