Configuring carrier zones and transit durations by using APIs
After you create carriers and carrier services, you must create carrier zones.
Upload zone definitions for a carrier service
- You are launching a new store, and you want to introduce a zone with the new store's postal code.
- You are shipping to new destination postal codes.
To introduce new zones for an existing carrier service, ensure that the new zones do not overlap with the previously uploaded zones. To specify the zones in which the carrier services operate, use the Upload zone definitions API.
To change the zone definitions for the existing postal codes for a carrier service, first delete all existing zones for the carrier service by using the Delete carrier zones for a carrier service API.
Create or update carrier transit durations for a carrier service and zone
To create or update the transit durations by zone for a carrier service, use the Upload transit durations by zones for carrier service API.
Create or update a specific zone component or route
To create or update the transit durations for a specific zone component or route within a zone
for a carrier service, use the following command:POST
/cas/{tenantId}/v1/configuration/carrierServices/{carrierServiceId}/zones/_bulkUpsert
API
Delete shipping zone components
Consider the following use cases in which you might want to delete shipping zone components:
- You are creating new zones or rearranging postal codes for a specific store.
- You are shutting down a store or the store is no longer eligible for shipping to a specific location.
- You uploaded a batch of components by mistake and want to undo the action.
- You want to move zone components from one shipping zone to another. In this case, you must delete existing zone components and reupload them with reference to new shipping zone.
Ensure to create new shopping zone components before deleting the conflicting ones. Once the new shipping zone components are created for the specific carrier service, deleting conflicting components overcomes overlap or gaps in zone coverage.
- Create zones to handle your in-country shipping scenario
- Create zones to handle your international shipping scenario
- Specifying transit durations for each zone
- Specifying transit rates for each zone
For more information, see Carrier zones.