Taxes
Taxes describe the amount of tax owing for orders, shipments and shipment lineitems.
Read Order Taxes
Retrieves the total tax for an order; which includes the order’s tax amount, currency, and type of tax (VAT - Value Added Tax, HST - Harmonized Sales Tax, etc.).
Workflow
- Start with order
GETthe link with rel: tax- Render the response
Response Fields
Type: taxes.taxes
| Name | Description | Type |
|---|---|---|
total | The total tax. | object |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
cost | The cost of the tax(es). | array |
title | The name of the tax. | string |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
Read Shipment Taxes
Retrieves the total tax for a shipment; which includes the shipments’ tax amount, currency, and type of tax (VAT, HST, etc.).
Workflow
- Start with shipment
GETthe link with rel: tax- Render the response
Response Fields
Type: taxes.taxes
| Name | Description | Type |
|---|---|---|
total | The total tax. | object |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
cost | The cost of the tax(es). | array |
title | The name of the tax. | string |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
Read Shipment Line Item Taxes
Retrieve the tax amount for a shipment line item.
Workflow
- Start with shipment-line-item
GETthe link with rel: tax- Render the response
Response Fields
Type: taxes.taxes
| Name | Description | Type |
|---|---|---|
total | The total tax. | object |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
cost | The cost of the tax(es). | array |
title | The name of the tax. | string |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |