Search shipments.

GET

/v1/shipments

Vendor Access: Forbidden — This endpoint is not accessible to vendor users.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Returns the search results for shipments.

Body

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.dev.ordermesh.io/shipment/v1/shipments?id=&orderExternalId=&merchantId=&merchantIds=&vendorId=&vendorIds=&vendorName=&facilityId=&facilityName=&merchantOrderId=&merchantName=&status=&statuses=&currency=&startDate=&endDate=&searchAll=&page=&pageSize=&sortBy=&sortAsc=&isPollingStopped=&isRejectedByVendor=&version=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "shipments": [
        {
            "id": "2f9ad24e-a645-42ab-9f5f-d62d2b5e654f",
            "shortId": "S1234567890",
            "orderExternalId": "5b7eb217-9c42-4432-a275-11d3cf10ed0b",
            "merchantOrderId": null,
            "merchantId": "308bebdc-e8de-4ea9-b457-5a5f9402b8f2",
            "merchantName": "Merchant test",
            "vendorId": "772061af-421e-4055-bb2a-6bbb697e8a67",
            "vendorName": "Vendor test",
            "facilityId": "ed3777f4-10e4-4d90-902d-628a9f02df2e",
            "facilityName": "Facility test",
            "status": 4,
            "currency": "USD",
            "created": "2022-04-03T12:00:00",
            "isPollingStopped": null,
            "isRejectedByVendor": null,
            "isPendingVendorAcceptance": false,
            "isPendingMerchantAcceptance": false
        },
        {
            "id": "85a47257-8550-4eee-af15-bf5b0d9c4af8",
            "shortId": "S1234567891",
            "orderExternalId": "78812eb1-b6b9-4e37-b466-17f6168d234e",
            "merchantOrderId": null,
            "merchantId": "10f89566-d17a-4274-a988-2e57a563b659",
            "merchantName": "Merchant test",
            "vendorId": "e332e8e1-4c1e-423a-aba6-d5316d59a4e9",
            "vendorName": "Vendor test",
            "facilityId": "07d2e56e-a701-43ea-8508-d3062c0dc514",
            "facilityName": "Facility test",
            "status": 3,
            "currency": "USD",
            "created": "2022-04-06T12:00:00",
            "isPollingStopped": true,
            "isRejectedByVendor": null,
            "isPendingVendorAcceptance": null,
            "isPendingMerchantAcceptance": null
        },
        {
            "id": "34535284-26b8-4848-a601-aa0826588aee",
            "shortId": "S1234567892",
            "orderExternalId": "0fd3e7fc-2e92-4bec-8327-bab69903c75e",
            "merchantOrderId": null,
            "merchantId": "ed497f73-d6bd-45f7-b402-ab5896e07df3",
            "merchantName": "Merchant test",
            "vendorId": "2885132c-71f7-4aea-aeec-df8aa3352357",
            "vendorName": "Vendor test",
            "facilityId": "2da86697-c9b9-40de-803b-a002b1166731",
            "facilityName": "Facility test",
            "status": 2,
            "currency": "USD",
            "created": "2022-04-08T12:00:00",
            "isPollingStopped": null,
            "isRejectedByVendor": true,
            "isPendingVendorAcceptance": null,
            "isPendingMerchantAcceptance": null
        }
    ],
    "total": 3
}

Modified at 2026-09-10 16:04:02

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

Reroute shipment.