GET
/
happy-returns
/
shipments
/
{happy_returns_shipment_id}
Get Shipment Information
curl --request GET \
  --url https://api.loopreturns.com/api/v1/happy-returns/shipments/{happy_returns_shipment_id} \
  --header 'X-Authorization: <api-key>'
{
  "loop_shipment_id": 12345,
  "happy_returns_shipment_id": "123456",
  "line_item_count": 2,
  "return_count": 1,
  "created_at": "2024-03-19dT12:34:56+00:00",
  "updated_at": "2024-03-20T12:34:56+00:00"
}

Authorizations

​
X-Authorization
string
header
required

Path Parameters

​
happy_returns_shipment_id
string
required

The unique identifier associated with the shipment.

Response

Success

​
loop_shipment_id
integer

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

Examples:

12345

​
happy_returns_shipment_id
string

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

Examples:

"123456"

​
line_item_count
integer

The number of line items included in the shipment.

Examples:

2

​
return_count
integer

The number of Loop returns represented in the shipment.

Examples:

1

​
created_at
string

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

Examples:

"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.

Examples:

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