Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Happy Returns Shipment

Get Shipments

Get information about all Happy Returns shipments created within a given timeframe. The response is a paginated list of shipments, with up to 200 shipments per page.

If no date range is provided, the response will return data from the last 24 hours.

Required API key scope

  • Happy Returns Shipments (Read)
get/happy-returns/shipments

Query parameters

fromstring date-time
Example:2024-01-01T00:00:00.000Z

The start date and time for the shipment list, using the ISO 8601 date format.

tostring date-time
Example:2024-03-31T23:59:59.000Z

The end date and time for the shipment list, using the ISO 8601 date format.

pageinteger
Example:1

The page number of paginated results to return.

Response

Success

current_pageinteger

The identifier associated with the current page.

first_page_urlstring

The link to the first page of paginated results.

frominteger

The number of the first shipment on the page.

last_pageinteger

The identifier associated with the last page.

last_page_urlstring

The link to the last page of paginated results.

next_page_urlstring nullable

The link to the next page of paginated results.

pathstring

The endpoint's path.

per_pageinteger

The number of shipments per page.

prev_page_urlstring nullable

The link to the previous page of paginated results.

tointeger

The number of the last shipment on the page.

totalinteger

The total number of shipments returned.

Example response

{
  "current_page": 1,
  "data": [
    {
      "loop_shipment_id": 12345,
      "happy_returns_shipment_id": "123456",
      "line_item_count": 2,
      "return_count": 1,
      "created_at": "2024-03-19T12:34:56+00:00",
      "updated_at": "2024-03-20T12:34:56+00:00"
    }
  ],
  "first_page_url": "https://api.loopreturns.com/api/v1/happy-returns/shipments/list?from=2022-01-01&to=2023-03-01&page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.loopreturns.com/api/v1/happy-returns/shipments/list?from=2022-01-01&to=2023-03-01&page=1",
  "path": "https://api.loopreturns.com/api/v1/happy-returns/shipments/list",
  "per_page": 200,
  "to": 1,
  "total": 1
}