> 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

# ListInstalledDeliveryCarriers

# Package: shippingDelivery

# Namespace: DeliveryProfiles

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers.md

## Permission Scopes:
Read eCommerce - all read permissions: SCOPE.DC-ECOM-MEGA.READ-ECOM

## Introduction

Retrieves a list of all delivery carriers installed on a site.


Use this method to discover available carriers before adding them to delivery regions.

---

## REST API

### Schema

```
 Method: listInstalledDeliveryCarriers
 Description: Retrieves a list of all delivery carriers installed on a site.   Use this method to discover available carriers before adding them to delivery regions.
 URL: https://www.wixapis.com/ecom/v1/delivery-profiles/installed-carriers
 Method: GET
 Return type: ListInstalledDeliveryCarriersResponse
  - name: installedDeliveryCarriers | type: array<InstalledDeliveryCarrier> | description: List of installed delivery carriers on the site. 
     - name: id | type: string | description: Carrier app GUID. 
     - name: displayName | type: string | description: Carrier display name. 
     - name: description | type: string | description: Carrier description. 
     - name: learnMoreUrl | type: string | description: URL to learn more about the carrier. 
     - name: dashboardUrl | type: string | description: URL to the carrier's dashboard. 
     - name: fallbackDefinitionMandatory | type: boolean | description: Whether a backup rate is required for this carrier. 
     - name: thumbnailUrl | type: string | description: URL for the carrier's thumbnail image. 
     - name: toggleGetCarrierSettingsEnabled | type: boolean | description: Whether the carrier supports retrieving carrier settings. 


```

### Examples

### List installed delivery carriers
Retrieves a list of installed delivery carriers

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

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.shippingDelivery.DeliveryProfiles.listInstalledDeliveryCarriers()
 Description: Retrieves a list of all delivery carriers installed on a site.   Use this method to discover available carriers before adding them to delivery regions.
 Return type: PROMISE<ListInstalledDeliveryCarriersResponse>
  - name: installedDeliveryCarriers | type: array<InstalledDeliveryCarrier> | description: List of installed delivery carriers on the site. 
     - name: _id | type: string | description: Carrier app GUID. 
     - name: displayName | type: string | description: Carrier display name. 
     - name: description | type: string | description: Carrier description. 
     - name: learnMoreUrl | type: string | description: URL to learn more about the carrier. 
     - name: dashboardUrl | type: string | description: URL to the carrier's dashboard. 
     - name: fallbackDefinitionMandatory | type: boolean | description: Whether a backup rate is required for this carrier. 
     - name: thumbnailUrl | type: string | description: URL for the carrier's thumbnail image. 
     - name: toggleGetCarrierSettingsEnabled | type: boolean | description: Whether the carrier supports retrieving carrier settings. 


```

### Examples

### List installed delivery carriers
```javascript
import { deliveryProfile } from "@wix/ecom";

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

/* Promise resolves to:
 * {
 *   installedCarriers: [
 *     {
 *       appId: "45c44b27-ca7b-4891-8c0d-1747d588b835",
 *       name: "Standard Shipping",
 *       ...
 *     },
 *   ],
 * }
 */

```

### listInstalledDeliveryCarriers (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 listInstalledDeliveryCarriers() {
  const response = await myWixClient.deliveryProfile.listInstalledDeliveryCarriers();
};
```

---