KIBO OMS DOCUMENTATION

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.

Version2.0
Callhttps://integration.shopatron.com/api/v2/shipment/action/adjustTax
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/shipment/action/adjustTax.json

The .json address above can be used to access the schema within Postman. An example use of the Adjust Tax API action follows here — or go directly to the schema or the sample Postman collection.

Example

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:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".
itemTaxarrayThe tax amount and rate per item.

Optional Parameters

The request can also include the following additional properties:

ParameterTypeDescription
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:

ParameterTypeDescription
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.

"itemTax":[
  {
    "orderItemID":"11111",
    "itemTaxAmount":5.00
  }

The Full Request

This sample will set the tax of the designated Order Item 11111 to $5.00.

{
 "shipmentID":"00000",
 "shippingTax":6.00,
 "shippingTaxRate":0,
 "shouldRectify":true,
 "itemTax":[
   {
     "orderItemID":"11111",
     "itemTaxAmount":5.00
   }
 ]
}

The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was edited.


Megan MayfieldOMS Dev: Adjust Shipment Tax