Skip to content

List the return labels of an order

Request

Returns the return labels of an order, newest first: labels with a tracking number from any source (the Hive app, this API, the customer returns portal, or a label printed into the parcel at packing), and every label requested through this API whatever its status, including pending and failed ones.

The label documents are not included; read one label with GET /orders/{id}/return_labels/{label_id} to get its PDF.

Security
BearerAuth
Path
idinteger, (int64)required

Order ID

curl -i -X GET \
  'https://developers.hive.app/_mock/merchant-api-v2/mapi_v2_oas31/orders/{id}/return_labels' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

The order's return labels

Bodyapplication/json
dataArray of objects(ReturnLabel)required

The order's return labels, newest first

Response
{
  "data": [
    { … }
  ]
}