> 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

# ListDeliveryCarriers

# Package: shippingDelivery

# Namespace: DeliveryProfiles

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

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

## Introduction

Retrieves delivery carrier settings for a delivery profile.


Returns detailed carrier configurations, including regional settings for each carrier. This method provides more comprehensive information than [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers.md).

---

## REST API

### Schema

```
 Method: listDeliveryCarriers
 Description: Retrieves delivery carrier settings for a delivery profile.   Returns detailed carrier configurations, including regional settings for each carrier. This method provides more comprehensive information than [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers.md).
 URL: https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-carriers
 Method: POST
 Method parameters:
   param name: appIds | type: array<appIds> | description: App GUIDs of the delivery carriers to retrieve settings for. 
 Return type: ListDeliveryCarriersResponse
  - name: results | type: array<ListDeliveryCarriersResult> | description: List of delivery carrier results. 
     - name: deliveryCarrierMetadata | type: ItemMetadata | description: Metadata for the result, including success or error information. 
        - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: deliveryCarrierDetails | type: DeliveryCarrierDetails | description: Delivery carrier details. 
        - 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. 
        - name: toggleUpdateCarrierActiveStatusEnabled | type: boolean | description: Whether the carrier supports updating carrier active status. 
     - name: deliveryCarrierRegionalSettings | type: array<DeliveryCarrierRegionalSettings> | description: Regional settings for the delivery carrier. 
        - name: deliveryRegionId | type: string | description: Delivery region GUID. 
        - name: dashboardTables | type: array<DashboardTable> | description: Dashboard tables with shipping configuration for this region. Multiple tables can exist if the carrier is an aggregator of multiple services. 
           - name: title | type: string | description: Table title. 
           - name: columns | type: array<Column> | description: Table columns. 
              - name: key | type: string | description: Column key, used to retrieve data from rows. 
              - name: name | type: string | description: Column display name. 
           - name: rows | type: array<Row> | description: Table rows containing the configuration data. 
              - name: key | type: string | description: Unique row identifier, used to identify the row for editing. 
              - name: data | type: object | description: Row data as a JSON object. Each key corresponds to a column key. 
              - name: active | type: boolean | description: Whether this row's configuration is active. 
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_PROFILE_NOT_FOUND | Description: Couldn't find the delivery profile.
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_CARRIER_NOT_FOUND | Description: Couldn't find the delivery carrier, or it isn't assigned to the specified delivery region.


```

### Examples

### List delivery carriers
Gets delivery carrier settings for a delivery profile and delivery region

```curl
curl -X POST \
  'https://www.wixapis.com/ecom/v1/delivery-profiles/8046df3c-7575-4098-a5ab-c91ad8f33c47/delivery-carriers' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appIds": [
      "50d8c12f-715e-41ad-be25-d0f61375dbee",
      "45c44b27-ca7b-4891-8c0d-1747d588b835"
    ]
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.shippingDelivery.DeliveryProfiles.listDeliveryCarriers(deliveryProfileId, options)
 Description: Retrieves delivery carrier settings for a delivery profile.   Returns detailed carrier configurations, including regional settings for each carrier. This method provides more comprehensive information than [List Installed Delivery Carriers](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/shipping-delivery/delivery-profiles/list-installed-delivery-carriers.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  deliveryProfileId
 Method parameters: 
   param name: deliveryProfileId | type: string | description: Delivery profile GUID. | required: true
   param name: options | type: ListDeliveryCarriersOptions  none 
        - name: appIds | type: array | description: App GUIDs of the delivery carriers to retrieve settings for. 
 Return type: PROMISE<ListDeliveryCarriersResponse>
  - name: results | type: array<ListDeliveryCarriersResult> | description: List of delivery carrier results. 
     - name: deliveryCarrierMetadata | type: ItemMetadata | description: Metadata for the result, including success or error information. 
        - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: deliveryCarrierDetails | type: DeliveryCarrierDetails | description: Delivery carrier details. 
        - 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. 
        - name: toggleUpdateCarrierActiveStatusEnabled | type: boolean | description: Whether the carrier supports updating carrier active status. 
     - name: deliveryCarrierRegionalSettings | type: array<DeliveryCarrierRegionalSettings> | description: Regional settings for the delivery carrier. 
        - name: deliveryRegionId | type: string | description: Delivery region GUID. 
        - name: dashboardTables | type: array<DashboardTable> | description: Dashboard tables with shipping configuration for this region. Multiple tables can exist if the carrier is an aggregator of multiple services. 
           - name: title | type: string | description: Table title. 
           - name: columns | type: array<Column> | description: Table columns. 
              - name: key | type: string | description: Column key, used to retrieve data from rows. 
              - name: name | type: string | description: Column display name. 
           - name: rows | type: array<Row> | description: Table rows containing the configuration data. 
              - name: key | type: string | description: Unique row identifier, used to identify the row for editing. 
              - name: data | type: object | description: Row data as a JSON object. Each key corresponds to a column key. 
              - name: active | type: boolean | description: Whether this row's configuration is active. 
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 

 Possible Errors:
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_PROFILE_NOT_FOUND | Description: Couldn't find the delivery profile.
   HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: DELIVERY_CARRIER_NOT_FOUND | Description: Couldn't find the delivery carrier, or it isn't assigned to the specified delivery region.


```

### Examples

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

async function listDeliveryCarriers() {
  const response = await deliveryProfile.listDeliveryCarriers(
    "8046df3c-7575-4098-a5ab-c91ad8f33c47",
    { appIds: ["45c44b27-ca7b-4891-8c0d-1747d588b835"] }
  );
  return response;
}

/* Promise resolves to:
 * {
 *   results: [
 *     {
 *       deliveryCarrierMetadata: {
 *         success: true,
 *         _id: "45c44b27-ca7b-4891-8c0d-1747d588b835",
 *       },
 *       deliveryCarrierDetails: {
 *         displayName: "Standard Shipping",
 *       },
 *     },
 *   ],
 * }
 */

```

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

---