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

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.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=&isPendingVendorAcceptance=&isPendingMerchantAcceptance=&version=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "shipments": [
        {
            "id": "e609bbd8-acb8-4db4-b30c-3565b80acff2",
            "shortId": "S1234567890",
            "orderExternalId": "dc023e3d-9490-41ab-8978-cd6af8c4d80c",
            "merchantOrderId": null,
            "merchantId": "ad07ef31-0031-46e2-8da6-7681e9f81a48",
            "merchantName": "Merchant test",
            "vendorId": "621d1986-b651-4e39-a951-194b4311cf0c",
            "vendorName": "Vendor test",
            "facilityId": "b6c170c3-49d6-42cd-a670-e9efb4d030f5",
            "facilityName": "Facility test",
            "status": 4,
            "currency": "USD",
            "created": "2022-04-03T12:00:00",
            "isPollingStopped": null,
            "isRejectedByVendor": null,
            "isPendingVendorAcceptance": false,
            "isPendingMerchantAcceptance": false,
            "requireCustomShippingDocs": false,
            "hasCustomShippingDocs": null,
            "shippingLabelUrl": null,
            "packingSlipUrl": null
        },
        {
            "id": "79d359b6-5868-4130-81a0-cdb143f31f66",
            "shortId": "S1234567891",
            "orderExternalId": "e91ccdf3-8d1a-4c34-9f59-de441efe56ac",
            "merchantOrderId": null,
            "merchantId": "69db62a7-4acf-477d-8d52-197d5841bd82",
            "merchantName": "Merchant test",
            "vendorId": "3d6a0a87-c921-4b5b-925d-30582cd1956b",
            "vendorName": "Vendor test",
            "facilityId": "5ea40ab3-ad88-4021-ad58-b134be838145",
            "facilityName": "Facility test",
            "status": 3,
            "currency": "USD",
            "created": "2022-04-06T12:00:00",
            "isPollingStopped": true,
            "isRejectedByVendor": null,
            "isPendingVendorAcceptance": null,
            "isPendingMerchantAcceptance": null,
            "requireCustomShippingDocs": null,
            "hasCustomShippingDocs": null,
            "shippingLabelUrl": null,
            "packingSlipUrl": null
        },
        {
            "id": "001988f4-8042-4e53-b140-e1c081ea771b",
            "shortId": "S1234567892",
            "orderExternalId": "6fdf3e2f-e598-4b5a-b0f8-7e2ba4a15ccf",
            "merchantOrderId": null,
            "merchantId": "a01c20d5-4863-487c-beff-36823073a002",
            "merchantName": "Merchant test",
            "vendorId": "aa969290-169c-46bf-b7b8-3ead95378adb",
            "vendorName": "Vendor test",
            "facilityId": "e3a394df-1dc7-40ef-89e3-19efb20d38c2",
            "facilityName": "Facility test",
            "status": 2,
            "currency": "USD",
            "created": "2022-04-08T12:00:00",
            "isPollingStopped": null,
            "isRejectedByVendor": true,
            "isPendingVendorAcceptance": null,
            "isPendingMerchantAcceptance": null,
            "requireCustomShippingDocs": null,
            "hasCustomShippingDocs": null,
            "shippingLabelUrl": null,
            "packingSlipUrl": null
        }
    ],
    "total": 3
}

Modified at 2026-10-23 19:44:50

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

Reroute shipment.