There are a few additional fields that need to be updated for an order so that it is successful.
Tax
The first is a tax field which is optional and can be used to add a fixed amount of tax.
If your site has already calculated the tax for an order, this field can be used. The tax field will accept a float value representing the tax amount.
Set the tax field with the following format
"tax" : {
"amount" : 10.00,
"rate" : 0.1,
"shipping_inclusive" : true
}
Variable
Type
Description
Default Value
amount
Decimal
Tax Amount
0.00
rate (Optional)
Decimal
Tax rate in decimal. 10% is 0.1
0.00
shipping_inclusive
Boolean
if set to true shipping is also counted as tax
FALSE
##Promocode
"tax" : {
"amount" : 10.00,
"rate" : 0.1,
"shipping_inclusive" : true
}
Variable | Type | Description | Default Value |
---|---|---|---|
amount | Decimal | Tax Amount | 0.00 |
rate (Optional) | Decimal | Tax rate in decimal. 10% is 0.1 | 0.00 |
shipping_inclusive | Boolean | if set to true shipping is also counted as tax | FALSE |
Another important field in the order is the extraData field which is used to store any additional information about the order.
Since it is a required field, if you have no extra data that needs to be added to the order you can simply store your website URL within the field.
Note that this is a required field!
Set the Promo field with the following format
{
"promocode" : "PROMO"
}
Variable
Type
Description
promocode
String
Preapplied promo code
##extraData
{
"promocode" : "PROMO"
}
Variable | Type | Description |
---|---|---|
promocode | String | Preapplied promo code |
Another important field in the order is the extraData field which is used to store any additional information about the order.
Since it is a required field, if you have no extra data that needs to be added to the order you can simply store your website URL within the field.
Set the extraData field with the following format
"extraData" : {
"site": "url"
}
Variable
Type
Description
extraData
JSON Object
Extra Data to pass into the order, store the website URL if no extra data is needed.
"extraData" : {
"site": "url"
}
Variable | Type | Description |
---|---|---|
extraData | JSON Object | Extra Data to pass into the order, store the website URL if no extra data is needed. |