Get Shipment Information

Get high level information from a Happy Returns shipment.

Required API key scope

• Happy Returns Shipments (Read)

GET /happy-returns/shipments/{happy_returns_shipment_id}

Get Shipment Information

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id} \
  --header 'X-Authorization: <api-key>'

200

{
  "loop_shipment_id": 123,
  "happy_returns_shipment_id": "<string>",
  "line_item_count": 123,
  "return_count": 123,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

X-Authorization · string · header · required

Path Parameters

happy_returns_shipment_id · string · required

The unique identifier associated with the shipment.

Response

200

application/json

Success

loop_shipment_id · integer

The unique identifier associated with the shipment, assigned by Loop.

Example:

12345

happy_returns_shipment_id · string

The unique identifier associated with the shipment, assigned by Happy Returns.

Example:

"123456"

line_item_count · integer

The number of line items included in the shipment.

Example:

2

return_count · integer

The number of Loop returns represented in the shipment.

Example:

1

created_at · string

The date and time at which the shipment was created, using the ISO 8601 date format.

Example:

"2024-03-19dT12:34:56+00:00"

updated_at · string

The date and time at which the shipment was last updated, using the ISO 8601 date format.

Example:

"2024-03-20T12:34:56+00:00"