GET
/
label-requests
List Label Requests
curl --request GET \
  --url https://api.loopreturns.com/api/v1/label-requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 9007199254740991,
      "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": "<string>",
          "price": {
            "amount": 50000,
            "currency_code": "USD"
          },
          "country_of_origin": "USA",
          "hs_code": "61051000",
          "sku": "99999999"
        }
      ],
      "errors": [
        "<any>"
      ],
      "return_id": 1001,
      "shop_id": 50,
      "status": "fulfilled",
      "created_at": "2023-04-25T13:25:00-05:00"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
from
string

Returns label requests after or equal to a minimum date.

Examples:

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

​
to
string

Returns label requests before a maximum date.

Examples:

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

​
return_id
integer

Return label requests associated with a specific return_id.

Examples:

67329889100573

​
status
enum<string>

The status of the label.

Available options:
new,
pre_transit,
in_transit,
out_for_delivery,
delivered
Examples:

"new"

​
limit
integer
default:50

The per page limit of label requests to return

Required range: 0 <= x <= 250
​
offset
integer

The number of label requsts to offset.

Response

200
application/json

Success

The response is of type object.