About the Delivery Profiles API

The Delivery Profiles API allows you to manage shipping configurations for a site that sells products. Delivery profiles define where products ship and the carriers that handle those deliveries.

The Delivery Profiles API provides functionality to:

• Create, update, and delete delivery profiles.
• Add, update, and remove delivery regions in profiles.
• Add, update, and remove delivery carriers in regions.
• Query delivery profiles and retrieve carrier information.

Data hierarchy

The API follows this hierarchy:

Default delivery profile

When you install any of the Wix Stores, Wix Bookings, Wix Events, or Wix Restaurants business solutions, Wix automatically creates a default delivery profile. This profile:

• Can't be deleted because every site requires one for core delivery functionality.
• Can't be transferred to another profile.
• Is used by products that don't have an explicit delivery profile assignment.

Default delivery profile setup

When you create a site, Wix automatically configures the default delivery profile with:

1. International region: A delivery region with empty destinations that serves as a "Rest of World" configuration, applying to any destination not explicitly defined in other regions. This region includes a native Free Shipping carrier that is pre-configured.

2. Domestic region (conditional): If a Wix user specifies their country in site settings, the system creates an additional Domestic delivery region for that country. This region also includes the native Free Shipping carrier pre-configured.

You can customize both regions by adding carriers, modifying backup rates, or adjusting destinations. You can also disable or delete regions.

Before you begin

Before you start coding, note the following:

• You can't assign overlapping destinations in a delivery profile. You can use the same destination in different profiles, but not in the same profile.
• If a delivery carrier doesn't return a rate for a specific shipping option, the system uses the backup rate.
• Assign products to delivery profiles using the deliveryProfileId field in the Products API. Products without an explicit assignment use the default delivery profile.

Use cases

• Set up shipping for a new store.
• Expand delivery to new regions.
• Configure backup rates for carriers.

Terminology

• Delivery profile: A collection of delivery regions that defines shipping options for products.
• Delivery region: A geographic area with associated delivery carriers. Each region specifies destinations (countries and subdivisions) where products can ship.
• Delivery carrier: A shipping provider assigned to a delivery region, such as UPS, FedEx, or a custom shipping app.
• Destination: A specific country or subdivision in a delivery region.
• Backup rate: A fallback shipping rate used when a carrier doesn't return a rate for a specific shipping option.