Delivery Profile Object


A DeliveryProfile is a collection of delivery configurations that define shipping options for products. Each profile contains delivery regions, which specify where products can be shipped and which carriers can deliver to those destinations. Use delivery profiles to organize and manage different shipping strategies for your store.

Properties
idstringRead-onlyformat GUID

DeliveryProfile ID.


namestringminLength 1maxLength 256

DeliveryProfile name.


defaultbooleanRead-only

Indicates whether this is the default DeliveryProfile. The first delivery profile is automatically created and marked as default when the Wix Stores app is installed. Default status cannot be changed or transferred to another profile. The default profile cannot be deleted because every site requires one for core delivery functionality.


deliveryRegionsArray <DeliveryRegion>minItems 0maxItems 100

A list of DeliveryProfile regions.


createdByCreatedBy

Information about who created the delivery profile. Contains either an app ID (for profiles created by apps) or a user ID (for profiles created by site users).


revisionstringRead-onlyformat int64

DeliveryProfile revision.


createdDatestringRead-onlyformat date-time

Date and time the DeliveryProfile was created.


updatedDatestringRead-onlyformat date-time

Date and time the DeliveryProfile was last updated.


extendedFieldsExtendedFields

Extended fields must be configured in the app dashboard before they can be accessed with API calls.

Did this help?