REresolvepay
Shipments

List Shipments

get/shipments

Request

Query parameters

merchant_invoice_idstring

Filter shipments by specific merchant invoice ID.

fulfillment_method'shipping_provider' | 'self_delivery' | 'customer_pickup' | 'services_only'

Filter shipments by fulfillment method.

verification_status'verified' | 'pending'

Filter shipments by verification status.

shipment_courierstring

Filter shipments by shipping courier.

limitinteger

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

starting_afterstring

Pagination cursor for fetching results after a specific shipment ID.

ending_beforestring

Pagination cursor for fetching results before a specific shipment ID.

searchstring

Search term to filter shipments across multiple fields.

searchBy'tracking_number' | 'courier' | 'id' | 'merchant_invoice_id'

Specific field to search within.

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

Response

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

limitinteger

Number of results returned per page.

pageinteger

Current page number.

countinteger

Total number of shipments matching the query.

Example response

{
  "limit": 10,
  "page": 1,
  "count": 25,
  "results": [
    {
      "id": "ship_1234567890abcdef",
      "merchant_invoice_id": "inv_1234567890abcdef",
      "fulfillment_method": "shipping_provider",
      "shipment_tracking_number": "1Z123E45678901234",
      "shipment_courier": "ups",
      "verification_status": "verified",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T14:45:00Z",
      "tracking_status": "delivered",
      "tracking_substatus": "delivered_001",
      "expected_delivery": "2024-01-20T18:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.