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": 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.

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[]