Order List

Use the https://app.ship.com/public/orders/paginated endpoint to get a paginated list of orders.

Request Parameters

Request Example

<pre style="background: #f4f4f4; padding: 1rem; border-radius: 4px;">
GET https://www.ship.com/public/orders/paginated?page=1&amp;pageSize=10&amp;startDate=2024-10-01
Authorization: Bearer OAUTH2.abc123xyz456...
</pre>

Response Structure

Success Response

{
  "success": true,
  "result": [ /* array of orders */ ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 25,
    "totalOrders": 100,
    "totalPages": 4
  }
}

Pagination Object

{
  "currentPage": 1,
  "pageSize": 25,
  "totalOrders": 100,
  "totalPages": 4
}

Error Response

{
  "success": false,
  "error": "Invalid or Expired Credentials"
}