Skip to content
Merchant API/
/
List Shipments

List Shipments

Request

Security
bearerAuth or basicAuth
Query
merchant_invoice_idstring

Filter shipments by specific merchant invoice ID.

Example:merchant_invoice_id=inv_1234567890abcdef
fulfillment_methodstring

Filter shipments by fulfillment method.

Enum:"shipping_provider""self_delivery""customer_pickup""services_only"
Example:fulfillment_method=shipping_provider
verification_statusstring

Filter shipments by verification status.

Enum:"verified""pending"
Example:verification_status=verified
shipment_courierstring

Filter shipments by shipping courier.

Example:shipment_courier=ups
limitinteger, [ 1 .. 100 ]

Number of results to return per page (1-100).

Default:10
Example:limit=25
starting_afterstring

Pagination cursor for fetching results after a specific shipment ID.

Example:starting_after=ship_1234567890abcdef
ending_beforestring

Pagination cursor for fetching results before a specific shipment ID.

Example:ending_before=ship_9876543210fedcba
searchstring

Search term to filter shipments across multiple fields.

Example:search=1Z123E45678901234
searchBystring

Specific field to search within.

Enum:"tracking_number""courier""id""merchant_invoice_id"
Example:searchBy=tracking_number
sortstring

Sort records by the specified fields.

The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.

Multiple sort fields supported by allowing comma-separated sort fields. Sort fields will be applied in the order specified.

Sorting is allowed by the following fields: id, created_at.

Example: sort=id,-created_at

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/shipments?merchant_invoice_id=inv_1234567890abcdef&fulfillment_method=shipping_provider&verification_status=verified&shipment_courier=ups&limit=25&starting_after=ship_1234567890abcdef&ending_before=ship_9876543210fedcba&search=1Z123E45678901234&searchBy=tracking_number&sort=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Bodyapplication/json
limitinteger

Number of results returned per page.

Example:10
pageinteger

Current page number.

Example:1
countinteger

Total number of shipments matching the query.

Example:25
resultsArray of objects(ShipmentObject)
Response
{
  "limit": 10,
  "page": 1,
  "count": 25,
  "results": [
    { … }
  ]
}