A shipment’s fee can be edited separately from the shipment and item taxes, using the Adjust Shipping Fee 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 URL | https://{tenantId}-translation.mozu.com/api/v2/shipment/action/adjustShippingFee |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/shipment/action/adjustShippingFee |
| Supported Formats | JSON |
| HTTP Method | POST |
Example
This example case creates a call that will edit a shipment based on the following information:
- Shipment ID 111111
- Shipment Fee of $5.00
Required Parameters
The request has three required properties and no optional parameters. The necessary elements are:
| Parameter | Type | Description |
| 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.
{
"shipmentID":111111,
"shippingFee":5.00,
"shouldRectify":true
}The returned response follows the same structure as the Get Shipment API, providing information about the shipment that was edited.