---
title: "Get Shipments"
method: GET
path: "/happy-returns/shipments"
tags: ["Happy Returns Shipment"]
---

# Get Shipments

`GET /happy-returns/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)

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `page` integer

## Response `200`

Success

- object
  - `current_page` integer — The identifier associated with the current page.
  - `data` Shipment[] — The data for each entry in the shipment list.
    - `loop_shipment_id` integer — The unique identifier associated with the shipment, assigned by Loop.
    - `happy_returns_shipment_id` string — The unique identifier associated with the shipment, assigned by Happy Returns.
    - `line_item_count` integer — The number of line items included in the shipment.
    - `return_count` integer — The number of Loop returns represented in the shipment.
    - `created_at` string, date-time — The date and time at which the shipment was created, using the ISO 8601 date format.
    - `updated_at` string, date-time — The date and time at which the shipment was last updated, using the ISO 8601 date format.
  - `first_page_url` string — The link to the first page of paginated results.
  - `from` integer — The number of the first shipment on the page.
  - `last_page` integer — The identifier associated with the last page.
  - `last_page_url` string — The link to the last page of paginated results.
  - `next_page_url` string, nullable — The link to the next page of paginated results.
  - `path` string — The endpoint's path.
  - `per_page` integer — The number of shipments per page.
  - `prev_page_url` string, nullable — The link to the previous page of paginated results.
  - `to` integer — The number of the last shipment on the page.
  - `total` integer — The total number of shipments returned.

## Other responses

- `401` — Unauthorized
- `404` — Resource Not Found
- `422` — Unprocessable Content

---

[API](https://skmtc.dev/loopreturns/apis/listings-api.md) · [All operations](https://skmtc.dev/loopreturns/apis/listings-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/loopreturns/listings-api/revisions/750e6012dbb8/schema)