> 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

# GetDeliveryDestinationProperties

# Package: shippingDelivery

# Namespace: DeliveryProfiles

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/get-delivery-destination-properties.md

## Permission Scopes:
Wix Multilingual - Nile Wrapper Domain Events Read: SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ

## Introduction

Retrieves delivery destination properties.


Returns properties for Rest of World, as well as aggregated country and subdivision data. Properties include whether postal codes are required and whether pickup is the only delivery option for each destination.

---

## REST API

### Schema

```
 Method: getDeliveryDestinationProperties
 Description: Retrieves delivery destination properties.   Returns properties for Rest of World, as well as aggregated country and subdivision data. Properties include whether postal codes are required and whether pickup is the only delivery option for each destination.
 URL: https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-destination-properties
 Method: GET
 Return type: GetDeliveryDestinationPropertiesResponse
  - name: restOfWorld | type: DeliveryDestinationProperties | description: Delivery destination properties for Rest of World. 
     - name: postalCodeRequired | type: boolean | description: Whether a postal code is required for delivery to this destination. 
     - name: pickupOnly | type: boolean | description: Whether only pickup is available at this destination. 
  - name: countries | type: array<CountryDeliveryProperties> | description: List of countries and their delivery destination properties. 
     - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
     - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the country. 
     - name: subdivisions | type: array<SubdivisionDeliveryProperties> | description: List of subdivisions and their delivery destination properties. 
        - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
        - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the subdivision. 


```

### Examples

### Get delivery destination properties
Retrieves delivery destination properties for all configured destinations, including postal code requirements and pickup-only settings

```curl
curl -X GET \
  'https://www.wixapis.com/ecom/v1/delivery-profiles/delivery-destination-properties' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.shippingDelivery.DeliveryProfiles.getDeliveryDestinationProperties()
 Description: Retrieves delivery destination properties.   Returns properties for Rest of World, as well as aggregated country and subdivision data. Properties include whether postal codes are required and whether pickup is the only delivery option for each destination.
 Return type: PROMISE<GetDeliveryDestinationPropertiesResponse>
  - name: restOfWorld | type: DeliveryDestinationProperties | description: Delivery destination properties for Rest of World. 
     - name: postalCodeRequired | type: boolean | description: Whether a postal code is required for delivery to this destination. 
     - name: pickupOnly | type: boolean | description: Whether only pickup is available at this destination. 
  - name: countries | type: array<CountryDeliveryProperties> | description: List of countries and their delivery destination properties. 
     - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
     - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the country. 
     - name: subdivisions | type: array<SubdivisionDeliveryProperties> | description: List of subdivisions and their delivery destination properties. 
        - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
        - name: deliveryDestinationProperties | type: DeliveryDestinationProperties | description: Delivery destination properties for the subdivision. 


```

### Examples

### Get delivery destination properties
```javascript
import { deliveryProfile } from "@wix/ecom";

async function getDeliveryDestinationProperties() {
  const response = await deliveryProfile.getDeliveryDestinationProperties();
  return response;
}

/* Promise resolves to:
 * {
 *   restOfWorld: { postalCodeRequired: true, pickupOnly: false },
 *   countries: [
 *     {
 *       country: "US",
 *       deliveryDestinationProperties: { postalCodeRequired: true, pickupOnly: false },
 *       subdivisions: [],
 *     },
 *   ],
 * }
 */

```

### getDeliveryDestinationProperties (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { deliveryProfile } from '@wix/ecom';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { deliveryProfile },
  // Include the auth strategy and host as relevant
});


async function getDeliveryDestinationProperties() {
  const response = await myWixClient.deliveryProfile.getDeliveryDestinationProperties();
};
```

---