Delivery Profile Object


A delivery profile is a collection of delivery regions 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.

Properties
createdByCreatedBy

Information about who created the delivery profile.

Currently only for use with Wix Restaurants.


createdDatestringRead-onlyformat date-time

Date and time the delivery profile was created.


defaultbooleanRead-only

Whether this is the default delivery profile.

Notes:

  • The first delivery profile is automatically created and marked as default when the Wix Stores, Wix Bookings, Wix Events, or Wix Restaurants business solutions are installed on a site.
  • Default status can't be changed or transferred to another profile.
  • The default profile can't be deleted because every site requires one for core delivery functionality.

deliveryRegionsArray <DeliveryRegion>minItems 0maxItems 100

Delivery regions in this profile.


extendedFieldsExtendedFields

Custom field data for the delivery profile object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Delivery profile ID.


namestringminLength 1maxLength 256

Delivery profile name.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the delivery profile is updated. To prevent conflicting changes, the current revision must be passed when updating the delivery profile. Ignored when creating a delivery profile.


updatedDatestringRead-onlyformat date-time

Date and time the delivery profile was last updated.

Did this help?