Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Get Sales By Order Id

Example

GET /v-beta/sales_orders/:sales_order_id

1
2
3
GET /v-beta/sales_orders/32e18d70-52e0-5002-ab7a-ae33843c2187 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
{
"sales_order_id": "e5a64168-f8d5-5a30-9e93-57f3e61da87b",
"external_order_id": "1774",
"external_order_number": "#SH1801",
"order_source":
{
"order_source_id": "0b6acb5a-430e-464d-a3f7-e7e0175a2a76",
"order_source_nickname": "My Shopify Shop",
"order_source_code": "shopify",
"order_source_friendly_name": "Shopify",
"refresh_info":
{
"status": "idle",
"last_refresh_attempt": "2019-07-25T15:24:46.657Z",
"refresh_date": "2019-07-25T15:24:46.657Z"
},
"active": true
},
"sales_order_status":
{
"payment_status": "unknown",
"fulfillment_status": "fulfilled",
"is_cancelled": false
},
"order_date": "2019-07-25T15:24:46.657Z",
"created_at": "2019-07-25T15:24:46.657Z",
"modified_at": "2019-07-25T15:24:46.657Z",
"payment_details":
{
"subtotal":
{
"currency": "usd",
"amount": 0
},
"estimated_shipping":
{
"currency": "usd",
"amount": 22.38
},
"estimated_tax":
{
"currency": "usd",
"amount": 1.85
},
"grand_total":
{
"currency": "usd",
"amount": 24.23
}
},
"customer":
{
"name": "Amanda Miller",
"phone": "555-555-5555",
"email": "[email protected]"
},
"bill_to":
{
"email": "[email protected]",
"address":
{
"name": null,
"phone": null,
"company_name": null,
"address_line1": "",
"address_line2": null,
"address_line3": null,
"city_locality": null,
"state_province": null,
"postal_code": null,
"country_code": null,
"address_residential_indicator": "no"
}
},
"ship_to":
{
"name": "Amanda Miller",
"phone": "555-555-5555",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US",
"address_residential_indicator": "yes"
},
"sales_order_items": [
{
"sales_order_item_id": "eb8628f7-64ae-5df1-80c6-5e8f24099036",
"line_item_details":
{
"name": "black hotdog shirt L (Default Title)",
"sku": "SHIRT-HD-BLK-L",
"weight":
{
"value": 143.989,
"unit": "ounce"
}
},
"ship_to":
{
"name": "Amanda Miller",
"phone": "555-555-5555",
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "US",
"address_residential_indicator": "yes"
},
"requested_shipping_options":
{
"shipping_service": "Priority Express Mail",
"ship_date": null
},
"price_summary":
{
"unit_price":
{
"currency": "usd",
"amount": 0
},
"estimated_tax":
{
"currency": "usd",
"amount": 0
},
"estimated_shipping": null,
"total":
{
"currency": "usd",
"amount": 0
}
},
"quantity": 1,
"is_gift": false
}]
}