v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB

Label Requests

Get Label Request

Get details about a single label request.

Required API key scope

Label Requests (Read)

get/label-requests/{id}

Path parameters

idinteger required

Example:67329889100573

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

Response

Success

idstring required

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

return_idinteger required

The return id of the return.

shop_idinteger required

The id of the shop belonging to the merchant.

status'issued' | 'cancelled' | 'fulfilled' required

The status of the label request.

created_atstring date-time required

Example response

{
  "id": "67329889100573",
  "addresses": {
    "origin": {
      "id": 23432434,
      "hash": "dd93hf99d83hdops9d8fhh38fhd03hh3",
      "created_at": "2021-10-01T03:30:15.000Z",
      "updated_at": "2021-10-01T03:30:15.000Z",
      "name": "Staples",
      "company": "Example Company",
      "address1": "1747 Olentangy River Rd",
      "city": "Columbus",
      "state": "OH",
      "zip": "43212",
      "country": "United States of America",
      "country_code": "US",
      "latitude": 39.995329,
      "longitude": -83.026838
    },
    "destination": {
      "id": 23432434,
      "hash": "dd93hf99d83hdops9d8fhh38fhd03hh3",
      "created_at": "2021-10-01T03:30:15.000Z",
      "updated_at": "2021-10-01T03:30:15.000Z",
      "name": "Staples",
      "company": "Example Company",
      "address1": "1747 Olentangy River Rd",
      "city": "Columbus",
      "state": "OH",
      "zip": "43212",
      "country": "United States of America",
      "country_code": "US",
      "latitude": 39.995329,
      "longitude": -83.026838
    }
  },
  "parcel": {
    "height": 5,
    "length": 20.2,
    "width": 10.9,
    "weight": 65.9
  },
  "errors": [
    {
      "reason": "INVALID_ADDRESS",
      "message": "Failed to generate a label, the origin address is invalid",
      "created_at": "2023-04-25T13:25:00-05:00"
    }
  ],
  "return_id": 1001,
  "shop_id": 50,
  "status": "issued",
  "created_at": "2023-04-25T13:25:00-05:00"
}