Skip to main content
GET
/
label-requests
List Label Requests
curl --request GET \
  --url https://api.loopreturns.com/api/v1/label-requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
from
string<date-time>

Returns label requests after or equal to a minimum date. The date the label was created.

Example:

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

​
to
string<date-time>

Returns label requests before a maximum date. The date the label was created.

Example:

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

​
return_id
integer

Return label requests associated with a specific return_id.

Example:

67329889100573

​
status
enum<string>

The status of the label request.

Available options:
issued,
cancelled,
fulfilled
Example:

"issued"

​
limit
integer
default:50

The per page limit of label requests to return

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

The number of label requests to offset.

Response

Success

​
data
object[]