---
title: "List Shipments"
method: GET
path: "/shipments"
tags: ["Shipments"]
---

# List Shipments

`GET /shipments`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/shipments`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/docs/shipments/get.ts> (a function with typed inputs; its response is checked against the schema)

Return a list of shipments across your sub-merchants.

## Query parameters

- `merchant_invoice_id` string
- `fulfillment_method` 'shipping_provider' | 'self_delivery' | 'customer_pickup' | 'services_only'
- `verification_status` 'verified' | 'pending'
- `shipment_courier` string
- `limit` integer
- `starting_after` string
- `ending_before` string
- `search` string
- `searchBy` 'tracking_number' | 'courier' | 'id' | 'merchant_invoice_id'
- `sort` string

## Response `200`

An object with an array of Shipments up to the specified limit.

- ShipmentsList
  - `limit` integer: Number of results returned per page.
  - `page` integer: Current page number.
  - `count` integer: Total number of shipments matching the query.
  - `results` ShipmentObject[]
    - `id` string: Unique identifier of the Shipment.
    - `merchant_invoice_id` string: ID of the associated merchant invoice.
    - `fulfillment_method` 'shipping_provider' | 'self_delivery' | 'customer_pickup' | 'services_only': Method of fulfillment for the shipment.
    - `shipment_tracking_number` string: Tracking number provided by the shipping courier.
    - `shipment_courier` string: Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers. See the [Shipments API documentation](#tag/Shipments) for the complete list of supported couriers.
    - `verification_status` 'verified' | 'pending': Manual or automatic verification status of the shipment.
    - `created_at` string, date-time: Date time when the shipment was created.
    - `updated_at` string, date-time: Date time when the shipment was last updated.
    - `tracking_status` string, nullable: Current tracking status of the shipment from the courier.
    - `tracking_substatus` string, nullable: Detailed tracking substatus providing additional context about the shipment's current state.
    - `expected_delivery` string, date-time, nullable: Expected delivery date and time provided by the shipping courier.

## Other responses

- `400`: Bad request error
- `401`: Unauthorized error
- `429`: Rate limit error

---

[API](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-partners-api-reference/revisions/5a1c75b8b404?raw)