Order Management

Order List

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

Request Parameters

Parameter	Type	Required	Default	Description
page	int	No	1	Page number to fetch
pageSize	int	No	25	Number of results per page
startDate	string (ISO)	No	–	Filter orders created on or after this date
endDate	string (ISO)	No	–	Filter orders created on or before this date

Request Example

GET https://www.ship.com/public/orders/paginated?page=1&pageSize=10&startDate=2024-10-01
Authorization: Bearer OAUTH2.abc123xyz456...

Response Structure

Success Response:

Field	Type	Description
success	boolean	Indicates whether the request succeeded
result	array	List of orders
pagination	object	Metadata about result set

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}