Order List

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

Request Parameters

Request Example

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

Response Structure

Success Response

1{
2  "success": true,
3  "result": [ /* array of orders */ ],
4  "pagination": {
5    "currentPage": 1,
6    "pageSize": 25,
7    "totalOrders": 100,
8    "totalPages": 4
9  }
10}

Pagination Object

1{
2  "currentPage": 1,
3  "pageSize": 25,
4  "totalOrders": 100,
5  "totalPages": 4
6}

Error Response

1{
2  "success": false,
3  "error": "Invalid or Expired Credentials"
4}