Skip to main content
GET
Get Label Request

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

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

Example:

67329889100573

Response

Success

id
string
required

The unique identifier for the label request, created by Loop. Note that this field is serialized as a string here, while the id path parameter (for example on GET /label-requests/{id}) and CreateLabelRequest.label_request_id are integers — callers should not assume a single JSON type for this identifier across calls.

Example:

"67329889100573"

addresses
object
required
parcel
object
required
products
object[]
required
errors
object[]
required

An append-only history of errors reported for this label request via POST /label-requests/{id}/errors. Its presence does not close or cancel the request.

return_id
integer<int64>
required

The return id of the return.

Example:

1001

shop_id
integer<int64>
required

The id of the shop belonging to the merchant.

Example:

50

status
enum<string>
required

The status of the label request.

Available options:
issued,
cancelled,
fulfilled
Example:

"issued"

created_at
string<date-time>
required

A date-time value in ISO 8601 format. What it represents (for example, when a label, label request, or reported error was created, or a date-range filter bound) depends on the field or parameter referencing this schema.

Example:

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