Get Order Detail

Deprecated

GET

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

GET

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

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

Get order's Detail

Authentication

authTokenstring

API Key authentication via header

Path parameters

orderIdstringRequired

Response

Response Success

codedoubleOptional

Response status code

dataobjectOptional

Response data

messagestringOptional

Response message

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors