import { CreateDeliveryProfileRequest as CreateDeliveryProfileRequest$1, CreateDeliveryProfileResponse as CreateDeliveryProfileResponse$1, GetDeliveryProfileRequest as GetDeliveryProfileRequest$1, GetDeliveryProfileResponse as GetDeliveryProfileResponse$1, UpdateDeliveryProfileRequest as UpdateDeliveryProfileRequest$1, UpdateDeliveryProfileResponse as UpdateDeliveryProfileResponse$1, DeleteDeliveryProfileRequest as DeleteDeliveryProfileRequest$1, DeleteDeliveryProfileResponse as DeleteDeliveryProfileResponse$1, QueryDeliveryProfilesRequest as QueryDeliveryProfilesRequest$1, QueryDeliveryProfilesResponse as QueryDeliveryProfilesResponse$1, AddDeliveryRegionRequest as AddDeliveryRegionRequest$1, AddDeliveryRegionResponse as AddDeliveryRegionResponse$1, UpdateDeliveryRegionRequest as UpdateDeliveryRegionRequest$1, UpdateDeliveryRegionResponse as UpdateDeliveryRegionResponse$1, GetDeliveryProfileByDeliveryRegionIdRequest as GetDeliveryProfileByDeliveryRegionIdRequest$1, GetDeliveryProfileByDeliveryRegionIdResponse as GetDeliveryProfileByDeliveryRegionIdResponse$1, RemoveDeliveryRegionRequest as RemoveDeliveryRegionRequest$1, RemoveDeliveryRegionResponse as RemoveDeliveryRegionResponse$1, AddDeliveryCarrierRequest as AddDeliveryCarrierRequest$1, AddDeliveryCarrierResponse as AddDeliveryCarrierResponse$1, RemoveDeliveryCarrierRequest as RemoveDeliveryCarrierRequest$1, RemoveDeliveryCarrierResponse as RemoveDeliveryCarrierResponse$1, UpdateDeliveryCarrierRequest as UpdateDeliveryCarrierRequest$1, UpdateDeliveryCarrierResponse as UpdateDeliveryCarrierResponse$1, ListInstalledDeliveryCarriersRequest as ListInstalledDeliveryCarriersRequest$1, ListInstalledDeliveryCarriersResponse as ListInstalledDeliveryCarriersResponse$1, GetDeliveryDestinationPropertiesRequest as GetDeliveryDestinationPropertiesRequest$1, GetDeliveryDestinationPropertiesResponse as GetDeliveryDestinationPropertiesResponse$1, ListDeliveryCarriersRequest as ListDeliveryCarriersRequest$1, ListDeliveryCarriersResponse as ListDeliveryCarriersResponse$1, UpdateCarrierSettingsRequest as UpdateCarrierSettingsRequest$1, UpdateCarrierSettingsResponse as UpdateCarrierSettingsResponse$1, SetDeliveryCarrierActiveStatusRequest as SetDeliveryCarrierActiveStatusRequest$1, SetDeliveryCarrierActiveStatusResponse as SetDeliveryCarrierActiveStatusResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** * 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. */ interface DeliveryProfile { /** * Delivery profile ID. * @format GUID * @readonly */ id?: string | null; /** * Delivery profile name. * @minLength 1 * @maxLength 256 */ name?: string | null; /** * 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. * @readonly */ default?: boolean | null; /** * Delivery regions in this profile. * @maxSize 100 */ deliveryRegions?: DeliveryRegion[]; /** * Information about who created the delivery profile. * * Currently only for use with Wix Restaurants. */ createdBy?: CreatedBy; /** * 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. * @readonly */ revision?: string | null; /** * Date and time the delivery profile was created. * @readonly */ createdDate?: Date | null; /** * Date and time the delivery profile was last updated. * @readonly */ updatedDate?: Date | null; /** Custom field data for the delivery profile object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. */ extendedFields?: ExtendedFields; } /** * A delivery region defines a geographic area and its associated delivery carriers. * Each region specifies destinations (countries and subdivisions) where products can be shipped and the carriers available for those deliveries. * * During the eCommerce onboarding flow, an "International" region with empty destinations is automatically created. This serves as a "Rest of World" configuration that applies to destinations not explicitly defined in other regions. */ interface DeliveryRegion { /** * Delivery region ID. * @format GUID * @readonly */ deliveryRegionId?: string | null; /** * Delivery region name. For example, `"Domestic"` or `"International"`. * @minLength 1 * @maxLength 256 */ name?: string | null; /** * Whether this delivery region is active and available during checkout. * * Default: `true` */ active?: boolean | null; /** * Delivery carriers assigned to this region. Carriers are managed using the [Add Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/add-delivery-carrier), [Update Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/update-delivery-carrier), and [Remove Delivery Carrier](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/remove-delivery-carrier) methods. * @maxSize 25 * @readonly */ deliveryCarriers?: DeliveryCarrier[]; /** * Geographic destinations covered by this region. If empty, the region applies globally (Rest of World). A site can have up to 250 destinations across all delivery profiles. * @maxSize 250 */ destinations?: Destination[]; /** * Date and time the delivery region was created. * @readonly */ createdDate?: Date | null; } interface DeliveryCarrier { /** * Carrier app ID. * * Get app IDs from the [app dashboard](https://dev.wix.com/dc3/my-apps/), or by calling [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers). * @format GUID */ appId?: string; /** * Backup rate to use when the carrier doesn't return a rate for a specific shipping option. * * When `active` is `false` and the carrier doesn't return a rate, the carrier's shipping options aren't shown to customers. */ backupRate?: BackupRate; /** * Additional charges to add to the delivery rate. These charges are combined with the carrier's rate into a single shipping cost and itemized in order details. * @maxSize 10 */ additionalCharges?: AdditionalCharge[]; } interface BackupRate { /** * Title displayed for the backup rate. For example, `"Standard Shipping"`. * @minLength 1 * @maxLength 256 */ title?: string | null; /** * Backup rate amount. * @decimalValue options { gte:0, maxScale:6 } */ amount?: string | null; /** * Whether the backup rate is active. * * The backup rate is used in the following situations: * + When `active` is `true`. * + When the carrier does not return a cost for any reason. * * If active, and no cost is returned by the carrier, the backup rate will be displayed to customers as the shipping option. * * Default: `false` */ active?: boolean; } interface AdditionalCharge { /** * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. * @maxLength 250 */ description?: string | null; /** * Additional fixed charge amount to add to the delivery rate. For example, `"12.50"`. * @maxLength 16 */ amount?: string; } /** Geographic destination for a delivery region. */ interface Destination { /** * 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. * @format COUNTRY */ countryCode?: string; /** * Subdivision codes in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. For example, `"US-CA"` for California. If empty, the delivery region applies to the entire country. * * The following countries don't support subdivision-level delivery and require an empty `subdivisions` list. Sending subdivisions for these countries fails with `SUBDIVISIONS_UNSUPPORTED_FOR_COUNTRY`: * `AT`, `BE`, `BS`, `CH`, `CI`, `CZ`, `DO`, `GR`, `NO`, `PL`, `RS`, `SD`, `SI`, `SK`, `SN`. * @maxSize 100 * @minLength 1 * @maxLength 256 */ subdivisions?: string[]; } interface CreatedBy extends CreatedByIdOneOf { /** * App ID, when the delivery profile was created by an external application or Wix service. * @format GUID */ appId?: string | null; /** * Wix user ID, when the delivery profile was created by a Wix user using the dashboard or an API call. * @format GUID */ userId?: string | null; } /** @oneof */ interface CreatedByIdOneOf { /** * App ID, when the delivery profile was created by an external application or Wix service. * @format GUID */ appId?: string | null; /** * Wix user ID, when the delivery profile was created by a Wix user using the dashboard or an API call. * @format GUID */ userId?: string | null; } interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } /** Event payload for when a delivery region is added to a delivery profile. */ interface DeliveryRegionAdded { /** * ID of the delivery profile containing the region. * @format GUID */ deliveryProfileId?: string; /** * ID of the added delivery region. * @format GUID * @readonly */ deliveryRegionId?: string | null; /** * Delivery region name. For example, `"Domestic"`. * @minLength 1 * @maxLength 256 */ name?: string | null; /** Whether the delivery region is active. */ active?: boolean | null; /** * Delivery carriers assigned to this region. * @maxSize 25 * @readonly */ deliveryCarriers?: DeliveryCarrier[]; /** * Geographic destinations covered by this region. * @maxSize 200 */ destinations?: Destination[]; /** * Date and time the delivery region was created. * @readonly */ createdDate?: Date | null; } /** Event payload for when a delivery region is removed from a delivery profile. */ interface DeliveryRegionRemoved { /** * ID of the delivery profile that contained the region. * @format GUID */ deliveryProfileId?: string; /** * ID of the removed delivery region. * @format GUID */ deliveryRegionId?: string; } /** Event payload for when a delivery region is updated. */ interface DeliveryRegionUpdated { /** * ID of the delivery profile containing the region. * @format GUID */ deliveryProfileId?: string; /** * ID of the updated delivery region. * @format GUID * @readonly */ deliveryRegionId?: string | null; /** * Delivery region name. For example, `"Domestic"`. * @minLength 1 * @maxLength 256 */ name?: string | null; /** Whether the delivery region is active. */ active?: boolean | null; /** * Delivery carriers assigned to this region. * @maxSize 25 * @readonly */ deliveryCarriers?: DeliveryCarrier[]; /** * Geographic destinations covered by this region. If empty, the region applies globally. * @maxSize 200 */ destinations?: Destination[]; /** * Date and time the delivery region was created. * @readonly */ createdDate?: Date | null; } interface CreateDeliveryProfileRequest { /** Delivery profile to create. */ deliveryProfile: DeliveryProfile; } interface CreateDeliveryProfileResponse { /** Created delivery profile. */ deliveryProfile?: DeliveryProfile; } interface GetDeliveryProfileRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; } interface GetDeliveryProfileResponse { /** Retrieved delivery profile. */ deliveryProfile?: DeliveryProfile; } interface UpdateDeliveryProfileRequest { /** Delivery profile to update. */ deliveryProfile: DeliveryProfile; } interface UpdateDeliveryProfileResponse { /** Updated delivery profile. */ deliveryProfile?: DeliveryProfile; } interface DeleteDeliveryProfileRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; } interface DeleteDeliveryProfileResponse { } interface DeleteDefaultDeliveryProfileRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId?: string; } interface DeleteDefaultDeliveryProfileResponse { } interface QueryDeliveryProfilesRequest { /** Query options. */ query?: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` * @maxSize 5 */ sort?: Sorting[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryDeliveryProfilesResponse { /** * List of delivery profiles. * @maxSize 100 */ deliveryProfiles?: DeliveryProfile[]; /** Paging metadata. */ pagingMetadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface AddDeliveryRegionRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; /** Delivery region to add. */ deliveryRegion: DeliveryRegion; /** * Delivery profile revision. * @readonly */ revision?: string | null; } interface AddDeliveryRegionResponse { /** Updated delivery profile with the new delivery region. */ deliveryProfile?: DeliveryProfile; } interface UpdateDeliveryRegionRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; /** Delivery region to update. */ deliveryRegion: DeliveryRegion; /** * Delivery profile revision. * @readonly */ revision?: string | null; } interface UpdateDeliveryRegionResponse { /** Updated delivery profile with the updated delivery region. */ deliveryProfile?: DeliveryProfile; } interface GetDeliveryProfileByDeliveryRegionIdRequest { /** * Delivery region ID. * @format GUID */ deliveryRegionId: string; } interface GetDeliveryProfileByDeliveryRegionIdResponse { /** Delivery profile containing the requested region. */ deliveryProfile?: DeliveryProfile; } interface RemoveDeliveryRegionRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; /** * Delivery region ID. * @format GUID */ deliveryRegionId: string; /** * Delivery profile revision. * @readonly */ revision?: string | null; } interface RemoveDeliveryRegionResponse { /** Updated delivery profile with the delivery region removed. */ deliveryProfile?: DeliveryProfile; } interface AddDeliveryCarrierRequest { /** * Delivery region ID. * @format GUID */ deliveryRegionId: string; /** Delivery carrier to add. */ deliveryCarrier: DeliveryCarrier; } interface AddDeliveryCarrierResponse { /** Updated delivery profile. */ deliveryProfile?: DeliveryProfile; } interface RemoveDeliveryCarrierRequest { /** * Delivery region ID. * @format GUID */ deliveryRegionId: string; /** * App ID of the delivery carrier to remove. * @format GUID */ appId: string; } interface RemoveDeliveryCarrierResponse { /** Updated delivery profile. */ deliveryProfile?: DeliveryProfile; } interface UpdateDeliveryCarrierRequest { /** * Delivery region ID. * @format GUID */ deliveryRegionId: string; /** Delivery carrier to update. */ deliveryCarrier?: DeliveryCarrier; } interface UpdateDeliveryCarrierResponse { /** Updated delivery profile with the updated delivery carrier. */ deliveryProfile?: DeliveryProfile; } interface ListInstalledDeliveryCarriersRequest { } interface ListInstalledDeliveryCarriersResponse { /** * List of installed delivery carriers on the site. * @maxSize 100 */ installedDeliveryCarriers?: InstalledDeliveryCarrier[]; } interface InstalledDeliveryCarrier { /** * Carrier app ID. * @format GUID */ id?: string; /** * Carrier display name. * @maxLength 256 */ displayName?: string; /** * Carrier description. * @maxLength 200 */ description?: string | null; /** * URL to learn more about the carrier. * @maxLength 200 */ learnMoreUrl?: string | null; /** * URL to the carrier's dashboard. * @minLength 1 * @maxLength 2048 * @format WEB_URL */ dashboardUrl?: string | null; /** Whether a backup rate is required for this carrier. */ fallbackDefinitionMandatory?: boolean | null; /** * URL for the carrier's thumbnail image. * @format WEB_URL */ thumbnailUrl?: string | null; /** Whether the carrier supports retrieving carrier settings. */ toggleGetCarrierSettingsEnabled?: boolean; } interface ListDeliveryDestinationsRequest { } interface ListDeliveryDestinationsResponse { /** Scope of destinations. When `WORLDWIDE` is selected, the `destinations` list is empty. */ destinationScope?: DestinationScopeWithLiterals; /** * List of configured destinations. * @maxSize 200 */ destinations?: Destination[]; } declare enum DestinationScope { /** Specific destinations are configured. */ SPECIFIC_DESTINATIONS = "SPECIFIC_DESTINATIONS", /** All destinations worldwide. */ WORLDWIDE = "WORLDWIDE" } /** @enumType */ type DestinationScopeWithLiterals = DestinationScope | 'SPECIFIC_DESTINATIONS' | 'WORLDWIDE'; interface RequiredZipcodeRequest { } interface RequiredZipcodeResponse { /** Whether the site requires a postal code for delivery. */ requiredZipcode?: boolean; } interface GetDeliveryDestinationPropertiesRequest { } interface GetDeliveryDestinationPropertiesResponse { /** Delivery destination properties for Rest of World. */ restOfWorld?: DeliveryDestinationProperties; /** * List of countries and their delivery destination properties. * @maxSize 195 */ countries?: CountryDeliveryProperties[]; } interface DeliveryDestinationProperties { /** Whether a postal code is required for delivery to this destination. */ postalCodeRequired?: boolean; /** Whether only pickup is available at this destination. */ pickupOnly?: boolean; } interface CountryDeliveryProperties { /** * 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. * @format COUNTRY */ country?: string; /** Delivery destination properties for the country. */ deliveryDestinationProperties?: DeliveryDestinationProperties; /** * List of subdivisions and their delivery destination properties. * @maxSize 100 */ subdivisions?: SubdivisionDeliveryProperties[]; } interface SubdivisionDeliveryProperties { /** * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. * @minLength 1 * @maxLength 5 */ subdivision?: string; /** Delivery destination properties for the subdivision. */ deliveryDestinationProperties?: DeliveryDestinationProperties; } interface ListDeliveryCarriersRequest { /** * Delivery profile ID. * @format GUID */ deliveryProfileId: string; /** * App IDs of the delivery carriers to retrieve settings for. * @format GUID * @minSize 1 * @maxSize 25 */ appIds?: string[]; } interface ListDeliveryCarriersResponse { /** * List of delivery carrier results. * @maxSize 100 */ results?: ListDeliveryCarriersResult[]; /** Bulk action metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface ListDeliveryCarriersResult { /** Metadata for the result, including success or error information. */ deliveryCarrierMetadata?: ItemMetadata; /** Delivery carrier details. */ deliveryCarrierDetails?: DeliveryCarrierDetails; /** * Regional settings for the delivery carrier. * @minSize 1 * @maxSize 5 */ deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[]; } interface ItemMetadata { /** * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). * @format GUID */ id?: string | null; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface DeliveryCarrierDetails { /** * Carrier app ID. * @format GUID */ id?: string; /** * Carrier display name. * @maxLength 256 */ displayName?: string; /** * Carrier description. * @maxLength 200 */ description?: string | null; /** * URL to learn more about the carrier. * @maxLength 200 */ learnMoreUrl?: string | null; /** * URL to the carrier's dashboard. * @minLength 1 * @maxLength 2048 * @format WEB_URL */ dashboardUrl?: string | null; /** Whether a backup rate is required for this carrier. */ fallbackDefinitionMandatory?: boolean | null; /** * URL for the carrier's thumbnail image. * @format WEB_URL */ thumbnailUrl?: string | null; /** Whether the carrier supports retrieving carrier settings. */ toggleGetCarrierSettingsEnabled?: boolean; /** Whether the carrier supports updating carrier active status. */ toggleUpdateCarrierActiveStatusEnabled?: boolean; } interface DeliveryCarrierRegionalSettings { /** * Delivery region ID. * @format GUID */ deliveryRegionId?: string; /** * Dashboard tables with shipping configuration for this region. Multiple tables can exist if the carrier is an aggregator of multiple services. * @minSize 1 * @maxSize 5 */ dashboardTables?: DashboardTable[]; } interface DashboardTable { /** * Table title. * @maxLength 256 */ title?: string; /** * Table columns. * @maxSize 200 */ columns?: Column[]; /** * Table rows containing the configuration data. * @maxSize 25 */ rows?: Row[]; } interface Column { /** * Column key, used to retrieve data from rows. * @maxLength 256 */ key?: string; /** * Column display name. * @maxLength 256 */ name?: string; } interface Row { /** * Unique row identifier, used to identify the row for editing. * @maxLength 256 */ key?: string; /** Row data as a JSON object. Each key corresponds to a column key. */ data?: Record | null; /** Whether this row's configuration is active. */ active?: boolean; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface UpdateCarrierSettingsRequest { /** * Carrier app ID. * @format GUID */ carrierId: string; /** * Row ID in the carrier's dashboard settings table that identifies the specific shipping configuration to update. Retrieved from [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers). * @format GUID */ rowId: string; /** New active status. */ active: boolean | null; } interface UpdateCarrierSettingsResponse { } interface SetDeliveryCarrierActiveStatusRequest { /** * Carrier app ID. * @format GUID */ carrierAppId: string; /** * Row identifier in the carrier's dashboard settings table that identifies the specific shipping configuration to update. * * Pass the `row.key` field from the response of [List Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-delivery-carriers). * @format GUID */ rowId: string; /** Whether the configuration defined in the row is active. */ active: boolean | null; } interface SetDeliveryCarrierActiveStatusResponse { } interface UpdateExtendedFieldsRequest { /** ID of the entity to update. */ id: string; /** Identifier for the app whose extended fields are being updated. */ namespace: string; /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */ namespaceData: Record | null; } interface UpdateExtendedFieldsResponse { /** Updated delivery profile. */ deliveryProfile?: DeliveryProfile; } interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * A meta site id. * @format GUID */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * TODO(meta-site): Change validation once validations are disabled for consumers * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659 * @maxSize 4000 */ assets?: Asset[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } interface Asset { /** * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). * @maxLength 36 */ appDefId?: string; /** * An instance id. For legacy reasons may be UUID or a string. * @maxLength 200 */ instanceId?: string; /** An application state. */ state?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; interface SiteCreated { /** * A template identifier (empty if not created from a template). * @maxLength 36 */ originTemplateId?: string; /** * An account id of the owner. * @format GUID */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContextWithLiterals; /** * A meta site id from which this site was created. * * In case of a creation from a template it's a template id. * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site. * @format GUID */ originMetaSiteId?: string | null; /** * A meta site name (URL slug). * @maxLength 20 */ siteName?: string; /** A namespace. */ namespace?: NamespaceWithLiterals; } declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */ SHOUT_OUT = "SHOUT_OUT", /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ALBUMS = "ALBUMS", /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_SITE = "DEV_SITE", /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ LOGOS = "LOGOS", /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE", /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_FORMS = "STANDALONE_FORMS", /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_EVENTS = "STANDALONE_EVENTS", /** MIMIR - Siteless account for MIMIR Ai Job runner. */ MIMIR = "MIMIR", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS", /** Nautilus platform. */ NAUTILUS = "NAUTILUS" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS'; /** Site transferred to another user. */ interface SiteTransferred { /** * A previous owner id (user that transfers meta site). * @format GUID */ oldOwnerId?: string; /** * A new owner id (user that accepts meta site). * @format GUID */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ interface ServiceProvisioned { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * An instance id from which this instance is originated. * @maxLength 36 */ originInstanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; /** * The origin meta site id * @format GUID */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed { /** * A new meta site name (URL slug). * @maxLength 20 */ newSiteName?: string; /** * A previous meta site name (URL slug). * @maxLength 255 */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } /** * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc. * * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up * with sites and its urls, you need to listen to another topic/event. Read about it: * * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service */ interface SiteUrlChanged { } /** * Used at the end of the deletion flow for both draft sites and when a user deletes a site. * Consumed by other teams to remove relevant data. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface Empty { } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } /** @docsIgnore */ type CreateDeliveryProfileApplicationErrors = { code?: 'DELIVERY_PROFILES_LIMIT_EXCEEDED'; description?: string; data?: Record; } | { code?: 'DESTINATIONS_COLLISION'; description?: string; data?: Record; } | { code?: 'SINGLE_DEFAULT_DELIVERY_PROFILE'; description?: string; data?: Record; } | { code?: 'UNKNOWN_DELIVERY_CARRIER'; description?: string; data?: Record; } | { code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE'; description?: string; data?: Record; } | { code?: 'SUBDIVISIONS_UNSUPPORTED_FOR_COUNTRY'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateDeliveryProfileApplicationErrors = { code?: 'DELIVERY_REGION_CANNOT_BE_UPDATED'; description?: string; data?: Record; } | { code?: 'DEFAULT_CANNOT_BE_UPDATED'; description?: string; data?: Record; }; /** @docsIgnore */ type AddDeliveryRegionApplicationErrors = { code?: 'DELIVERY_PROFILE_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DESTINATIONS_COLLISION'; description?: string; data?: Record; } | { code?: 'UNKNOWN_DELIVERY_CARRIER'; description?: string; data?: Record; } | { code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE'; description?: string; data?: Record; } | { code?: 'SUBDIVISIONS_UNSUPPORTED_FOR_COUNTRY'; description?: string; data?: Record; }; /** @docsIgnore */ type AddDeliveryRegionValidationErrors = { ruleName?: 'DELIVERY_REGION_NAME_ALREADY_EXISTS'; }; /** @docsIgnore */ type UpdateDeliveryRegionApplicationErrors = { code?: 'DELIVERY_PROFILE_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DESTINATIONS_COLLISION'; description?: string; data?: Record; } | { code?: 'DELIVERY_CARRIER_CANNOT_BE_UPDATED'; description?: string; data?: Record; } | { code?: 'SUBDIVISIONS_UNSUPPORTED_FOR_COUNTRY'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateDeliveryRegionValidationErrors = { ruleName?: 'DELIVERY_REGION_NAME_ALREADY_EXISTS'; }; /** @docsIgnore */ type GetDeliveryProfileByDeliveryRegionIdApplicationErrors = { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type RemoveDeliveryRegionApplicationErrors = { code?: 'DELIVERY_PROFILE_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type AddDeliveryCarrierApplicationErrors = { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'CARRIER_ALREADY_EXISTS_IN_REGION'; description?: string; data?: Record; } | { code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE'; description?: string; data?: Record; } | { code?: 'UNKNOWN_DELIVERY_CARRIER'; description?: string; data?: Record; }; /** @docsIgnore */ type AddDeliveryCarrierValidationErrors = { ruleName?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE'; }; /** @docsIgnore */ type RemoveDeliveryCarrierApplicationErrors = { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateDeliveryCarrierApplicationErrors = { code?: 'DELIVERY_REGION_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DELIVERY_CARRIER_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'UNKNOWN_DELIVERY_CARRIER'; description?: string; data?: Record; } | { code?: 'APP_ID_CANNOT_BE_UPDATED'; description?: string; data?: Record; }; /** @docsIgnore */ type ListDeliveryCarriersApplicationErrors = { code?: 'DELIVERY_CARRIER_NOT_FOUND'; description?: string; data?: Record; } | { code?: 'DELIVERY_PROFILE_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateCarrierSettingsApplicationErrors = { code?: 'DELIVERY_CARRIER_NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type SetDeliveryCarrierActiveStatusApplicationErrors = { code?: 'DELIVERY_CARRIER_NOT_FOUND'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createDeliveryProfile(): __PublicMethodMetaInfo<'POST', {}, CreateDeliveryProfileRequest$1, CreateDeliveryProfileRequest, CreateDeliveryProfileResponse$1, CreateDeliveryProfileResponse>; declare function getDeliveryProfile(): __PublicMethodMetaInfo<'GET', { deliveryProfileId: string; }, GetDeliveryProfileRequest$1, GetDeliveryProfileRequest, GetDeliveryProfileResponse$1, GetDeliveryProfileResponse>; declare function updateDeliveryProfile(): __PublicMethodMetaInfo<'PATCH', { deliveryProfileId: string; }, UpdateDeliveryProfileRequest$1, UpdateDeliveryProfileRequest, UpdateDeliveryProfileResponse$1, UpdateDeliveryProfileResponse>; declare function deleteDeliveryProfile(): __PublicMethodMetaInfo<'DELETE', { deliveryProfileId: string; }, DeleteDeliveryProfileRequest$1, DeleteDeliveryProfileRequest, DeleteDeliveryProfileResponse$1, DeleteDeliveryProfileResponse>; declare function queryDeliveryProfiles(): __PublicMethodMetaInfo<'GET', {}, QueryDeliveryProfilesRequest$1, QueryDeliveryProfilesRequest, QueryDeliveryProfilesResponse$1, QueryDeliveryProfilesResponse>; declare function addDeliveryRegion(): __PublicMethodMetaInfo<'POST', { deliveryProfileId: string; }, AddDeliveryRegionRequest$1, AddDeliveryRegionRequest, AddDeliveryRegionResponse$1, AddDeliveryRegionResponse>; declare function updateDeliveryRegion(): __PublicMethodMetaInfo<'PATCH', { deliveryProfileId: string; deliveryRegionId: string; }, UpdateDeliveryRegionRequest$1, UpdateDeliveryRegionRequest, UpdateDeliveryRegionResponse$1, UpdateDeliveryRegionResponse>; declare function getDeliveryProfileByDeliveryRegionId(): __PublicMethodMetaInfo<'GET', { deliveryRegionId: string; }, GetDeliveryProfileByDeliveryRegionIdRequest$1, GetDeliveryProfileByDeliveryRegionIdRequest, GetDeliveryProfileByDeliveryRegionIdResponse$1, GetDeliveryProfileByDeliveryRegionIdResponse>; declare function removeDeliveryRegion(): __PublicMethodMetaInfo<'DELETE', { deliveryProfileId: string; deliveryRegionId: string; }, RemoveDeliveryRegionRequest$1, RemoveDeliveryRegionRequest, RemoveDeliveryRegionResponse$1, RemoveDeliveryRegionResponse>; declare function addDeliveryCarrier(): __PublicMethodMetaInfo<'POST', {}, AddDeliveryCarrierRequest$1, AddDeliveryCarrierRequest, AddDeliveryCarrierResponse$1, AddDeliveryCarrierResponse>; declare function removeDeliveryCarrier(): __PublicMethodMetaInfo<'POST', {}, RemoveDeliveryCarrierRequest$1, RemoveDeliveryCarrierRequest, RemoveDeliveryCarrierResponse$1, RemoveDeliveryCarrierResponse>; declare function updateDeliveryCarrier(): __PublicMethodMetaInfo<'PATCH', {}, UpdateDeliveryCarrierRequest$1, UpdateDeliveryCarrierRequest, UpdateDeliveryCarrierResponse$1, UpdateDeliveryCarrierResponse>; declare function listInstalledDeliveryCarriers(): __PublicMethodMetaInfo<'GET', {}, ListInstalledDeliveryCarriersRequest$1, ListInstalledDeliveryCarriersRequest, ListInstalledDeliveryCarriersResponse$1, ListInstalledDeliveryCarriersResponse>; declare function getDeliveryDestinationProperties(): __PublicMethodMetaInfo<'GET', {}, GetDeliveryDestinationPropertiesRequest$1, GetDeliveryDestinationPropertiesRequest, GetDeliveryDestinationPropertiesResponse$1, GetDeliveryDestinationPropertiesResponse>; declare function listDeliveryCarriers(): __PublicMethodMetaInfo<'POST', { deliveryProfileId: string; }, ListDeliveryCarriersRequest$1, ListDeliveryCarriersRequest, ListDeliveryCarriersResponse$1, ListDeliveryCarriersResponse>; declare function updateCarrierSettings(): __PublicMethodMetaInfo<'POST', {}, UpdateCarrierSettingsRequest$1, UpdateCarrierSettingsRequest, UpdateCarrierSettingsResponse$1, UpdateCarrierSettingsResponse>; declare function setDeliveryCarrierActiveStatus(): __PublicMethodMetaInfo<'POST', {}, SetDeliveryCarrierActiveStatusRequest$1, SetDeliveryCarrierActiveStatusRequest, SetDeliveryCarrierActiveStatusResponse$1, SetDeliveryCarrierActiveStatusResponse>; declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', { id: string; }, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddDeliveryCarrierApplicationErrors as AddDeliveryCarrierApplicationErrorsOriginal, type AddDeliveryCarrierRequest as AddDeliveryCarrierRequestOriginal, type AddDeliveryCarrierResponse as AddDeliveryCarrierResponseOriginal, type AddDeliveryCarrierValidationErrors as AddDeliveryCarrierValidationErrorsOriginal, type AddDeliveryRegionApplicationErrors as AddDeliveryRegionApplicationErrorsOriginal, type AddDeliveryRegionRequest as AddDeliveryRegionRequestOriginal, type AddDeliveryRegionResponse as AddDeliveryRegionResponseOriginal, type AddDeliveryRegionValidationErrors as AddDeliveryRegionValidationErrorsOriginal, type AdditionalCharge as AdditionalChargeOriginal, type ApplicationError as ApplicationErrorOriginal, type Asset as AssetOriginal, type BackupRate as BackupRateOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type Column as ColumnOriginal, type CountryDeliveryProperties as CountryDeliveryPropertiesOriginal, type CreateDeliveryProfileApplicationErrors as CreateDeliveryProfileApplicationErrorsOriginal, type CreateDeliveryProfileRequest as CreateDeliveryProfileRequestOriginal, type CreateDeliveryProfileResponse as CreateDeliveryProfileResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DashboardTable as DashboardTableOriginal, type DeleteContext as DeleteContextOriginal, type DeleteDefaultDeliveryProfileRequest as DeleteDefaultDeliveryProfileRequestOriginal, type DeleteDefaultDeliveryProfileResponse as DeleteDefaultDeliveryProfileResponseOriginal, type DeleteDeliveryProfileRequest as DeleteDeliveryProfileRequestOriginal, type DeleteDeliveryProfileResponse as DeleteDeliveryProfileResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryCarrierDetails as DeliveryCarrierDetailsOriginal, type DeliveryCarrier as DeliveryCarrierOriginal, type DeliveryCarrierRegionalSettings as DeliveryCarrierRegionalSettingsOriginal, type DeliveryDestinationProperties as DeliveryDestinationPropertiesOriginal, type DeliveryProfile as DeliveryProfileOriginal, type DeliveryRegionAdded as DeliveryRegionAddedOriginal, type DeliveryRegion as DeliveryRegionOriginal, type DeliveryRegionRemoved as DeliveryRegionRemovedOriginal, type DeliveryRegionUpdated as DeliveryRegionUpdatedOriginal, type Destination as DestinationOriginal, DestinationScope as DestinationScopeOriginal, type DestinationScopeWithLiterals as DestinationScopeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetDeliveryDestinationPropertiesRequest as GetDeliveryDestinationPropertiesRequestOriginal, type GetDeliveryDestinationPropertiesResponse as GetDeliveryDestinationPropertiesResponseOriginal, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors as GetDeliveryProfileByDeliveryRegionIdApplicationErrorsOriginal, type GetDeliveryProfileByDeliveryRegionIdRequest as GetDeliveryProfileByDeliveryRegionIdRequestOriginal, type GetDeliveryProfileByDeliveryRegionIdResponse as GetDeliveryProfileByDeliveryRegionIdResponseOriginal, type GetDeliveryProfileRequest as GetDeliveryProfileRequestOriginal, type GetDeliveryProfileResponse as GetDeliveryProfileResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InstalledDeliveryCarrier as InstalledDeliveryCarrierOriginal, type ItemMetadata as ItemMetadataOriginal, type ListDeliveryCarriersApplicationErrors as ListDeliveryCarriersApplicationErrorsOriginal, type ListDeliveryCarriersRequest as ListDeliveryCarriersRequestOriginal, type ListDeliveryCarriersResponse as ListDeliveryCarriersResponseOriginal, type ListDeliveryCarriersResult as ListDeliveryCarriersResultOriginal, type ListDeliveryDestinationsRequest as ListDeliveryDestinationsRequestOriginal, type ListDeliveryDestinationsResponse as ListDeliveryDestinationsResponseOriginal, type ListInstalledDeliveryCarriersRequest as ListInstalledDeliveryCarriersRequestOriginal, type ListInstalledDeliveryCarriersResponse as ListInstalledDeliveryCarriersResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type QueryDeliveryProfilesRequest as QueryDeliveryProfilesRequestOriginal, type QueryDeliveryProfilesResponse as QueryDeliveryProfilesResponseOriginal, type RemoveDeliveryCarrierApplicationErrors as RemoveDeliveryCarrierApplicationErrorsOriginal, type RemoveDeliveryCarrierRequest as RemoveDeliveryCarrierRequestOriginal, type RemoveDeliveryCarrierResponse as RemoveDeliveryCarrierResponseOriginal, type RemoveDeliveryRegionApplicationErrors as RemoveDeliveryRegionApplicationErrorsOriginal, type RemoveDeliveryRegionRequest as RemoveDeliveryRegionRequestOriginal, type RemoveDeliveryRegionResponse as RemoveDeliveryRegionResponseOriginal, type RequiredZipcodeRequest as RequiredZipcodeRequestOriginal, type RequiredZipcodeResponse as RequiredZipcodeResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type Row as RowOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetDeliveryCarrierActiveStatusApplicationErrors as SetDeliveryCarrierActiveStatusApplicationErrorsOriginal, type SetDeliveryCarrierActiveStatusRequest as SetDeliveryCarrierActiveStatusRequestOriginal, type SetDeliveryCarrierActiveStatusResponse as SetDeliveryCarrierActiveStatusResponseOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SubdivisionDeliveryProperties as SubdivisionDeliveryPropertiesOriginal, type UpdateCarrierSettingsApplicationErrors as UpdateCarrierSettingsApplicationErrorsOriginal, type UpdateCarrierSettingsRequest as UpdateCarrierSettingsRequestOriginal, type UpdateCarrierSettingsResponse as UpdateCarrierSettingsResponseOriginal, type UpdateDeliveryCarrierApplicationErrors as UpdateDeliveryCarrierApplicationErrorsOriginal, type UpdateDeliveryCarrierRequest as UpdateDeliveryCarrierRequestOriginal, type UpdateDeliveryCarrierResponse as UpdateDeliveryCarrierResponseOriginal, type UpdateDeliveryProfileApplicationErrors as UpdateDeliveryProfileApplicationErrorsOriginal, type UpdateDeliveryProfileRequest as UpdateDeliveryProfileRequestOriginal, type UpdateDeliveryProfileResponse as UpdateDeliveryProfileResponseOriginal, type UpdateDeliveryRegionApplicationErrors as UpdateDeliveryRegionApplicationErrorsOriginal, type UpdateDeliveryRegionRequest as UpdateDeliveryRegionRequestOriginal, type UpdateDeliveryRegionResponse as UpdateDeliveryRegionResponseOriginal, type UpdateDeliveryRegionValidationErrors as UpdateDeliveryRegionValidationErrorsOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, setDeliveryCarrierActiveStatus, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };