| sfcc.analytics | Intelligence | Analytics | Access analytics subject areas, metadata, and query operations. | GET /subject-areas (getSubjectAreas)
GET /subject-areas/{subjectAreaId} (getSubjectAreaById)
POST /query/{subjectAreaId} (querySubjectArea) |
| sfcc.catalogs | Product | Catalogs | Read catalog information. | GET /catalogs (getCatalogs)
GET /catalogs/{catalogId} (getCatalog)
GET /catalogs/{catalogId}/categories (getCategoriesFromCatalog)
GET /catalogs/{catalogId}/categories/{categoryId} (getCategoryFromCatalog)
POST /catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-search (searchProductsAssignedToCategory)
GET /catalogs/{catalogId}/categories/{categoryId}/products/{productId} (getAssignedProductFromCategory)
GET /catalogs/{catalogId}/categories/{categoryId}/rules-execution (getCategorizationStatus)
GET /catalogs/{catalogId}/categories/{categoryId}/excluded-products (getExclusionList)
GET /catalogs/{catalogId}/categories/{categoryId}/rules (getCategoryRules)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId} (getRuleById)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions (getCategoryRuleConditions)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId} (getCategoryRuleCondition)
POST /catalogs/{catalogId}/category-search (searchCategoriesInCatalog)
POST /catalog-search (searchCatalogs)
POST /category-search (searchCategories) |
| sfcc.catalogs.rw | Product | Catalogs | Create, read, update, and delete catalogs. | GET /catalogs (getCatalogs)
GET /catalogs/{catalogId} (getCatalog)
PATCH /catalogs/{catalogId} (updateCatalog)
GET /catalogs/{catalogId}/categories (getCategoriesFromCatalog)
GET /catalogs/{catalogId}/categories/{categoryId} (getCategoryFromCatalog)
PUT /catalogs/{catalogId}/categories/{categoryId} (createCategoryInCatalog)
DELETE /catalogs/{catalogId}/categories/{categoryId} (deleteCategoryFromCatalog)
PATCH /catalogs/{catalogId}/categories/{categoryId} (updateCategoryInCatalog)
POST /catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-search (searchProductsAssignedToCategory)
GET /catalogs/{catalogId}/categories/{categoryId}/products/{productId} (getAssignedProductFromCategory)
PUT /catalogs/{catalogId}/categories/{categoryId}/products/{productId} (assignProductToCategory)
DELETE /catalogs/{catalogId}/categories/{categoryId}/products/{productId} (unassignProductFromCategory)
PATCH /catalogs/{catalogId}/categories/{categoryId}/products/{productId} (updateProductCategoryAssignment)
GET /catalogs/{catalogId}/categories/{categoryId}/rules-execution (getCategorizationStatus)
POST /catalogs/{catalogId}/categories/{categoryId}/rules-execution (runCategoryRules)
GET /catalogs/{catalogId}/categories/{categoryId}/excluded-products (getExclusionList)
POST /catalogs/{catalogId}/categories/{categoryId}/excluded-products (addProductsToExclusionList)
DELETE /catalogs/{catalogId}/categories/{categoryId}/excluded-products (removeProductsFromExclusionList)
GET /catalogs/{catalogId}/categories/{categoryId}/rules (getCategoryRules)
POST /catalogs/{catalogId}/categories/{categoryId}/rules (createCategoryRules)
DELETE /catalogs/{catalogId}/categories/{categoryId}/rules (deleteCategoryRules)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId} (getRuleById)
PUT /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId} (createUpdateRule)
DELETE /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId} (deleteRule)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions (getCategoryRuleConditions)
DELETE /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions (deleteCategoryRuleConditions)
GET /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId} (getCategoryRuleCondition)
PUT /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId} (createOrUpdateCategoryRuleCondition)
DELETE /catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions/{conditionId} (deleteCategoryRuleCondition)
POST /catalogs/{catalogId}/category-search (searchCategoriesInCatalog)
POST /catalog-search (searchCatalogs)
POST /category-search (searchCategories) |
| sfcc.cdn-zones | CDN Zones | CDN Zones | Read information related to CDN Zones. | GET /mtls/code-upload-certificates (getCodeUploadCertificates)
GET /mtls/code-upload-certificates/{mtlsCertificateId} (getCodeUploadCertificate)
GET /page-shield/notifications (getPageShieldNotification)
GET /zones/{zoneId}/page-shield/policies (getPageShieldPolicies)
GET /zones/{zoneId}/page-shield/policies/{policyId} (getPageShieldPolicy)
GET /zones/{zoneId}/page-shield/scripts (getPageShieldScripts)
GET /zones/{zoneId}/page-shield/scripts/{scriptId} (getPageShieldScript)
GET /zones/info (getZonesInfo)
GET /zones/{zoneId}/waf/groups (getWafGroups)
GET /zones/{zoneId}/waf/rules (getWafRules)
GET /zones/{zoneId}/waf/rules/{ruleId} (getWafRule)
GET /zones/{zoneId}/speed-settings (getSpeedSettings)
GET /zones/{zoneId}/security-settings (getSecuritySettings)
GET /zones/{zoneId}/certificates (getCertificates)
GET /zones/{zoneId}/mrtrules (getMrtRules)
GET /zones/{zoneId}/logpush/jobs (listLogpushJob)
GET /zones/{zoneId}/logpush/jobs/{jobId} (getLogpushJob)
GET /zones/{zoneId}/firewall/waf/packages/owasp (getOwaspWafPackage)
GET /zones/{zoneId}/firewall-custom/rules (getCustomRules)
GET /zones/{zoneId}/firewall-custom/rules/{ruleId} (getCustomRule)
GET /zones/{zoneId}/rate-limiting/rules (getRateLimitingRules)
GET /zones/{zoneId}/rate-limiting/rules/{ruleId} (getRateLimitingRule)
GET /zones/{zoneId}/firewall-managed/rulesets (getWafManagedRulesets)
GET /zones/{zoneId}/firewall-managed/rulesets/{rulesetId}/rules (getWafManagedRulesInRuleset)
GET /zones/{zoneId}/origin-header-modification/{type} (getOriginHeaderModification)
GET /zones/{zoneId}/settings/ciphers (getCipherSuites)
GET /webhook (getWebhooks)
GET /webhook/{webhookId} (getWebhook)
GET /zones/{zoneId}/cache/rules (getCacheRules) |
| sfcc.cdn-zones.rw | CDN Zones | CDN Zones | Create, read, update, and delete information related to CDN Zones. | POST /storefront-zones (createStorefrontZone)
GET /mtls/code-upload-certificates (getCodeUploadCertificates)
POST /mtls/code-upload-certificates (createCodeUploadCertificate)
GET /mtls/code-upload-certificates/{mtlsCertificateId} (getCodeUploadCertificate)
DELETE /mtls/code-upload-certificates/{mtlsCertificateId} (deleteCodeUploadCertificate)
GET /page-shield/notifications (getPageShieldNotification)
POST /page-shield/notifications (postPageShieldNotification)
DELETE /page-shield/notifications/{webhookId} (deletePageShieldNotification)
GET /zones/{zoneId}/page-shield/policies (getPageShieldPolicies)
POST /zones/{zoneId}/page-shield/policies (createPageShieldPolicy)
GET /zones/{zoneId}/page-shield/policies/{policyId} (getPageShieldPolicy)
PUT /zones/{zoneId}/page-shield/policies/{policyId} (updatePageShieldPolicy)
DELETE /zones/{zoneId}/page-shield/policies/{policyId} (deletePageShieldPolicy)
GET /zones/{zoneId}/page-shield/scripts (getPageShieldScripts)
GET /zones/{zoneId}/page-shield/scripts/{scriptId} (getPageShieldScript)
GET /zones/info (getZonesInfo)
GET /zones/{zoneId}/waf/groups (getWafGroups)
PUT /zones/{zoneId}/waf/groups/{groupId} (updateWafGroup)
GET /zones/{zoneId}/waf/rules (getWafRules)
GET /zones/{zoneId}/waf/rules/{ruleId} (getWafRule)
PUT /zones/{zoneId}/waf/rules/{ruleId} (updateWafRule)
GET /zones/{zoneId}/speed-settings (getSpeedSettings)
PATCH /zones/{zoneId}/speed-settings (updateSpeedSettings)
GET /zones/{zoneId}/security-settings (getSecuritySettings)
PATCH /zones/{zoneId}/security-settings (updateSecuritySettings)
POST /zones/{zoneId}/cachepurge (cachePurge)
PATCH /zones/{zoneId}/ocapicachingpagerule (toggleOcapiCachingPageRule)
GET /zones/{zoneId}/certificates (getCertificates)
POST /zones/{zoneId}/certificates (addCertificateForZone)
DELETE /zones/{zoneId}/certificates/{certificateId} (deleteCertificate)
PATCH /zones/{zoneId}/certificates/{certificateId} (updateCertificate)
PATCH /zones/{zoneId}/certificates/custom-hostnames/{customHostnameId} (validateCustomHostname)
GET /zones/{zoneId}/mrtrules (getMrtRules)
POST /zones/{zoneId}/mrtrules (createMrtRules)
PATCH /zones/{zoneId}/mrtrules (updateMrtRuleset)
DELETE /zones/{zoneId}/mrtrules/{rulesetId} (deleteMrtRuleset)
DELETE /zones/{zoneId}/mrtrules/{rulesetId}/rules/{ruleId} (deleteMrtRule)
PATCH /zones/{zoneId}/mrtrules/{rulesetId}/rules/{ruleId} (updateMrtRule)
POST /zones/{zoneId}/logpush/ownership (createLogpushOwnership)
GET /zones/{zoneId}/logpush/jobs (listLogpushJob)
POST /zones/{zoneId}/logpush/jobs (createLogpushJob)
GET /zones/{zoneId}/logpush/jobs/{jobId} (getLogpushJob)
PUT /zones/{zoneId}/logpush/jobs/{jobId} (updateLogpushJob)
DELETE /zones/{zoneId}/logpush/jobs/{jobId} (deleteLogpushJob)
GET /zones/{zoneId}/firewall/waf/packages/owasp (getOwaspWafPackage)
PATCH /zones/{zoneId}/firewall/waf/packages/owasp (patchOwaspWafPackage)
GET /zones/{zoneId}/firewall-custom/rules (getCustomRules)
POST /zones/{zoneId}/firewall-custom/rules (createCustomRule)
PATCH /zones/{zoneId}/firewall-custom/rules (updateOrderOfCustomRules)
GET /zones/{zoneId}/firewall-custom/rules/{ruleId} (getCustomRule)
DELETE /zones/{zoneId}/firewall-custom/rules/{ruleId} (deleteCustomRule)
PATCH /zones/{zoneId}/firewall-custom/rules/{ruleId} (updateCustomRule)
GET /zones/{zoneId}/rate-limiting/rules (getRateLimitingRules)
POST /zones/{zoneId}/rate-limiting/rules (createRateLimitingRule)
GET /zones/{zoneId}/rate-limiting/rules/{ruleId} (getRateLimitingRule)
DELETE /zones/{zoneId}/rate-limiting/rules/{ruleId} (deleteRateLimitingRule)
PATCH /zones/{zoneId}/rate-limiting/rules/{ruleId} (updateRateLimitingRule)
GET /zones/{zoneId}/firewall-managed/rulesets (getWafManagedRulesets)
PATCH /zones/{zoneId}/firewall-managed/rulesets/{rulesetId} (updateWafManagedRuleset)
GET /zones/{zoneId}/firewall-managed/rulesets/{rulesetId}/rules (getWafManagedRulesInRuleset)
PATCH /zones/{zoneId}/firewall-managed/rulesets/{rulesetId}/rules/{ruleId} (updateWafManagedRuleInRuleset)
PUT /zones/{zoneId}/firewall-managed/migration (migrateZoneToWafV2)
GET /zones/{zoneId}/origin-header-modification/{type} (getOriginHeaderModification)
PUT /zones/{zoneId}/origin-header-modification/{type} (upsertOriginHeaderModification)
DELETE /zones/{zoneId}/origin-header-modification/{type} (deleteOriginHeaderModification)
GET /zones/{zoneId}/settings/ciphers (getCipherSuites)
PATCH /zones/{zoneId}/settings/ciphers (updateCipherSuites)
PATCH /page-shield/notifications/{webhookId} (updatePageShieldNotification)
GET /webhook (getWebhooks)
POST /webhook (createWebhook)
GET /webhook/{webhookId} (getWebhook)
PUT /webhook/{webhookId} (updateWebhook)
DELETE /webhook/{webhookId} (deleteWebhook)
GET /zones/{zoneId}/cache/rules (getCacheRules)
POST /zones/{zoneId}/cache/rules (createCacheRule)
PATCH /zones/{zoneId}/cache/rules/{ruleId} (updateCacheRule)
DELETE /zones/{zoneId}/cache/rules/{ruleId} (deleteCacheRule)
GET /turnstile/widgets (listTurnstileWidgets)
POST /turnstile/widgets (createTurnstileWidget)
GET /turnstile/widgets/{sitekey} (getTurnstileWidget)
PUT /turnstile/widgets/{sitekey} (updateTurnstileWidget)
DELETE /turnstile/widgets/{sitekey} (deleteTurnstileWidget) |
| sfcc.consents | Customer | Consents | Read customer consent preferences. | GET /subscriptions (getSubscriptions) |
| sfcc.consents.rw | Customer | Consents | Create, read, update, and delete customer consent preferences. | PUT /subscriptions/{subscriptionId} (createSubscription)
PATCH /subscriptions/{subscriptionId} (updateSubscription)
DELETE /subscriptions/{subscriptionId} (deleteSubscription) |
| sfcc.cors-preferences | Configuration | CORS Preferences | Read Cross-Origin Resource Sharing (CORS) preferences. | GET /cors (getCorsPreferences) |
| sfcc.cors-preferences.rw | Configuration | CORS Preferences | Create, read, update, and delete Cross-Origin Resource Sharing (CORS) preferences. | GET /cors (getCorsPreferences)
PUT /cors (updateCorsPreferences)
DELETE /cors (deleteCorsPreferences) |
| sfcc.custom-apis | DX | Custom APIs | Read resolved Custom API endpoints and their registration status (active/not_registered), including error reasons for failed registrations. | GET /endpoints (getEndpoints) |
| sfcc.custom-apis.rw | DX | Custom APIs | Read endpoints and perform admin-level management actions for Custom APIs (read/write when available). | No endpoints currently require this scope. |
| sfcc.customergroups | Customer | Customer Groups | Read customer groups. | POST /customer-group-search (searchCustomerGroup)
GET /customer-groups (getCustomerGroups)
PUT /customer-groups/{customerGroupId}/members (assignCustomerGroupMembers)
DELETE /customer-groups/{customerGroupId}/members (unassignCustomerGroupMembers) |
| sfcc.customergroups.rw | Customer | Customer Groups | Create, read, update, and delete customer groups. | POST /customer-group-search (searchCustomerGroup)
GET /customer-groups (getCustomerGroups)
PUT /customer-groups/{customerGroupId}/members (assignCustomerGroupMembers)
DELETE /customer-groups/{customerGroupId}/members (unassignCustomerGroupMembers) |
| sfcc.customerlists | Customer | Customers | Read customer list associated with a site. | POST /customer-lists/{customerListId}/customer-search (searchCustomerInCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo} (getCustomerFromCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo}/addresses (getAddressesForCustomerFromCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId} (getAddressForCustomerFromCustomerList) |
| sfcc.customerlists.rw | Customer | Customers | Create, read, update, and delete customer lists associated with a site. | POST /customer-lists/{customerListId}/customer-search (searchCustomerInCustomerList)
POST /customer-lists/{customerListId}/customers (createCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo} (getCustomerFromCustomerList)
PUT /customer-lists/{customerListId}/customers/{customerNo} (createCustomerInCustomerList)
DELETE /customer-lists/{customerListId}/customers/{customerNo} (deleteCustomerFromCustomerList)
PATCH /customer-lists/{customerListId}/customers/{customerNo} (updateCustomerInCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo}/addresses (getAddressesForCustomerFromCustomerList)
POST /customer-lists/{customerListId}/customers/{customerNo}/addresses (createAddressForCustomerInCustomerList)
GET /customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId} (getAddressForCustomerFromCustomerList)
DELETE /customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId} (removeAddressForCustomerInCustomerList)
PATCH /customer-lists/{customerListId}/customers/{customerNo}/addresses/{addressId} (updateAddressForCustomerInCustomerList) |
| sfcc.experiences | Experience | Experiences | Read merchandiser experiences. | GET /libraries/{libraryId}/folders/{folderId}/sub-folders (getSubFolders)
GET /libraries/{libraryId}/content/{contentId} (getContent)
GET /libraries/{libraryId}/content/{contentId}/folders (getContentFolders)
GET /libraries/{libraryId}/folder-assignments/{contentId}/{folderId} (getFolderAssignment)
GET /libraries/{libraryId}/folders/{folderId}/content (getFolderContent)
GET /slots/{slotId}/{contextType} (getSlot)
POST /slot-search (searchSlots)
GET /slots/{slotId}/slot-configurations/{configurationId} (getSlotConfiguration)
POST /slot-configurations-search (searchSlotConfigurations)
GET /page-types (getPageTypes)
GET /component-types (getComponentTypes) |
| sfcc.experiences.rw | Experience | Experiences | Create, read, update, and delete merchandiser experiences. | PUT /pages/{pageId} (createOrUpdatePage)
GET /libraries/{libraryId}/folders/{folderId} (getContentFolder)
PUT /libraries/{libraryId}/folders/{folderId} (createOrUpdateContentFolder)
PATCH /libraries/{libraryId}/folders/{folderId} (patchContentFolder)
DELETE /libraries/{libraryId}/folders/{folderId} (deleteContentFolder)
GET /libraries/{libraryId}/folders/{folderId}/sub-folders (getSubFolders)
GET /libraries/{libraryId}/content/{contentId} (getContent)
PUT /libraries/{libraryId}/content/{contentId} (createOrUpdateContent)
PATCH /libraries/{libraryId}/content/{contentId} (patchContent)
DELETE /libraries/{libraryId}/content/{contentId} (deleteContent)
GET /libraries/{libraryId}/content/{contentId}/folders (getContentFolders)
GET /libraries/{libraryId}/folder-assignments/{contentId}/{folderId} (getFolderAssignment)
PUT /libraries/{libraryId}/folder-assignments/{contentId}/{folderId} (createOrUpdateFolderAssignment)
PATCH /libraries/{libraryId}/folder-assignments/{contentId}/{folderId} (updateFolderAssignment)
DELETE /libraries/{libraryId}/folder-assignments/{contentId}/{folderId} (deleteFolderAssignment)
GET /libraries/{libraryId}/folders/{folderId}/content (getFolderContent)
GET /slots/{slotId}/{contextType} (getSlot)
POST /slot-search (searchSlots)
GET /slots/{slotId}/slot-configurations/{configurationId} (getSlotConfiguration)
PUT /slots/{slotId}/slot-configurations/{configurationId} (createOrUpdateSlotConfiguration)
PATCH /slots/{slotId}/slot-configurations/{configurationId} (patchSlotConfiguration)
DELETE /slots/{slotId}/slot-configurations/{configurationId} (deleteSlotConfiguration)
POST /slot-configurations-search (searchSlotConfigurations)
GET /page-types (getPageTypes)
GET /component-types (getComponentTypes) |
| sfcc.gift-certificates | Pricing | Gift Certificates | Read gift certificates. | POST /gift-certificates (giftCertificatesSearch)
GET /gift-certificates/{merchantId} (getGiftCertificate) |
| sfcc.gift-certificates.rw | Pricing | Gift Certificates | Create, read, update, and delete gift certificates. | PUT /gift-certificates (createGiftCertificate)
POST /gift-certificates (giftCertificatesSearch)
GET /gift-certificates/{merchantId} (getGiftCertificate)
DELETE /gift-certificates/{merchantId} (deleteGiftCertificate)
PATCH /gift-certificates/{merchantId} (updateGiftCertificate) |
| sfcc.granular-replications | Administration | Replications | Read replication information. | GET /granular-processes (listPublishProcesses)
GET /granular-processes/{id} (getPublishProcess) |
| sfcc.granular-replications.rw | Administration | Replications | Create, read, update, and delete replications. | GET /granular-processes (listPublishProcesses)
POST /granular-processes (publishItems)
GET /granular-processes/{id} (getPublishProcess) |
| sfcc.inventory-lists | Inventory | Inventory Lists | Read inventory lists. | GET /inventory-lists/{inventoryListId}/product-inventory-records/{productId} (getProductInventoryRecord)
GET /inventory-lists/{inventoryListId} (getInventoryList) |
| sfcc.inventory-lists.rw | Inventory | Inventory Lists | Create, read, update, and delete inventory lists. | GET /inventory-lists/{inventoryListId}/product-inventory-records/{productId} (getProductInventoryRecord)
PUT /inventory-lists/{inventoryListId}/product-inventory-records/{productId} (createOrUpdateProductInventoryRecord)
PATCH /inventory-lists/{inventoryListId}/product-inventory-records/{productId} (updateProductInventoryRecord)
DELETE /inventory-lists/{inventoryListId}/product-inventory-records/{productId} (deleteProductInventoryRecord)
GET /inventory-lists/{inventoryListId} (getInventoryList)
PUT /inventory-lists/{inventoryListId} (createOrUpdateInventoryList)
PATCH /inventory-lists/{inventoryListId} (updateInventoryList)
DELETE /inventory-lists/{inventoryListId} (deleteInventoryList) |
| sfcc.inventory.availability | Inventory | Inventory Availability | Read availability. Account Manager Authentication. | POST /availability-records/actions/get-deltas (getAvailabilityDeltas)
POST /availability-records/actions/get-availability (skuAvailabilityByLocationAndOrGroup) |
| sfcc.inventory.availability.rw | Inventory | Inventory Availability | Create, read, update, and delete availability. Account Manager Authentication. | POST /availability-records/delta-token (createNewDeltaToken)
POST /availability-records/delta-token/actions/update (updateDeltaToken)
POST /availability-records/actions/batch-update (batchInventoryUpdate)
PATCH /availability-records/actions/batch-update (batchInventoryPatch)
PUT /locations/{locationId}/availability-records/skus/{sku}/{requestId} (replaceSkuLocation)
DELETE /locations/{locationId}/availability-records/skus/{sku}/{requestId} (deleteLocationSku)
PATCH /locations/{locationId}/availability-records/skus/{sku}/{requestId} (updateSkuLocation) |
| sfcc.inventory.impex-graphs | Inventory | Inventory Impex | Read location graph exports. Account Manager Authentication. | POST /location-graph/exports (getLocationGraphExport)
DELETE /location-graph/exports/{exportId} (deleteLocationGraphExports)
GET /location-graph/exports/{exportId}/file-content (downloadLocationGraphExportFile)
GET /location-graph/exports/{exportId}/status (getLocationGraphExportStatus) |
| sfcc.inventory.impex-inventory | Inventory | Inventory Impex | Read inventory exports. Account Manager Authentication. | POST /product-segmentation/imports (submitProductSegmentationImport)
GET /product-segmentation/imports/{importId}/file-content (downloadProductSegmentationImportResults)
POST /product-segmentation/exports (initiateProductSegmentationExport)
DELETE /product-segmentation/exports/{exportId} (deleteProductSegmentationExport)
GET /product-segmentation/exports/{exportId}/file-content (downloadProductSegmentationExportFile)
GET /product-segmentation/exports/{exportId}/status (retrieveProductSegmentationExportStatus)
POST /availability-records/exports (initiateAvailabilityExport)
DELETE /availability-records/exports/{exportId} (deleteAvailabilityExport)
GET /availability-records/exports/{exportId}/file-content (downloadAvailabilityExportFile)
GET /availability-records/exports/{exportId}/status (retrieveGroupExportStatus)
GET /event-log/exports/{exportId}/status (retrieveEventLogExportStatus)
GET /event-log/exports/{exportId}/file-content (downloadEventsActivityExportFile)
DELETE /reservations/exports/{exportId} (deleteReservationsExport)
GET /reservations/exports/{exportId}/file-content (downloadReservationsExportFile)
GET /reservations/exports/{exportId}/status (retrieveReservationsExportStatus) |
| sfcc.inventory.impex-inventory.rw | Inventory | Inventory Impex | Read inventory imports. Account Manager Authentication. | POST /product-segmentation/actions/batch-update (batchProductSegmentationRequest)
GET /availability-records/imports (getInventoryImport)
POST /availability-records/imports (submitInventoryImport)
DELETE /availability-records/imports/{importId} (deleteInventoryImport)
GET /availability-records/imports/{importId}/status (getAvailabilityImportStatus)
GET /availability-records/imports/{importId}/file-content (downloadAvailabilityImportResultsFile)
POST /availability-records/imports/uploadlink/{uploadLinkId} (postUploadImportFile)
POST /product-segmentation/imports (submitProductSegmentationImport)
DELETE /product-segmentation/imports/{importId} (deleteProductSegmentationImport)
GET /product-segmentation/imports/{importId}/status (getProductSegmentationImportStatus)
POST /product-segmentation/imports/uploadlink/{uploadLinkId} (postProductSegmentationUploadImportFile)
POST /product-segmentation/exports (initiateProductSegmentationExport)
POST /event-log/exports (submitEventsActivityExport)
POST /reservations/exports (submitReservationsExport) |
| sfcc.inventory.reservations | Inventory | Inventory Reservation | Read reservation information. Account Manager Authentication. | No endpoints currently require this scope. |
| sfcc.inventory.reservations.rw | Inventory | Inventory Reservation | Create, read, update, and delete reservations. Account Manager Authentication. | PUT /reservation-documents/{reservationId} (createReservations)
PATCH /reservation-documents/{reservationId} (updateReservation)
POST /transfers (moveReservationQuantity)
POST /releases (unreserveReservations)
POST /fulfillments (fulfillQuantity) |
| sfcc.jobs | Administration | Jobs | Read job information. | POST /job-execution-search (searchJobExecutions)
GET /jobs/{jobId}/executions/{executionId} (getJobExecution) |
| sfcc.jobs.rw | Administration | Jobs | Create, read, update, and delete jobs. | POST /job-execution-search (searchJobExecutions)
POST /jobs/{jobId}/executions (createJobExecution)
GET /jobs/{jobId}/executions/{executionId} (getJobExecution)
DELETE /jobs/{jobId}/executions/{executionId} (deleteJobExecution) |
| sfcc.metrics | Observability | Metrics | Read metrics and observability data. | GET /metrics/overall (getOverallMetrics)
GET /metrics/sales (getSalesMetrics)
GET /metrics/ecdn (getEcdnMetrics)
GET /metrics/third-party (getThirdPartyMetrics)
GET /metrics/scapi (getScapiMetrics)
GET /metrics/scapi-hooks (getScapiHooksMetrics)
GET /metrics/mrt (getMrtMetrics)
GET /metrics/controller (getControllerMetrics)
GET /metrics/ocapi (getOcapiMetrics) |
| sfcc.object-definitions | Configuration | Object Definitions | Read object definitions. | GET /system/object-types (getSystemObjectTypes)
POST /system/object-types-search (searchSystemObjectTypes)
GET /system/object-types/{objectType} (getSystemObjectType)
GET /system/object-types/{objectType}/attribute-groups (getAttributeGroups)
GET /system/object-types/{objectType}/attribute-groups/{id} (getAttributeGroup)
GET /system/object-types/{objectType}/attribute-definitions (getAttributeDefinitions)
GET /system/object-types/{objectType}/attribute-definitions/{id} (getAttributeDefinition) |
| sfcc.object-definitions.rw | Configuration | Object Definitions | Create, read, update, and delete object definitions. | GET /system/object-types (getSystemObjectTypes)
POST /system/object-types-search (searchSystemObjectTypes)
GET /system/object-types/{objectType} (getSystemObjectType)
POST /system/object-types/{objectType}/attribute-definition-search (searchAttributeDefinitionForSystemObject)
POST /system/object-types/{objectType}/attribute-group-search (searchAttributeGroupsForSystemObject)
GET /system/object-types/{objectType}/attribute-groups (getAttributeGroups)
GET /system/object-types/{objectType}/attribute-groups/{id} (getAttributeGroup)
PUT /system/object-types/{objectType}/attribute-groups/{id} (createOrReplaceAttributeGroup)
PATCH /system/object-types/{objectType}/attribute-groups/{id} (updateAttributeGroup)
DELETE /system/object-types/{objectType}/attribute-groups/{id} (deleteAttributeGroup)
PUT /system/object-types/{objectType}/attribute-groups/{groupId}/attribute-definitions/{defId} (assignAttributeDefinitionToGroup)
DELETE /system/object-types/{objectType}/attribute-groups/{groupId}/attribute-definitions/{defId} (unassignAttributeDefinitionFromGroup)
GET /system/object-types/{objectType}/attribute-definitions (getAttributeDefinitions)
GET /system/object-types/{objectType}/attribute-definitions/{id} (getAttributeDefinition)
PUT /system/object-types/{objectType}/attribute-definitions/{id} (createOrReplaceAttributeDefinition)
PATCH /system/object-types/{objectType}/attribute-definitions/{id} (updateAttributeDefinition)
DELETE /system/object-types/{objectType}/attribute-definitions/{id} (deleteAttributeDefinition) |
| sfcc.orders | Checkout | Orders | Read orders from a management perspective. | GET /orders (getOrders)
GET /orders/{orderNo} (getOrder) |
| sfcc.orders.rw | Checkout | Orders | Create, read, update, and delete an existing order, for example, with a status update. | GET /orders (getOrders)
POST /orders (createOrders)
GET /orders/{orderNo} (getOrder)
PATCH /orders/{orderNo} (updateOrder)
PUT /orders/{orderNo}/confirmation-status (updateOrderConfirmationStatus)
PUT /orders/{orderNo}/export-status (updateOrderExportStatus)
PUT /orders/{orderNo}/external-status (updateOrderExternalStatus)
PUT /orders/{orderNo}/payment-status (updateOrderPaymentStatus)
PUT /orders/{orderNo}/shipping-status (updateOrderShippingStatus)
POST /orders/{orderNo}/oms-status-events (createOmsStatusEvent)
PUT /orders/{orderNo}/status (updateOrderStatus)
PATCH /orders/{orderNo}/payment-instruments/{paymentInstrumentId} (updateOrderPaymentInstrument)
PATCH /orders/{orderNo}/payment-instruments/{paymentInstrumentId}/transaction (updateOrderPaymentTransaction)
PUT /orders/{orderNo}/shipments/{shipmentId}/shipping-address (updateOrderShippingAddress) |
| sfcc.preferences | Configuration | Preferences | Read site and environment-specific settings. | GET /global-custom-preferences (getGlobalCustomPreferenceList)
GET /site-custom-preferences (getSiteCustomPreferenceList)
GET /global-preference-groups/{groupId}/{instanceType} (getGlobalPreferenceGroup)
GET /site-preference-groups/{groupId}/{instanceType} (getSitePreferenceGroup)
POST /site-preference-groups/{groupId}/{instanceType}/preference-search (searchSitePreferences)
GET /site-preference-groups/{groupId}/{instanceType}/preferences/{preferenceId} (getSitePreference) |
| sfcc.price-books | Pricing | Price Books | Read price books. | GET /price-books (getPriceBooks)
GET /price-books/{priceBookId} (getPriceBook)
GET /price-books/{priceBookId}/price-book-entries (getPriceBookEntries)
GET /price-books/{priceBookId}/price-book-entries/{productId} (getPriceBookEntry)
GET /price-books/{priceBookId}/site-assignments (getPriceBookSiteAssignments)
POST /price-book-search (searchPriceBooks) |
| sfcc.price-books.rw | Pricing | Price Books | Create, read, update, and delete price books. | GET /price-books (getPriceBooks)
GET /price-books/{priceBookId} (getPriceBook)
PUT /price-books/{priceBookId} (createOrUpdatePriceBook)
PATCH /price-books/{priceBookId} (updatePriceBook)
DELETE /price-books/{priceBookId} (deletePriceBook)
GET /price-books/{priceBookId}/price-book-entries (getPriceBookEntries)
GET /price-books/{priceBookId}/price-book-entries/{productId} (getPriceBookEntry)
PUT /price-books/{priceBookId}/price-book-entries/{productId} (createOrUpdatePriceBookEntry)
PATCH /price-books/{priceBookId}/price-book-entries/{productId} (updatePriceBookEntry)
DELETE /price-books/{priceBookId}/price-book-entries/{productId} (deletePriceBookEntry)
GET /price-books/{priceBookId}/site-assignments (getPriceBookSiteAssignments)
PUT /price-books/{priceBookId}/site-assignments/{siteId} (createOrUpdatePriceBookSiteAssignment)
DELETE /price-books/{priceBookId}/site-assignments/{siteId} (deletePriceBookSiteAssignment)
POST /price-book-search (searchPriceBooks) |
| sfcc.products | Product | Products | Read products assigned to a catalog. | GET /products/{productId} (getProduct)
POST /products/{productId}/variant-search (searchProductVariations)
GET /products/{masterProductId}/variation-groups (getVariationGroupsForMasterProduct)
GET /products/{masterProductId}/variation-groups/{id} (getVariationGroupForMasterProduct)
GET /products/{masterProductId}/variations (getVariationsForMasterProduct)
GET /products/{masterProductId}/variations/{id} (getVariationForMasterProduct)
GET /products/{productId}/product-options (getProductOptions)
GET /products/{productId}/product-options/{id} (getProductOption)
GET /products/{productId}/product-options/{optionId}/values/{id} (getProductOptionValue)
GET /products/{productId}/variation-attributes/{attributeId}/values/{id} (getVariationAttributeValue)
GET /products/{productId}/variation-attributes (getVariationAttributes)
GET /products/{productId}/variation-attributes/{id} (getVariationAttribute)
GET /categorization-attribute-definitions (getCategorizationAttributeDefinitions)
POST /product-search (searchProducts)
POST /unassigned-product-search (searchUnassignedProducts) |
| sfcc.products.rw | Product | Products | Create, read, update, and delete products from a catalog. | GET /products/{productId} (getProduct)
PUT /products/{productId} (createProduct)
DELETE /products/{productId} (deleteProduct)
PATCH /products/{productId} (updateProduct)
POST /products/{productId}/variant-search (searchProductVariations)
GET /products/{masterProductId}/variation-groups (getVariationGroupsForMasterProduct)
GET /products/{masterProductId}/variation-groups/{id} (getVariationGroupForMasterProduct)
PUT /products/{masterProductId}/variation-groups/{id} (assignVariationGroupToMasterProduct)
DELETE /products/{masterProductId}/variation-groups/{id} (unassignVariationGroupFromMasterProduct)
PATCH /products/{masterProductId}/variation-groups/{id} (updateVariationGroupForMasterProduct)
GET /products/{masterProductId}/variations (getVariationsForMasterProduct)
GET /products/{masterProductId}/variations/{id} (getVariationForMasterProduct)
PUT /products/{masterProductId}/variations/{id} (assignVariationForMasterProduct)
DELETE /products/{masterProductId}/variations/{id} (unassignVariationFromMasterProduct)
PATCH /products/{masterProductId}/variations/{id} (updateVariationForMasterProduct)
GET /products/{productId}/product-options (getProductOptions)
GET /products/{productId}/product-options/{id} (getProductOption)
PUT /products/{productId}/product-options/{id} (createProductOption)
DELETE /products/{productId}/product-options/{id} (deleteProductOption)
PATCH /products/{productId}/product-options/{id} (updateProductOption)
GET /products/{productId}/product-options/{optionId}/values/{id} (getProductOptionValue)
PUT /products/{productId}/product-options/{optionId}/values/{id} (createProductOptionValue)
DELETE /products/{productId}/product-options/{optionId}/values/{id} (deleteProductOptionValue)
PATCH /products/{productId}/product-options/{optionId}/values/{id} (updateProductOptionValue)
GET /products/{productId}/variation-attributes/{attributeId}/values/{id} (getVariationAttributeValue)
PUT /products/{productId}/variation-attributes/{attributeId}/values/{id} (createVariationAttributeValue)
DELETE /products/{productId}/variation-attributes/{attributeId}/values/{id} (deleteVariationAttributeValue)
PATCH /products/{productId}/variation-attributes/{attributeId}/values/{id} (updateVariationAttributeValue)
GET /products/{productId}/variation-attributes (getVariationAttributes)
GET /products/{productId}/variation-attributes/{id} (getVariationAttribute)
PUT /products/{productId}/variation-attributes/{id} (createVariationAttribute)
DELETE /products/{productId}/variation-attributes/{id} (deleteVariationAttribute)
PATCH /products/{productId}/variation-attributes/{id} (updateVariationAttribute)
GET /categorization-attribute-definitions (getCategorizationAttributeDefinitions)
POST /product-search (searchProducts)
POST /unassigned-product-search (searchUnassignedProducts) |
| sfcc.promotions | Pricing | Promotions | Read campaigns, coupons, promotions, and assignments. | POST /assignments (assignmentsSearch)
POST /campaigns (campaignsSearch)
GET /campaigns/{campaignId} (getCampaign)
GET /campaigns/{campaignId}/promotions (getCampaignPromotionAssignments)
GET /campaigns/{campaignId}/promotions/{promotionId} (getCampaignPromotionAssignment)
POST /coupons (couponsSearch)
POST /coupons/redemptions (couponRedemptionsSearch)
GET /coupons/{couponId} (getCoupon)
GET /coupons/{couponId}/codes (getCouponCodes)
POST /promotions (promotionsSearch)
GET /promotions/{id} (getPromotion)
GET /promotions/{id}/discount-rule (getPromotionDiscountRule)
GET /promotions/{id}/compatibility (getPromotionCompatibility) |
| sfcc.promotions.rw | Pricing | Promotions | Create, read, update, and delete campaigns, coupons, promotions, and assignments. | POST /assignments (assignmentsSearch)
POST /campaigns (campaignsSearch)
GET /campaigns/{campaignId} (getCampaign)
PUT /campaigns/{campaignId} (createCampaign)
DELETE /campaigns/{campaignId} (deleteCampaign)
PATCH /campaigns/{campaignId} (updateCampaign)
GET /campaigns/{campaignId}/promotions (getCampaignPromotionAssignments)
GET /campaigns/{campaignId}/promotions/{promotionId} (getCampaignPromotionAssignment)
PUT /campaigns/{campaignId}/promotions/{promotionId} (assignPromotionToCampaign)
PATCH /campaigns/{campaignId}/promotions/{promotionId} (updateCampaignPromotionAssignment)
DELETE /campaigns/{campaignId}/promotions/{promotionId} (unassignPromotionFromCampaign)
POST /coupons (couponsSearch)
POST /coupons/redemptions (couponRedemptionsSearch)
POST /coupons/actions/redeem (redeemCoupon)
GET /coupons/{couponId} (getCoupon)
PUT /coupons/{couponId} (createCoupon)
DELETE /coupons/{couponId} (deleteCoupon)
PATCH /coupons/{couponId} (updateCoupon)
GET /coupons/{couponId}/codes (getCouponCodes)
POST /coupons/{couponId}/codes (updateCouponCodes)
POST /promotions (promotionsSearch)
GET /promotions/{id} (getPromotion)
PUT /promotions/{id} (createPromotion)
DELETE /promotions/{id} (deletePromotion)
PATCH /promotions/{id} (updatePromotion)
GET /promotions/{id}/discount-rule (getPromotionDiscountRule)
PUT /promotions/{id}/discount-rule (createPromotionDiscountRule)
PATCH /promotions/{id}/discount-rule (updatePromotionDiscountRule)
DELETE /promotions/{id}/discount-rule (deletePromotionDiscountRule)
GET /promotions/{id}/compatibility (getPromotionCompatibility)
PUT /promotions/{id}/compatibility (createPromotionCompatibility)
PATCH /promotions/{id}/compatibility (updatePromotionCompatibility) |
| sfcc.roles | Administration | Roles | Read roles. | GET /roles (getRoles)
GET /roles/{roleId} (getRole)
GET /roles/{roleId}/permissions (getRolePermissions)
POST /roles/{roleId}/user-search (searchRoleUsers)
GET /roles/{roleId}/users (getRoleUsers) |
| sfcc.roles.rw | Administration | Roles | Create, read, update, and delete roles. | GET /roles (getRoles)
GET /roles/{roleId} (getRole)
PUT /roles/{roleId} (createRole)
DELETE /roles/{roleId} (deleteRole)
GET /roles/{roleId}/permissions (getRolePermissions)
PUT /roles/{roleId}/permissions (setRolePermissions)
POST /roles/{roleId}/user-search (searchRoleUsers)
GET /roles/{roleId}/users (getRoleUsers)
PUT /roles/{roleId}/users/{login} (assignUserToRole)
DELETE /roles/{roleId}/users/{login} (unassignUserFromRole) |
| sfcc.scapi-schemas | DX | SCAPI Schemas | Read SCAPI schema registry. | GET /schemas (getSchemaList)
GET /schemas/{apiFamily}/{apiName}/{apiVersion} (getSchemaDetails) |
| sfcc.scripts | DX | Scripts | Read scripts. | GET /code-versions (getCodeVersions)
GET /code-versions/{codeVersionId} (getCodeVersion) |
| sfcc.scripts.rw | DX | Scripts | Create, read, update, and delete scripts. | GET /code-versions (getCodeVersions)
GET /code-versions/{codeVersionId} (getCodeVersion)
PUT /code-versions/{codeVersionId} (createCodeVersion)
PATCH /code-versions/{codeVersionId} (updateCodeVersion)
DELETE /code-versions/{codeVersionId} (deleteCodeVersion) |
| sfcc.seo | Site | SEO | Read SEO configurations. | No endpoints currently require this scope. |
| sfcc.seo.rw | Site | SEO | Create, read, update, and delete SEO configurations. | PUT /sitemap (uploadCustomSitemapAndTriggerSitemapGeneration) |
| sfcc.sites | Configuration | Sites | Read site information. | POST /site-search (searchSites)
GET /sites (getSites)
GET /sites/{siteId} (getSiteById)
GET /sites/{siteId}/custom-cartridges (getSiteCustomCartridges) |
| sfcc.sites.rw | Configuration | Sites | Create, read, update, and delete site information. | POST /site-search (searchSites)
GET /sites (getSites)
GET /sites/{siteId} (getSiteById)
GET /sites/{siteId}/custom-cartridges (getSiteCustomCartridges)
PUT /sites/{siteId}/custom-cartridges (replaceSiteCustomCartridges) |
| sfcc.source-codes | Pricing | Source Code Groups | Read source codes. | GET /source-code-groups/{id} (getSourceCodeGroup)
POST /source-code-groups (sourceCodeGroupsSearch) |
| sfcc.source-codes.rw | Pricing | Source Code Groups | Create, read, update, and delete source codes. | GET /source-code-groups/{id} (getSourceCodeGroup)
PUT /source-code-groups/{id} (createSourceCodeGroup)
DELETE /source-code-groups/{id} (deleteSourceCodeGroup)
PATCH /source-code-groups/{id} (updateSourceCodeGroup)
POST /source-code-groups (sourceCodeGroupsSearch) |
| sfcc.store-redirect-mappings | Site | Store Redirect Mappings | Read store redirect mappings. | GET /store-redirect-mappings (getAllStoreRedirectMappings)
GET /store-redirect-mappings/{sourceStoreId} (getStoreRedirectMapping) |
| sfcc.store-redirect-mappings.rw | Site | Store Redirect Mappings | Create, read, update, and delete store redirect mappings. | GET /store-redirect-mappings (getAllStoreRedirectMappings)
POST /store-redirect-mappings/actions/bulk (upsertStoreRedirectMappings)
POST /store-redirect-mappings/actions/bulk-delete (deleteStoreRedirectMappings)
GET /store-redirect-mappings/{sourceStoreId} (getStoreRedirectMapping) |
| sfcc.storefront.deployments.rw | Deployment | Deployments | Upload, deploy, and get a bundle and all bundles. Get one or all deployments. | GET /storefronts/{storefrontId}/bundles (getBundlesForStorefront)
POST /storefronts/{storefrontId}/bundles (uploadBundleForStorefront)
GET /storefronts/{storefrontId}/environments/{environmentId}/deployments (getDeploymentsForEnvironment)
POST /storefronts/{storefrontId}/environments/{environmentId}/deployments (createDeploymentForEnvironment)
GET /storefronts/{storefrontId}/environments/{environmentId}/deployments/{deploymentId} (getDeploymentById) |
| sfcc.storefront.environments.rw | Environment | Environments | Create, clone, delete, and edit environments, access control headers, redirects. List environments. Create cache invalidation. | GET /storefronts/{storefrontId}/environments (getEnvironmentsForStorefront)
POST /storefronts/{storefrontId}/environments (createEnvironmentForStorefront)
POST /storefronts/{storefrontId}/environments/clone (cloneEnvironmentForStorefront)
GET /storefronts/{storefrontId}/environments/{environmentId} (getEnvironmentById)
PATCH /storefronts/{storefrontId}/environments/{environmentId} (updateEnvironment)
DELETE /storefronts/{storefrontId}/environments/{environmentId} (deleteEnvironment)
PUT /storefronts/{storefrontId}/environments/{environmentId}/primary (setPrimaryEnvironment)
POST /storefronts/{storefrontId}/environments/{environmentId}/cache-invalidations (createCacheInvalidation)
GET /storefronts/{storefrontId}/environments/{environmentId}/environment-variables (getEnvironmentVariables)
PATCH /storefronts/{storefrontId}/environments/{environmentId}/environment-variables (updateEnvironmentVariables)
GET /storefronts/{storefrontId}/environments/{environmentId}/access-control-headers (getAccessControlHeaders)
POST /storefronts/{storefrontId}/environments/{environmentId}/access-control-headers (createAccessControlHeader)
GET /storefronts/{storefrontId}/environments/{environmentId}/access-control-headers/{accessControlHeaderId} (getAccessControlHeader)
DELETE /storefronts/{storefrontId}/environments/{environmentId}/access-control-headers/{accessControlHeaderId} (deleteAccessControlHeader)
GET /storefronts/{storefrontId}/environments/{environmentId}/redirects (getRedirects)
POST /storefronts/{storefrontId}/environments/{environmentId}/redirects (createRedirect)
GET /storefronts/{storefrontId}/environments/{environmentId}/redirects/{redirectId} (getRedirect)
PATCH /storefronts/{storefrontId}/environments/{environmentId}/redirects/{redirectId} (updateRedirect)
DELETE /storefronts/{storefrontId}/environments/{environmentId}/redirects/{redirectId} (deleteRedirect)
POST /storefronts/{storefrontId}/environments/{environmentId}/redirects/actions/clone (cloneRedirects) |
| sfcc.storefront.storefronts.rw | Storefront | Storefronts | Create, get, edit, and delete storefronts. | GET /storefronts (getStorefronts)
POST /storefronts (createStorefront)
GET /storefronts/{storefrontId} (getStorefrontById)
PATCH /storefronts/{storefrontId} (updateStorefront)
DELETE /storefronts/{storefrontId} (deleteStorefront) |
| sfcc.stores | Store | Stores | Read store information. | GET /stores (getStores)
GET /stores/{id} (getStore)
POST /store-search (searchStores) |
| sfcc.timeouts | Configuration | Timeouts | Read timeout configuration. | GET /timeouts (getTimeouts) |
| sfcc.timeouts.rw | Configuration | Timeouts | Create, read, update, and delete timeout configuration. | GET /timeouts (getTimeouts)
PUT /timeouts (putTimeouts)
DELETE /timeouts (deleteTimeouts) |
| sfcc.users | Administration | Users | Read user information. | GET /users (getUsers)
GET /users/{login} (getUser) |
| sfcc.users.rw | Administration | Users | Create, read, update, and delete users. | GET /users (getUsers)
GET /users/{login} (getUser)
PUT /users/{login} (createOrReplaceUser)
PATCH /users/{login} (updateUser)
DELETE /users/{login} (deleteUser) |