Configuring carrier service surcharges by using APIs

Transportation carrier services apply extra charges and fees, such as fuel surcharges, when you use their service for shipping purposes. You can configure and manage carrier service surcharges by using APIs. Then, these surcharges that you configure are applied to any route for the carrier service.

Before you begin

Ensure that you are familiar with the surcharges concept. For more information, see Surcharges. You can also configure surcharges by using the UI. For more information, see Configuring carrier services.

1. To create or update the carrier service surcharge configuration based on the carrier service ID and charge type, open the Set or update surcharge configuration API.
2. Assign the CARRIER_SERVICE value to the chargeScope attribute.
3. Use the following APIs to retrieve or delete the carrier service configuration:
   • To retrieve the carrier service surcharge configuration based on the carrier service ID and charge type, use the Get carrier service surcharge configuration API.
   • To delete the carrier service surcharge configuration based on the carrier service ID and charge type, use the Delete carrier service surcharge configuration API.
   • To retrieve a list of carrier service surcharge configurations based on the carrier service ID, use the List carrier service surcharge configurations API.
4. Optional: To specify a sequence in which to apply the surcharges, in the Set or update surcharge configuration API, provide a value for the chargeTier attribute.

Results

The shipping cost calculation logic checks if any carrier service level surcharges are configured. 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 carrier service surcharges. For more information, see Scenario: Carrier service surcharges.