Get Order

GET

https://your_store.example.com/api/storefront/orders/:orderId

GET

/api/storefront/orders/:orderId

$ curl https://your_store.example.com/api/storefront/orders/1 \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "orderId": 12345,
3   "cartId": "a3f1c9e2-4b7d-4f8a-9c3e-2d5f7b6a9e1c",
4   "currency": {
5     "name": "United States Dollar",
6     "code": "USD",
7     "symbol": "$",
8     "decimalPlaces": 2
9   },
10   "isTaxIncluded": true,
11   "baseAmount": 150,
12   "discountAmount": 15,
13   "giftWrappingCostTotal": 5,
14   "orderAmount": 140,
15   "orderAmountAsInteger": 14000,
16   "coupons": [
17     {
18       "code": "SPRINGSALE",
19       "id": "coupon123",
20       "displayName": "Spring Sale 10% Off",
21       "couponType": "percentage",
22       "discountedAmount": 15
23     }
24   ],
25   "lineItems": [
26     {
27       "physicalItems": [
28         {
29           "quantity": 2,
30           "id": "lineitem001",
31           "parentId": null,
32           "variantId": 101,
33           "productId": 5001,
34           "sku": "TSHIRT-BLUE-M",
35           "name": "Blue T-Shirt - Medium",
36           "url": "https://yourstore.example.com/products/blue-tshirt",
37           "brand": "Acme Apparel",
38           "isTaxable": true,
39           "imageUrl": "https://yourstore.example.com/images/products/blue-tshirt.jpg",
40           "discounts": {},
41           "discountAmount": 5,
42           "couponAmount": 5,
43           "listPrice": 25,
44           "salePrice": 20,
45           "extendedListPrice": 50,
46           "extendedSalePrice": 40,
47           "type": "physical",
48           "addedByPromotion": false,
49           "isShippingRequired": true,
50           "giftWrapping": {
51             "name": "Festive Wrap",
52             "message": "Happy Birthday!",
53             "amount": 5
54           },
55           "categories": [
56             {}
57           ]
58         }
59       ],
60       "digitalItems": [
61         {
62           "quantity": 1,
63           "id": "lineitem002",
64           "parentId": null,
65           "variantId": 202,
66           "productId": 6002,
67           "sku": "EBOOK-123",
68           "name": "Learn JavaScript eBook",
69           "url": "https://yourstore.example.com/products/learn-javascript-ebook",
70           "brand": "Tech Books",
71           "isTaxable": true,
72           "imageUrl": "https://yourstore.example.com/images/products/learn-javascript-ebook.jpg",
73           "discounts": [
74             {
75               "coupon": 3
76             }
77           ],
78           "discountAmount": 3,
79           "couponAmount": 3,
80           "listPrice": 15,
81           "salePrice": 12,
82           "extendedListPrice": 15,
83           "extendedSalePrice": 12,
84           "type": "digital",
85           "downloadFileUrls": [
86             "https://yourstore.example.com/downloads/learn-javascript-ebook.pdf"
87           ],
88           "downloadPageUrl": "https://yourstore.example.com/downloads/learn-javascript",
89           "downloadSize": "5MB",
90           "categories": [
91             {}
92           ]
93         }
94       ],
95       "giftCertificate": [
96         {
97           "name": "Gift Card $50",
98           "quantity": 1,
99           "isTaxable": false,
100           "amount": 50,
101           "type": "gift_certificate"
102         }
103       ]
104     }
105   ],
106   "customerId": "cust789",
107   "billingAddress": {
108     "countryCode": "US",
109     "firstName": "Jane",
110     "lastName": "Doe",
111     "email": "jane.doe@example.com",
112     "company": "Doe Enterprises",
113     "address1": "123 Elm Street",
114     "address2": "Apt 4B",
115     "city": "Springfield",
116     "stateOrProvince": "Illinois",
117     "stateOrProvinceCode": "IL",
118     "country": "United States",
119     "postalCode": "62704",
120     "phone": "+12175551234",
121     "customFields": [
122       {
123         "fieldId": "custom1",
124         "fieldValue": "Leave package at front door"
125       }
126     ]
127   },
128   "status": "INCOMPLETE",
129   "hasDigitalItems": true,
130   "isDownloadable": true,
131   "isComplete": true,
132   "customerMessage": "Please deliver between 9am-5pm.",
133   "shippingCostTotal": 10,
134   "shippingCostBeforeDiscount": 12,
135   "comparisonShippingCost": 12,
136   "handlingCostTotal": 0,
137   "customerCanBeCreated": true,
138   "taxes": [
139     {
140       "name": "Sales Tax",
141       "amount": 8
142     }
143   ],
144   "taxTotal": 8,
145   "channelId": 2,
146   "consignments": {
147     "shipping": [
148       {
149         "lineItems": [
150           {
151             "id": 4
152           }
153         ],
154         "shippingAddressId": 1,
155         "firstName": "Jane",
156         "lastName": "Doe",
157         "company": "Doe Enterprises",
158         "address1": "123 Elm Street",
159         "address2": "Apt 4B",
160         "city": "Springfield",
161         "stateOrProvince": "Illinois",
162         "postalCode": "62704",
163         "country": "United States",
164         "countryCode": "US",
165         "email": "jane.doe@example.com",
166         "phone": "+12175551234",
167         "itemsTotal": 1,
168         "itemsShipped": 0,
169         "shippingMethod": "Standard Shipping",
170         "baseCost": 10,
171         "costExTax": 10,
172         "costIncTax": 11,
173         "costTax": 1,
174         "costTaxClassId": 2,
175         "shippingCostBeforeDiscount": 12,
176         "comparisonShippingCost": 12,
177         "baseHandlingCost": 0,
178         "handlingCostExTax": 0,
179         "handlingCostIncTax": 0,
180         "handlingCostTax": 0,
181         "handlingCostTaxClassId": 2,
182         "shippingZoneId": 1,
183         "shippingZoneName": "United States",
184         "customFields": [
185           {
186             "name": "special note",
187             "value": "super rare"
188           }
189         ]
190       }
191     ]
192   }
193 }

Returns Order data. This will return order data immediately after an order is placed on the storefront.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

Returns *Order* data. This will return order data immediately after an order is placed on the storefront. > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint.

Path parameters

orderIdintegerRequired

ID of an Order.

Query parameters

includelist of enumsOptional

Sub-resources to include in an Order, in a comma-separated list. The ID and the specified fields will be returned.

Response

orderIddoubleOptional>=1

cartIdstringOptionalformat: "uuid"

The ID of cart that was converted to order.

currencyobjectOptional

This will always be the same between cart and checkout.

isTaxIncludedbooleanOptional

Whether this item is taxable.

baseAmountdoubleOptional

Cost of cartʼs contents before applying discounts.

discountAmountfloatOptional

Discounted amount.

giftWrappingCostTotaldoubleOptional

Gift wrapping for all items, including or excluding tax.

orderAmountdoubleOptional

Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes where applicable.

orderAmountAsIntegerdoubleOptional

Order amount represented in integer. Eg. 1234 for $12.34

couponslist of objectsOptional

Array of AppliedCoupon objects applied to this cart.

lineItemslist of objectsOptional

Array of LineItem objects.

customerIdstringOptional

billingAddressobjectOptional

statusenumOptional

Order status.

hasDigitalItemsbooleanOptional

Specifies whether this order has at least one digital item.

isDownloadablebooleanOptional

Specifies whether this order is fully paid, so that digital items can be downloaded.

isCompletebooleanOptional

Specifies whether this order is complete and ready to be taken to the order confirmation page.

customerMessagestringOptional

Shopperʼs provided message for the order.

shippingCostTotaldoubleOptional

shippingCostBeforeDiscountdoubleOptional

Estimated total shipping cost before any shipping discounts have been applied.

comparisonShippingCostdoubleOptional

The total shipping cost to be shown to shopper in the summary as struck-through.

If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated total shipping cost before any coupons applied (but after automatic promotions applied).
If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated total shipping cost before any discounts applied, similar to the shippingCostBeforeDiscount.

handlingCostTotaldoubleOptional

customerCanBeCreatedbooleanOptional

taxeslist of objectsOptional

taxTotalintegerOptional

channelIddoubleOptional

ID of the channel which the order belongs to.

consignmentsobjectOptional

All the consignments of the order.