Search Orders by OrderID

Request

This operation returns a list of orders that match the provided search criteria.

Security

bearerAuth

Bodyapplication/jsonrequired

filtersArray of objects(Filter)

Searches for orders based on the provided filter criteria. Use this request to retrieve one or more orders by orderId.

pageinteger

Zero-based page index to fetch.
Example: 0 for the first page, 1 for the second, etc.

sizeinteger

Number of records per page. Choose a value that balances payload size and latency.

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement/api/v1/orders/search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": [
      {
        "name": "orderId",
        "value": [
          "PBqTYEhO31JY"
        ]
      }
    ],
    "page": 0,
    "size": 0
  }'

Responses

Requested order has been retrived sucessfully.

Bodyapplication/json

ordersArray of objects(Order Response)

List of orders that match the query criteria.

pageInfoobject(PageInfo)

Response

{
  "orders": [
    {
      "orderInfo": { … },
      "orderShippingInfo": { … }
    }
  ],
  "pageInfo": {
    "total": 28,
    "pages": 3,
    "page": 1
  }
}