Adjust Shipment Tax
The tax of a shipment or individual order items can be edited by specifying updated information with the Adjust Tax action of the Shipment API.
The .json address above can be used to access the schema within Postman. An example use of the Adjust Tax API action follows below, or view the schema or the sample Postman collection.
This example case creates a call that will edit a shipment based on the following information:
- Shipment ID 00000
- $5.00 tax on Order Item 11111
The request has the following necessary parameters:
|shipmentID||integer||A unique identifier for the shipment. The minimum value is “1”.|
|shouldRectify||boolean||Whether the shipment should be rectified, i.e. immediately sent to READY status, or not.|
The request can also include the following additional properties:
|itemTax||array||An array of itemTax objects that define the tax amount and rate per item. See below for the properties included in each entry of the array.|
|shippingTax||number||The new shipping tax amount.|
|shippingTaxRate||number||The new shipping tax rate.|
|shipmentItemTax||number||The new item tax for the shipment.|
Each Item Tax entry has three available parameters to construct it, though none are strictly required:
|orderItemID||integer||A unique identifier for the order item. The minimum value is “0”.|
|itemTaxAmount||number||The new item tax amount for the item. The minimum value is “0”.|
|itemTaxRate||number||The new item tax rate for the item. The minimum value is “0”.|
Below is the Item Tax object that will be used in the example request.
The Full Request
This sample will set the tax of the designated Order Item 11111 to $5.00.
The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was edited.