Order Management
Order Management

Order Details

Retrieve an order with GET https://app.ship.com/public/order/{id}. The only parameter is the numeric order id in the URL path; there is no request body. Requires the Authorization: Bearer header.

Request Parameters

Field Type Max Length Required Description
id integer - Yes Order id (URL path parameter)

Item Object Structure

Field Type Required Description
itemCode string Yes Unique item identifier
upc string No Universal Product Code
price decimal No Item price
quantity integer Yes Quantity ordered

Successful Response Example

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

Response Structure

Field Type Description
success boolean Indicates if the request was successful
result object The order object (see example)
error string Error message if request failed