Skip to main content
GET
/
label-requests
/
{id}
Get Label Request
curl --request GET \
  --url https://api.loopreturns.com/api/v1/label-requests/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "67329889100573",
  "addresses": {
    "origin": {
      "name": "John Smith",
      "company": "Acme, Co",
      "address1": "123 Example St",
      "address2": "Box 123",
      "city": "Columbus",
      "region": "OH",
      "postal_code": "12345",
      "country": "United States of America",
      "country_code": "US"
    },
    "destination": {
      "name": "John Smith",
      "company": "Acme, Co",
      "address1": "123 Example St",
      "address2": "Box 123",
      "city": "Columbus",
      "region": "OH",
      "postal_code": "12345",
      "country": "United States of America",
      "country_code": "US"
    }
  },
  "parcel": {
    "height": 5,
    "length": 20.2,
    "width": 10.9,
    "weight": 65.9
  },
  "products": [
    {
      "name": "Product Name",
      "price": [
        {
          "amount": 50000,
          "currency": "USD"
        },
        {
          "amount": 25000,
          "currency": "CAD"
        },
        {
          "amount": 1500,
          "currency": "EUR"
        }
      ],
      "country_of_origin": "USA",
      "hs_code": "61051000",
      "sku": "99999999"
    }
  ],
  "errors": "<array>",
  "return_id": 1001,
  "shop_id": 50,
  "status": "issued",
  "created_at": "2023-04-25T13:25:00-05:00"
}

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.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
integer
required

The unique identifier for the label request, created by Loop.

Example:

67329889100573

Response

Success

​
id
string

The unique identifier for the label request, created by Loop.

Example:

"67329889100573"

​
addresses
object
​
parcel
object
​
products
object[]
​
errors
array
​
return_id
integer<int64>

The return id of the return.

Example:

1001

​
shop_id
integer<int64>

The id of the shop belonging to the merchant.

Example:

50

​
status
enum<string>

The status of the label request.

Available options:
issued,
cancelled,
fulfilled
Example:

"issued"

​
created_at
string<date-time>

The date the label was created.

Example:

"2023-04-25T13:25:00-05:00"