Get Order Detail

Deprecated

GET

https://api-b2b.bigcommerce.com/api/v2/io/orders/:orderId/details

GET

/api/v2/io/orders/:orderId/details

1 curl https://api-b2b.bigcommerce.com/api/v2/io/orders/orderId/details \
2      -H "authToken: <apiKey>"

1 {
2   "code": 200,
3   "data": {
4     "base_handling_cost": "0.0000",
5     "base_shipping_cost": "0.0000",
6     "base_wrapping_cost": "0.0000",
7     "cart_id": "f6a167af-fdc2-4409-8282-0358c36b46c5",
8     "coupon_discount": "0.0000",
9     "credit_card_type": "",
10     "currency_code": "USD",
11     "currency_exchange_rate": "1.0000000000",
12     "currency_id": 1,
13     "customer_id": 168,
14     "customer_message": "123456\n123456798",
15     "date_created": "Tue, 29 Oct 2019 12:33:25 +0000",
16     "date_modified": "Tue, 29 Oct 2019 12:33:29 +0000",
17     "date_shipped": "",
18     "default_currency_code": "USD",
19     "default_currency_id": 1,
20     "discount_amount": "0.0000",
21     "ebay_order_id": "0",
22     "external_source": "",
23     "geoip_country": "China",
24     "geoip_country_iso2": "CN",
25     "gift_certificate_amount": "0.0000",
26     "handling_cost_ex_tax": "0.0000",
27     "handling_cost_inc_tax": "0.0000",
28     "handling_cost_tax": "0.0000",
29     "handling_cost_tax_class_id": 2,
30     "id": "126",
31     "ip_address": "171.213.12.107",
32     "is_deleted": false,
33     "is_email_opt_in": false,
34     "items_shipped": 0,
35     "items_total": 20,
36     "order_is_digital": false,
37     "order_source": "www",
38     "payment_method": "PO",
39     "payment_provider_id": "",
40     "payment_status": "",
41     "products": [
42       {
43         "applied_discounts": "",
44         "base_cost_price": "0.0000",
45         "base_price": "5.0019",
46         "base_total": "100.0000",
47         "base_wrapping_cost": "0.0000",
48         "bin_picking_number": "",
49         "configurable_fields": "",
50         "cost_price_ex_tax": "0.0000",
51         "cost_price_inc_tax": "0.0000",
52         "cost_price_tax": "0.0000",
53         "depth": "0.0000",
54         "ebay_item_id": "",
55         "ebay_transaction_id": "",
56         "event_date": "",
57         "event_name": "",
58         "external_id": "",
59         "fixed_shipping_cost": "0.0000",
60         "fulfillment_source": "",
61         "height": "0.0000",
62         "id": "39",
63         "is_bundled_product": false,
64         "is_refunded": false,
65         "name": "[Sample] Tiered Wire Basket",
66         "option_set_id": "",
67         "order_address_id": "27",
68         "order_id": "126",
69         "parent_order_product_id": "",
70         "price_tax": "0.0000",
71         "product_options": "",
72         "quantity": "20",
73         "quantity_refunded": "0",
74         "quantity_shipped": 0,
75         "refund_amount": "0.0000",
76         "return_id": 0,
77         "sku": "TWB",
78         "total_ex_tax": "100.0000",
79         "total_inc_tax": "100.0000",
80         "total_tax": "0.0000",
81         "type": "physical",
82         "upc": "",
83         "variant_id": "69",
84         "weight": "1.0000",
85         "width": "0.0000",
86         "wrapping_cost_ex_tax": "0.0000",
87         "wrapping_cost_inc_tax": "0.0000",
88         "wrapping_cost_tax": "0.0000",
89         "wrapping_message": "",
90         "wrapping_name": "",
91         "price_ex_tax": "5.0000",
92         "price_inc_tax": "5.0000",
93         "product_id": 97
94       }
95     ],
96     "refunded_amount": "0.0000",
97     "shippingAddress": {
98       "base_cost": "0.0000",
99       "base_handling_cost": "0.0000",
100       "city": "Irvine",
101       "company": "qqqq",
102       "cost_ex_tax": "0.0000",
103       "cost_inc_tax": "0.0000",
104       "cost_tax": "0.0000",
105       "cost_tax_class_id": "2",
106       "country": "United States",
107       "email": "15002803905@163.com",
108       "form_fields": "",
109       "handling_cost_ex_tax": "0.0000",
110       "handling_cost_inc_tax": "0.0000",
111       "handling_cost_tax": "0.0000",
112       "handling_cost_tax_class_id": 2,
113       "items_shipped": "0",
114       "items_total": "20",
115       "phone": "9497486023",
116       "shipping_method": "Free Shipping",
117       "shipping_zone_id": 1,
118       "shipping_zone_name": "United States",
119       "state": "California",
120       "zip": "92618",
121       "country_iso2": "US",
122       "first_name": "sdsdsd",
123       "id": 27,
124       "last_name": "errte",
125       "order_id": 126,
126       "shipping_quotes": {
127         "resource": "/orders/126/shippingaddresses/27/shippingquotes",
128         "url": "https://api.bigcommerce.com/stores/1i6zpxpe3g/v2/orders/126/shippingaddresses/27/shippingquotes"
129       },
130       "street_1": "15440 Laguna Canyon Road, Ste 213",
131       "street_2": "ssadsdas"
132     },
133     "shipping_address_count": 1,
134     "shipping_cost_ex_tax": "0.0000",
135     "shipping_cost_inc_tax": "0.0000",
136     "shipping_cost_tax": "0.0000",
137     "shipping_cost_tax_class_id": 2,
138     "staff_notes": "",
139     "status": "Awaiting Payment",
140     "status_id": 7,
141     "store_credit_amount": "0.0000",
142     "subtotal_ex_tax": "100.0000",
143     "subtotal_inc_tax": "100.0000",
144     "subtotal_tax": "0.0000",
145     "total_ex_tax": "100.0000",
146     "total_inc_tax": "100.0000",
147     "total_tax": "0.0000",
148     "wrapping_cost_ex_tax": "0.0000",
149     "wrapping_cost_inc_tax": "0.0000",
150     "wrapping_cost_tax": "0.0000",
151     "wrapping_cost_tax_class_id": 3,
152     "billing_address": {
153       "city": "Irvine",
154       "company": "qqqq",
155       "country": "United States",
156       "country_iso2": "US",
157       "email": "15002803905@163.com",
158       "first_name": "sdsdsd",
159       "form_fields": [],
160       "last_name": "errte",
161       "phone": "9497486023",
162       "state": "California",
163       "street_1": "15440 Laguna Canyon Road, Ste 213",
164       "street_2": "ssadsdas",
165       "zip": "92618"
166     },
167     "channel_id": "1",
168     "coupons": {
169       "resource": "/orders/126/coupons",
170       "url": "https://api.bigcommerce.com/stores/1i6zpxpe3g/v2/orders/126/coupons"
171     },
172     "custom_status": "Awaiting Payment",
173     "poNumber": "123456798",
174     "shipments": false,
175     "shipping_addresses": {
176       "resource": "/orders/126/shippingaddresses",
177       "url": "https://api.bigcommerce.com/stores/1i6zpxpe3g/v2/orders/126/shippingaddresses"
178     },
179     "store_default_currency_code": "USD",
180     "store_default_to_transactional_exchange_rate": "1.0000000000",
181     "tax_provider_id": "BasicTaxProvider"
182   },
183   "message": "SUCCESS"
184 }

Get order's Detail

Authentication

authTokenstring

API Key authentication via header

Path parameters

orderIdstringRequired

Response

Response Success

codedouble

Response status code

dataobject

Response data

messagestring

Response message

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors