> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Package: shippingDelivery

# Namespace: deliveryProfiles

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/delivery-profile-region-added.md

## Introduction

Triggered when a delivery region is added to a delivery profile.

---

## REST API

### Schema

```
Webhook: Delivery Profile Region Added
Description: Triggered when a delivery region is added to a delivery profile.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: actionEvent | type: object | description: Custom action event details.
    - name: body | type: DeliveryRegionAdded | description: The event body.
        - name: deliveryProfileId | type: string | description: GUID of the delivery profile containing the region.
        - name: deliveryRegionId | type: string | description: GUID of the added delivery region.
        - name: name | type: string | description: Delivery region name. For example, `"Domestic"`.
        - name: active | type: boolean | description: Whether the delivery region is active.
        - name: deliveryCarriers | type: array<DeliveryCarrier> | description: Delivery carriers assigned to this region.
           - name: appId | type: string | description: Carrier app GUID.  Get app GUIDs 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.md).
           - name: backupRate | type: BackupRate | description: 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.
              - name: title | type: string | description: Title displayed for the backup rate. For example, `"Standard Shipping"`.
              - name: amount | type: string | description: Backup rate amount.
              - name: active | type: boolean | description: 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`
           - name: additionalCharges | type: array<AdditionalCharge> | description: 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.
              - name: description | type: string | description: Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
              - name: amount | type: string | description: Additional fixed charge amount to add to the delivery rate. For example, `"12.50"`.
        - name: destinations | type: array<Destination> | description: Geographic destinations covered by this region.
           - name: countryCode | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
           - name: subdivisions | type: array | description: 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`.
        - name: createdDate | type: string | description: Date and time the delivery region was created.

```

---

## JavaScript SDK

### Schema

```
Webhook: onDeliveryProfileRegionAdded
Description: Triggered when a delivery region is added to a delivery profile.
Payload: DeliveryProfileRegionAddedEnvelope
  - name: data | type: DeliveryRegionAdded | description: none
     - name: deliveryProfileId | type: string | description: GUID of the delivery profile containing the region.
     - name: deliveryRegionId | type: string | description: GUID of the added delivery region.
     - name: name | type: string | description: Delivery region name. For example, `"Domestic"`.
     - name: active | type: boolean | description: Whether the delivery region is active.
     - name: deliveryCarriers | type: array<DeliveryCarrier> | description: Delivery carriers assigned to this region.
        - name: appId | type: string | description: Carrier app GUID.  Get app GUIDs 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.md).
        - name: backupRate | type: BackupRate | description: 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.
           - name: title | type: string | description: Title displayed for the backup rate. For example, `"Standard Shipping"`.
           - name: amount | type: string | description: Backup rate amount.
           - name: active | type: boolean | description: 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`
        - name: additionalCharges | type: array<AdditionalCharge> | description: 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.
           - name: description | type: string | description: Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
           - name: amount | type: string | description: Additional fixed charge amount to add to the delivery rate. For example, `"12.50"`.
     - name: destinations | type: array<Destination> | description: Geographic destinations covered by this region.
        - name: countryCode | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
        - name: subdivisions | type: array | description: 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`.
     - name: _createdDate | type: Date | description: Date and time the delivery region was created.
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: 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`.
     - name: slug | type: string | description: 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`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: 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.

```

### Examples


```javascript
import { deliveryProfile } from '@wix/ecom';

deliveryProfile.onDeliveryProfileRegionAdded((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { deliveryProfile } from '@wix/ecom';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      deliveryProfile,
    },
});

wixClient.deliveryProfile.onDeliveryProfileRegionAdded((event) => {
    // handle your event here
});
```

---