Commit Tax Quote

POST

https://your_app.example.com/commit

POST

/commit

1 import requests
2 
3 url = "https://your_app.example.com/commit"
4 
5 payload = {
6     "id": "113",
7     "currency_code": "USD",
8     "customer": {
9         "customer_id": "0",
10         "customer_group_id": "0",
11         "taxability_code": "",
12         "tax_properties": [
13             {
14                 "code": "property123",
15                 "value": "property-value"
16             }
17         ]
18     },
19     "transaction_date": "2019-08-13T03:40:15+00:00",
20     "documents": [
21         {
22             "id": "shipping_14",
23             "destination_address": {
24                 "line1": "402 S Vine St",
25                 "line2": "",
26                 "city": "Van Wert",
27                 "region_name": "Ohio",
28                 "region_code": "OH",
29                 "country_name": "United States",
30                 "country_code": "US",
31                 "postal_code": "45891",
32                 "type": "RESIDENTIAL",
33                 "company_name": ""
34             },
35             "origin_address": {
36                 "line1": "2139 W ANDERSON LN",
37                 "line2": "",
38                 "city": "AUSTIN",
39                 "region_name": "Texas",
40                 "region_code": "TX",
41                 "country_name": "United States",
42                 "country_code": "US",
43                 "postal_code": "78757",
44                 "type": "COMMERCIAL",
45                 "company_name": ""
46             },
47             "shipping": {
48                 "id": "shipping_14",
49                 "price": {
50                     "amount": 10,
51                     "tax_inclusive": False
52                 },
53                 "quantity": 1,
54                 "type": "shipping",
55                 "item_code": "Flat Rate",
56                 "name": "Shipping to Van Wert, United States 45891",
57                 "tax_class": {
58                     "code": "",
59                     "class_id": "6",
60                     "name": "Shipping"
61                 },
62                 "tax_exempt": False
63             },
64             "handling": {
65                 "id": "handling_14",
66                 "price": {
67                     "amount": 0,
68                     "tax_inclusive": False
69                 },
70                 "quantity": 1,
71                 "type": "handling",
72                 "item_code": "Flat Rate",
73                 "name": "Handling for Van Wert, United States 45891",
74                 "tax_class": {
75                     "code": "",
76                     "class_id": "6",
77                     "name": "Handling"
78                 },
79                 "tax_exempt": False
80             },
81             "items": [
82                 {
83                     "id": "product_13",
84                     "price": {
85                         "amount": 450,
86                         "tax_inclusive": False
87                     },
88                     "quantity": 2,
89                     "type": "item",
90                     "item_code": "ABS",
91                     "name": "[Sample] Able Brewing System",
92                     "tax_class": {
93                         "code": "",
94                         "class_id": "0",
95                         "name": "Default Tax Class"
96                     },
97                     "tax_exempt": False,
98                     "wrapping": {
99                         "id": "product_14",
100                         "price": {
101                             "amount": 5,
102                             "tax_inclusive": False
103                         },
104                         "quantity": 1,
105                         "type": "wrapping",
106                         "item_code": "",
107                         "name": "Wrapping: Holiday",
108                         "tax_class": {
109                             "code": "",
110                             "class_id": "6",
111                             "name": "Wrapping"
112                         },
113                         "tax_exempt": False
114                     }
115                 },
116                 {
117                     "id": "product_14",
118                     "price": {
119                         "amount": 200,
120                         "tax_inclusive": False
121                     },
122                     "quantity": 1,
123                     "type": "item",
124                     "item_code": "CLC",
125                     "name": "[Sample] Canvas Laundry Cart",
126                     "tax_class": {
127                         "code": "",
128                         "class_id": "0",
129                         "name": "Default Tax Class"
130                     },
131                     "tax_exempt": False,
132                     "wrapping": {
133                         "id": "product_14",
134                         "price": {
135                             "amount": 5,
136                             "tax_inclusive": False
137                         },
138                         "quantity": 1,
139                         "type": "wrapping",
140                         "item_code": "",
141                         "name": "Wrapping: Holiday",
142                         "tax_class": {
143                             "code": "",
144                             "class_id": "6",
145                             "name": "Wrapping"
146                         },
147                         "tax_exempt": False
148                     }
149                 }
150             ],
151             "billing_address": {
152                 "line1": "402 S Vine St",
153                 "line2": "",
154                 "city": "Van Wert",
155                 "region_name": "Ohio",
156                 "region_code": "OH",
157                 "country_name": "United States",
158                 "country_code": "US",
159                 "postal_code": "45891",
160                 "type": "RESIDENTIAL",
161                 "company_name": ""
162             }
163         }
164     ]
165 }
166 headers = {
167     "X-Bc-Store-Hash": "X-Bc-Store-Hash",
168     "Authorization": "Basic <username>:<password>",
169     "Content-Type": "application/json"
170 }
171 
172 response = requests.post(url, json=payload, headers=headers)
173 
174 print(response.json())

1 {
2   "id": "113",
3   "documents": [
4     {
5       "id": "shipping_14",
6       "items": [
7         {
8           "id": "product_13",
9           "price": {
10             "amount_inclusive": 675,
11             "amount_exclusive": 450,
12             "total_tax": 225,
13             "tax_rate": 0.5,
14             "sales_tax_summary": [
15               {
16                 "name": "Brutal Tax",
17                 "rate": 0.5,
18                 "amount": 225,
19                 "tax_class": {
20                   "code": "US",
21                   "class_id": "0",
22                   "name": "Brutal Tax"
23                 },
24                 "id": "Brutal Tax"
25               }
26             ]
27           },
28           "type": "item",
29           "wrapping": {
30             "id": "product_14",
31             "price": {
32               "amount_inclusive": 7.5,
33               "amount_exclusive": 5,
34               "total_tax": 2.5,
35               "tax_rate": 0.5,
36               "sales_tax_summary": [
37                 {
38                   "name": "BRUTAL TAX",
39                   "rate": 0.5,
40                   "amount": 2.5,
41                   "tax_class": {
42                     "code": "US",
43                     "class_id": "6",
44                     "name": "Wrapping"
45                   },
46                   "id": "1"
47                 }
48               ]
49             },
50             "type": "wrapping"
51           }
52         },
53         {
54           "id": "product_14",
55           "price": {
56             "amount_inclusive": 300,
57             "amount_exclusive": 200,
58             "total_tax": 100,
59             "tax_rate": 0.5,
60             "sales_tax_summary": [
61               {
62                 "name": "Brutal Tax",
63                 "rate": 0.5,
64                 "amount": 100,
65                 "tax_class": {
66                   "code": "US",
67                   "class_id": "0",
68                   "name": "Brutal Tax"
69                 },
70                 "id": "Brutal Tax"
71               }
72             ]
73           },
74           "type": "item",
75           "wrapping": {
76             "id": "product_14",
77             "price": {
78               "amount_inclusive": 7.5,
79               "amount_exclusive": 5,
80               "total_tax": 2.5,
81               "tax_rate": 0.5,
82               "sales_tax_summary": [
83                 {
84                   "name": "BRUTAL TAX",
85                   "rate": 0.5,
86                   "amount": 2.5,
87                   "tax_class": {
88                     "code": "US",
89                     "class_id": "6",
90                     "name": "Wrapping"
91                   },
92                   "id": "1"
93                 }
94               ]
95             },
96             "type": "wrapping"
97           }
98         }
99       ],
100       "shipping": {
101         "id": "shipping_14",
102         "price": {
103           "amount_inclusive": 15,
104           "amount_exclusive": 10,
105           "total_tax": 5,
106           "tax_rate": 0.5,
107           "sales_tax_summary": [
108             {
109               "name": "Brutal Tax",
110               "rate": 0.5,
111               "amount": 5,
112               "tax_class": {
113                 "code": "US",
114                 "class_id": "0",
115                 "name": "Brutal Tax"
116               },
117               "id": "Brutal Tax"
118             }
119           ]
120         },
121         "type": "shipping"
122       },
123       "handling": {
124         "id": "handling_14",
125         "price": {
126           "amount_inclusive": 0,
127           "amount_exclusive": 0,
128           "total_tax": 0,
129           "tax_rate": 0.5,
130           "sales_tax_summary": [
131             {
132               "name": "Brutal Tax",
133               "rate": 0.5,
134               "amount": 0,
135               "tax_class": {
136                 "code": "US",
137                 "class_id": "0",
138                 "name": "Brutal Tax"
139               },
140               "id": "Brutal Tax"
141             }
142           ]
143         },
144         "type": "handling"
145       },
146       "external_id": "sample-doc-123456789"
147     }
148   ]
149 }

Submit the quote request to be persisted by the enabled third-party tax provider. A commit operation is intended to be submitted once only, when the Order has been confirmed and paid.

Merchants may adjust when commit operations occur by adjusting the document submission strategy in their store tax settings. The selected document submission strategy will adjust whether order status or payment status is used to determine if the order is paid. For more information, see the Tax Settings API Reference.

Server URL

For supporting tax providers, the server URL contains the tax providerʼs profile field; for example, your_profile.example.com.

The Try it feature is not currently supported for this endpoint.

Submit the quote request to be persisted by the enabled third-party tax provider. A commit operation is intended to be submitted once only, when the Order has been confirmed and paid. Merchants may adjust when commit operations occur by adjusting the document submission strategy in their store tax settings. The selected document submission strategy will adjust whether order status or payment status is used to determine if the order is paid. For more information, see the [Tax Settings API Reference](/developer/api-reference/rest/admin/management/tax/tax-settings). > Server URL > - For supporting tax providers, the server URL contains the tax providerʼs profile field; for example, `your_profile.example.com`. > - The Try it feature is not currently supported for this endpoint.

Authentication

AuthorizationBasic

The HTTP Basic Authentication (developer.mozilla.org) credentials used to authenticate each API request to the tax provider from the associated store; set and update username, password, and optionally profile, using the Update a Connection request. profile is an optional field and will be used with supporting providers only.

For more, see developer-configured authentication for Provider APIs.

The [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) (developer.mozilla.org) credentials used to authenticate each API request to the tax provider from the associated store; set and update `username`, `password`, and optionally `profile`, using the [Update a Connection](/developer/api-reference/rest/tax-provider/tax-provider-connection#update-a-connection) request. `profile` is an optional field and will be used with supporting providers only. For more, see [developer-configured authentication](/developer/docs/overview/api-accounts#developer-configured-authentication) for Provider APIs.

Request

This endpoint expects an object.

idstringRequired

Unique ID of the taxable document (order, cart, quote, etc) this tax quote request is being generated for. Will remain consistent for the lifetime of the entity being estimated.

currency_codestringRequired

ISO 4217 3 character currency code that all prices on this request are in.

customerobjectRequired

If the shopper is a registered customer in the merchant’s store, basic details for that customer.

transaction_datedatetimeRequired

ISO 8601 formatted date the shopper placed this order. Tax quotes are expected to reflect taxes applicable on this date. Dates will be provided in UTC.

documentslist of objectsRequired

One or more consignments containing items being purchased by the shopper, including shipping and handling fees that are charged for each consignment. Most orders will contain a single consignment (to a single shipping address), however the BigCommerce platform also supports “Multi-address orders” which allow shoppers to place a single order with items shipped to different addresses.

Response

idstring

The unique identifier of the tax quote that was requested. This value must either match the ID of the requested quote or be an external ID on the tax provider’s system. This value will be used for future adjust and void operations.

documentslist of objects

Represents an order quote or part of an order quote of tax-relevant items fulfilled from a single origin address to a single destination address, including arrays of shipping and handling fee objects for each item. Most order quotes contain a single document; however, BigCommerce supports “multi-address orders”, which may come from or go to distinct sets of addresses and thus require multiple documents per quote.

Represents an order quote or part of an order quote of tax-relevant items fulfilled from a single origin address to a single destination address, including arrays of shipping and handling fee objects for each item. Most order quotes contain a single document; however, BigCommerce supports "multi-address orders", which may come from or go to distinct sets of addresses and thus require multiple documents per quote.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors