Adjust Shipping Fee
A shipment’s fee can be edited separately from the shipment and item taxes, using the Adjust Shipping Fee action of the Shipment API.
The .json address above can be used to access the schema within Postman. An example use of the Adjust Shipping Fee API 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 111111
- Shipment Fee of $5.00
The request has three required properties and no optional parameters. The necessary elements are:
|shipmentID||integer||A unique identifier for the shipment. The minimum value is “1”.|
|shippingFee||number||The new shipping fee to be applied.|
|shouldRectify||boolean||Whether the order should be rectified, i.e. immediately sent to READY status, or not.|
The Full Request
This sample will set the shipping fee of the designated shipment 111111 to $5.00.
The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was edited.