Delivery Profiles: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Set up shipping for a new store

A new eCommerce store needs to configure delivery options for its shipments. The store wants to offer shipping to the United States with a single carrier.

To set up shipping for a new store:

  1. Call List Installed Delivery Carriers to discover which carriers are available on a site.

  2. Call Query Delivery Profiles to retrieve the default delivery profile created when you installed Wix Stores.

  3. Call Add Delivery Region to create a region for domestic shipping. Include the destinations (countries and subdivisions) where you want to offer shipping:

    Copy

  4. Call Add Delivery Carrier to assign a carrier to the region. Use the deliveryRegionId returned from the previous step and include a backup rate in case the carrier doesn't return rates:

    Copy

Expand delivery to new regions

An established store wants to expand shipping services to Europe. The store needs to create a new delivery region with carriers that serve European destinations.

To expand delivery to new regions:

  1. Call List Installed Delivery Carriers to check which carriers support European destinations.

  2. Call Get Delivery Profile to retrieve the delivery profile you want to expand.

  3. Call Add Delivery Region to create a new region for European shipping:

    Copy

  4. Call Add Delivery Carrier to assign a carrier that serves European destinations to the new region.

Configure backup rates for carriers

A store wants to ensure customers always see shipping options, even when a carrier's API doesn't return rates for certain destinations.

To configure backup rates for carriers:

  1. Call Get Delivery Profile to retrieve the delivery profile containing the carrier you want to update.

  2. Identify the delivery region and carrier that needs a backup rate from the response.

  3. Call Update Delivery Carrier with the backup rate configuration:

    Copy

    When active is true, customers see the backup rate if the carrier doesn't return a rate. When active is false, the system hides the carrier's shipping options if the carrier returns no rate.

Did this help?