v1
latestOpenAPI 3.1.02026-07-2689175245.8 KBLabel Requests
List Label Requests
Retrieve a list of label requests.
Required API key scope
- Label Requests (Read)
get/label-requests
Query parameters
fromstring date-time
Example:2023-04-25T13:25:00-05:00
Returns label requests after or equal to a minimum date.
tostring date-time
Example:2023-04-25T13:25:00-05:00
Returns label requests before a maximum date.
return_idinteger
Example:67329889100573
Return label requests associated with a specific return_id.
status'issued' | 'cancelled' | 'fulfilled'
The status of the label request.
Example:issued
limitinteger
The per page limit of label requests to return
offsetinteger
The number of label requests to offset.
Response
Success
Example response
{
"data": [
{
"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"
}
]
}