Label requests

Body

application/json

topic

string

The webhook topic.

trigger

enum<string>

The event that triggered the webhook.

Available options:

label.request.issued,

label.request.cancelled

integer

The Loop label request ID.

return_id

integer

The Loop return ID.

shop_id

integer

The unique identifier of the shop that created the webhook.

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.

Show child attributes

addresses.origin

object

The address from which the label is being shipped.

Show child attributes

addresses.origin.name

string

The origin address name.

addresses.origin.address1

string

Line 1 of the origin address.

addresses.origin.company

string | null

The origin address company.

addresses.origin.address2

string | null

Line 2 of the origin address.

addresses.origin.city

string

The origin address city.

addresses.origin.state

string | null

The origin address state or province.

addresses.origin.zip

string

The origin address ZIP or postal code.

addresses.origin.country

string

The origin address country.

addresses.origin.country_code

string

The origin address ISO 3166-1 alpha-2 format country code.

addresses.origin.phone

string | null

The origin address phone. Numerical characters only.

addresses.destination

object

The address to which the label is being shipped.

Show child attributes

addresses.destination.name

string

The destination address name.

addresses.destination.address1

string

Line 1 of the destination address.

addresses.destination.company

string | null

The destination address company.

addresses.destination.address2

string | null

Line 2 of the destination address.

addresses.destination.city

string

The destination address city.

addresses.destination.state

string | null

The destination address state or province.

addresses.destination.zip

string

The destination address ZIP or postal code.

addresses.destination.country

string

The destination address country.

addresses.destination.country_code

string

The destination address ISO 3166-1 alpha-2 format country code.

addresses.destination.phone

string | null

The destination address phone. Numerical characters only.

parcel

object

The dimensions, weight, and contents of the parcel.

Show child attributes

parcel.height

number<double>

The height of the parcel in inches.

parcel.width

number<double>

The width of the parcel in inches.

parcel.length

number<double>

The length of the parcel in inches.

parcel.weight

number<double>

The weight of the parcel in grams.

products

object[]

Details about the products returned in the parcel.

Show child attributes

products.name

string

The product's name.

products.sku

string

The product's SKU.

products.hs_code

string | null

The product's HS (Harmonized System) code.

products.country_of_origin

string | null

The product's country of origin.

products.price

object

The product's price.

Show child attributes

products.price.amount

integer

products.price.currency

string

Maximum string length: 3

Response

200

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

Webhook Reference

Webhook Payloads

Body

Response