Order List

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

Request Parameters

Request Example

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

Response Structure

Success Response

1{
2  "success": true,
3  "result": [
4    {
5      "id": 0,
6      "customerId": 0,
7      "invoiceNumber": "string",
8      "orderNumber": "string",
9      "orderStatus": "string",
10      "firstName": "string",
11      "lastName": "string",
12      "email": "string",
13      "phone": "string",
14      "address1": "string",
15      "address2": "string",
16      "address3": "string",
17      "city": "string",
18      "state": "string",
19      "zip": "string",
20      "country": "string",
21      "total": 0.00,
22      "salesTax": 0.00,
23      "handling": 0.00,
24      "subtotal": 0.00,
25      "shipping": 0.00,
26      "weight": 0.00,
27      "discount": 0.00,
28      "length": 0.00,
29      "width": 0.00,
30      "height": 0.00,
31      "orderNote": "string",
32      "dateTime": "date",
33      "shipment": {
34        "shipDate": "date",
35        "shippingMethod": "string",
36        "shippingCost": 0.00,
37        "trackingNumber": "string",
38        "trackingURL": "string",
39        "shippingLabelURL": "string"
40      },
41      "items": [
42        {
43          "id": 0,
44          "itemCode": "string",
45          "upc": "string",
46          "price": 0.00,
47          "quantity": 0,
48          "totalPrice": 0.00
49        }
50      ]
51    }
52  ],
53  "pagination": {
54    "currentPage": 1,
55    "pageSize": 25,
56    "totalOrders": 100,
57    "totalPages": 4
58  }
59}

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}