get

/orders/{order_id}/taxes

Gets all order taxes using order_id. Each tax applied to an order. This information can be useful for reporting purposes. Pass in the query parameter ?details=true to return extra details about order taxes. order_product_id and line_item_type are also returned.

All values are read-only.

Authorization

apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
3 Query Parameters
2 Headers

Responses

1 Example
Schema
array[object]
$schema: http://json-schema.org/draft-04/schema#
id
integer

The unique numeric identifier of the taxes object.

1 validation
order_id
integer

The unique numeric identifier of the order to which the tax was applied. NOTE: Not included if the store was using the automatic tax feature.

1 validation
order_address_id
integer

The unique numeric identifier of the order address object associated with the order. NOTE: Not included if the store was using the automatic tax feature.

1 validation
tax_rate_id
integer

The unique numeric identifier of the tax rate.

1 validation
tax_class_id
integer

The unique numeric identifier of the tax class object. NOTE: Will be 0 if automatic tax was enabled, or if the default tax class was used.

1 validation
name
string

The name of the tax class object.

1 validation
class
string

The name of the type of tax that was applied. NOTE: will be ‘Automatic Tax’ if automatic tax was enabled.

1 validation
rate
string

The tax rate. The priority order in which the tax is applied (Float, Float-As-String, Integer)

1 validation
priority
number

The order in which the tax is applied

1 validation
priority_amount
string

The amount of tax calculated on the order. (Float, Float-As-String, Integer)

1 validation
line_amount
string

(Float, Float-As-String, Integer)

1 validation
order_product_id
string

If the line_item_type is item or handling then this field will be the order product id. Otherwise the field will return as null.

line_item_type
string

Type of tax on item

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
order_id
$$.env
1 variable not set
store_hash
X-Auth-Token