OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

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.

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

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.

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:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is “1”.
shippingFeenumberThe new shipping fee to be applied.
shouldRectifybooleanWhether 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.