Configuring zone component surcharges by using APIs

Zone component surcharges are extra charges that are applied to specific routes or zone components. These routes consist of pairs of origin and destination postal codes. For example, a carrier service might require extra charges, such as an extended delivery area surcharge on a specific route. This surcharge is added to the rate to ship the package on that route.

Before you begin

Zone component surcharges are configured by using the following APIs:

Procedure

  1. In the Set or update carrier service surcharge configuration API, assign the ZONE_COMPONENT value to the chargeScope attribute.
    By default, the CARRIER_SERVICE value is set.
  2. In the Upload shipping zone components API, use the surcharges CSV input column to specify one or more chargeType values for the surcharge that you want to assign to the specific zone component.
    You can specify up to five surcharges as a space-delimited list for a zone component.
  3. Optional: To specify a sequence in which to apply the surcharges, in the Upload shipping components API, provide a value for the chargeTier attribute.
    For more information, see Updating the sequence of surcharges.

Results

The shipping cost calculation logic checks if any zone component surcharges are configured for the delivery route for the package. Then, if surcharges are found, they are included in the shipping cost calculation.

What to do next

Become familiar with the scenario to set up zone component surcharges. For more information, see Scenario: Zone component surcharges.