Permissions resource (Data API 23.2)
Summary
| Http Method | Resource | Description |
|---|---|---|
| GET | /permissions | Get application specific permissions per type. |
| GET | /permissions/bm | Get Business Manager permissions per type. |
| GET | /permissions/bm/functional | Get functional permissions per scope. |
| GET | /permissions/bm/locale | Get locale permissions per scope. |
| GET | /permissions/bm/module | Get Business Manager module permissions per scope. |
| GET | /permissions/bm/webdav | Get WebDAV permissions per scope. |
| GET | /permissions/csc | Get permissions per type. |
| GET | /permissions/csc/module | Get CSC module permissions per scope. |
Get Application Permissions
Get application specific permissions per type.Url
GET https://hostname:port/dw/data/v23_2/permissions?expand={String}Formats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Query Parameters
| Parameter | Type | Description | Constraints |
|---|---|---|---|
| expand | String | The permission expand. A comma separated list with the allowed values (bm, csc). |
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions?expand=bm HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "permission_application_container",
"applications": [
"bm",
"csc"
],
"bm": {
"_type": "bmpermissions",
"functional_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/functional",
"locale_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/locale",
"module_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/module",
"types": [
"module",
"functional",
"webdav",
"locale"
],
"webdav_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/webdav"
}
}Get Business Manager Permissions
Get Business Manager permissions per type.Url
GET https://hostname:port/dw/data/v23_2/permissions/bm?expand={String}Formats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Query Parameters
| Parameter | Type | Description | Constraints |
|---|---|---|---|
| expand | String | The permission expand. A comma separated list with the allowed values (module, functional, webdav, locale). |
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/bm?expand=module HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "bmpermissions",
"functional_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/functional",
"locale_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/locale",
"module": {
"_type": "module_permissions",
"organization": [
{
"_type": "menu_item",
"display_name": {
"default": "Replication"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Start and control data replication processes."
},
"display_name": {
"default": "Data Replication"
},
"module_type": "BM",
"name": "global-data-rep-processes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Start and control code replication processes."
},
"display_name": {
"default": "Code Replication"
},
"module_type": "BM",
"name": "global-code-rep-processes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "global-replication",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Organization"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the organization profile including its default language."
},
"display_name": {
"default": "Organization Profile"
},
"module_type": "BM",
"name": "organization_profile",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the Business Manager users. If you also have permission for the Business Manager module \"Roles & Permissions\", this module allows you to assign and unassign the users to access roles."
},
"display_name": {
"default": "Users"
},
"module_type": "BM",
"name": "organization_users",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage roles and permissions. If you also have permission to the Business Manager module \"Users\", this module allows you to assign and unassign users to the access role."
},
"display_name": {
"default": "Roles & Permissions"
},
"module_type": "BM",
"name": "organization_roles",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage WebDAV Client Application Permissions."
},
"display_name": {
"default": "WebDAV Client Permissions"
},
"module_type": "BM",
"name": "webdavclient_permissions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "organization",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Sites"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the sites of this organization."
},
"display_name": {
"default": "Manage Sites"
},
"module_type": "BM",
"name": "sites_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the customer lists of this organization."
},
"display_name": {
"default": "Customer Lists"
},
"module_type": "BM",
"name": "customerlists_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage and assign content libraries for sites."
},
"display_name": {
"default": "Content Libraries"
},
"module_type": "BM",
"name": "contentlibraries_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "customerlists_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the hostnames and certificates for your embedded CDN."
},
"display_name": {
"default": "Embedded CDN Settings"
},
"module_type": "BM",
"name": "cdnManager",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "sites",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site Development"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Set up and configure Commerce Cloud UX Studio, view log files, and access files via WebDAV."
},
"display_name": {
"default": "Development Setup"
},
"module_type": "BM",
"name": "studio_setup",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View, activate, and delete code versions. Upload deployment archives."
},
"display_name": {
"default": "Code Deployment"
},
"module_type": "BM",
"name": "studio_code_deployment",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Customize type definitions of system objects."
},
"display_name": {
"default": "System Object Types"
},
"module_type": "BM",
"name": "studio_system_obj",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage type definitions for your custom objects."
},
"display_name": {
"default": "Custom Object Types"
},
"module_type": "BM",
"name": "studio_custom_obj",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Modify the displayed error pages in case the server is down or there is any other emergency."
},
"display_name": {
"default": "Custom Error Pages"
},
"module_type": "BM",
"name": "customization_err",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Modify the displayed pages in case the server is down for maintenance."
},
"display_name": {
"default": "Custom Maintenance Pages"
},
"module_type": "BM",
"name": "customization_maint",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Display deprecated API usage."
},
"display_name": {
"default": "Deprecated API Usage"
},
"module_type": "BM",
"name": "development_deprecated_api",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export object type definitions and custom object types."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "customization_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export of entire site and instance configurations."
},
"display_name": {
"default": "Site Import & Export"
},
"module_type": "BM",
"name": "instance_setup",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Open Commerce API settings."
},
"display_name": {
"default": "Open Commerce API Settings"
},
"module_type": "BM",
"name": "wapi_settings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure settings for the Customer Service Center, e.g. customizable areas."
},
"display_name": {
"default": "Customer Service Center Settings"
},
"module_type": "BM",
"name": "csc_config",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "studio",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Global Preferences"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Activate, deactivate, and maintain the locales and regional settings of the system."
},
"display_name": {
"default": "Locales"
},
"module_type": "BM",
"name": "global-prefs_locales",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and modify the instance time zone."
},
"display_name": {
"default": "Instance Time Zone"
},
"module_type": "BM",
"name": "global-prefs_timeZones",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure the change history settings for this instance."
},
"display_name": {
"default": "Change History"
},
"module_type": "BM",
"name": "auditing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure OAuth2 Providers for this instance."
},
"display_name": {
"default": "OAuth2 Providers"
},
"module_type": "BM",
"name": "oauth-providers",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Set the password restrictions and login lockout policies for all Business Manager users."
},
"display_name": {
"default": "Security"
},
"module_type": "BM",
"name": "global-prefs_securityPrefs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and validate geolocations as the basis of the store locator."
},
"display_name": {
"default": "Store Locator Data"
},
"module_type": "BM",
"name": "geolocations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View, create or delete instance page meta tag definitions."
},
"display_name": {
"default": "Page Meta Tags"
},
"module_type": "BM",
"name": "global-prefs_pagemetatags",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Activate or deactivate features for this instance."
},
"display_name": {
"default": "Feature Switches"
},
"module_type": "BM",
"name": "feature_switch_manager",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define global order search preferences."
},
"display_name": {
"default": "Order Search"
},
"module_type": "BM",
"name": "global-prefs_order_search",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage sequence numbers assigned to your orders and customers."
},
"display_name": {
"default": "Sequence Numbers"
},
"module_type": "BM",
"name": "global-prefs_orders_seriesnumbers",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define global product preferences."
},
"display_name": {
"default": "Products"
},
"module_type": "BM",
"name": "global-prefs_prodlocking",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage global retention settings for this instance."
},
"display_name": {
"default": "Retention Settings"
},
"module_type": "BM",
"name": "global-prefs_product_lists",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Adjust global settings for Import and Export."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "impex_settings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View global client timeouts for this instance."
},
"display_name": {
"default": "Global Timeouts"
},
"module_type": "BM",
"name": "global-prefs_timeouts",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure global custom preferences."
},
"display_name": {
"default": "Custom Preferences"
},
"module_type": "BM",
"name": "global-prefs_custom_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Opt in for Einstein Search Dictionaries."
},
"display_name": {
"default": "Einstein Search Dictionaries Opt-In"
},
"module_type": "BM",
"name": "global-prefs_einstein_data_privacy",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure Business Manager Analytics preferences for this instance."
},
"display_name": {
"default": "Analytics"
},
"module_type": "BM",
"name": "bma_config",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "global-prefs",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Operations"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Schedule, start, or check the status of scheduled jobs."
},
"display_name": {
"default": "Job Schedules"
},
"module_type": "BM",
"name": "jobschedules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View job history (Beta)."
},
"display_name": {
"default": "Job History"
},
"module_type": "BM",
"name": "jobmonitor",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Schedule, start, or check the status of scheduled jobs."
},
"display_name": {
"default": "Job Schedules (deprecated)"
},
"module_type": "BM",
"name": "operations_jobschedules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View job history."
},
"display_name": {
"default": "Job History (deprecated)"
},
"module_type": "BM",
"name": "operations_jobmonitor",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View an aggregated list of job run times per day."
},
"display_name": {
"default": "Job Statistics"
},
"module_type": "BM",
"name": "operations_jobstatistics",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export job schedules and services."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "operations_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and generate GMV and Order Journal reports."
},
"display_name": {
"default": "GMV Reports"
},
"module_type": "BM",
"name": "operations_exportorderjournal",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage custom log settings."
},
"display_name": {
"default": "Custom Log Settings"
},
"module_type": "BM",
"name": "operations_customlogging",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Start/Stop Code Profiling and View Results"
},
"display_name": {
"default": "Code Profiler"
},
"module_type": "BM",
"name": "operations_tracing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Profile and evaluate pipeline runtime performance."
},
"display_name": {
"default": "Pipeline Profiler"
},
"module_type": "BM",
"name": "operations_pipeline_performance",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Display quota status and limits."
},
"display_name": {
"default": "Quota Status"
},
"module_type": "BM",
"name": "operations_quotastatus",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View the change history of various object types."
},
"display_name": {
"default": "Change History"
},
"module_type": "BM",
"name": "operations_auditing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Monitor encryption keys used for internal encryption of sensitive data."
},
"display_name": {
"default": "Encryption Keys"
},
"module_type": "BM",
"name": "operations_encryption_keys",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage private keys and certificates."
},
"display_name": {
"default": "Private Keys and Certificates"
},
"module_type": "BM",
"name": "operations_certificates",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage services, service credentials, and service profiles."
},
"display_name": {
"default": "Services"
},
"module_type": "BM",
"name": "operations_services",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View reports of service status and performance."
},
"display_name": {
"default": "Service Status"
},
"module_type": "BM",
"name": "operations_services_stats",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and validate geolocation lookup for IP addresses."
},
"display_name": {
"default": "IP Address Geolocation Data"
},
"module_type": "BM",
"name": "operations_geoip",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure Predictive Intelligence settings."
},
"display_name": {
"default": "Predictive Intelligence"
},
"module_type": "BM",
"name": "operations_cqconfig",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "operations",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "World Wide Distribution"
},
"module_type": "BM",
"name": "worldwidedistribution",
"type": "module"
}
],
"scopes": [
"site",
"organization"
],
"site": [
{
"_type": "menu_item",
"display_name": {
"default": "Products and Catalogs"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the products of the organization."
},
"display_name": {
"default": "Products"
},
"module_type": "BM",
"name": "prod-cat_products",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the product sets of the organization."
},
"display_name": {
"default": "Product Sets"
},
"module_type": "BM",
"name": "prod-cat_product_sets",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the catalogs of the organization."
},
"display_name": {
"default": "Catalogs"
},
"module_type": "BM",
"name": "prod-cat_catalogs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage shared product options of a catalog."
},
"display_name": {
"default": "Product Options"
},
"module_type": "BM",
"name": "prod-cat_product_options",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage shared variation attributes of a catalog."
},
"display_name": {
"default": "Variation Attributes"
},
"module_type": "BM",
"name": "prod-cat_product_variations",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the recommendations for each of the organization catalogs."
},
"display_name": {
"default": "Recommendations"
},
"module_type": "BM",
"name": "prod-cat_recommendations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the price books of the organization."
},
"display_name": {
"default": "Price Books"
},
"module_type": "BM",
"name": "prod-cat_pricebooks",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the inventory lists of the organization."
},
"display_name": {
"default": "Inventory Lists"
},
"module_type": "BM",
"name": "prod-cat_inventory",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Schedule and run various catalog feeds."
},
"display_name": {
"default": "Catalog Feeds"
},
"module_type": "BM",
"name": "prod-cat_feeds",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "prod-cat_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export products and catalogs of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "prod-cat_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "prod-cat",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Content"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "View the content libraries for the organization. "
},
"display_name": {
"default": "Libraries"
},
"module_type": "BM",
"name": "library_content_libraries",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage folder structures of libraries."
},
"display_name": {
"default": "Library Folder"
},
"module_type": "BM",
"name": "library_folder",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the content assets of the site library."
},
"display_name": {
"default": "Content Assets"
},
"module_type": "BM",
"name": "library_content",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export library content of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "content_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "content",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Search"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage search indexes."
},
"display_name": {
"default": "Search Indexes"
},
"module_type": "BM",
"name": "search_indexes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search index rebuild schedule."
},
"display_name": {
"default": "Search Index Rebuild Schedule"
},
"module_type": "BM",
"name": "search_index_schedule",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Test queries against product index."
},
"display_name": {
"default": "Search Index Query Testing"
},
"module_type": "BM",
"name": "search_query_testing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the dictionaries used by search."
},
"display_name": {
"default": "Search Dictionaries"
},
"module_type": "BM",
"name": "search_dictionaries",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the searchable attributes for this site."
},
"display_name": {
"default": "Searchable Attributes"
},
"module_type": "BM",
"name": "search_attributes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage search driven redirect rules."
},
"display_name": {
"default": "Search Driven Redirects"
},
"module_type": "BM",
"name": "search_index_redirects",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage stop words for search."
},
"display_name": {
"default": "Stop Word Dictionary"
},
"module_type": "BM",
"name": "search_stopwords",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage category name indexing exclusions."
},
"display_name": {
"default": "Category Name Exclusions"
},
"module_type": "BM",
"name": "search_category-name-exclusions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage synonyms for search."
},
"display_name": {
"default": "Synonym Dictionary"
},
"module_type": "BM",
"name": "search_synonyms",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage hypernyms for search."
},
"display_name": {
"default": "Hypernym Dictionary"
},
"module_type": "BM",
"name": "search_hypernyms",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage compound words for search."
},
"display_name": {
"default": "Compound Word Dictionary"
},
"module_type": "BM",
"name": "search_compound-words",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage common phrases for search."
},
"display_name": {
"default": "Common Phrase Dictionary"
},
"module_type": "BM",
"name": "search_common-phrases",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage additional suggestion phrases and the suggestion black list."
},
"display_name": {
"default": "Search Suggestions"
},
"module_type": "BM",
"name": "search_suggestions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage stemming exceptions for search."
},
"display_name": {
"default": "Stemming Exceptions"
},
"module_type": "BM",
"name": "stemming_exceptions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the sorting rules for this site."
},
"display_name": {
"default": "Sorting Rules"
},
"module_type": "BM",
"name": "sorting_rules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the sorting rules presented to storefront customers."
},
"display_name": {
"default": "Storefront Sorting Options"
},
"module_type": "BM",
"name": "sorting_options",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search preferences for this site."
},
"display_name": {
"default": "Search Preferences"
},
"module_type": "BM",
"name": "search_preferences",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export search settings and sorting rules of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "search_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "search",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Online Marketing"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage campaigns for promotions, content slots, and sorting rules."
},
"display_name": {
"default": "Campaigns"
},
"module_type": "BM",
"name": "marketing_campaigns",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the A/B tests for promotions, content slots, and sorting rules."
},
"display_name": {
"default": "A/B Tests"
},
"module_type": "BM",
"name": "marketing_abtests",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the promotions for this site."
},
"display_name": {
"default": "Promotions"
},
"module_type": "BM",
"name": "marketing_promotions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the dynamic slot configurations of this site."
},
"display_name": {
"default": "Content Slots"
},
"module_type": "BM",
"name": "marketing_slot",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the coupon codes of this site."
},
"display_name": {
"default": "Coupons"
},
"module_type": "BM",
"name": "marketing_coupons",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage how the storefront handles incoming source codes."
},
"display_name": {
"default": "Source Code Groups"
},
"module_type": "BM",
"name": "sourcecode",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the active data of this site."
},
"display_name": {
"default": "Active Data"
},
"module_type": "BM",
"name": "marketing_activedata",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage store addresses and locations."
},
"display_name": {
"default": "Stores"
},
"module_type": "BM",
"name": "marketing_storelocations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the gift certificates of this site."
},
"display_name": {
"default": "Gift Certificates"
},
"module_type": "BM",
"name": "marketing_giftcert",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export marketing data of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "marketing_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "marketing",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Customers"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the customers of this site."
},
"display_name": {
"default": "Customers"
},
"module_type": "BM",
"name": "customers_manage",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the customer groups of this site."
},
"display_name": {
"default": "Customer Groups"
},
"module_type": "BM",
"name": "customers_groups",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage customer data snapshots."
},
"display_name": {
"default": "Snapshots"
},
"module_type": "BM",
"name": "customers_gdpr",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "customers_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export customers, customer groups and customers product lists."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "customers_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "customers",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Custom Objects"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage custom object instances."
},
"display_name": {
"default": "Custom Object Editor"
},
"module_type": "BM",
"name": "site-obj_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "site-obj_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export custom objects of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "site-obj_editor",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-obj",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Ordering"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the orders of this site."
},
"display_name": {
"default": "Orders"
},
"module_type": "BM",
"name": "orders_manage",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage taxation settings of this site."
},
"display_name": {
"default": "Taxation"
},
"module_type": "BM",
"name": "orders_taxation",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the payment processors of this site."
},
"display_name": {
"default": "Payment Processors"
},
"module_type": "BM",
"name": "orders_paymethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the payment methods of this site."
},
"display_name": {
"default": "Payment Methods"
},
"module_type": "BM",
"name": "orders_paymentmethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the shipping methods of this site."
},
"display_name": {
"default": "Shipping Methods"
},
"module_type": "BM",
"name": "orders_shipmethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export ordering data of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "orders_export",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Capture orders on behalf of a customer."
},
"display_name": {
"default": "Customer Service Center"
},
"module_type": "BM",
"name": "customer_service_center_module",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "orders",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Analytics"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "\n These reports and dashboards provide filterable metrics for all sites. You must have the appropriate role assigned in Account Manager to access Reports and Dashboards.\n "
},
"display_name": {
"default": "Reports and Dashboards (New!)"
},
"module_type": "BM",
"name": "analytics_reportsdashboards",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "\n These reports include data on the conversion of visits, shopping carts, and checkouts to orders, as well as visits to shopping carts, to checkouts, and to orders. They also list information about the conversion of search phrases.\n "
},
"display_name": {
"default": "Conversion Reports"
},
"module_type": "BM",
"name": "analytics_conversion",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the orders and revenue, average revenue, average order, ordered products, and gift certificates."
},
"display_name": {
"default": "Purchase Reports"
},
"module_type": "BM",
"name": "analytics_purchase",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top products ordered by quantity and by revenue."
},
"display_name": {
"default": "Catalog Reports"
},
"module_type": "BM",
"name": "analytics_catalog",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top search terms, the top referring search engines, and the conversion of search phrases."
},
"display_name": {
"default": "Search and Navigation Reports"
},
"module_type": "BM",
"name": "analytics_seachnav",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the number of new customers, number of first time buyers, and the total number of registered customers."
},
"display_name": {
"default": "Customer Reports"
},
"module_type": "BM",
"name": "analytics_customer",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top pages, top referrers, top user agents, top robots, total requests, request runtime, total visits, and visit duration."
},
"display_name": {
"default": "Traffic Reports"
},
"module_type": "BM",
"name": "analytics_traffic",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide an overview of the A/B tests performed on your store and include data on group segmentation and conversion rates."
},
"display_name": {
"default": "A/B Testing Reports"
},
"module_type": "BM",
"name": "analytics_abtesting",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide insight into technical operations data of your store such as pipeline performance numbers and page caching characteristics."
},
"display_name": {
"default": "Technical Reports"
},
"module_type": "BM",
"name": "analytics_technical",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide insight into object churn trends, performance numbers, and characteristics."
},
"display_name": {
"default": "Object Churn Trends"
},
"module_type": "BM",
"name": "analytics_object_manipulation",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "analytics",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site URLs"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Define URL rules for this site."
},
"display_name": {
"default": "URL Rules"
},
"module_type": "BM",
"name": "site-urls_searchsupport",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define URL redirect rules for this site."
},
"display_name": {
"default": "URL Redirects"
},
"module_type": "BM",
"name": "site-urls_url-redirects",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define dynamic URL mapping rules for this site."
},
"display_name": {
"default": "Dynamic Mapping"
},
"module_type": "BM",
"name": "site-urls_url-mapping-rules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define static URL mapping rules for this site."
},
"display_name": {
"default": "Static Mapping"
},
"module_type": "BM",
"name": "site-urls_url-mappings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define robots behavior for the current site."
},
"display_name": {
"default": "Robots"
},
"module_type": "BM",
"name": "site-urls_url-robots",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define host name aliases for this site."
},
"display_name": {
"default": "Aliases"
},
"module_type": "BM",
"name": "site-urls_aliases",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define customer CDN settings for this site."
},
"display_name": {
"default": "Customer CDN Settings"
},
"module_type": "BM",
"name": "site-urls_customer_cdns",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure XML Sitemap feed for search engines like Google, Bing, Yahoo, Baidu and Yandex."
},
"display_name": {
"default": "Sitemaps"
},
"module_type": "BM",
"name": "site-urls_sitemaps",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Get detailed information about URL request processing."
},
"display_name": {
"default": "URL Request Analyzer"
},
"module_type": "BM",
"name": "site-urls_url-request-analyzer",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-urls",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site Preferences"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Define the locking preferences for products and content assets."
},
"display_name": {
"default": "Locking"
},
"module_type": "BM",
"name": "site-prefs_prodlocking",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the behavior of baskets on this site."
},
"display_name": {
"default": "Baskets"
},
"module_type": "BM",
"name": "site-prefs_cart",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the behavior of A/B tests on this site."
},
"display_name": {
"default": "A/B Tests"
},
"module_type": "BM",
"name": "site-prefs_abtest",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the site's allowed and default locales."
},
"display_name": {
"default": "Locales"
},
"module_type": "BM",
"name": "site-prefs_sitelocales",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the site's currencies."
},
"display_name": {
"default": "Currencies"
},
"module_type": "BM",
"name": "site-prefs_currencies",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage source code settings."
},
"display_name": {
"default": "Source Codes"
},
"module_type": "BM",
"name": "site-prefs_sourcecode",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the gift certificates preferences for this site."
},
"display_name": {
"default": "Gift Certificates"
},
"module_type": "BM",
"name": "site-prefs_giftcertificates",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search preferences for this site."
},
"display_name": {
"default": "Search Preferences"
},
"module_type": "BM",
"name": "site-prefs_search",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage sequence numbers assigned to your orders."
},
"display_name": {
"default": "Sequence Numbers"
},
"module_type": "BM",
"name": "site-prefs_seriesnumbers",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage essential order settings for this site."
},
"display_name": {
"default": "Order"
},
"module_type": "BM",
"name": "site-prefs_orderexport",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the coupon preferences for this site."
},
"display_name": {
"default": "Coupons"
},
"module_type": "BM",
"name": "site-prefs_couponprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the promotion preferences for this site."
},
"display_name": {
"default": "Promotions"
},
"module_type": "BM",
"name": "site-prefs_promotionprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the storefront toolkit preferences for this site."
},
"display_name": {
"default": "Storefront Toolkit"
},
"module_type": "BM",
"name": "site-prefs_storefronttoolkitprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure storefront URL preferences."
},
"display_name": {
"default": "Storefront URLs"
},
"module_type": "BM",
"name": "site-prefs_storefront_url_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure custom site preferences."
},
"display_name": {
"default": "Custom Preferences"
},
"module_type": "BM",
"name": "site-prefs_custom_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Pinterest Commerce configuration."
},
"display_name": {
"default": "Pinterest Commerce"
},
"module_type": "BM",
"name": "site-prefs_pinterest_commerce",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage privacy preferences for this site."
},
"display_name": {
"default": "Privacy"
},
"module_type": "BM",
"name": "site-prefs_privacy",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the Customer Service Center preferences for this site."
},
"display_name": {
"default": "Customer Service Center Preferences"
},
"module_type": "BM",
"name": "site-prefs_csc",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Apple Pay configuration."
},
"display_name": {
"default": "Apple Pay"
},
"module_type": "BM",
"name": "site-prefs_apple-pay",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-prefs",
"type": "module"
}
]
},
"module_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/module",
"types": [
"module",
"functional",
"webdav",
"locale"
],
"webdav_link": "https://example.com/s/-/dw/data/v23_2/permissions/bm/webdav"
}Get Functional Permissions
Get functional permissions per scope.Url
GET https://hostname:port/dw/data/v23_2/permissions/bm/functionalFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/bm/functional HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "functional_permissions",
"organization": [
{
"_type": "functional_permission",
"description": {
"default": "Allows to access log files and import/export directories on the server via WebDAV."
},
"display_name": {
"default": "WebDAV_Transfer_Files"
},
"name": "WebDAV_Transfer_Files",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to access directories of custom cartridges via WebDAV."
},
"display_name": {
"default": "WebDAV_Manage_Customization"
},
"name": "WebDAV_Manage_Customization",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to access the realm-wide shared directory via WebDAV."
},
"display_name": {
"default": "WebDAV_Realm_Access"
},
"name": "WebDAV_Realm_Access",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to access the security logs via WebDAV."
},
"display_name": {
"default": "WebDAV_Security_Logs_Access"
},
"name": "WebDAV_Security_Logs_Access",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage and start data replication processes for global replication groups (i.e. system object type definitions)."
},
"display_name": {
"default": "Replication_Run_For_Org"
},
"name": "Replication_Run_For_Org",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage all catalogs and their assets in all sites."
},
"display_name": {
"default": "Manage_All_Catalogs"
},
"name": "Manage_All_Catalogs",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to delete catalogs including all their assets in all sites. Required for catalog import functionality. Prerequisite: requires permission Manage_All_Catalogs in order to take effect."
},
"display_name": {
"default": "Delete_All_Catalogs"
},
"name": "Delete_All_Catalogs",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage all libraries and their assets in all sites."
},
"display_name": {
"default": "Manage_All_Libraries"
},
"name": "Manage_All_Libraries",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage all pricebooks and product prices in all sites."
},
"display_name": {
"default": "Manage_All_PriceBooks"
},
"name": "Manage_All_PriceBooks",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage all inventory lists and inventory records in all sites."
},
"display_name": {
"default": "Manage_Inventory"
},
"name": "Manage_Inventory",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to merge customers of one customer list into another customer list."
},
"display_name": {
"default": "Merge_Customers"
},
"name": "Merge_Customers",
"type": "functional",
"values": [
"ACCESS"
]
}
],
"scopes": [
"site",
"organization"
],
"site": [
{
"_type": "functional_permission",
"description": {
"default": "Allows administrators to log into storefront on behalf of a customer."
},
"display_name": {
"default": "Login_On_Behalf"
},
"name": "Login_On_Behalf",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage and start data replication processes for site-specific replication groups (i.e. search indexes)."
},
"display_name": {
"default": "Replication_Run_For_Site"
},
"name": "Replication_Run_For_Site",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to log in as an agent user to the storefront. Restrict the access to only those Business Manager users that have permission 'Login_Agent'."
},
"display_name": {
"default": "Login_Agent"
},
"name": "Login_Agent",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage the catalog and its assets in the selected site."
},
"display_name": {
"default": "Manage_Site_Catalog"
},
"name": "Manage_Site_Catalog",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage a library and its assets in the selected site."
},
"display_name": {
"default": "Manage_Site_Library"
},
"name": "Manage_Site_Library",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage the price books assigned to the selected site."
},
"display_name": {
"default": "Manage_Site_PriceBooks"
},
"name": "Manage_Site_PriceBooks",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to manage the site inventory list and its inventory records in the selected site."
},
"display_name": {
"default": "Manage_Site_Inventory"
},
"name": "Manage_Site_Inventory",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows the addition or deletion of a price adjustment at the item level."
},
"display_name": {
"default": "Adjust_Item_Price"
},
"name": "Adjust_Item_Price",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows the addition or deletion of a price adjustment at the shipping level."
},
"display_name": {
"default": "Adjust_Shipping_Price"
},
"name": "Adjust_Shipping_Price",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows the addition or deletion of a price adjustment at the order level."
},
"display_name": {
"default": "Adjust_Order_Price"
},
"name": "Adjust_Order_Price",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows the deletion of a note at the order or basket level."
},
"display_name": {
"default": "Delete_Order_Note"
},
"name": "Delete_Order_Note",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows the deletion of an order."
},
"display_name": {
"default": "Delete_Order"
},
"name": "Delete_Order",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to create an order as an agent via the Shop API."
},
"display_name": {
"default": "Create_Order_On_Behalf_Of"
},
"name": "Create_Order_On_Behalf_Of",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to search for orders as an agent via the Shop API."
},
"display_name": {
"default": "Search_Orders"
},
"name": "Search_Orders",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows to handle external orders as an agent via the Shop API."
},
"display_name": {
"default": "Handle_External_Orders"
},
"name": "Handle_External_Orders",
"type": "functional",
"values": [
"ACCESS"
]
},
{
"_type": "functional_permission",
"description": {
"default": "Allows access to a password-protected storefront."
},
"display_name": {
"default": "Access_Protected_Storefront"
},
"name": "Access_Protected_Storefront",
"type": "functional",
"values": [
"ACCESS"
]
}
]
}Get Locale Permissions
Get locale permissions per scope.Url
GET https://hostname:port/dw/data/v23_2/permissions/bm/localeFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/bm/locale HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "locale_permissions",
"scopes": [
"unscoped"
],
"unscoped": [
{
"_type": "locale_permission",
"display_name": {
"default": "Default"
},
"locale_id": "default",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Arabic"
},
"locale_id": "ar",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Arabic (Algeria)"
},
"locale_id": "ar_DZ",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Chinese"
},
"locale_id": "zh",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Chinese (China)"
},
"locale_id": "zh_CN",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Dutch"
},
"locale_id": "nl",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "English"
},
"locale_id": "en",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "English (Canada)"
},
"locale_id": "en_CA",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "English (United States)"
},
"locale_id": "en_US",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "French"
},
"locale_id": "fr",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "French (Belgium)"
},
"locale_id": "fr_BE",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "French (Canada)"
},
"locale_id": "fr_CA",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "French (France)"
},
"locale_id": "fr_FR",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "German"
},
"locale_id": "de",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "German (Germany)"
},
"locale_id": "de_DE",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "locale_permission",
"display_name": {
"default": "Spanish"
},
"locale_id": "es",
"type": "locale",
"values": [
"ACCESS",
"READONLY"
]
}
]
}Get Business Manager Module Permissions
Get Business Manager module permissions per scope.Url
GET https://hostname:port/dw/data/v23_2/permissions/bm/moduleFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/bm/module HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "module_permissions",
"organization": [
{
"_type": "menu_item",
"display_name": {
"default": "Replication"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Start and control data replication processes."
},
"display_name": {
"default": "Data Replication"
},
"module_type": "BM",
"name": "global-data-rep-processes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Start and control code replication processes."
},
"display_name": {
"default": "Code Replication"
},
"module_type": "BM",
"name": "global-code-rep-processes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "global-replication",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Organization"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the organization profile including its default language."
},
"display_name": {
"default": "Organization Profile"
},
"module_type": "BM",
"name": "organization_profile",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the Business Manager users. If you also have permission for the Business Manager module \"Roles & Permissions\", this module allows you to assign and unassign the users to access roles."
},
"display_name": {
"default": "Users"
},
"module_type": "BM",
"name": "organization_users",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage roles and permissions. If you also have permission to the Business Manager module \"Users\", this module allows you to assign and unassign users to the access role."
},
"display_name": {
"default": "Roles & Permissions"
},
"module_type": "BM",
"name": "organization_roles",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage WebDAV Client Application Permissions."
},
"display_name": {
"default": "WebDAV Client Permissions"
},
"module_type": "BM",
"name": "webdavclient_permissions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "organization",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Sites"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the sites of this organization."
},
"display_name": {
"default": "Manage Sites"
},
"module_type": "BM",
"name": "sites_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the customer lists of this organization."
},
"display_name": {
"default": "Customer Lists"
},
"module_type": "BM",
"name": "customerlists_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage and assign content libraries for sites."
},
"display_name": {
"default": "Content Libraries"
},
"module_type": "BM",
"name": "contentlibraries_manage",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "customerlists_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the hostnames and certificates for your embedded CDN."
},
"display_name": {
"default": "Embedded CDN Settings"
},
"module_type": "BM",
"name": "cdnManager",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "sites",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site Development"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Set up and configure Commerce Cloud UX Studio, view log files, and access files via WebDAV."
},
"display_name": {
"default": "Development Setup"
},
"module_type": "BM",
"name": "studio_setup",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View, activate, and delete code versions. Upload deployment archives."
},
"display_name": {
"default": "Code Deployment"
},
"module_type": "BM",
"name": "studio_code_deployment",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Customize type definitions of system objects."
},
"display_name": {
"default": "System Object Types"
},
"module_type": "BM",
"name": "studio_system_obj",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage type definitions for your custom objects."
},
"display_name": {
"default": "Custom Object Types"
},
"module_type": "BM",
"name": "studio_custom_obj",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Modify the displayed error pages in case the server is down or there is any other emergency."
},
"display_name": {
"default": "Custom Error Pages"
},
"module_type": "BM",
"name": "customization_err",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Modify the displayed pages in case the server is down for maintenance."
},
"display_name": {
"default": "Custom Maintenance Pages"
},
"module_type": "BM",
"name": "customization_maint",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Display deprecated API usage."
},
"display_name": {
"default": "Deprecated API Usage"
},
"module_type": "BM",
"name": "development_deprecated_api",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export object type definitions and custom object types."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "customization_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export of entire site and instance configurations."
},
"display_name": {
"default": "Site Import & Export"
},
"module_type": "BM",
"name": "instance_setup",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Open Commerce API settings."
},
"display_name": {
"default": "Open Commerce API Settings"
},
"module_type": "BM",
"name": "wapi_settings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure settings for the Customer Service Center, e.g. customizable areas."
},
"display_name": {
"default": "Customer Service Center Settings"
},
"module_type": "BM",
"name": "csc_config",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "studio",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Global Preferences"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Activate, deactivate, and maintain the locales and regional settings of the system."
},
"display_name": {
"default": "Locales"
},
"module_type": "BM",
"name": "global-prefs_locales",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and modify the instance time zone."
},
"display_name": {
"default": "Instance Time Zone"
},
"module_type": "BM",
"name": "global-prefs_timeZones",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure the change history settings for this instance."
},
"display_name": {
"default": "Change History"
},
"module_type": "BM",
"name": "auditing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure OAuth2 Providers for this instance."
},
"display_name": {
"default": "OAuth2 Providers"
},
"module_type": "BM",
"name": "oauth-providers",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Set the password restrictions and login lockout policies for all Business Manager users."
},
"display_name": {
"default": "Security"
},
"module_type": "BM",
"name": "global-prefs_securityPrefs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and validate geolocations as the basis of the store locator."
},
"display_name": {
"default": "Store Locator Data"
},
"module_type": "BM",
"name": "geolocations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View, create or delete instance page meta tag definitions."
},
"display_name": {
"default": "Page Meta Tags"
},
"module_type": "BM",
"name": "global-prefs_pagemetatags",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Activate or deactivate features for this instance."
},
"display_name": {
"default": "Feature Switches"
},
"module_type": "BM",
"name": "feature_switch_manager",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define global order search preferences."
},
"display_name": {
"default": "Order Search"
},
"module_type": "BM",
"name": "global-prefs_order_search",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage sequence numbers assigned to your orders and customers."
},
"display_name": {
"default": "Sequence Numbers"
},
"module_type": "BM",
"name": "global-prefs_orders_seriesnumbers",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define global product preferences."
},
"display_name": {
"default": "Products"
},
"module_type": "BM",
"name": "global-prefs_prodlocking",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage global retention settings for this instance."
},
"display_name": {
"default": "Retention Settings"
},
"module_type": "BM",
"name": "global-prefs_product_lists",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Adjust global settings for Import and Export."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "impex_settings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View global client timeouts for this instance."
},
"display_name": {
"default": "Global Timeouts"
},
"module_type": "BM",
"name": "global-prefs_timeouts",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure global custom preferences."
},
"display_name": {
"default": "Custom Preferences"
},
"module_type": "BM",
"name": "global-prefs_custom_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Opt in for Einstein Search Dictionaries."
},
"display_name": {
"default": "Einstein Search Dictionaries Opt-In"
},
"module_type": "BM",
"name": "global-prefs_einstein_data_privacy",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure Business Manager Analytics preferences for this instance."
},
"display_name": {
"default": "Analytics"
},
"module_type": "BM",
"name": "bma_config",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "global-prefs",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Operations"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Schedule, start, or check the status of scheduled jobs."
},
"display_name": {
"default": "Job Schedules"
},
"module_type": "BM",
"name": "jobschedules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View job history (Beta)."
},
"display_name": {
"default": "Job History"
},
"module_type": "BM",
"name": "jobmonitor",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Schedule, start, or check the status of scheduled jobs."
},
"display_name": {
"default": "Job Schedules (deprecated)"
},
"module_type": "BM",
"name": "operations_jobschedules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View job history."
},
"display_name": {
"default": "Job History (deprecated)"
},
"module_type": "BM",
"name": "operations_jobmonitor",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View an aggregated list of job run times per day."
},
"display_name": {
"default": "Job Statistics"
},
"module_type": "BM",
"name": "operations_jobstatistics",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export job schedules and services."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "operations_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and generate GMV and Order Journal reports."
},
"display_name": {
"default": "GMV Reports"
},
"module_type": "BM",
"name": "operations_exportorderjournal",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage custom log settings."
},
"display_name": {
"default": "Custom Log Settings"
},
"module_type": "BM",
"name": "operations_customlogging",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Start/Stop Code Profiling and View Results"
},
"display_name": {
"default": "Code Profiler"
},
"module_type": "BM",
"name": "operations_tracing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Profile and evaluate pipeline runtime performance."
},
"display_name": {
"default": "Pipeline Profiler"
},
"module_type": "BM",
"name": "operations_pipeline_performance",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Display quota status and limits."
},
"display_name": {
"default": "Quota Status"
},
"module_type": "BM",
"name": "operations_quotastatus",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View the change history of various object types."
},
"display_name": {
"default": "Change History"
},
"module_type": "BM",
"name": "operations_auditing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Monitor encryption keys used for internal encryption of sensitive data."
},
"display_name": {
"default": "Encryption Keys"
},
"module_type": "BM",
"name": "operations_encryption_keys",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage private keys and certificates."
},
"display_name": {
"default": "Private Keys and Certificates"
},
"module_type": "BM",
"name": "operations_certificates",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage services, service credentials, and service profiles."
},
"display_name": {
"default": "Services"
},
"module_type": "BM",
"name": "operations_services",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View reports of service status and performance."
},
"display_name": {
"default": "Service Status"
},
"module_type": "BM",
"name": "operations_services_stats",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "View and validate geolocation lookup for IP addresses."
},
"display_name": {
"default": "IP Address Geolocation Data"
},
"module_type": "BM",
"name": "operations_geoip",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure Predictive Intelligence settings."
},
"display_name": {
"default": "Predictive Intelligence"
},
"module_type": "BM",
"name": "operations_cqconfig",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "operations",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "World Wide Distribution"
},
"module_type": "BM",
"name": "worldwidedistribution",
"type": "module"
}
],
"scopes": [
"site",
"organization"
],
"site": [
{
"_type": "menu_item",
"display_name": {
"default": "Products and Catalogs"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the products of the organization."
},
"display_name": {
"default": "Products"
},
"module_type": "BM",
"name": "prod-cat_products",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the product sets of the organization."
},
"display_name": {
"default": "Product Sets"
},
"module_type": "BM",
"name": "prod-cat_product_sets",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the catalogs of the organization."
},
"display_name": {
"default": "Catalogs"
},
"module_type": "BM",
"name": "prod-cat_catalogs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage shared product options of a catalog."
},
"display_name": {
"default": "Product Options"
},
"module_type": "BM",
"name": "prod-cat_product_options",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage shared variation attributes of a catalog."
},
"display_name": {
"default": "Variation Attributes"
},
"module_type": "BM",
"name": "prod-cat_product_variations",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the recommendations for each of the organization catalogs."
},
"display_name": {
"default": "Recommendations"
},
"module_type": "BM",
"name": "prod-cat_recommendations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the price books of the organization."
},
"display_name": {
"default": "Price Books"
},
"module_type": "BM",
"name": "prod-cat_pricebooks",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the inventory lists of the organization."
},
"display_name": {
"default": "Inventory Lists"
},
"module_type": "BM",
"name": "prod-cat_inventory",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Schedule and run various catalog feeds."
},
"display_name": {
"default": "Catalog Feeds"
},
"module_type": "BM",
"name": "prod-cat_feeds",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "prod-cat_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export products and catalogs of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "prod-cat_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "prod-cat",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Content"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "View the content libraries for the organization. "
},
"display_name": {
"default": "Libraries"
},
"module_type": "BM",
"name": "library_content_libraries",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage folder structures of libraries."
},
"display_name": {
"default": "Library Folder"
},
"module_type": "BM",
"name": "library_folder",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the content assets of the site library."
},
"display_name": {
"default": "Content Assets"
},
"module_type": "BM",
"name": "library_content",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export library content of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "content_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "content",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Search"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage search indexes."
},
"display_name": {
"default": "Search Indexes"
},
"module_type": "BM",
"name": "search_indexes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search index rebuild schedule."
},
"display_name": {
"default": "Search Index Rebuild Schedule"
},
"module_type": "BM",
"name": "search_index_schedule",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Test queries against product index."
},
"display_name": {
"default": "Search Index Query Testing"
},
"module_type": "BM",
"name": "search_query_testing",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the dictionaries used by search."
},
"display_name": {
"default": "Search Dictionaries"
},
"module_type": "BM",
"name": "search_dictionaries",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the searchable attributes for this site."
},
"display_name": {
"default": "Searchable Attributes"
},
"module_type": "BM",
"name": "search_attributes",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage search driven redirect rules."
},
"display_name": {
"default": "Search Driven Redirects"
},
"module_type": "BM",
"name": "search_index_redirects",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage stop words for search."
},
"display_name": {
"default": "Stop Word Dictionary"
},
"module_type": "BM",
"name": "search_stopwords",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage category name indexing exclusions."
},
"display_name": {
"default": "Category Name Exclusions"
},
"module_type": "BM",
"name": "search_category-name-exclusions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage synonyms for search."
},
"display_name": {
"default": "Synonym Dictionary"
},
"module_type": "BM",
"name": "search_synonyms",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage hypernyms for search."
},
"display_name": {
"default": "Hypernym Dictionary"
},
"module_type": "BM",
"name": "search_hypernyms",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage compound words for search."
},
"display_name": {
"default": "Compound Word Dictionary"
},
"module_type": "BM",
"name": "search_compound-words",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage common phrases for search."
},
"display_name": {
"default": "Common Phrase Dictionary"
},
"module_type": "BM",
"name": "search_common-phrases",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage additional suggestion phrases and the suggestion black list."
},
"display_name": {
"default": "Search Suggestions"
},
"module_type": "BM",
"name": "search_suggestions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage stemming exceptions for search."
},
"display_name": {
"default": "Stemming Exceptions"
},
"module_type": "BM",
"name": "stemming_exceptions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the sorting rules for this site."
},
"display_name": {
"default": "Sorting Rules"
},
"module_type": "BM",
"name": "sorting_rules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the sorting rules presented to storefront customers."
},
"display_name": {
"default": "Storefront Sorting Options"
},
"module_type": "BM",
"name": "sorting_options",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search preferences for this site."
},
"display_name": {
"default": "Search Preferences"
},
"module_type": "BM",
"name": "search_preferences",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export search settings and sorting rules of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "search_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "search",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Online Marketing"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage campaigns for promotions, content slots, and sorting rules."
},
"display_name": {
"default": "Campaigns"
},
"module_type": "BM",
"name": "marketing_campaigns",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the A/B tests for promotions, content slots, and sorting rules."
},
"display_name": {
"default": "A/B Tests"
},
"module_type": "BM",
"name": "marketing_abtests",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the promotions for this site."
},
"display_name": {
"default": "Promotions"
},
"module_type": "BM",
"name": "marketing_promotions",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the dynamic slot configurations of this site."
},
"display_name": {
"default": "Content Slots"
},
"module_type": "BM",
"name": "marketing_slot",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the coupon codes of this site."
},
"display_name": {
"default": "Coupons"
},
"module_type": "BM",
"name": "marketing_coupons",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage how the storefront handles incoming source codes."
},
"display_name": {
"default": "Source Code Groups"
},
"module_type": "BM",
"name": "sourcecode",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the active data of this site."
},
"display_name": {
"default": "Active Data"
},
"module_type": "BM",
"name": "marketing_activedata",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage store addresses and locations."
},
"display_name": {
"default": "Stores"
},
"module_type": "BM",
"name": "marketing_storelocations",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the gift certificates of this site."
},
"display_name": {
"default": "Gift Certificates"
},
"module_type": "BM",
"name": "marketing_giftcert",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export marketing data of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "marketing_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "marketing",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Customers"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the customers of this site."
},
"display_name": {
"default": "Customers"
},
"module_type": "BM",
"name": "customers_manage",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the customer groups of this site."
},
"display_name": {
"default": "Customer Groups"
},
"module_type": "BM",
"name": "customers_groups",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage customer data snapshots."
},
"display_name": {
"default": "Snapshots"
},
"module_type": "BM",
"name": "customers_gdpr",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "customers_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export customers, customer groups and customers product lists."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "customers_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "customers",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Custom Objects"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage custom object instances."
},
"display_name": {
"default": "Custom Object Editor"
},
"module_type": "BM",
"name": "site-obj_impex",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Open the batch process monitor."
},
"display_name": {
"default": "Batch Processes"
},
"module_type": "BM",
"name": "site-obj_batchprocs",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export custom objects of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "site-obj_editor",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-obj",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Ordering"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Manage the orders of this site."
},
"display_name": {
"default": "Orders"
},
"module_type": "BM",
"name": "orders_manage",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage taxation settings of this site."
},
"display_name": {
"default": "Taxation"
},
"module_type": "BM",
"name": "orders_taxation",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the payment processors of this site."
},
"display_name": {
"default": "Payment Processors"
},
"module_type": "BM",
"name": "orders_paymethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the payment methods of this site."
},
"display_name": {
"default": "Payment Methods"
},
"module_type": "BM",
"name": "orders_paymentmethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the shipping methods of this site."
},
"display_name": {
"default": "Shipping Methods"
},
"module_type": "BM",
"name": "orders_shipmethods",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Import and export ordering data of this site."
},
"display_name": {
"default": "Import & Export"
},
"module_type": "BM",
"name": "orders_export",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Capture orders on behalf of a customer."
},
"display_name": {
"default": "Customer Service Center"
},
"module_type": "BM",
"name": "customer_service_center_module",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "orders",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Analytics"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "\n These reports and dashboards provide filterable metrics for all sites. You must have the appropriate role assigned in Account Manager to access Reports and Dashboards.\n "
},
"display_name": {
"default": "Reports and Dashboards (New!)"
},
"module_type": "BM",
"name": "analytics_reportsdashboards",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "\n These reports include data on the conversion of visits, shopping carts, and checkouts to orders, as well as visits to shopping carts, to checkouts, and to orders. They also list information about the conversion of search phrases.\n "
},
"display_name": {
"default": "Conversion Reports"
},
"module_type": "BM",
"name": "analytics_conversion",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the orders and revenue, average revenue, average order, ordered products, and gift certificates."
},
"display_name": {
"default": "Purchase Reports"
},
"module_type": "BM",
"name": "analytics_purchase",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top products ordered by quantity and by revenue."
},
"display_name": {
"default": "Catalog Reports"
},
"module_type": "BM",
"name": "analytics_catalog",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top search terms, the top referring search engines, and the conversion of search phrases."
},
"display_name": {
"default": "Search and Navigation Reports"
},
"module_type": "BM",
"name": "analytics_seachnav",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the number of new customers, number of first time buyers, and the total number of registered customers."
},
"display_name": {
"default": "Customer Reports"
},
"module_type": "BM",
"name": "analytics_customer",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports include data on the top pages, top referrers, top user agents, top robots, total requests, request runtime, total visits, and visit duration."
},
"display_name": {
"default": "Traffic Reports"
},
"module_type": "BM",
"name": "analytics_traffic",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide an overview of the A/B tests performed on your store and include data on group segmentation and conversion rates."
},
"display_name": {
"default": "A/B Testing Reports"
},
"module_type": "BM",
"name": "analytics_abtesting",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide insight into technical operations data of your store such as pipeline performance numbers and page caching characteristics."
},
"display_name": {
"default": "Technical Reports"
},
"module_type": "BM",
"name": "analytics_technical",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "These reports provide insight into object churn trends, performance numbers, and characteristics."
},
"display_name": {
"default": "Object Churn Trends"
},
"module_type": "BM",
"name": "analytics_object_manipulation",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "analytics",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site URLs"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Define URL rules for this site."
},
"display_name": {
"default": "URL Rules"
},
"module_type": "BM",
"name": "site-urls_searchsupport",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define URL redirect rules for this site."
},
"display_name": {
"default": "URL Redirects"
},
"module_type": "BM",
"name": "site-urls_url-redirects",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define dynamic URL mapping rules for this site."
},
"display_name": {
"default": "Dynamic Mapping"
},
"module_type": "BM",
"name": "site-urls_url-mapping-rules",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define static URL mapping rules for this site."
},
"display_name": {
"default": "Static Mapping"
},
"module_type": "BM",
"name": "site-urls_url-mappings",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define robots behavior for the current site."
},
"display_name": {
"default": "Robots"
},
"module_type": "BM",
"name": "site-urls_url-robots",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define host name aliases for this site."
},
"display_name": {
"default": "Aliases"
},
"module_type": "BM",
"name": "site-urls_aliases",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define customer CDN settings for this site."
},
"display_name": {
"default": "Customer CDN Settings"
},
"module_type": "BM",
"name": "site-urls_customer_cdns",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure XML Sitemap feed for search engines like Google, Bing, Yahoo, Baidu and Yandex."
},
"display_name": {
"default": "Sitemaps"
},
"module_type": "BM",
"name": "site-urls_sitemaps",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Get detailed information about URL request processing."
},
"display_name": {
"default": "URL Request Analyzer"
},
"module_type": "BM",
"name": "site-urls_url-request-analyzer",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-urls",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Site Preferences"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Define the locking preferences for products and content assets."
},
"display_name": {
"default": "Locking"
},
"module_type": "BM",
"name": "site-prefs_prodlocking",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the behavior of baskets on this site."
},
"display_name": {
"default": "Baskets"
},
"module_type": "BM",
"name": "site-prefs_cart",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the behavior of A/B tests on this site."
},
"display_name": {
"default": "A/B Tests"
},
"module_type": "BM",
"name": "site-prefs_abtest",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the site's allowed and default locales."
},
"display_name": {
"default": "Locales"
},
"module_type": "BM",
"name": "site-prefs_sitelocales",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Define the site's currencies."
},
"display_name": {
"default": "Currencies"
},
"module_type": "BM",
"name": "site-prefs_currencies",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage source code settings."
},
"display_name": {
"default": "Source Codes"
},
"module_type": "BM",
"name": "site-prefs_sourcecode",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the gift certificates preferences for this site."
},
"display_name": {
"default": "Gift Certificates"
},
"module_type": "BM",
"name": "site-prefs_giftcertificates",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the search preferences for this site."
},
"display_name": {
"default": "Search Preferences"
},
"module_type": "BM",
"name": "site-prefs_search",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage sequence numbers assigned to your orders."
},
"display_name": {
"default": "Sequence Numbers"
},
"module_type": "BM",
"name": "site-prefs_seriesnumbers",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage essential order settings for this site."
},
"display_name": {
"default": "Order"
},
"module_type": "BM",
"name": "site-prefs_orderexport",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the coupon preferences for this site."
},
"display_name": {
"default": "Coupons"
},
"module_type": "BM",
"name": "site-prefs_couponprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the promotion preferences for this site."
},
"display_name": {
"default": "Promotions"
},
"module_type": "BM",
"name": "site-prefs_promotionprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the storefront toolkit preferences for this site."
},
"display_name": {
"default": "Storefront Toolkit"
},
"module_type": "BM",
"name": "site-prefs_storefronttoolkitprefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure storefront URL preferences."
},
"display_name": {
"default": "Storefront URLs"
},
"module_type": "BM",
"name": "site-prefs_storefront_url_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Configure custom site preferences."
},
"display_name": {
"default": "Custom Preferences"
},
"module_type": "BM",
"name": "site-prefs_custom_prefs",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Pinterest Commerce configuration."
},
"display_name": {
"default": "Pinterest Commerce"
},
"module_type": "BM",
"name": "site-prefs_pinterest_commerce",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage privacy preferences for this site."
},
"display_name": {
"default": "Privacy"
},
"module_type": "BM",
"name": "site-prefs_privacy",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage the Customer Service Center preferences for this site."
},
"display_name": {
"default": "Customer Service Center Preferences"
},
"module_type": "BM",
"name": "site-prefs_csc",
"system": true,
"type": "module",
"values": [
"READONLY",
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Manage Apple Pay configuration."
},
"display_name": {
"default": "Apple Pay"
},
"module_type": "BM",
"name": "site-prefs_apple-pay",
"system": true,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "BM",
"name": "site-prefs",
"type": "module"
}
]
}Get WebDAV Permissions
Get WebDAV permissions per scope.Url
GET https://hostname:port/dw/data/v23_2/permissions/bm/webdavFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/bm/webdav HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "webdav_permissions",
"scopes": [
"unscoped"
],
"unscoped": [
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access '/impex' via WebDAV."
},
"folder": "/impex",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access '/logs' via WebDAV."
},
"folder": "/logs",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access '/static' via WebDAV."
},
"folder": "/static",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access '/temp' via WebDAV."
},
"folder": "/temp",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": ""
},
"folder": "/catalogs/*",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access catalog 'SiteGenesis' via WebDAV."
},
"folder": "/catalogs/SiteGenesis",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access catalog 'SiteGenesisGlobal' via WebDAV."
},
"folder": "/catalogs/SiteGenesisGlobal",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": ""
},
"folder": "/libraries/*",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access library 'SiteGenesis' via WebDAV."
},
"folder": "/libraries/SiteGenesis",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access library 'SiteGenesisGlobal' via WebDAV."
},
"folder": "/libraries/SiteGenesisGlobal",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": ""
},
"folder": "/dynamic/*",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access dynamic 'SiteGenesis' via WebDAV."
},
"folder": "/dynamic/SiteGenesis",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access dynamic 'SiteGenesisGlobal' via WebDAV."
},
"folder": "/dynamic/SiteGenesisGlobal",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": ""
},
"folder": "/CustomerSnapshots/*",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access customer snapshots for site 'SiteGenesis' via WebDAV."
},
"folder": "/CustomerSnapshots/SiteGenesis",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
},
{
"_type": "webdav_permission",
"description": {
"default": "Allows to access customer snapshots for site 'SiteGenesisGlobal' via WebDAV."
},
"folder": "/CustomerSnapshots/SiteGenesisGlobal",
"type": "webdav",
"values": [
"ACCESS",
"READONLY"
]
}
]
}Get Permissions
Get permissions per type.Url
GET https://hostname:port/dw/data/v23_2/permissions/csc?expand={String}Formats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Query Parameters
| Parameter | Type | Description | Constraints |
|---|---|---|---|
| expand | String | The permission expand. A comma separated list with the allowed values (module, functional, webdav, locale). |
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/csc?expand=module HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "cscpermissions",
"module": {
"_type": "module_permissions",
"scopes": [
"site",
"organization"
],
"site": [
{
"_type": "menu_item",
"display_name": {
"default": "Customer"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a customer address."
},
"display_name": {
"default": "Check Address"
},
"module_type": "CSC",
"name": "customer_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "customer",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Basket"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a shipping address."
},
"display_name": {
"default": "Check Shipping Address"
},
"module_type": "CSC",
"name": "basket_shipping_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Check a billing address."
},
"display_name": {
"default": "Check Billing Address"
},
"module_type": "CSC",
"name": "basket_billing_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Reserve inventory for the basket."
},
"display_name": {
"default": "Reserve Inventory"
},
"module_type": "CSC",
"name": "basket_reserve_inventory",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "basket",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Order"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a billing address."
},
"display_name": {
"default": "Check Billing Address"
},
"module_type": "CSC",
"name": "order_billing_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Check a shipping address."
},
"display_name": {
"default": "Check Shipping Address"
},
"module_type": "CSC",
"name": "order_shipping_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "order",
"type": "module"
}
]
},
"module_link": "https://example.com/s/-/dw/data/v23_2/permissions/csc/module",
"types": [
"module"
]
}Get CSC Module Permissions
Get CSC module permissions per scope.Url
GET https://hostname:port/dw/data/v23_2/permissions/csc/moduleFormats
json, xml
Authentication
| Name | Description |
|---|---|
| OAuth | Authentication via OAuth token. |
Response Document
Sample
REQUEST:
GET /s/-/dw/data/v23_2/permissions/csc/module HTTP/1.1
Host: example.com
Accept: application/json
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Content-Length:123456
{
"_v" : "23.2",
"_type": "module_permissions",
"scopes": [
"site",
"organization"
],
"site": [
{
"_type": "menu_item",
"display_name": {
"default": "Customer"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a customer address."
},
"display_name": {
"default": "Check Address"
},
"module_type": "CSC",
"name": "customer_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "customer",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Basket"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a shipping address."
},
"display_name": {
"default": "Check Shipping Address"
},
"module_type": "CSC",
"name": "basket_shipping_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Check a billing address."
},
"display_name": {
"default": "Check Billing Address"
},
"module_type": "CSC",
"name": "basket_billing_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Reserve inventory for the basket."
},
"display_name": {
"default": "Reserve Inventory"
},
"module_type": "CSC",
"name": "basket_reserve_inventory",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "basket",
"type": "module"
},
{
"_type": "menu_item",
"display_name": {
"default": "Order"
},
"menu_actions": [
{
"_type": "menu_action",
"description": {
"default": "Check a billing address."
},
"display_name": {
"default": "Check Billing Address"
},
"module_type": "CSC",
"name": "order_billing_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
},
{
"_type": "menu_action",
"description": {
"default": "Check a shipping address."
},
"display_name": {
"default": "Check Shipping Address"
},
"module_type": "CSC",
"name": "order_shipping_address_check",
"system": false,
"type": "module",
"values": [
"ACCESS"
]
}
],
"module_type": "CSC",
"name": "order",
"type": "module"
}
]
}X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.