Authorization Scopes Catalog
Scopes control which B2C Commerce endpoints a token can access. They provide use case specific permissions which cover multiple endpoints.
Scopes are formatted as sfcc.{{family}}[.rw]. The optional .rw suffix indicates read and write permissions.
For usage information, see Authorization for Shopper APIs and Authorization for Admin APIs.
To use scopes with Custom APIs, see Custom API Authentication and Authorization.
| Scope | API Family | API Name | Purpose |
|---|---|---|---|
| sfcc.catalogs | Product | Catalogs | Read catalog information. |
| sfcc.catalogs.rw | Product | Catalogs | Update, delete, and create catalogs. |
| sfcc.cdn-zones | CDN Zones | CDN Zones | Read information related to CDN Zones. |
| sfcc.cdn-zones.rw | CDN Zones | CDN Zones | Create, read, update, and delete information related to CDN Zones. |
| sfcc.customerlists | Customer | Customers | Read customer list associated with a site. |
| sfcc.customerlists.rw | Customer | Customers | Create, read, update, and delete customer lists associated with a site. |
| sfcc.gift-certificates | Pricing | Gift Certificates | View gift certificates. |
| sfcc.gift-certificates.rw | Pricing | Gift Certificates | Create, update, or delete gift certificates. |
| sfcc.inventory.availability | Inventory | Inventory Availability |
|
| sfcc.inventory.availability.rw | Inventory | Inventory Availabilit |
|
| sfcc.inventory.impex-graphs | Inventory | Inventory Impex |
|
| sfcc.inventory.impex-inventory | Inventory | Inventory Impex |
|
| sfcc.inventory.impex-inventory.rw | Inventory | Inventory Impex |
|
| sfcc.inventory.reservations | Inventory | Inventory Reservation |
|
| sfcc.inventory.reservations.rw | Inventory | Inventory Reservation |
|
| sfcc.orders | Checkout | Orders | List and view orders from a management perspective. |
| sfcc.orders.rw | Checkout | Orders | Update an existing order, for example, with a status update. |
| sfcc.preferences | Configuration | Preferences | Retrieve site and environment-specific settings. |
| sfcc.cors-preferences.rw | Configuration | CORS | Managed Cross-Origin Resource Sharing (CORS) preferences. |
| sfcc.products | Product | Products | Read products assigned to a catalog. |
| sfcc.products.rw | Product | Products | Create, read, update, and delete products from a catalog. |
| sfcc.promotions | Pricing | Promotions | View assignments. |
| sfcc.promotions | Pricing | Promotions | View campaigns. |
| sfcc.promotions | Pricing | Promotions | View coupons. |
| sfcc.promotions | Pricing | Promotions | View promotions. |
| sfcc.promotions.rw | Pricing | Promotions | Create, update, or delete assignments. |
| sfcc.promotions.rw | Pricing | Promotions | Create, update, or delete campaigns. |
| sfcc.promotions.rw | Pricing | Promotions | Create, update, or delete coupons. |
| sfcc.promotions.rw | Pricing | Promotions | Create, update, or delete promotions. |
| sfcc.pwdless_login | Shopper | Shopper Login | Allow users with an eCom profile to request a token by email that can be used to log in without a password even when their identity provider (Salesforce) is unavailable. |
| sfcc.session_bridge | Shopper | Shopper Login | Allow session bridging. |
| sfcc.shopper-baskets-orders | Checkout | Shopper Baskets | View only baskets and orders from an end-user perspective (shopper). |
| sfcc.shopper-baskets-orders.rw | Checkout | Shopper Baskets | Allow the client app to update an order, with additional information such as shipping or tax information. |
| sfcc.shopper-categories | Product | Shopper Products | Read categories to be displayed on a storefront for shoppers. |
| sfcc.shopper-context.rw | Shopper | Shopper Context | Manager Shopper Context. |
| sfcc.shopper-custom-objects.{object-type} | Custom Object | Shopper Custom Objects | View custom object information. Access can be restricted at the {object-type} level. This extends the standard objects provided by B2C Commerce. |
| sfcc.shopper-customers.login | Customer | Shopper Customers | Log in a shopper. |
| sfcc.shopper-customers.register | Customer | Shopper Customers | Register a shopper. |
| sfcc.shopper-experience | Experience | Shopper Experience | Read pages created in Page Designer. |
| sfcc.shopper-gift-certificates | Pricing | Shopper Gift Certificates | View gift certificates from a shopper perspective. |
| sfcc.shopper-myaccount | Customer | Shopper Customers | Read all data in a shopper account. |
| sfcc.shopper-myaccount.addresses | Customer | Shopper Customers | Read shopper addresses. |
| sfcc.shopper-myaccount.addresses.rw | Customer | Shopper Customers | Create, read, update, and delete addresses in a shopper account. |
| sfcc.shopper-myaccount.baskets | Customer | Shopper Customers | Read a shopper’s baskets. |
| sfcc.shopper-myaccount.orders | Customer | Shopper Customers | Read a shopper’s orders. |
| sfcc.shopper-myaccount.paymentinstruments | Customer | Shopper Customers | Read a shopper’s payment instruments. |
| sfcc.shopper-myaccount.paymentinstruments.rw | Customer | Shopper Customers | Create, read, update, and delete payment instruments in a shopper account. |
| sfcc.shopper-myaccount.productlists | Customer | Shopper Customers | Read wishlists associated with a shopper account. |
| sfcc.shopper-myaccount.productlists.rw | Customer | Shopper Customers | Create, read, update, and delete wishlists associated with a shopper account. |
| sfcc.shopper-myaccount.rw | Customer | Shopper Customers | Create, read, update, and delete all data in a shopper account. |
| sfcc.shopper-product-search | Search | Shopper Search | Enables search for products and product suggestions. |
| sfcc.shopper-productlists | Customer | Shopper Customers | Read public product lists or wishlists. |
| sfcc.shopper-products | Product | Shopper Products | Read products merchandized and available to be sold on a particular site. |
| sfcc.shopper-promotions | Pricing | Shopper Promotions | View promotions from a shopper perspective. |
| sfcc.shopper-seo | Site | Shopper SEO | View SEO-related information. |
| sfcc.shopper-stores | Store | Shopper Stores | Enables you to search for, and obtain details on stores. |
| sfcc.source-codes | Pricing | Source Code Groups | View source codes. |
| sfcc.source-codes.rw | Pricing | Source Code Groups | Create, update, or delete source codes. |
| sfcc.ta_ext_on_behalf_of | Shopper | Shopper Login | Call trusted agent endpoints. |
| sfcc.ts_ext_on_behalf_of | Shopper | Shopper Login | Call trusted system endpoints. |
Here's an example set of scopes required for a shopping application (like a PWA Kit storefront):