Skip to main content

This container defines the updated shipping cost information for a rate object identified by rateId.

To view a list of all rate objects and corresponding rateID values, issue getRateTable for the rate table identified by rateTableId.

Type that uses RateUpdate

RateTableUpdate

Call that uses RateUpdate

POST
/rate_table/{rate_table_id}/update_shipping_cost

Fields

Field
Type
Description
additionalCost
Amount
An additional shipping cost added to the base shipping rate (i.e., shippingCost).

This amount applies only to the following rateTableBasis options:
  • WEIGHT: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped.
  • SURCHARGE: This is a flat amount that is added to the base shipping rate.
This field is returned only when it is applicable to the specified rate ID.
rateId
string
The identifier for the rate object.

Note: This is a string automatically assigned by the system when the rate object is created. It cannot be changed or updated.
shippingCost
Amount
This is the base shipping rate for an item.

This amount applies only to the following rateTableBasis options:
  • ITEM: This is a flat rate shipping cost per item being shipped.
  • WEIGHT: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped.