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": 123,
  "addresses": {
    "origin": {
      "address1": "<string>",
      "city": "<string>",
      "country_code": "<string>",
      "name": "<string>",
      "company": "<string>",
      "address2": "<string>",
      "region": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "destination": {
      "address1": "<string>",
      "city": "<string>",
      "country_code": "<string>",
      "name": "<string>",
      "company": "<string>",
      "address2": "<string>",
      "region": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    }
  },
  "parcel": {
    "height": 123,
    "length": 123,
    "width": 123,
    "weight": 123
  },
  "products": [
    {
      "name": "<string>",
      "price": {
        "amount": 123,
        "currency_code": "USD"
      },
      "country_of_origin": "<string>",
      "hs_code": "<string>",
      "sku": "<string>"
    }
  ],
  "errors": "<array>",
  "return_id": 123,
  "shop_id": 123,
  "status": "issued",
  "created_at": "2023-11-07T05:31:56Z"
}

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
integer<int64>

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

Example:

9007199254740991

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"