---
schema_version: "1"
id: 4d7e7f327a42d69bbf3bf27858a142d91fe0087c835f095fd9ab99354b2a9846
title: Class ShopperConsentMgr
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/commerce-cloud/script-api/references/current/dw.customer.consent.ShopperConsentMgr.md
canonical_url: https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ShopperConsentMgr.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6438ffb43b210cc350239dd72edc97ee725bd6488d3e58ed7513f6cec77edbdc
products:
  - B2C Commerce
  - Salesforce APIs
---
<!-- prettier-ignore-start -->
# Class ShopperConsentMgr

- [TopLevel.Object](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [dw.customer.consent.ShopperConsentMgr](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ShopperConsentMgr.md)

Provides static helper methods for managing shopper marketing consent subscriptions.


This API enables retrieving and updating marketing consent preferences.
Consent subscriptions define communication categories (e.g., "Newsletter", "Product Updates")
and the channels (EMAIL, SMS, WHATSAPP) through which marketing communications can be sent.




**Prerequisites:**

- The Marketing Consent feature must be enabled and configured
- For consent status retrieval, the current request must have a customer context





**Example usage:**

```
var ShopperConsentMgr = require('dw/customer/consent/ShopperConsentMgr');

// Get all subscriptions for the current site
var subscriptions = ShopperConsentMgr.getSubscriptions();

for each (var sub in subscriptions) {
    trace('Subscription: ' + sub.subscriptionId + ' - ' + sub.title);
    trace('Available channels: ' + sub.channels.join(', '));
}

// Get subscriptions with consent status (for authenticated customers)
var subsWithStatus = ShopperConsentMgr.getSubscriptions(null, true);

// Update consent for a specific subscription
ShopperConsentMgr.updateSubscription(
    'customer@example.com',
    'newsletter-subscription',
    'EMAIL',
    'OPT_IN'
);
```


**See Also:**
- [MarketingConsentSubscription](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.MarketingConsentSubscription.md)
- [ConsentStatusEntry](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ConsentStatusEntry.md)


## Property Summary

| Property | Description |
| --- | --- |
| [subscriptions](#subscriptions): [Collection](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) `(read-only)` | Retrieves marketing consent subscriptions for the current site. |

## Constructor Summary

This class does not have a constructor, so you cannot create it directly.
## Method Summary

| Method | Description |
| --- | --- |
| static [getSubscriptions](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ShopperConsentMgr.md#getsubscriptions)() | Retrieves marketing consent subscriptions for the current site. |
| static [getSubscriptions](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ShopperConsentMgr.md#getsubscriptionslist-boolean)([List](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.List.md), [Boolean](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)) | Retrieves marketing consent subscriptions for the current site with optional filtering and status. |
| static [updateSubscription](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.ShopperConsentMgr.md#updatesubscriptionstring-string-string-string)([String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Updates consent status for a subscription. |

### Methods inherited from class Object

[assign](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)
## Property Details

### subscriptions
- subscriptions: [Collection](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) `(read-only)`
  - : Retrieves marketing consent subscriptions for the current site.
      
      
      This method returns all available consent subscriptions without consent status information.



---

## Method Details

### getSubscriptions()
- static getSubscriptions(): [Collection](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md)
  - : Retrieves marketing consent subscriptions for the current site.
      
      
      This method returns all available consent subscriptions without consent status information.


    **Returns:**
    - A collection of [MarketingConsentSubscription](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.MarketingConsentSubscription.md) objects.

    **Throws:**
    - ShopperConsentException - if the consent feature is not enabled or retrieval fails.


---

### getSubscriptions(List, Boolean)
- static getSubscriptions(tags: [List](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.List.md), includeConsentStatus: [Boolean](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md)): [Collection](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md)
  - : Retrieves marketing consent subscriptions for the current site with optional filtering and status.
      
      
      Use this method to retrieve subscriptions filtered by tags and optionally include
      the current consent status for authenticated customers.


    **Parameters:**
    - tags - Optional list of tags to filter subscriptions. Pass null for all subscriptions.
    - includeConsentStatus - If true, includes the current consent status for each subscription.                              Requires a customer context.

    **Returns:**
    - A collection of [MarketingConsentSubscription](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.consent.MarketingConsentSubscription.md) objects.

    **Throws:**
    - ShopperConsentException - if the consent feature is not enabled, retrieval fails,                                  or consent status retrieval fails.


---

### updateSubscription(String, String, String, String)
- static updateSubscription(contactPointValue: [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), subscriptionId: [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), channel: [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md), status: [String](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): void
  - : Updates consent status for a subscription.
      
      
      This method updates the consent status in Salesforce Core for the specified
      contact point and subscription channel combination.


    **Parameters:**
    - contactPointValue - The contact point value (email address or phone number).
    - subscriptionId - The subscription ID.
    - channel - The channel type ("EMAIL", "SMS", or "WHATSAPP").
    - status - The consent status ("OPT\_IN" or "OPT\_OUT").

    **Throws:**
    - ShopperConsentException - if the consent feature is not enabled or update fails.


---

<!-- prettier-ignore-end -->