Adjust Shipment Tax


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

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.

Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URLhttps://{tenantId}
Sandbox URLhttps://{tenantId}
Supported FormatsJSON


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

Required Parameters

The request has the following necessary parameters:

shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.
shouldRectifybooleanWhether the shipment should be rectified, i.e. immediately sent to READY status, or not.

Optional Parameters

The request can also include the following additional properties:

itemTaxarrayThe tax amount and rate per item.
shippingTaxnumberThe new shipping tax amount.
shippingTaxRatenumberThe new shipping tax rate.
shipmentItemTaxnumberThe new item tax for the shipment.

Item Tax

Item Tax (/itemTax/{object}) has three available parameters to construct it, though none are strictly required:

orderItemIDintegerA unique identifier for the order item. The minimum value is “0”.
itemTaxAmountnumberThe new item tax amount for the item. The minimum value is “0”.
itemTaxRatenumberThe 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.