Skip to main content
WEBHOOK
LabelRequests
{
  "topic": "<string>",
  "trigger": "label.request.issued",
  "id": 123,
  "return_id": 123,
  "shop_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "addresses": {
    "origin": {
      "name": "<string>",
      "address1": "<string>",
      "company": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "phone": "<string>"
    },
    "destination": {
      "name": "<string>",
      "address1": "<string>",
      "company": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "phone": "<string>"
    }
  },
  "parcel": {
    "height": 123,
    "width": 123,
    "length": 123,
    "weight": 123
  },
  "products": [
    {
      "name": "<string>",
      "sku": "<string>",
      "hs_code": "<string>",
      "country_of_origin": "<string>",
      "price": {
        "amount": 123,
        "currency": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.loopreturns.com/llms.txt

Use this file to discover all available pages before exploring further.

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
integer

The Loop label request ID.

Example:

6340

​
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<date-time>

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.