List Label Requests

GET

label-requests

curl --request GET \
  --url https://api.loopreturns.com/api/v1/label-requests \
  --header 'X-Authorization: <api-key>'

{
  "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

X-Authorization

string

header

required

API Scope: "Developer Tools"

Query Parameters

from

string

Returns label requests after or equal to a minimum date.

Example:

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

string

Returns label requests before a maximum date.

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.

Available options:

new,

pre_transit,

in_transit,

out_for_delivery,

delivered

Example:

"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

data

object[]

data.id

integer

The unique identifier for the label, created by Loop.

Example:

9007199254740991

data.addresses

object

data.addresses.origin

object

Example:

{
  "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"
}

data.addresses.destination

object

Example:

{
  "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"
}

data.parcel

object

data.products

object[]

data.products.name

string

The name of the product.

data.products.price

object

Example:

{ "amount": 50000, "currency_code": "USD" }

data.products.country_of_origin

string

The country of origin of the product.

Example:

"USA"

data.products.hs_code

string

The HS (Harmonized System) code of the product.

Example:

"61051000"

data.products.sku

string

The SKU of the product.

Example:

"99999999"

data.errors

any[]

data.return_id

integer

The return id of the return.

Example:

1001

data.shop_id

integer

The id of the shop belonging to the merchant.

Example:

50

data.status

string

Example:

"fulfilled"

data.created_at

string

The date the label was created.

Example:

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

Get Shipment Items Get Label Request

curl --request GET \
  --url https://api.loopreturns.com/api/v1/label-requests \
  --header 'X-Authorization: <api-key>'

{
  "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"
    }
  ]
}

Using the API

APIs

Required API key scope

Authorizations

Query Parameters

Response