Search shipments.

GET

/v1/shipments

Request

Query Params

Responses

🟢200OK

text/plain

Returns the search results for shipments.

Body

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dev.ordermesh.io/v1/shipments?id&orderExternalId&merchantId&merchantIds&vendorId&vendorIds&vendorName&facilityId&facilityName&status&currency&startDate&endDate&searchAll&page&pageSize&sortBy&sortAsc&version'

Response Example

200 - Success Example

{
    "shipments": [
        {
            "id": "a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
            "shortId": "S1234567890",
            "orderExternalId": "a2e5663e-e52f-440b-a626-8cb16969feee",
            "merchantId": "1",
            "merchantName": "Merchant test",
            "vendorId": "2",
            "vendorName": "Vendor test",
            "facilityId": "1",
            "facilityName": "Facility test",
            "status": 1,
            "currency": "USD",
            "created": "0001-01-01T00:00:00"
        }
    ],
    "total": 1
}

Modified at 2026-03-02 17:34:25

Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.

Reroute shipment.