Edit in GitHubLog an issue

Restricting access to anonymous web APIs

Adobe Commerce allows some web APIs to be accessed by unauthenticated (anonymous) users. Many of these APIs allow a customer to have a robust shopping experience on the website without having to log in.

A subset of these APIs can return information about products, promotions, and storefronts that a merchant might consider proprietary. For example, Catalog module APIs can provide information about an item's pricing and quantity, as well as items that are currently not for sale. The CMS module could reveal information about upcoming promotional landing pages and coupons. The Store module can reveal too much information about individual websites.

For this reason, by default, Commerce now prevents anonymous users from accessing the APIs that could reveal sensitive information. When the feature is enabled, the user must have administrator privileges to execute the affected APIs.

The following table lists the APIs that are no longer available to an anonymous user by default:

ProductModuleAPIAction
Open Source
Catalog
/V1/products
GET
Open Source
Catalog
/V1/products/:sku
GET
Open Source
Catalog
/V1/products/attributes/:attributeCode
GET
Open Source
Catalog
/V1/products/types
GET
Open Source
Catalog
/V1/products/attribute-sets/sets/list
GET
Open Source
Catalog
/V1/products/attribute-sets/:attributeSetId
GET
Open Source
Catalog
/V1/products/attribute-sets/:attributeSetId/attributes
GET
Open Source
Catalog
/V1/products/attribute-sets/groups/list
GET
Open Source
Catalog
/V1/products/attributes/:attributeCode/options
GET
Open Source
Catalog
/V1/products/media/types/:attributeSetName
GET
Open Source
Catalog
/V1/products/:sku/media/:entryId
GET
Open Source
Catalog
/V1/products/:sku/media
GET
Open Source
Catalog
/V1/products/:sku/group-prices/:customerGroupId/tiers
GET
Open Source
Catalog
/V1/categories/:categoryId
GET
Open Source
Catalog
/V1/categories
GET
Open Source
Catalog
/V1/products/:sku/options
GET
Open Source
Catalog
/V1/products/:sku/options/:optionId
GET
Open Source
Catalog
/V1/products/links/types
GET
Open Source
Catalog
/V1/products/links/:type/attributes
GET
Open Source
Catalog
/V1/products/:sku/links/:type
GET
Open Source
Catalog
/V1/categories/:categoryId/products
GET
Open Source
CatalogInventory
/V1/stockStatuses/:productSku
GET
Open Source
Cms
/V1/cmsPage/:pageId
GET
Open Source
Cms
/V1/cmsBlock/:blockId
GET
Open Source
ConfigurableProduct
/V1/configurable-products/:sku/children
GET
Open Source
ConfigurableProduct
/V1/configurable-products/:sku/options/:id
GET
Open Source
ConfigurableProduct
/V1/configurable-products/:sku/options/all
GET
Open Source
Store
/V1/store/storeViews
GET
Open Source
Store
/V1/store/storeGroups
GET
Open Source
Store
/V1/store/websites
GET
Open Source
Store
/V1/store/storeConfigs
GET

If the list of APIs that are inaccessible to anonymous users must be updated for a third-party extension, an integrator can add to their extension's di.xml file to update or replace the functionality defined in the WebapiSecurity module.

The following APIs remain accessible to anonymous users. Most of these must remain accessible to support the checkout and add-to-cart Ajax functionalities.

ProductModuleAPIAction
Open Source
Catalog
/V1/products-render-info
GET
Open Source
Checkout
/V1/guest-carts/:cartId/payment-information
POST
Open Source
Checkout
/V1/guest-carts/:cartId/payment-information
GET
Open Source
Checkout
/V1/guest-carts/:cartId/set-payment-information
POST
Open Source
Checkout
/V1/guest-carts/:cartId/shipping-information
POST
Open Source
Checkout
/V1/guest-carts/:cartId/totals-information
POST
Open Source
Customer
/V1/customers
POST
Open Source
Customer
/V1/customers/:customerId/password/resetLinkToken/:resetPasswordLinkToken
GET
Open Source
Customer
/V1/customers/password
PUT
Open Source
Customer
/V1/customers/resetPassword
POST
Open Source
Customer
/V1/customers/isEmailAvailable
POST
Open Source
Directory
/V1/directory/countries
GET
Open Source
Directory
/V1/directory/countries/:countryId
GET
Open Source
Directory
/V1/directory/currency
GET
Open Source
GiftMessage
/V1/guest-carts/:cartId/gift-message
GET
Open Source
GiftMessage
/V1/guest-carts/:cartId/gift-message
POST
Open Source
GiftMessage
/V1/guest-carts/:cartId/gift-message/:itemId
GET
Open Source
GiftMessage
/V1/guest-carts/:cartId/gift-message/:itemId
POST
Open Source
Integration
/V1/integration/admin/token
POST
Open Source
Integration
/V1/integration/customer/token
POST
Open Source
Quote
/V1/guest-carts/:cartId/billing-address
GET
Open Source
Quote
/V1/guest-carts/:cartId/billing-address
POST
Open Source
Quote
/V1/guest-carts/:cartId/items
GET
Open Source
Quote
/V1/guest-carts/:cartId/items
POST
Open Source
Quote
/V1/guest-carts/:cartId/items/:itemId
PUT
Open Source
Quote
/V1/guest-carts/:cartId/items/:itemId
DELETE
Open Source
Quote
/V1/guest-carts
POST
Open Source
Quote
/V1/guest-carts/:cartId/order
PUT
Open Source
Quote
/V1/guest-carts/:cartId
GET
Open Source
Quote
/V1/guest-carts/:cartId/collect-totals
PUT
Open Source
Quote
/V1/guest-carts/:cartId/totals
GET
Open Source
Quote
/V1/guest-carts/:cartId/coupons
GET
Open Source
Quote
/V1/guest-carts/:cartId/coupons/:couponCode
PUT
Open Source
Quote
/V1/guest-carts/:cartId/coupons
DELETE
Open Source
Quote
/V1/guest-carts/:cartId/selected-payment-method
GET
Open Source
Quote
/V1/guest-carts/:cartId/selected-payment-method
PUT
Open Source
Quote
/V1/guest-carts/:cartId/payment-methods
GET
Open Source
Quote
/V1/guest-carts/:cartId/estimate-shipping-methods
POST
Open Source
Quote
/V1/guest-carts/:cartId/shipping-methods
GET
Open Source
Search
/V1/search
GET
Commerce
GiftCardAccount
/V1/carts/guest-carts/:cartId/giftCards/:giftCardCode
DELETE
Commerce
GiftCardAccount
/V1/carts/guest-carts/:cartId/giftCards
POST
Commerce
GiftCardAccount
/V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode
GET
Commerce
GiftRegistry
/V1/guest-giftregistry/:cartId/estimate-shipping-methods
POST
Commerce
WorldPay
/V1/worldpay-guest-carts/:cartId/payment-information
POST
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.