Table of Contents
Get Started
Tasks
- Admin
- A-B Test Campaigns
- Access Rights
- Address Types
- Addresses
- AddThisInterests
- Admin Access Rights
- Admin Metadata Catalog
- Admin SAML AuthnRequest
- Admin SAML IdP Settings
- Admin SAML LogoutRequest
- Admin Security Criteria
- Admin Security Criteria Resources
- Admin Service Provider Entity Descriptor
- Admin Single Log out
- Admin Single Sign On
- Announcement and Quick Links
- Appeasement
- AppeasementTypes
- Application Deployments
- Application Level JavaScript
- Application Stylings
- Applications
- Asset Import-Export
- Asset Packages
- Audiences
- Blogs
- Browser Types
- Carriers
- Catalogs
- CEC Content
- Changed Assets
- Claimables
- CMS Channel Map Methods
- CMS Content Map Methods
- CMS Publish Notification Processing
- Collections
- Component Instance
- Component Selection
- Content Type
- Country Region
- Coupon Batches
- Currency
- Currency Exchange Rate
- Dashboard Report Configuration
- Data Admin
- Elements
- Email Notifications
- Enrichment Maps
- Error Log Entries
- Event WebHooks
- Export Operations
- Export Process
- Extension Server Environment Variables
- Extension Server\Extension Server Commands
- Extension Server\Extension Server Logs
- Extension Server\Extension Server Tail Logs
- Extension Server\Extension Server Test Jobs
- Extension Server\Extension Server Test Status
- Extensions
- Failed WebHook Messages
- Files
- Function WebHooks
- Hreflang Groups
- Import Operations
- Import Process
- Internal Profile Roles
- Internal Profiles
- Inventory
- Item Types
- JsFrameworkAdminEndpoint
- Layouts
- Locales
- Locations
- Logging
- Media Tag
- Merchant Settings
- createScheduledJob
- getAdminConfiguration
- getAgentConfiguration
- getAllowedUrls
- getASASettings
- getBasicAuthConfiguration
- getCloudConfiguration
- getCollectionEndpointsConfiguration
- getDefaultLocale
- getDefaultPriceListGroup
- getDirectEditConfiguration
- getDirectEditConfigurations
- getDirectPriceEditConfiguration
- getExtendedRemorsePeriod
- getExternalServiceData
- getExternalServicesData
- getFallbackShippingConfiguration
- getGateway
- getGateways
- getInventoryConfiguration
- getMerchantTimezone
- getPaymentTypes
- getPolicies
- getPriceListCurrency
- getRemorsePeriod
- getReportingCurrency
- getResponseHeaders
- getRestrictedWords
- getRevenueBilling
- getSamlSettings
- getScheduledJob
- getSeoConfig
- getShopperProfileConfiguration
- getStorefrontUrl
- getTextSearchSettings
- getWhitelistUrls
- getXssConfiguration
- listSelectedBillingCountries
- renewSamlCertificate
- saveAdminConfiguration
- saveAgentConfiguration
- saveExtendedRemorsePeriod
- saveItemPriceOverride
- savePolicies
- saveRemorsePeriod
- saveTextSearchSettings
- supportedJobs
- updateAllowedUrls
- updateASASettings
- updateBasicAuthConfiguration
- updateClientConfiguration
- updateCloudConfiguration
- updateCollectionEndpointsConfiguration
- updateDefaultLocale
- updateDefaultPriceListGroup
- updateDirectEditConfiguration
- updateDirectPriceEditConfiguration
- updateExternalServiceData
- updateFallbackShippingConfiguration
- updateGateway
- updateInventoryConfiguration
- updateMerchantTimezone
- updatePaymentTypes
- updatePriceLocale
- updateReportingCurrency
- updateResponseHeaders
- updateRestrictedWords
- updateRobotsFile
- updateSamlSettings
- updateScheduledJob
- updateSelectedBillingCountries
- updateSeoConfig
- updateShopperProfileConfiguration
- updateWhitelistUrls
- updateXssConfiguration
- Message Tags
- Metadata
- Notification messages
- Notification settings
- OAuth
- OOTB SSE
- OpenID
- Order Types
- Orders
- Organization Request
- Organizations
- add an secondary address to an Organization
- createOrganization
- delete an Address for an Organization
- generates the authorization code for an Organization
- get Address for an Organization
- Get site based Organization properties
- getOrganization
- listOrganizationRoles
- listOrganizations
- update address for an Organization
- update site based Organization properties
- updateOrganization
- Page Tags
- Create a body end page tag.
- Create a body start page tag.
- Create a head page tag.
- Delete a body end tag.
- Delete a body start tag.
- Delete a head tag.
- Get a body end page tag.
- Get a body start page tag.
- Get a head page tag.
- List body end page tags.
- List body start page tags.
- List head page tags.
- Update a body end page tag.
- Update a body start page tag.
- Update a head page tag.
- PaymentGateways
- Places
- PriceListGroup
- Prices
- Product Notify
- Product Properties
- Product Types
- Products
- Profile Context List
- Profile Request
- Profiles
- addProfileAddress
- addUserRoles
- appendSecondaryOrganizations
- batchGrantPromotions
- createProfile
- deleteProfileAddress
- getCreditCard
- getProfile
- getProfileAddress
- listCreditCards
- listProfileAddresses
- listProfiles
- listRoles associated with a profile
- removeRoles
- removeSecondaryOrganizations
- replaceSecondaryOrganizations
- resetPassword
- updateCreditCard
- updateParentOrganization
- updateProfile
- updateProfileAddress
- updateProfiles
- updateUserRoles
- Promotion Folders
- Promotion Templates
- Promotions
- Publishing
- Publishing Change Applications
- Publishing Change Authors
- Publishing Change Lists
- Publishing Changes
- Publishing History
- Reasons
- Recommendations
- createRecommendationGlobalRule
- createRecommendationStrategy
- deleteRecommendationGlobalRule
- deleteRecommendationStrategy
- getRecommendationGlobalRule
- getRecommendationGlobalRuleConditions
- getRecommendationStrategy
- getRecommendationStrategyConditions
- listRecommendationGlobalRules
- listRecommendationStrategies
- updateRecommendationGlobalRule
- updateRecommendationStrategy
- Redirects
- Register Admin
- Report Cache
- Report Filter Configuration
- Reports
- Resources
- Response Filters
- Return Requests
- Roles
- SAML IdP Settings
- Search Admin and Configuration
- Application Configuration
- Application Operations
- Dimension Value Service
- Facet Lists
- Index Attributes
- Create an index attribute
- Create index attributes
- Create owner attributes
- Delete an index attribute
- Delete index Attributes
- Delete owner index attributes
- Partial update an index attribute
- Partial update owner attributes
- Partially update index attributes
- Update an index attribute
- Update index attributes
- Update owner attributes
- View index attribute
- View index attributes
- View owner attributes
- Keyword Redirects
- Create an Keyword Redirect Entry.
- Create Keyword Redirect Group.
- Create Keyword Redirects Configuration
- Delete Keyword Redirect Entry
- Delete Keyword Redirect Group
- Delete Keyword Redirects
- Partial update Keyword Redirect Entry.
- Partial update Keyword Redirect Group.
- Partial update Keyword Redirects Configuration
- Update an Keyword Redirect Entry.
- Update Keyword Redirect Group.
- Update Keyword Redirects configuration
- View Keyword Redirect Entry.
- View Keyword Redirect Group.
- View Keyword Redirects
- Page Configuration
- Creates a page configuration
- Creates a page root for a application
- Creates a site for a application
- Delete page root of a application
- Deletes the page.
- Deletes the site.
- Gets a list of immediate pages defined under site home
- Gets a Page configuration or lists down immediate pages under requested page.
- Updates a page configuration
- View all sites defined in a application
- Ranking Rules Configuration
- Rule Configuration
- Creates a rule configuration.
- Creates content collection folder at specified location.
- Creates content node for a application
- Delete content node of a application
- Deletes a content collection folder.
- Deletes a Rule.
- Updates a rule configuration.
- View content collection folders under 'content' root node.
- View rule definition
- View rules and content collection folders under specified content collection folder.
- Search Index Configuration
- Search Interfaces
- Create a search interface
- Create a search interface folder
- Delete a search interface
- Delete a search interface folder
- Partial update a search interface
- Partial update a search interface folder
- Update a search interface
- Update a search interface folder
- View a search interface
- View a search interface folder
- Services Configuration
- Thesaurus
- Search Data and Indexing
- Server Extensions
- Shipping Methods
- Shipping Regions
- Shopper Input
- Shopper Types
- Site Create Forms
- SiteGroups
- Sites
- Sites Settings
- SKU Properties
- Skus
- Slot Descriptors
- Slots
- Stack Descriptor
- StackingRules
- Stacks
- Tax Processor Manager
- Tenant
- Themes
- Clone a theme by ID
- Compile Agent Theme.
- Compile theme for asset.
- Compile theme.
- Compiles a Block of Less Code.
- Deletes a theme by its ID
- Link an image to a theme section.
- Parse theme.
- Recompile active theme.
- Restore a theme's source by ID
- Retrieve a theme by ID
- Retrieve a theme's source by ID
- Retrieve an active theme
- Retrieve the Agent theme source
- Retrieve the compilation settings for themes
- Retrieve themes
- Retrieves the Agent theme
- Set theme as the active agent theme.
- Sets a particular these as active.
- Update a theme by its ID
- Update a theme image
- Update a theme's source by its ID
- Update the Agent theme
- Update the Agent theme source
- Update the compilation settings for themes
- Timezone
- Token Cache
- UI Events
- URL Patterns
- Variants
- widgetDescriptors
- getAllWidgetDescriptors
- getAllWidgetDescriptorsByPageType
- getAllWidgetInstances
- getConfigDefinitionForWidgetDescriptor
- getConfigLocaleContentForWidgetDescriptor
- getConfigMetadataForWidgetDescriptor
- getFragmentMetadata
- getInstancesForWidgetDescriptor
- getSchemaForWidgetDescriptor
- getWidgetDescriptorBaseLess
- getWidgetDescriptorBaseLocaleContent
- getWidgetDescriptorBaseTemplate
- getWidgetDescriptorById
- getWidgetDescriptorJavascriptInfoById
- getWidgetDescriptorMetadata
- updateConfigLocaleContentForWidgetDescriptor
- updateConfigMetadataForWidgetDescriptor
- updateFragmentJavaScript
- updateFragmentMetadata
- updateFragmentTemplate
- updateHiddenWidgetTypes
- updateWidgetDescriptorBaseLess
- updateWidgetDescriptorBaseLocaleContent
- updateWidgetDescriptorBaseTemplate
- updateWidgetDescriptorJavascript
- updateWidgetDescriptorMetadata
- updateWidgetDescriptorSites
- Widgets
- Worksets
- Agent
- Agent Comments
- Agent Metadata Catalog
- Agent SAML AuthnRequest
- Agent SAML LogoutRequest
- Agent Service Provider Entity Descriptor
- Agent Single Log out
- Agent Single Sign On
- Appeasement
- AppeasementTypes
- Collections
- Currency
- Customers
- addCreditCard
- addProfileAddress
- createProfile
- deleteMultipleProfiles
- deleteProfile
- deleteProfileAddress
- deleteProfiles
- getCreditCard
- getProfile
- getProfileAddress
- listCreditCards
- listProfileAddresses
- listSiteProperties
- removeCreditCard
- resetPassword
- searchProfiles
- updateCreditCard
- updateProfile
- updateProfileAddress
- updateSiteProperties
- Exchange Order
- Files
- Internal Profiles
- Item Types
- List Country Region
- Locations
- Merchant Settings
- Metadata
- OAuth
- OpenID
- Order Amendment
- Order Types
- Orders
- approveOrder
- checkRequiresApproval
- copyOrder
- createOrder
- getGiftWithPurchaseChoices
- getOrder
- getUpsellMessages
- handleOrderActions
- initiateCancelOrder
- pickupItems
- redactOrder
- redactOrders
- rejectOrder
- rejectQuote
- removeIncompleteOrderForProfile
- repriceOrder
- requestQuote
- searchOrders
- submitCancelOrder
- updateOrder
- Organization Members
- Organization Request
- Organizations
- Organizations Address List
- Organizations Addresses
- Pages
- Payment
- Payment Groups
- PriceListGroup
- Prices
- Privacy
- Product Variants
- Products
- Profile Request
- PurchaseLists
- Reasons
- Reports
- Return Order
- Scheduled Orders
- Search
- Shipping Methods
- Shopper Context Endpoint
- Shopper Types
- Sites
- Sku
- Stock Status
- Recommendations
- Social Wish Lists
- Store
- Access Rights
- Address Types
- Assembler
- assemblerPages
- Audience Context
- Audience Membership
- CEC Content
- Client Applications
- Collections
- Country Region
- Currency
- Error Log Entries
- Files
- Images
- Inventory
- Item Types
- Locations
- Logging
- Merchant Settings
- Metadata
- OAuth
- Orders
- Approve an order
- Cancel an order
- Check an order requires approval
- copyOrder
- Create an order
- Get all orders for profile
- Get an order
- Get valid actions
- Initiate cancel of an order
- Price an order
- Reject a quote
- Reject an order
- Remove profile's incomplete order by ID
- Request a quote
- Retrieve an initial order by payment type
- Retrieve an order confirmation by UUID
- Retrieve return requests
- Retrieve the Gift-With-Purchase choices
- Submit cancel of an order
- Submit the quoted order
- Switch the current order
- Update an order
- Update the quoted order
- Current
- Organization Members
- Organization Request
- Organizations
- Organizations Address List
- Organizations Addresses
- Pages
- Payment
- Payment Groups
- PriceListGroup
- Prices
- Product Notify
- Product Types
- Products
- Profile Request
- Profiles
- addCreditCard
- addProfileAddress
- createProfile
- deleteProfileAddress
- getCreditCard
- getCurrentProfile
- getProfileAddress
- listCreditCards
- listProfileAddresses
- listSiteProperties
- registerProfile
- removeCreditCard
- resetPassword
- updateCreditCard
- updateExpiredPassword
- updateProfile
- updateProfileAddress
- updateSiteProperties
- Publishing
- PurchaseLists
- Resources
- Return Requests
- Roles
- SAML AuthnRequest
- Scheduled Orders
- Search
- Services
- ShareSettings
- Shipping Methods
- Shipping Regions
- Shopper Context Endpoint
- Sites
- Skus
- Static Wishlist
- Stock Status
- Store Extension
- Admin
- Orders
- Organization Request
- Organizations
- add an secondary address to an Organization
- createOrganization
- delete an Address for an Organization
- generates the authorization code for an Organization
- get Address for an Organization
- Get site based Organization properties
- getOrganization
- listOrganizationRoles
- listOrganizations
- update address for an Organization
- update site based Organization properties
- updateOrganization
- Profiles
- addProfileAddress
- appendSecondaryOrganizations
- createProfile
- deleteProfileAddress
- getProfile
- getProfileAddress
- listProfileAddresses
- listProfiles
- removeSecondaryOrganizations
- replaceSecondaryOrganizations
- resetPassword
- updateParentOrganization
- updateProfile
- updateProfileAddress
- updateProfiles
- updateUserRoles
- Promotions
- Token Cache
- Agent
- Customers
- addCreditCard
- addProfileAddress
- createProfile
- deleteMultipleProfiles
- deleteProfile
- deleteProfileAddress
- deleteProfiles
- getCreditCard
- getProfile
- getProfileAddress
- listCreditCards
- listProfileAddresses
- listSiteProperties
- removeCreditCard
- resetPassword
- searchProfiles
- updateCreditCard
- updateProfile
- updateProfileAddress
- updateSiteProperties
- Orders
- Customers
- Admin
- Store Metadata Catalog
- Timezone
- Visitor Info
- Web Analytics
- Webhook
- Account Assets
- Appeasement Submit
- Appeasement Validation
- ASA Additional Properties
- Asset Actions
- Calculate Shipping
- Cancel
- Cancel Order Update
- Cancel PCI
- Catalog and Price Group Assignment
- Contact Accounts
- Custom Currency
- Data Export
- Data Import
- Delete Order
- Design Studio Asset Update
- External Price Validation
- External Promotions
- External Tax Calculation
- Generic Card Payment
- Generic Payment
- Idle Cart
- Non PCI Return Request Validation
- Order
- Order Approvals
- Order Qualification
- Order Validation
- OrderRetryFailed
- OrderRetryFailed PCI
- Organization
- Organization Request
- Profile Request
- Publish Event
- Redact Order
- Remorse period started for a non PCI order
- Remorse period started for a PCI order
- Request Quote
- Return
- Return PCI
- Return Request Validation
- Shopper Profile Create
- Shopper Profile Delete
- Shopper Profile Update
- Update Inventory
- Update Quote