All REST Endpoints
Admin/Access Rights
Access Right endpoints
- createAccessRight
- Method: postPath:
/ccadmin/v1/accessRights
- getAccessRight
- Method: getPath:
/ccadmin/v1/accessRights/{id}
- listAccessRights
- Method: getPath:
/ccadmin/v1/accessRights
- updateAccessRight
- Method: putPath:
/ccadmin/v1/accessRights/{id}
Admin/AddThisInterests
Endpoint for retrieving suggestions for AddThis interests as you type. Unlike other listing endpoints, this one should really only be used with the q (filter) param. For example, GET .../addThisInterests/limit=10&sort=rank:desc&q=displayName co "fish".
- getAddThisInterests
- Method: getPath:
/ccadmin/v1/addThisInterests
Admin/Address Types
Endpoints for operations on address types.
- createAddressType
- Method: postPath:
/ccadmin/v1/addressTypes
- deleteAddressType
- Method: deletePath:
/ccadmin/v1/addressTypes/{id}
- listAddressTypes
- Method: getPath:
/ccadmin/v1/addressTypes
- updateAddressType
- Method: putPath:
/ccadmin/v1/addressTypes/{id}
Admin/Addresses
Addresses Endpoints
- listAddresses
- Method: getPath:
/ccadmin/v1/addresses
Admin/Admin Access Rights
Admin Access Right endpoints
- createAdminAccessRight
- Method: postPath:
/ccadmin/v1/adminAccessRights
- getAdminAccessRight
- Method: getPath:
/ccadmin/v1/adminAccessRights/{id}
- listAdminAccessRights
- Method: getPath:
/ccadmin/v1/adminAccessRights
- updateAdminAccessRight
- Method: putPath:
/ccadmin/v1/adminAccessRights/{id}
Admin/Admin Metadata Catalog
Metadata Catalog Admin Endpoints
- getBulkMetadata
- Method: getPath:
/ccadmin/v1/metadata-catalog/bulk
- getMetadataCatalog
- Method: getPath:
/ccadmin/v1/metadata-catalog
- getResourceMetadata
- Method: getPath:
/ccadmin/v1/metadata-catalog/{id}
- getWebhookMetadata
- Method: getPath:
/ccadmin/v1/metadata-catalog/webhook
- getWebHookResourceMetadata
- Method: getPath:
/ccadmin/v1/metadata-catalog/webhook/{id}
Admin/Admin SAML AuthnRequest
The operations from the Admin/Admin SAML AuthnRequest category.
- get SAML AuthnRequest
- Method: getPath:
/ccadmin/v1/saml/authnRequest
Admin/Admin SAML IdP Settings
The operations from the Admin/Admin SAML IdP Settings category.
- get Admin SAML IDP settings
- Method: getPath:
/ccadmin/v1/saml/metadata/idpSettings
- update Admin SAML IDP settings
- Method: putPath:
/ccadmin/v1/saml/metadata/idpSettings
Admin/Admin SAML LogoutRequest
The operations from the Admin/Admin SAML LogoutRequest category.
- get SAML LogoutRequest
- Method: getPath:
/ccadmin/v1/saml/logoutRequest
Admin/Admin Service Provider Entity Descriptor
The operations from the Admin/Admin Service Provider Entity Descriptor category.
- get Service Provider Entity Descriptor XML
- Method: getPath:
/ccadmin/v1/saml/metadata/spEntityDescriptor
- get Service Provider Signing Certificate
- Method: getPath:
/ccadmin/v1/saml/metadata/spCertificate
Admin/Admin Single Log out
The operations from the Admin/Admin Single Log out category.
- single log out
- Method: postPath:
/ccadmin/v1/saml/slo
Admin/Admin Single Sign On
The operations from the Admin/Admin Single Sign On category.
- single sign on
- Method: postPath:
/ccadmin/v1/saml/sso
Admin/Announcement and Quick Links
Announcement and Quick Links endpoint.
- createPost
- Method: postPath:
/ccadmin/v1/posts
- deletePost
- Method: deletePath:
/ccadmin/v1/posts/{id}
- getPost
- Method: getPath:
/ccadmin/v1/posts/{id}
- getPosts
- Method: getPath:
/ccadmin/v1/posts
- handlePostUpdates
- Method: putPath:
/ccadmin/v1/posts/{id}
Admin/Appeasement
The operations from the Admin/Appeasement category.
- createAppeasement
- Method: postPath:
/ccadmin/v1/appeasements
- deleteAppeasement
- Method: deletePath:
/ccadmin/v1/appeasements/{id}
- getAppeasement
- Method: getPath:
/ccadmin/v1/appeasements/{id}
- listAppeasements
- Method: getPath:
/ccadmin/v1/appeasements
- updateAppeasement
- Method: putPath:
/ccadmin/v1/appeasements/{id}
Admin/AppeasementTypes
Appeasement Types Admin endpoints
- createType
- Method: postPath:
/ccadmin/v1/appeasementTypes
- getType
- Method: getPath:
/ccadmin/v1/appeasementTypes/{id}
- listTypes
- Method: getPath:
/ccadmin/v1/appeasementTypes
- updateType
- Method: putPath:
/ccadmin/v1/appeasementTypes/{id}
Admin/Application Level JavaScript
Endpoints for operations on Application Level JavaScript.
- getApplicationJavaScript
- Method: getPath:
/ccadmin/v1/applicationJavaScript/{name}
- listAllApplicationJavaScript
- Method: getPath:
/ccadmin/v1/applicationJavaScript
- updateApplicationJavaScript
- Method: putPath:
/ccadmin/v1/applicationJavaScript/{name}
Admin/Application Stylings
Application Styling Endpoints.
- createApplicationStyling
- Method: postPath:
/ccadmin/v1/applicationStyling
- deleteApplicationStyling
- Method: deletePath:
/ccadmin/v1/applicationStyling/{id}
- getApplicationStyling
- Method: getPath:
/ccadmin/v1/applicationStyling/{id}
- getApplicationStylingSource
- Method: getPath:
/ccadmin/v1/applicationStyling/{id}/source
- listApplicationStylings
- Method: getPath:
/ccadmin/v1/applicationStyling
- updateApplicationStyling
- Method: putPath:
/ccadmin/v1/applicationStyling/{id}
- updateApplicationStylingSource
- Method: putPath:
/ccadmin/v1/applicationStyling/{id}/source
Admin/Applications
Endpoints for operations on Applications.
- appIdOperation
- Method: postPath:
/ccadmin/v1/applicationIds/{id}
- createApplicationID
- Method: postPath:
/ccadmin/v1/applicationIds
- deleteApplicationID
- Method: deletePath:
/ccadmin/v1/applicationIds/{id}
- getApplicationID
- Method: getPath:
/ccadmin/v1/applicationIds/{id}
- getApplicationIDs
- Method: getPath:
/ccadmin/v1/applicationIds
- updateApplicationID
- Method: putPath:
/ccadmin/v1/applicationIds/{id}
Admin/Asset Import-Export
Asset import/export endpoints
- exportAssets
- Method: getPath:
/ccadmin/v1/asset/export
- getImportProgress
- Method: getPath:
/ccadmin/v1/asset/import/{token}
- getImportStatus
- Method: getPath:
/ccadmin/v1/asset/importStatus
- getValidationReport
- Method: getPath:
/ccadmin/v1/asset/validationReport/{token}
- importAssets
- Method: postPath:
/ccadmin/v1/asset/import
- uploadAssets
- Method: postPath:
/ccadmin/v1/asset/upload
- validateAssets
- Method: postPath:
/ccadmin/v1/asset/validate
Admin/Asset Packages
Endpoint operations for asset packages
- getAssetPackage
- Method: getPath:
/ccadmin/v1/assetPackages/{assetId}
Admin/Audience Rule Properties
Endpoint for querying the properties available for building Audience rules
- listAudienceRuleProperties
- Method: getPath:
/ccadmin/v1/audienceRuleProperties
Admin/Audience Sizes
This endpoint produces a list of shopper counts for a given list of Audience rules. The endpoint also returns the total estimated number of registered shoppers in the system.
- audienceSizes
- Method: postPath:
/ccadmin/v1/audienceSizes
Admin/Audience Usage
Retrieve the list of Audience consumers. The items in the response will have the following fields: id, displayName, assetType, assetTypeDisplayName, description. Items may also have an optional additionalMetaData property.
- audienceUsage
- Method: getPath:
/ccadmin/v1/audienceUsage/{id}
Admin/Audiences
Endpoints for managing Audiences used for personalization.
- createAudience
- Method: postPath:
/ccadmin/v1/audiences
- deleteAudience
- Method: deletePath:
/ccadmin/v1/audiences/{id}
- getAudience
- Method: getPath:
/ccadmin/v1/audiences/{id}
- listAudiences
- Method: getPath:
/ccadmin/v1/audiences
- updateAudience
- Method: putPath:
/ccadmin/v1/audiences/{id}
Admin/Blogs
Blogs endpoint
- listBlogEntries
- Method: getPath:
/ccadmin/v1/blogs
Admin/Browser Types
Endpoints for managing browser types and their associated User-Agent patterns, specifically the user agents that should be served Cloud Commerce static page snapshots instead of JavaScript-enabled pages.
- deleteBrowserType
- Method: deletePath:
/ccadmin/v1/browserTypes/{id}
- getBrowserType
- Method: getPath:
/ccadmin/v1/browserTypes/{id}
- setBrowserType
- Method: putPath:
/ccadmin/v1/browserTypes/{id}
Admin/CMS Channel Map Methods
Endpoints for operations on CMS Channel Maps.
- createCmsChannelMap
- Method: postPath:
/ccadmin/v1/cmsChannelMaps
- deleteCmsChannelMap
- Method: deletePath:
/ccadmin/v1/cmsChannelMaps/{id}
- getCmsChannelMap
- Method: getPath:
/ccadmin/v1/cmsChannelMaps/{id}
- listCmsChannelMaps
- Method: getPath:
/ccadmin/v1/cmsChannelMaps
- updateCmsChannelMap
- Method: putPath:
/ccadmin/v1/cmsChannelMaps
Admin/CMS Content Map Methods
Endpoints for operations on CMS Content Maps.
- createCmsContentMap
- Method: postPath:
/ccadmin/v1/cmsContentMaps
- deleteCmsContentMap
- Method: deletePath:
/ccadmin/v1/cmsContentMaps/{id}
- getCmsContentMap
- Method: getPath:
/ccadmin/v1/cmsContentMaps/{id}
- listCmsContentMaps
- Method: getPath:
/ccadmin/v1/cmsContentMaps
- updateCmsContentMap
- Method: putPath:
/ccadmin/v1/cmsContentMaps
Admin/CMS Publish Notification Processing
Process notifications from external Content Management Systems.
- notify
- Method: postPath:
/ccadmin/v1/contentnotification/{cmsId}
Admin/Carriers
Endpoints for Carrier Operations.
- addCarrier
- Method: postPath:
/ccadmin/v1/carriers
- getAllCarriers
- Method: getPath:
/ccadmin/v1/carriers
- getCarrier
- Method: getPath:
/ccadmin/v1/carriers/{id}
- updateCarrier
- Method: putPath:
/ccadmin/v1/carriers/{id}
Admin/Catalogs
Catalog endpoints
- createCatalog
- Method: postPath:
/ccadmin/v1/catalogs
- deleteCatalog
- Method: deletePath:
/ccadmin/v1/catalogs/{id}
- getCatalog
- Method: getPath:
/ccadmin/v1/catalogs/{id}
- listCatalogs
- Method: getPath:
/ccadmin/v1/catalogs
- updateCatalog
- Method: putPath:
/ccadmin/v1/catalogs/{id}
Admin/Claimables
Endpoints related to the creation and manipulation of promotion claimables.
- createPromotionClaimable
- Method: postPath:
/ccadmin/v1/claimables
- deletePromotionClaimable
- Method: deletePath:
/ccadmin/v1/claimables/{id}
- getPromotionClaimable
- Method: getPath:
/ccadmin/v1/claimables/{id}
- listPromotionClaimables
- Method: getPath:
/ccadmin/v1/claimables
- updatePromotionClaimable
- Method: putPath:
/ccadmin/v1/claimables/{id}
Admin/Collections
Collection endpoints
- assignProducts
- Method: postPath:
/ccadmin/v1/collections/assignProducts
- createCollection
- Method: postPath:
/ccadmin/v1/collections
- deleteCollection
- Method: deletePath:
/ccadmin/v1/collections/{id}
- getCollection
- Method: getPath:
/ccadmin/v1/collections/{id}
- listCollections
- Method: getPath:
/ccadmin/v1/collections
- moveCollection
- Method: putPath:
/ccadmin/v1/collections
- updateCollection
- Method: putPath:
/ccadmin/v1/collections/{id}
Admin/Content Type
The operations from the Admin/Content Type category.
- Retrieve list of OCE (CEC) Content Items
- Method: getPath:
/ccadmin/v1/cecContentType
Admin/Country Region
Endpoints for read operations on Country and its states and regions
- addCountries
- Method: postPath:
/ccadmin/v1/countries/addCountries
- addRegions
- Method: postPath:
/ccadmin/v1/countries/{id}/addRegions
- deleteCountries
- Method: postPath:
/ccadmin/v1/countries/deleteCountries
- deleteCountry
- Method: deletePath:
/ccadmin/v1/countries/{id}
- deleteRegions
- Method: postPath:
/ccadmin/v1/countries/{id}/deleteRegions
- getCountryRegions
- Method: getPath:
/ccadmin/v1/countries/{id}
- listCountries
- Method: getPath:
/ccadmin/v1/countries
- updateCountryRegions
- Method: putPath:
/ccadmin/v1/countries/{id}
Admin/Coupon Batches
Endpoints related to the management of coupon batches for promotions.
- createPromotionCouponBatch
- Method: postPath:
/ccadmin/v1/couponBatches
- deletePromotionCouponBatch
- Method: deletePath:
/ccadmin/v1/couponBatches/{id}
- getCouponBatch
- Method: getPath:
/ccadmin/v1/couponBatches/{id}
- listPromotionCouponBatches
- Method: getPath:
/ccadmin/v1/couponBatches
- updateCouponBatch
- Method: putPath:
/ccadmin/v1/couponBatches/{id}
Admin/Currency
Endpoints for operations on currencies.
- createCurrency
- Method: postPath:
/ccadmin/v1/currencies
- deleteCurrency
- Method: deletePath:
/ccadmin/v1/currencies/{id}
- getCurrency
- Method: getPath:
/ccadmin/v1/currencies/{id}
- listCurrencies
- Method: getPath:
/ccadmin/v1/currencies
- updateCurrency
- Method: putPath:
/ccadmin/v1/currencies/{id}
Admin/Currency Exchange Rate
Endpoints for operations on currency exchange rates.
- createExchangeRate
- Method: postPath:
/ccadmin/v1/exchangerates
- deleteExchangeRate
- Method: deletePath:
/ccadmin/v1/exchangerates/{id}
- getExchangeRate
- Method: getPath:
/ccadmin/v1/exchangerates/{id}
- listExchangeRates
- Method: getPath:
/ccadmin/v1/exchangerates
- updateExchangeRate
- Method: putPath:
/ccadmin/v1/exchangerates/{id}
Admin/Dashboard Report Configuration
Endpoints for the Admin dashboard report configurations.
- getDashboardReportConfigurations
- Method: getPath:
/ccadmin/v1/dashboardReportConfigurations
Admin/Data Admin
Data Admin endpoints
- getAdminData
- Method: getPath:
/ccadmin/v1/dataAdmin/{dataKey}
- Retrieve list of CEC Content Items
- Method: getPath:
/ccadmin/v1/cecContent
Admin/Elements
Endpoints for operations on Global Elements.
- getElements
- Method: getPath:
/ccadmin/v1/elements
- getGlobalElementJavaScript
- Method: getPath:
/ccadmin/v1/elements/{tag}/javascript
- getGlobalElementMetadata
- Method: getPath:
/ccadmin/v1/elements/{tag}/metadata
- getGlobalElementTemplate
- Method: getPath:
/ccadmin/v1/elements/{tag}/template
- updateGlobalElementJavaScript
- Method: putPath:
/ccadmin/v1/elements/{tag}/javascript
- updateGlobalElementMetadata
- Method: putPath:
/ccadmin/v1/elements/{tag}/metadata
- updateGlobalElementTemplate
- Method: putPath:
/ccadmin/v1/elements/{tag}/template
Admin/Email
for Email Service Data
- downloadEmailTemplates
- Method: getPath:
/ccadmin/v1/email/types/{emailTypeId}/templates
- getEmailNotificationTypes
- Method: getPath:
/ccadmin/v1/email/notificationTypes
- updateEmailTemplates
- Method: putPath:
/ccadmin/v1/email/types/{emailTypeId}/templates
Admin/Email Notifications
for Email Notifications
- sendEmailNotification
- Method: postPath:
/ccadmin/v1/emailNotifications
Admin/Error Log Entries
Error Log Entry endpoints
- createErrorlog
- Method: postPath:
/ccadmin/v1/errorLogs
Admin/Event WebHooks
Event WebHook endpoints. Event WebHooks send events to one or more external servers.
- getWebHook
- Method: getPath:
/ccadmin/v1/webhooks/{id}
- getWebHooks
- Method: getPath:
/ccadmin/v1/webhooks
- updateWebHook
- Method: putPath:
/ccadmin/v1/webhooks/{id}
- updateWebHooks
- Method: putPath:
/ccadmin/v1/webhooks
- webHookOperation
- Method: postPath:
/ccadmin/v1/webhooks/{id}
Admin/Export Operations
Endpoint for export operations
- listExportOperations
- Method: getPath:
/ccadmin/v1/exportOperations
Admin/Export Process
Endpoints for export process
- abortExportProcess
- Method: postPath:
/ccadmin/v1/exportProcess/{token}/abort
- executeExport
- Method: postPath:
/ccadmin/v1/exportProcess
- getExportProcess
- Method: getPath:
/ccadmin/v1/exportProcess/{token}
Admin/Extension Server Commands
Endpoints for managing the extension servers.
- doServerPush
- Method: postPath:
/ccadmin/v1/servers/push
- doServerRestart
- Method: postPath:
/ccadmin/v1/servers/restart
Admin/Extension Server Environment Variables
Extension Server Environment Variables endpoints
- doCreateExtensionVariable
- Method: postPath:
/ccadmin/v1/extensionEnvironmentVariables
- doDeleteExtensionVariable
- Method: deletePath:
/ccadmin/v1/extensionEnvironmentVariables/{id}
- doGetExtensionVariable
- Method: getPath:
/ccadmin/v1/extensionEnvironmentVariables/{id}
- doUpdateExtensionVariable
- Method: putPath:
/ccadmin/v1/extensionEnvironmentVariables/{id}
- listExtensionVariable
- Method: getPath:
/ccadmin/v1/extensionEnvironmentVariables
Admin/Extension Server Lint Jobs
Endpoints for operations related to the execution of Extension Server Lint jobs.
- getCompletedLintJobs
- Method: getPath:
/ccadmin/v1/lintJobs
- getLintJobResults
- Method: getPath:
/ccadmin/v1/lintJobs/{id}
- lintJobExecutionRequest
- Method: postPath:
/ccadmin/v1/lintJobs
Admin/Extension Server Lint Status
Endpoints for operations on the status of Extension Server Lint jobs.
- getLintStatus
- Method: getPath:
/ccadmin/v1/lintStatus/{id}
Admin/Extension Server Logs
Endpoints for operations on Extension Server Logs.
- getExtensionServerLogs
- Method: getPath:
/ccadmin/v1/logs
Admin/Extension Server Tail Logs
The operations from the Admin/Extension Server Tail Logs category.
- getExtensionServerTailLogs
- Method: getPath:
/ccadmin/v1/logs/tail
Admin/Extension Server Test Jobs
Endpoints for operations related to the execution of Extension Server test jobs.
- getCompletedTestJobs
- Method: getPath:
/ccadmin/v1/testJobs
- getTestJobResults
- Method: getPath:
/ccadmin/v1/testJobs/{id}
- testJobExecutionRequest
- Method: postPath:
/ccadmin/v1/testJobs
Admin/Extension Server Test Status
Endpoints for operations on the status of Extension Server test jobs.
- getTestStatus
- Method: getPath:
/ccadmin/v1/testStatus/{id}
Admin/Extension Server/Lint Jobs
Endpoints for operations related to the execution of Extension Server Lint jobs.
- getCompletedLintJobs
- Method: getPath:
/ccadminx/custom/v1/lintJobs
- getLintJobResults
- Method: getPath:
/ccadminx/custom/v1/lintJobs/{id}
- lintJobExecutionRequest
- Method: postPath:
/ccadminx/custom/v1/lintJobs
Admin/Extension Server/Lint Status
Endpoints for operations on the status of Extension Server Lint jobs.
- getLintStatus
- Method: getPath:
/ccadminx/custom/v1/lintStatus/{id}
Admin/Extension Server/Logs
Endpoints for operations on the Extension Server logs.
- getExtensionServerLogs
- Method: getPath:
/ccadminx/custom/v1/logs
Admin/Extension Server/Server Commands
Endpoints for managing the extension servers.
- doServerPush
- Method: postPath:
/ccadminx/custom/v1/servers/push
- doServerRestart
- Method: postPath:
/ccadminx/custom/v1/servers/restart
Admin/Extension Server/Test Jobs
Endpoints for operations related to the execution of Extension Server test jobs.
- getCompletedTestJobs
- Method: getPath:
/ccadminx/custom/v1/testJobs
- getTestJobResults
- Method: getPath:
/ccadminx/custom/v1/testJobs/{id}
- testJobExecutionRequest
- Method: postPath:
/ccadminx/custom/v1/testJobs
Admin/Extension Server/Test Status
Endpoints for operations on the status of Extension Server test jobs.
- getTestStatus
- Method: getPath:
/ccadminx/custom/v1/testStatus/{id}
Admin/Extensions
Endpoints for operations on Extensions.
- createExtension
- Method: postPath:
/ccadmin/v1/extensions
- deleteExtension
- Method: deletePath:
/ccadmin/v1/extensions/{id}
- getAllExtensions
- Method: getPath:
/ccadmin/v1/extensions
- processExtension
- Method: postPath:
/ccadmin/v1/extensions/{id}
Admin/Failed WebHook Messages
Endpoints for viewing and managing WebHook messages that failed to be sent.
- deleteFailedMessage
- Method: deletePath:
/ccadmin/v1/webhookFailedMessages/{id}
- deleteFailedMessages
- Method: postPath:
/ccadmin/v1/webhookFailedMessages/delete
- getFailedMessage
- Method: getPath:
/ccadmin/v1/webhookFailedMessages/{id}
- getFailedMessages
- Method: getPath:
/ccadmin/v1/webhookFailedMessages
- requeueFailedMessages
- Method: postPath:
/ccadmin/v1/webhookFailedMessages/requeue
- updateFailedMessage
- Method: putPath:
/ccadmin/v1/webhookFailedMessages/{id}
- updateFailedMessages
- Method: putPath:
/ccadmin/v1/webhookFailedMessages
Admin/Files
File endpoints
- createFolder
- Method: postPath:
/ccadmin/v1/files/createFolder
- deleteFile
- Method: postPath:
/ccadmin/v1/files/deleteFile
- deleteFiles
- Method: postPath:
/ccadmin/v1/files/deleteFiles
- deleteMediaItems
- Method: postPath:
/ccadmin/v1/files/deleteMediaItems
- doFileSegmentUpload
- Method: postPath:
/ccadmin/v1/files/{id}
- doFileUploadMultipart
- Method: postPath:
/ccadmin/v1/files
- getFiles
- Method: getPath:
/ccadmin/v1/files
- getFileURI
- Method: getPath:
/ccadmin/v1/files/uriMapping/{id}
- getMediaContents
- Method: getPath:
/ccadmin/v1/files/mediaContents
- getUploadReport
- Method: getPath:
/ccadmin/v1/files/mediaUploadReport/{token}
- getUploadTypes
- Method: getPath:
/ccadmin/v1/files/uploadTypes
- resumeFileUpload
- Method: putPath:
/ccadmin/v1/files/{id}
- startFileUpload
- Method: putPath:
/ccadmin/v1/files
- updateMediaItem
- Method: putPath:
/ccadmin/v1/files/mediaContents
Admin/Function WebHooks
Function WebHook endpoints. Function WebHooks provide a means of invoking an external server to retrieve data or perform a calculation. Function WebHooks receive and return JSON.
- functionWebHookOperation
- Method: postPath:
/ccadmin/v1/functionWebhooks/{id}
- getFunctionWebHook
- Method: getPath:
/ccadmin/v1/functionWebhooks/{id}
- getFunctionWebHooks
- Method: getPath:
/ccadmin/v1/functionWebhooks
- updateFunctionWebHook
- Method: putPath:
/ccadmin/v1/functionWebhooks/{id}
- updateFunctionWebHooks
- Method: putPath:
/ccadmin/v1/functionWebhooks
Admin/Health Check
Admin health check endpoints
- deletePaymentGatewayAuthorizationResponses
- Method: deletePath:
/ccadmin/v1/healthCheck/payments
Admin/Hreflang Groups
The operations from the Admin/Hreflang Groups category.
- createGroup
- Method: postPath:
/ccadmin/v1/hreflangGroups
- deleteGroup
- Method: deletePath:
/ccadmin/v1/hreflangGroups/{id}
- getGroup
- Method: getPath:
/ccadmin/v1/hreflangGroups/{id}
- getGroups
- Method: getPath:
/ccadmin/v1/hreflangGroups
- updateGroup
- Method: putPath:
/ccadmin/v1/hreflangGroups/{id}
Admin/Import Operations
Endpoint for import operations
- listImportOperations
- Method: getPath:
/ccadmin/v1/importOperations
Admin/Import Process
Endpoints for import process
- abortImportProcess
- Method: postPath:
/ccadmin/v1/importProcess/{token}/abort
- executeImport
- Method: postPath:
/ccadmin/v1/importProcess
- getImportProcess
- Method: getPath:
/ccadmin/v1/importProcess/{token}
Admin/Internal Profile Roles
Internal Profile Roles endpoints
- createAdminRole
- Method: postPath:
/ccadmin/v1/adminRoles
- getAdminRole
- Method: getPath:
/ccadmin/v1/adminRoles/{id}
- listInternalProfileRoles
- Method: getPath:
/ccadmin/v1/adminRoles
- updateAdminRole
- Method: putPath:
/ccadmin/v1/adminRoles/{id}
Admin/Internal Profiles
Internal Profile endpoints
- createAdminProfile
- Method: postPath:
/ccadmin/v1/adminProfiles/
- getAdminProfile
- Method: getPath:
/ccadmin/v1/adminProfiles/{id}
- getAuthenticatorInfo
- Method: postPath:
/ccadmin/v1/adminProfiles/getAuthenticatorInfo
- getCurrentAdminProfile
- Method: getPath:
/ccadmin/v1/adminProfiles/current
- listAdminProfiles
- Method: getPath:
/ccadmin/v1/adminProfiles
- requestPasswordReset
- Method: postPath:
/ccadmin/v1/adminProfiles/requestPasswordReset
- resetAuthenticatorKey
- Method: postPath:
/ccadmin/v1/adminProfiles/resetAuthenticatorKey
- sendMFAPasswordReset
- Method: postPath:
/ccadmin/v1/adminProfiles/sendMFAPasswordReset
- sendNewAdminUserEmail
- Method: postPath:
/ccadmin/v1/adminProfiles/sendNewAdminUserEmail
- sendPasswordReset
- Method: postPath:
/ccadmin/v1/adminProfiles/sendPasswordReset
- updateAdminProfile
- Method: putPath:
/ccadmin/v1/adminProfiles/{id}
- updateCurrentAdminProfile
- Method: putPath:
/ccadmin/v1/adminProfiles/current
Admin/Inventory
Inventory endpoints
- createInventory
- Method: postPath:
/ccadmin/v1/inventories
- deleteInventory
- Method: deletePath:
/ccadmin/v1/inventories/{id}
- getInventory
- Method: getPath:
/ccadmin/v1/inventories/{id}
- listInventories
- Method: getPath:
/ccadmin/v1/inventories
- updateInventory
- Method: putPath:
/ccadmin/v1/inventories/{id}
Admin/Item Types
Item type admin endpoints
- deleteItemTypeProperty
- Method: deletePath:
/ccadmin/v1/itemTypes/{itemTypeId}/properties/{propertyId}
- getItemType
- Method: getPath:
/ccadmin/v1/itemTypes/{id}
- updateItemType
- Method: putPath:
/ccadmin/v1/itemTypes/{id}
Admin/JsFrameworkAdminEndpoint
JS Framework Admin Endpoints allow the administrator to upgrade to the latest storefront framework or roll back to the previous Storefront. In addition it also allows the administrator to upgrade to latest Agent JS framework and roll back to the previous Agent version
- getAgentCurrentVersionDetails
- Method: getPath:
/ccadmin/v1/jsframeworkadmin/agentVersion
- getCurrentVersionDetails
- Method: getPath:
/ccadmin/v1/jsframeworkadmin
- rollbackAgentCurrentVersion
- Method: postPath:
/ccadmin/v1/jsframeworkadmin/rollbackAgentVersion
- rollbackCurrentVersion
- Method: postPath:
/ccadmin/v1/jsframeworkadmin/rollbackVersion
- upgradeAgentCurrentVersion
- Method: postPath:
/ccadmin/v1/jsframeworkadmin/upgradeAgentVersion
- upgradeCurrentVersion
- Method: postPath:
/ccadmin/v1/jsframeworkadmin/upgradeVersion
Admin/Layouts
Layout endpoints
- cloneLayout
- Method: postPath:
/ccadmin/v1/layouts/{id}
- deleteLayout
- Method: deletePath:
/ccadmin/v1/layouts/{id}
- getLayout
- Method: getPath:
/ccadmin/v1/layouts/{id}
- getLayoutStructure
- Method: getPath:
/ccadmin/v1/layouts/{id}/structure
- listLayouts
- Method: getPath:
/ccadmin/v1/layouts
- saveLayoutStructure
- Method: putPath:
/ccadmin/v1/layouts/{id}/structure
- updateLayout
- Method: putPath:
/ccadmin/v1/layouts/{id}
Admin/Locales
Endpoints to access application supported locales.
- listLocales
- Method: getPath:
/ccadmin/v1/locales
Admin/Locations
Endpoints to support operations related to locations. A location identifies a store or warehouse that can house inventory.
- createLocation
- Method: postPath:
/ccadmin/v1/locations
- deleteLocation
- Method: deletePath:
/ccadmin/v1/locations/{id}
- getLocation
- Method: getPath:
/ccadmin/v1/locations/{id}
- listLocations
- Method: getPath:
/ccadmin/v1/locations
- updateLocation
- Method: putPath:
/ccadmin/v1/locations/{id}
Admin/Logging
Endpoints that interact with the server's log files.
- log
- Method: postPath:
/ccadmin/v1/logging/log
- logClientErrors
- Method: postPath:
/ccadmin/v1/logging/logClientErrors
- logInfoPost
- Method: postPath:
/ccadmin/v1/logging/logInfoPost
- logInfoPostWithHeaders
- Method: postPath:
/ccadmin/v1/logging/logInfoPostWithHeaders
- Query the storefront server logs for client side errors.
- Method: getPath:
/ccadmin/v1/logging
Admin/Media Tag
Endpoints related to the media tags associated with media items.
- listMediaTags
- Method: getPath:
/ccadmin/v1/mediaTags
Admin/Merchant Settings
Endpoints for merchant settings.
- createScheduledJob
- Method: postPath:
/ccadmin/v1/merchant/scheduledJobs
- getAdminConfiguration
- Method: getPath:
/ccadmin/v1/merchant/adminConfiguration
- getAgentConfiguration
- Method: getPath:
/ccadmin/v1/merchant/agentConfiguration
- getASASettings
- Method: getPath:
/ccadmin/v1/merchant/assistedSellingSettings
- getBasicAuthConfiguration
- Method: getPath:
/ccadmin/v1/merchant/basicAuth
- getCloudConfiguration
- Method: getPath:
/ccadmin/v1/merchant/cloudConfiguration
- getCollectionEndpointsConfiguration
- Method: getPath:
/ccadmin/v1/merchant/collectionEndpointsConfiguration
- getDefaultLocale
- Method: getPath:
/ccadmin/v1/merchant/defaultLocale
- getDefaultPriceListGroup
- Method: getPath:
/ccadmin/v1/merchant/defaultPriceListGroup
- getDirectEditConfiguration
- Method: getPath:
/ccadmin/v1/merchant/directEdit/{name}
- getDirectEditConfigurations
- Method: getPath:
/ccadmin/v1/merchant/directEdit/
- getDirectPriceEditConfiguration
- Method: getPath:
/ccadmin/v1/merchant/directPriceEdit
- getExtendedRemorsePeriod
- Method: getPath:
/ccadmin/v1/merchant/extendedRemorsePeriod
- getExternalServiceData
- Method: getPath:
/ccadmin/v1/merchant/{id}
- getExternalServicesData
- Method: getPath:
/ccadmin/v1/merchant
- getFallbackShippingConfiguration
- Method: getPath:
/ccadmin/v1/merchant/fallbackShippingConfiguration
- getGateway
- Method: getPath:
/ccadmin/v1/merchant/paymentGateways/{id}
- getGateways
- Method: getPath:
/ccadmin/v1/merchant/paymentGateways
- getInventoryConfiguration
- Method: getPath:
/ccadmin/v1/merchant/inventoryConfiguration
- getMerchantTimezone
- Method: getPath:
/ccadmin/v1/merchant/timezone
- getPaymentTypes
- Method: getPath:
/ccadmin/v1/merchant/paymentTypes
- getPolicies
- Method: getPath:
/ccadmin/v1/merchant/profilePolicies
- getPriceListCurrency
- Method: getPath:
/ccadmin/v1/merchant/priceListCurrency
- getRemorsePeriod
- Method: getPath:
/ccadmin/v1/merchant/remorsePeriod
- getReportingCurrency
- Method: getPath:
/ccadmin/v1/merchant/reportingCurrency
- getResponseHeaders
- Method: getPath:
/ccadmin/v1/merchant/responseHeaders
- getRestrictedWords
- Method: getPath:
/ccadmin/v1/merchant/profilePolicies/restrictedWords
- getRevenueBilling
- Method: getPath:
/ccadmin/v1/merchant/revenueBilling
- getSamlSettings
- Method: getPath:
/ccadmin/v1/merchant/samlSettings
- getScheduledJob
- Method: getPath:
/ccadmin/v1/merchant/scheduledJobs
- getSeoConfig
- Method: getPath:
/ccadmin/v1/merchant/seoConfig
- getShopperProfileConfiguration
- Method: getPath:
/ccadmin/v1/merchant/shopperProfileConfiguration
- getStorefrontUrl
- Method: getPath:
/ccadmin/v1/merchant/storefrontUrl
- getTextSearchSettings
- Method: getPath:
/ccadmin/v1/merchant/textSearch
- getWhitelistUrls
- Method: getPath:
/ccadmin/v1/merchant/whiteListUrls
- getXssConfiguration
- Method: getPath:
/ccadmin/v1/merchant/xssConfiguration
- listSelectedBillingCountries
- Method: getPath:
/ccadmin/v1/merchant/billingCountries
- saveAdminConfiguration
- Method: putPath:
/ccadmin/v1/merchant/adminConfiguration
- saveAgentConfiguration
- Method: putPath:
/ccadmin/v1/merchant/agentConfiguration
- saveExtendedRemorsePeriod
- Method: putPath:
/ccadmin/v1/merchant/extendedRemorsePeriod
- saveItemPriceOverride
- Method: putPath:
/ccadmin/v1/merchant/itemPriceOverride
- savePolicies
- Method: putPath:
/ccadmin/v1/merchant/profilePolicies
- saveRemorsePeriod
- Method: putPath:
/ccadmin/v1/merchant/remorsePeriod
- saveTextSearchSettings
- Method: putPath:
/ccadmin/v1/merchant/textSearch
- supportedJobs
- Method: getPath:
/ccadmin/v1/merchant/scheduledJobs/supportedJobs
- updateASASettings
- Method: putPath:
/ccadmin/v1/merchant/assistedSellingSettings
- updateBasicAuthConfiguration
- Method: putPath:
/ccadmin/v1/merchant/basicAuth
- updateClientConfiguration
- Method: putPath:
/ccadmin/v1/merchant/clientConfiguration
- updateCloudConfiguration
- Method: putPath:
/ccadmin/v1/merchant/cloudConfiguration
- updateCollectionEndpointsConfiguration
- Method: putPath:
/ccadmin/v1/merchant/collectionEndpointsConfiguration
- updateDefaultLocale
- Method: putPath:
/ccadmin/v1/merchant/defaultLocale
- updateDefaultPriceListGroup
- Method: putPath:
/ccadmin/v1/merchant/defaultPriceListGroup
- updateDirectEditConfiguration
- Method: putPath:
/ccadmin/v1/merchant/directEdit/{name}
- updateDirectPriceEditConfiguration
- Method: putPath:
/ccadmin/v1/merchant/directPriceEdit
- updateExternalServiceData
- Method: putPath:
/ccadmin/v1/merchant/{id}
- updateFallbackShippingConfiguration
- Method: putPath:
/ccadmin/v1/merchant/fallbackShippingConfiguration
- updateGateway
- Method: putPath:
/ccadmin/v1/merchant/paymentGateways
- updateInventoryConfiguration
- Method: putPath:
/ccadmin/v1/merchant/inventoryConfiguration
- updateMerchantTimezone
- Method: putPath:
/ccadmin/v1/merchant/timezone
- updatePaymentTypes
- Method: putPath:
/ccadmin/v1/merchant/paymentTypes
- updatePriceLocale
- Method: putPath:
/ccadmin/v1/merchant/priceLocale
- updateReportingCurrency
- Method: putPath:
/ccadmin/v1/merchant/reportingCurrency
- updateResponseHeaders
- Method: putPath:
/ccadmin/v1/merchant/responseHeaders
- updateRestrictedWords
- Method: postPath:
/ccadmin/v1/merchant/profilePolicies/updateRestrictedWords
- updateRobotsFile
- Method: putPath:
/ccadmin/v1/merchant/robots
- updateSamlSettings
- Method: putPath:
/ccadmin/v1/merchant/samlSettings
- updateScheduledJob
- Method: putPath:
/ccadmin/v1/merchant/scheduledJobs
- updateSelectedBillingCountries
- Method: putPath:
/ccadmin/v1/merchant/billingCountries
- updateSeoConfig
- Method: putPath:
/ccadmin/v1/merchant/seoConfig
- updateShopperProfileConfiguration
- Method: putPath:
/ccadmin/v1/merchant/shopperProfileConfiguration
- updateWhitelistUrls
- Method: putPath:
/ccadmin/v1/merchant/whiteListUrls
- updateXssConfiguration
- Method: putPath:
/ccadmin/v1/merchant/xssConfiguration
Admin/Message Tags
The operations from the Admin/Message Tags category.
- createMessageTag
- Method: postPath:
/ccadmin/v1/messageTags
- deleteMessageTag
- Method: deletePath:
/ccadmin/v1/messageTags/{id}
- getMessageTag
- Method: getPath:
/ccadmin/v1/messageTags/{id}
- getMessageTags
- Method: getPath:
/ccadmin/v1/messageTags
- updateMessageTag
- Method: putPath:
/ccadmin/v1/messageTags/{id}
Admin/Metadata
Metadata endpoints
- getMetadata
- Method: getPath:
/ccadmin/v1/metadata/{id}
- updateMetadata
- Method: putPath:
/ccadmin/v1/metadata/{id}
Admin/Notification messages
Endpoints to list, read, update and delete notifications
- deleteNotification
- Method: deletePath:
/ccadmin/v1/notificationMessages/{id}
- getMessages
- Method: getPath:
/ccadmin/v1/notificationMessages
- getNotification
- Method: getPath:
/ccadmin/v1/notificationMessages/{id}
- updateNotification
- Method: putPath:
/ccadmin/v1/notificationMessages/{id}
Admin/Notification settings
Endpoints to read and update notification settings
- getSettings
- Method: getPath:
/ccadmin/v1/notificationSettings
- updateSettings
- Method: putPath:
/ccadmin/v1/notificationSettings
Admin/OAuth
OAuth endpoints
- generateOAuthToken
- Method: postPath:
/ccadmin/v1/token
- getEndpointAPI
- Method: getPath:
/ccadmin/v1/api/{id}
- getEndpointAPIs
- Method: getPath:
/ccadmin/v1/api
- getRegistry
- Method: getPath:
/ccadmin/v1/registry
- login
- Method: postPath:
/ccadmin/v1/login
- logout
- Method: postPath:
/ccadmin/v1/logout
- mfalogin
- Method: postPath:
/ccadmin/v1/mfalogin
- refresh
- Method: postPath:
/ccadmin/v1/refresh
- verify
- Method: postPath:
/ccadmin/v1/verify
Admin/OOTB SSE
Endpoints for the OOTB Server Side Extensions
- listServerSideExtensions
- Method: getPath:
/ccadmin/v1/sse
Admin/OpenID
The operations from the Admin/OpenID category.
- get Admin OpenID IDP settings
- Method: getPath:
/ccadmin/v1/openid/metadata/idpSettings
- get OpenID authorization code request
- Method: getPath:
/ccadmin/v1/openid/authzCodeRequest
- get OpenID logout request
- Method: getPath:
/ccadmin/v1/openid/logoutRequest
- OpenID Single Sign On
- Method: postPath:
/ccadmin/v1/openid/sso
- update Admin OpenID IDP settings
- Method: putPath:
/ccadmin/v1/openid/metadata/idpSettings
Admin/Order Types
Order Type endpoints
- getOrderType
- Method: getPath:
/ccadmin/v1/orderTypes/{id}
- listOrderTypes
- Method: getPath:
/ccadmin/v1/orderTypes
- updateOrderType
- Method: putPath:
/ccadmin/v1/orderTypes/{id}
Admin/Orders
The details of order created on the Oracle Commerce Cloud. The order includes item and shipment details
- deleteOrder
- Method: deletePath:
/ccadmin/v1/orders/{id}
- deleteOrders
- Method: postPath:
/ccadmin/v1/orders/delete
- getOrder
- Method: getPath:
/ccadmin/v1/orders/{id}
- getOrders
- Method: getPath:
/ccadmin/v1/orders
- syncQuote
- Method: putPath:
/ccadmin/v1/orders/syncQuote
- updateOrder
- Method: putPath:
/ccadmin/v1/orders/{id}
- updateQuoteStatus
- Method: putPath:
/ccadmin/v1/orders/updateQuoteStatus
Admin/Organization Request
End points for operations for account based commerce in Oracle Commerce Cloud
- Approve organization request
- Method: postPath:
/ccadmin/v1/organizationRequests/{id}/approve
- deleteOrganizationRequest - only for application access
- Method: deletePath:
/ccadmin/v1/organizationRequests/{id}
- getOrganizationRequests
- Method: getPath:
/ccadmin/v1/organizationRequests/{id}
- listOrganizationRequests
- Method: getPath:
/ccadmin/v1/organizationRequests
- Reject organization request
- Method: postPath:
/ccadmin/v1/organizationRequests/{id}/reject
- updateOrganizationRequests
- Method: putPath:
/ccadmin/v1/organizationRequests/{id}
Admin/Organizations
End points for operations for account based commerce in Oracle Commerce Cloud
- add an secondary address to an Organization
- Method: postPath:
/ccadmin/v1/organizations/{id}/secondaryAddresses
- createOrganization
- Method: postPath:
/ccadmin/v1/organizations
- delete an Address for an Organization
- Method: deletePath:
/ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
- generates the authorization code for an Organization
- Method: postPath:
/ccadmin/v1/organizations/{id}/authorizationCode
- get Address for an Organization
- Method: getPath:
/ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
- Get site based Organization properties
- Method: getPath:
/ccadmin/v1/organizations/{id}/siteOrganizationProperties
- getOrganization
- Method: getPath:
/ccadmin/v1/organizations/{id}
- listOrganizationRoles
- Method: getPath:
/ccadmin/v1/organizations/{id}/organizationalRoles
- listOrganizations
- Method: getPath:
/ccadmin/v1/organizations
- update address for an Organization
- Method: putPath:
/ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
- update site based Organization properties
- Method: postPath:
/ccadmin/v1/organizations/{id}/updateSiteOrganizationProperties
- updateOrganization
- Method: putPath:
/ccadmin/v1/organizations/{id}
Admin/PaymentGateways
Endpoints for Payment Gateway Operations.
- addPaymentGateway
- Method: postPath:
/ccadmin/v1/paymentGateways
- getAllGateways
- Method: getPath:
/ccadmin/v1/paymentGateways
- getPaymentGateway
- Method: getPath:
/ccadmin/v1/paymentGateways/{id}
- updatePaymentGateway
- Method: putPath:
/ccadmin/v1/paymentGateways/{id}
Admin/Places
Endpoint for retrieving suggestions for cities, regions and countries as you type. Unlike other listing endpoints, this one should really only be used with the q (filter) param. For example, GET .../places/limit=10&sort=rank:desc&q=displayName sw "san".
- getPlaces
- Method: getPath:
/ccadmin/v1/places
Admin/PriceListGroup
Endpoints for operations on Price List Groups.
- createPriceListGroup
- Method: postPath:
/ccadmin/v1/priceListGroups
- createPriceListGroupActivationRequest
- Method: postPath:
/ccadmin/v1/priceListGroups/activationRequest
- deletePriceListGroup
- Method: deletePath:
/ccadmin/v1/priceListGroups/{id}
- getPriceListGroup
- Method: getPath:
/ccadmin/v1/priceListGroups/{id}
- getPriceListGroupActivationSummary
- Method: getPath:
/ccadmin/v1/priceListGroups/activationSummary/{token}
- listPriceListGroups
- Method: getPath:
/ccadmin/v1/priceListGroups
- listPriceListGroupsWithPrices
- Method: postPath:
/ccadmin/v1/priceListGroups/listWithPrices
- updatePriceListGroup
- Method: putPath:
/ccadmin/v1/priceListGroups/{id}
Admin/Prices
Prices endpoints
- deletePrice
- Method: deletePath:
/ccadmin/v1/prices/{id}
- getPrice
- Method: getPath:
/ccadmin/v1/prices/{id}
- listPrices
- Method: getPath:
/ccadmin/v1/prices
- setPrice
- Method: putPath:
/ccadmin/v1/prices/{id}
- updatePrices
- Method: putPath:
/ccadmin/v1/prices
Admin/Product Notify
Product Notification endpoints
- addProductNotification
- Method: postPath:
/ccadmin/v1/productnotify
- deleteProductNotification
- Method: deletePath:
/ccadmin/v1/productnotify/{id}
- deleteProductNotificationByProfileIdOrEmail
- Method: deletePath:
/ccadmin/v1/productnotify
Admin/Product Properties
Product Properties endpoints
- createProductTypeSpecification
- Method: postPath:
/ccadmin/v1/productProperties
- updateProductTypeSpecification
- Method: putPath:
/ccadmin/v1/productProperties/{id}
Admin/Product Types
Product Type endpoints
- addShopperInput
- Method: postPath:
/ccadmin/v1/productTypes/{typeId}/shopperInputs
- createProductType
- Method: postPath:
/ccadmin/v1/productTypes
- deleteProductType
- Method: deletePath:
/ccadmin/v1/productTypes/{id}
- getProductType
- Method: getPath:
/ccadmin/v1/productTypes/{id}
- listProductTypes
- Method: getPath:
/ccadmin/v1/productTypes
- removeShopperInput
- Method: deletePath:
/ccadmin/v1/productTypes/{typeId}/shopperInputs/{shopperInputId}
- updateProductType
- Method: putPath:
/ccadmin/v1/productTypes/{id}
Admin/Products
Product endpoints
- createProduct
- Method: postPath:
/ccadmin/v1/products
- createProductAssignmentToCollections
- Method: postPath:
/ccadmin/v1/products/{id}/addToCollections
- deleteProduct
- Method: deletePath:
/ccadmin/v1/products/{id}
- getProduct
- Method: getPath:
/ccadmin/v1/products/{id}
- listProducts
- Method: getPath:
/ccadmin/v1/products
- updateProduct
- Method: putPath:
/ccadmin/v1/products/{id}
- updateProductMembership
- Method: postPath:
/ccadmin/v1/products/membership
Admin/Profile Context List
Profile Context List Endpoints. A profileContextList has a ordered profileContexts property. Each profileContext in the list corresponds to a boolean property (such as an audience) on the profile. If the current shopper's profile has a true value for that boolean property, then the profileContext may be active. The first profileContext in the list that corresponds to a true shopper's profile property is the active profileContext. Currently, only a single ProfileContextList is supported, and it only applies to B2C shoppers. A profileContext can specify priceListGroups and a catalog that apply to shoppers in that profileContext.
- getProfileContextList
- Method: getPath:
/ccadmin/v1/profileContextLists/{id}
- getProfileContextLists
- Method: getPath:
/ccadmin/v1/profileContextLists
- updateProfileContextList
- Method: putPath:
/ccadmin/v1/profileContextLists/{id}
Admin/Profile Request
End points for operations for account based commerce in Oracle Commerce Cloud
- Approve profile request
- Method: postPath:
/ccadmin/v1/profileRequests/{id}/approve
- deleteProfileRequest - only for application access
- Method: deletePath:
/ccadmin/v1/profileRequests/{id}
- getProfileRequest
- Method: getPath:
/ccadmin/v1/profileRequests/{id}
- listProfileRequests
- Method: getPath:
/ccadmin/v1/profileRequests
- Reject Profile request
- Method: postPath:
/ccadmin/v1/profileRequests/{id}/reject
- updateProfileRequest
- Method: putPath:
/ccadmin/v1/profileRequests/{id}
Admin/Profiles
The details of customer profile created on Oracle Commerce Cloud. This includes account based commerce, the customer profile includes email, first name and last name.
- addProfileAddress
- Method: postPath:
/ccadmin/v1/profiles/{id}/addresses
- appendSecondaryOrganizations
- Method: postPath:
/ccadmin/v1/profiles/{id}/appendSecondaryOrganizations
- createProfile
- Method: postPath:
/ccadmin/v1/profiles
- deleteProfileAddress
- Method: deletePath:
/ccadmin/v1/profiles/{id}/addresses/{addressId}
- getProfile
- Method: getPath:
/ccadmin/v1/profiles/{id}
- getProfileAddress
- Method: getPath:
/ccadmin/v1/profiles/{id}/addresses/{addressId}
- listProfileAddresses
- Method: getPath:
/ccadmin/v1/profiles/{id}/addresses
- listProfiles
- Method: getPath:
/ccadmin/v1/profiles
- removeSecondaryOrganizations
- Method: postPath:
/ccadmin/v1/profiles/{id}/removeSecondaryOrganizations
- replaceSecondaryOrganizations
- Method: postPath:
/ccadmin/v1/profiles/{id}/replaceSecondaryOrganizations
- resetPassword
- Method: postPath:
/ccadmin/v1/profiles/resetPassword
- updateParentOrganization
- Method: postPath:
/ccadmin/v1/profiles/{id}/updateParentOrganization
- updateProfile
- Method: putPath:
/ccadmin/v1/profiles/{id}
- updateProfileAddress
- Method: putPath:
/ccadmin/v1/profiles/{id}/addresses/{addressId}
- updateProfiles
- Method: putPath:
/ccadmin/v1/profiles
- updateUserRoles
- Method: postPath:
/ccadmin/v1/profiles/{id}/updateUserRoles
Admin/Promotion Folders
Endpoints related to the creation and manipulation of promotion folders
- createPromotionFolder
- Method: postPath:
/ccadmin/v1/promotionFolders
- deletePromotionFolder
- Method: deletePath:
/ccadmin/v1/promotionFolders/{id}
- getPromotionFolder
- Method: getPath:
/ccadmin/v1/promotionFolders/{id}
- listPromotionFolders
- Method: getPath:
/ccadmin/v1/promotionFolders
- updatePromotionFolder
- Method: putPath:
/ccadmin/v1/promotionFolders/{id}
Admin/Promotion Templates
Endpoints related to getting information about promotion templates.
- getPromotionTemplate
- Method: getPath:
/ccadmin/v1/promotionTemplates/{id}
- listPromotionTemplates
- Method: getPath:
/ccadmin/v1/promotionTemplates
Admin/Promotions
Endpoints related to the creation and manipulation of promotions.
- createPromotion
- Method: postPath:
/ccadmin/v1/promotions
- deletePromotion
- Method: deletePath:
/ccadmin/v1/promotions/{id}
- getPromotion
- Method: getPath:
/ccadmin/v1/promotions/{id}
- listPromotions
- Method: getPath:
/ccadmin/v1/promotions
- updatePromotion
- Method: putPath:
/ccadmin/v1/promotions/{id}
Admin/Publishing
Endpoints for publishing
- deleteScheduledPublish
- Method: deletePath:
/ccadmin/v1/publish/schedules/{id}
- getPublishChanges
- Method: getPath:
/ccadmin/v1/publish/changes
- getPublishSchedule
- Method: getPath:
/ccadmin/v1/publish/schedules
- getPublishStatus
- Method: getPath:
/ccadmin/v1/publish
- publish
- Method: postPath:
/ccadmin/v1/publish
- purgeSchedulePublish
- Method: deletePath:
/ccadmin/v1/publish/schedules
Admin/Publishing Change Authors
Endpoints for publishing change authors
- getAllPublishingChangeAuthors
- Method: getPath:
/ccadmin/v1/publishingChangeAuthors
Admin/Publishing Change Lists
Endpoints for publishing change lists.
- getPublishingDependencies
- Method: getPath:
/ccadmin/v1/publishingChangeLists/{changeListId}
- publishChangeLists
- Method: postPath:
/ccadmin/v1/publishingChangeLists/publish
- storePublishingChangeList
- Method: postPath:
/ccadmin/v1/publishingChangeLists
Admin/Publishing Changes
Endpoint for publishing changes
- getPublishingChanges
- Method: getPath:
/ccadmin/v1/publishingChanges
Admin/Reasons
Reasons lookup endpoints
- createReason
- Method: postPath:
/ccadmin/v1/reasons
- deleteReason
- Method: deletePath:
/ccadmin/v1/reasons
- getReasons
- Method: getPath:
/ccadmin/v1/reasons
- updateReason
- Method: putPath:
/ccadmin/v1/reasons
Admin/Recommendations
The operations from the Admin/Recommendations category.
- createRecommendationGlobalRule
- Method: postPath:
/ccadmin/v1/recommendationGlobalRules
- createRecommendationStrategy
- Method: postPath:
/ccadmin/v1/recommendationStrategies
- deleteRecommendationGlobalRule
- Method: deletePath:
/ccadmin/v1/recommendationGlobalRules/{id}
- deleteRecommendationStrategy
- Method: deletePath:
/ccadmin/v1/recommendationStrategies/{id}
- getRecommendationGlobalRule
- Method: getPath:
/ccadmin/v1/recommendationGlobalRules/{id}
- getRecommendationGlobalRuleConditions
- Method: getPath:
/ccadmin/v1/recommendationGlobalRuleConditions
- getRecommendationStrategy
- Method: getPath:
/ccadmin/v1/recommendationStrategies/{id}
- getRecommendationStrategyConditions
- Method: getPath:
/ccadmin/v1/recommendationStrategyConditions
- listRecommendationGlobalRules
- Method: getPath:
/ccadmin/v1/recommendationGlobalRules
- listRecommendationStrategies
- Method: getPath:
/ccadmin/v1/recommendationStrategies
- updateRecommendationGlobalRule
- Method: putPath:
/ccadmin/v1/recommendationGlobalRules/{id}
- updateRecommendationStrategy
- Method: putPath:
/ccadmin/v1/recommendationStrategies/{id}
Admin/Redirects
Endpoints for managing redirection rules on the Oracle Commerce Cloud.
- createRedirect
- Method: postPath:
/ccadmin/v1/redirects
- deleteRedirect
- Method: deletePath:
/ccadmin/v1/redirects/{id}
- getRedirects
- Method: getPath:
/ccadmin/v1/redirects
- updateRedirect
- Method: putPath:
/ccadmin/v1/redirects/{id}
Admin/Register Admin
Endpoints to handle operations related to registering admin users.
- registerAdmin
- Method: postPath:
/ccadmin/v1/adminRegister
- resend
- Method: postPath:
/ccadmin/v1/adminRegister/resend
Admin/Report Cache
Endpoints to handle operations related to report data caches. Will be used to refresh the report data cache.
- refreshAllReportCaches
- Method: putPath:
/ccadmin/v1/reportCaches
Admin/Report Filter Configuration
Report Filter Configuration Endpoint
- listReportFilterConfigurations
- Method: getPath:
/ccadmin/v1/reportFilterConfigurations
- saveReportFilterConfiguration
- Method: postPath:
/ccadmin/v1/reportFilterConfigurations
- updateReportFilterConfiguration
- Method: putPath:
/ccadmin/v1/reportFilterConfigurations/{id}
Admin/Reports
Endpoints to handle operations related to reports. Will be used by all the reports present in the Dashboard and Full Reports pages of Admin.
- exportReportData
- Method: getPath:
/ccadmin/v1/reports/export
- getReportData
- Method: postPath:
/ccadmin/v1/reports/{id}
Admin/Resources
Resource Admin endpoints
- getResourceStrings
- Method: getPath:
/ccadmin/v1/resources/{bundle}
- updateCustomTranslations
- Method: putPath:
/ccadmin/v1/resources/{bundle}
Admin/Response Filters
Endpoints to configure response filters
- createFilter
- Method: postPath:
/ccadmin/v1/responseFilters
- deleteFilter
- Method: deletePath:
/ccadmin/v1/responseFilters/{id}
- getFilter
- Method: getPath:
/ccadmin/v1/responseFilters/{id}
- listFilters
- Method: getPath:
/ccadmin/v1/responseFilters
- updateFilter
- Method: putPath:
/ccadmin/v1/responseFilters/{id}
Admin/Return Requests
The operations from the Admin/Return Requests category.
- getReturnRequest
- Method: getPath:
/ccadmin/v1/returnRequests/{id}
- updateReturnRequest
- Method: putPath:
/ccadmin/v1/returnRequests/{id}
Admin/Roles
Roles endpoints
- createRole
- Method: postPath:
/ccadmin/v1/roles
- getRole
- Method: getPath:
/ccadmin/v1/roles/{id}
- listRoles
- Method: getPath:
/ccadmin/v1/roles
- updateRole
- Method: putPath:
/ccadmin/v1/roles/{id}
Admin/SAML IdP Settings
Endpoints to read and update Identity Provider settings
- getSamlIdPSettings
- Method: getPath:
/ccadmin/v1/samlIdentityProviders/{id}
- updateSamlIdPSettings
- Method: putPath:
/ccadmin/v1/samlIdentityProviders/{id}
Admin/SKU Properties
SKU properties endpoints
- createSkuProperty
- Method: postPath:
/ccadmin/v1/skuProperties
- getSkuProperties
- Method: getPath:
/ccadmin/v1/skuProperties
- getSkuProperty
- Method: getPath:
/ccadmin/v1/skuProperties/{id}
- reorderSkuProperties
- Method: postPath:
/ccadmin/v1/skuProperties/reorder
- updateSkuProperty
- Method: putPath:
/ccadmin/v1/skuProperties/{id}
Admin/Search Admin and Configuration/Application Configuration
The Application Configuration endpoints enable you to configure the Guided Search configuration of all application resources in a single archive file. This can be used to export the entire Guided Search configuration (/gsadmin/v1/cloud.zip) or more specific aspects, for example, /gsadmin/v1/cloud/thesaurus.zip.
- Create a resource configuration
- Method: postPath:
/gsadmin/v1/{appName}/{resourcePath}
- Delete a resource configuration
- Method: deletePath:
/gsadmin/v1/{appName}/{resourcePath}
- Delete application configuration
- Method: deletePath:
/gsadmin/v1/{appName}
- Download application configuration
- Method: getPath:
/gsadmin/v1/{appName}.zip
- Download resource configuration
- Method: getPath:
/gsadmin/v1/{appName}/{resourcePath}.zip
- Import application configuration
- Method: postPath:
/gsadmin/v1/{appName}
Admin/Search Admin and Configuration/Application Operations
The Application Operations endpoints enable you to trigger Guided Search indexing, update or publishing, and to query the status of an initiated operation.
- Inquire about the status of an operation
- Method: getPath:
/gsadmin/v1/{appName}/tasks/{taskId}
- Start operation
- Method: postPath:
/gsadmin/v1/{appName}/tasks
Admin/Search Admin and Configuration/Dimension Value Service
Service for retrieving information about dimension values.
- View all the children of a dimension value.
- Method: getPath:
/gsadmin/v1/{appName}/dimvals/{dimValKey}/children
- View dimension value for {dimValKey}.
- Method: getPath:
/gsadmin/v1/{appName}/dimvals/{dimValKey}
- View list of Dimensions.
- Method: getPath:
/gsadmin/v1/{appName}/dimvals
Admin/Search Admin and Configuration/Facet Lists
The facet lists endpoints enable you to create and edit ordered lists of facets that will appear in the Storefront's guided navigation. You can control in even more detail which facets appear, where and when, in what order. You can also control the ordering of facet values.
- createFacetList
- Method: postPath:
/gsadmin/v1/{appName}/content/facets/{facetListName}
- deleteFacetList
- Method: deletePath:
/gsadmin/v1/{appName}/content/facets/{facetListName}
- getFacetList
- Method: getPath:
/gsadmin/v1/{appName}/content/facets/{facetListName}
- listFacetLists
- Method: getPath:
/gsadmin/v1/{appName}/content/facets
- updateFacetList
- Method: putPath:
/gsadmin/v1/{appName}/content/facets/{facetListName}
Admin/Search Admin and Configuration/Index Attributes
You configure dimensions, Endeca record properties and derived properties through configuring index attributes. Index Attributes for each owner is configured in a separate JSON document. A JSON document with 'ecr:type' as 'attributes-folder' is the root of the index attributes configuration. This section describes operations to create, modify, view and delete index attributes in a specific application.
- Create an index attribute
- Method: postPath:
/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
- Create index attributes
- Method: postPath:
/gsadmin/v1/{appName}/attributes
- Create owner attributes
- Method: postPath:
/gsadmin/v1/{appName}/attributes/{owner}
- Delete an index attribute
- Method: deletePath:
/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
- Delete index Attributes
- Method: deletePath:
/gsadmin/v1/{appName}/attributes
- Delete owner index attributes
- Method: deletePath:
/gsadmin/v1/{appName}/attributes/{owner}
- Partial update an index attribute
- Method: patchPath:
/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
- Partial update owner attributes
- Method: patchPath:
/gsadmin/v1/{appName}/attributes/{owner}
- Partially update index attributes
- Method: patchPath:
/gsadmin/v1/{appName}/attributes
- Update an index attribute
- Method: putPath:
/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
- Update index attributes
- Method: putPath:
/gsadmin/v1/{appName}/attributes
- Update owner attributes
- Method: putPath:
/gsadmin/v1/{appName}/attributes/{owner}
- View index attribute
- Method: getPath:
/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
- View index attributes
- Method: getPath:
/gsadmin/v1/{appName}/attributes
- View owner attributes
- Method: getPath:
/gsadmin/v1/{appName}/attributes/{owner}
Admin/Search Admin and Configuration/Keyword Redirects
This endpoint enables a user to configure keyword redirects for an application. This section describes how to create, modify, view, and delete the keyword redirects configuration.
- Create an Keyword Redirect Entry.
- Method: postPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
- Create Keyword Redirect Group.
- Method: postPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}
- Create Keyword Redirects Configuration
- Method: postPath:
/gsadmin/v1/{appName}/redirects
- Delete Keyword Redirect Entry
- Method: deletePath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
- Delete Keyword Redirect Group
- Method: deletePath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}
- Delete Keyword Redirects
- Method: deletePath:
/gsadmin/v1/{appName}/redirects
- Partial update Keyword Redirect Entry.
- Method: patchPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
- Partial update Keyword Redirect Group.
- Method: patchPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}
- Partial update Keyword Redirects Configuration
- Method: patchPath:
/gsadmin/v1/{appName}/redirects
- Update an Keyword Redirect Entry.
- Method: putPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
- Update Keyword Redirect Group.
- Method: putPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}
- Update Keyword Redirects configuration
- Method: putPath:
/gsadmin/v1/{appName}/redirects
- View Keyword Redirect Entry.
- Method: getPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
- View Keyword Redirect Group.
- Method: getPath:
/gsadmin/v1/{appName}/redirects/{redirectGroup}
- View Keyword Redirects
- Method: getPath:
/gsadmin/v1/{appName}/redirects
Admin/Search Admin and Configuration/Page Configuration
These endpoints allows user to manage and organize page definitions for an application. User can manage 'page-root', 'site-home' and 'page' ecr types
- Creates a page configuration
- Method: postPath:
/gsadmin/v1/{appName}/pages/{siteHome}/{page}
- Creates a page root for a application
- Method: postPath:
/gsadmin/v1/{appName}/pages
- Creates a site for a application
- Method: postPath:
/gsadmin/v1/{appName}/pages/{siteHome}
- Delete page root of a application
- Method: deletePath:
/gsadmin/v1/{appName}/pages
- Deletes the page.
- Method: deletePath:
/gsadmin/v1/{appName}/pages/{siteHome}/{page}
- Deletes the site.
- Method: deletePath:
/gsadmin/v1/{appName}/pages/{siteHome}
- Gets a list of immediate pages defined under site home
- Method: getPath:
/gsadmin/v1/{appName}/pages/{siteHome}
- Gets a Page configuration or lists down immediate pages under requested page.
- Method: getPath:
/gsadmin/v1/{appName}/pages/{siteHome}/{page}
- Updates a page configuration
- Method: putPath:
/gsadmin/v1/{appName}/pages/{siteHome}/{page}
- View all sites defined in a application
- Method: getPath:
/gsadmin/v1/{appName}/pages
Admin/Search Admin and Configuration/Ranking Rules Configuration
These endpoints are a subset of the /rules endpoints with clarification on formats for dynamic curation configuration. As well as a new selector to work better with the Commerce Cloud administration interface.
- Creates a rule configuration.
- Method: postPath:
/gsadmin/v1/{appName}/content/rankingRules/{Rule}
- Deletes a Rule.
- Method: deletePath:
/gsadmin/v1/{appName}/content/rankingRules/{Rule}
- Retrieve a rule configuration.
- Method: getPath:
/gsadmin/v1/{appName}/content/rankingRules/{Rule}
- Updates a rule configuration.
- Method: putPath:
/gsadmin/v1/{appName}/content/rankingRules/{Rule}
- View a ranking Rule with expanded information.
- Method: getPath:
/gsadmin/v1/{appName}/content/rankingRules/{Rule}.ccadminui.json
- View list of ranking rules with expanded information.
- Method: getPath:
/gsadmin/v1/{appName}/content/rankingRules.ccadminui.json
- View list of ranking rules.
- Method: getPath:
/gsadmin/v1/{appName}/content/rankingRules
Admin/Search Admin and Configuration/Rule Configuration
These endpoints allows user to manage and organize rules for an application. User can manage 'content-root', 'content-collection-folder' and 'content-item' ecr types
- Creates a rule configuration.
- Method: postPath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
- Creates content collection folder at specified location.
- Method: postPath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}
- Creates content node for a application
- Method: postPath:
/gsadmin/v1/{appName}/content
- Delete content node of a application
- Method: deletePath:
/gsadmin/v1/{appName}/content
- Deletes a content collection folder.
- Method: deletePath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}
- Deletes a Rule.
- Method: deletePath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
- Updates a rule configuration.
- Method: putPath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
- View content collection folders under 'content' root node.
- Method: getPath:
/gsadmin/v1/{appName}/content
- View rule definition
- Method: getPath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
- View rules and content collection folders under specified content collection folder.
- Method: getPath:
/gsadmin/v1/{appName}/content/{contentCollectionFolder}
Admin/Search Admin and Configuration/Search Index Configuration
The Search Index endpoints enable you to configure the locales of an application as part of the search Index configuration. These endpoints also enable you to configure the types of words that can appear in the spelling dictionary, as well as whether wild cards are allowed in search terms.
- Create search index configuration
- Method: postPath:
/gsadmin/v1/{appName}/searchIndexConfig
- Delete search index configuration
- Method: deletePath:
/gsadmin/v1/{appName}/searchIndexConfig
- Partial update search index configuration
- Method: patchPath:
/gsadmin/v1/{appName}/searchIndexConfig
- Update search index configuration
- Method: putPath:
/gsadmin/v1/{appName}/searchIndexConfig
- View search index configuration
- Method: getPath:
/gsadmin/v1/{appName}/searchIndexConfig
Admin/Search Admin and Configuration/Search Interfaces
Search interfaces enable users to perform a record search on a group of dimensions or properties as if they were a single property. It is configured by a JSON document that includes attributes and fields. This section describes how to create, modify, view, and delete search interface configurations.
- Create a search interface
- Method: postPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Create a search interface folder
- Method: postPath:
/gsadmin/v1/{appName}/searchInterfaces
- Delete a search interface
- Method: deletePath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Delete a search interface folder
- Method: deletePath:
/gsadmin/v1/{appName}/searchInterfaces
- Partial update a search interface
- Method: patchPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Partial update a search interface folder
- Method: patchPath:
/gsadmin/v1/{appName}/searchInterfaces
- Update a search interface
- Method: putPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Update a search interface folder
- Method: putPath:
/gsadmin/v1/{appName}/searchInterfaces
- View a search interface
- Method: getPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- View a search interface folder
- Method: getPath:
/gsadmin/v1/{appName}/searchInterfaces
Admin/Search Admin and Configuration/Services Configuration
Service configuration endpoints can define external services used by storefront, assembler, or both. Often a corresponding endpoint is made in cc-admin. AIA Offers are a good example external service.
- Create service configuration
- Method: postPath:
/gsadmin/v1/{appName}/configuration/services/{serviceName}
- Get Service Configuration
- Method: getPath:
/gsadmin/v1/{appName}/configuration/services/{serviceName}
- Updates Service configuration
- Method: putPath:
/gsadmin/v1/{appName}/configuration/services/{serviceName}
- View list of all configuration blocks
- Method: getPath:
/gsadmin/v1/{appName}/configuration
- View list of all service configurations
- Method: getPath:
/gsadmin/v1/{appName}/configuration/services
Admin/Search Admin and Configuration/Thesaurus
This endpoint enables a user to configure thesaurus entries for an application. This section describes how to create, modify, view, and delete thesaurus entries.
- Create thesaurus
- Method: postPath:
/gsadmin/v1/{appName}/thesaurus
- Create thesaurus entry
- Method: postPath:
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
- Delete thesaurus
- Method: deletePath:
/gsadmin/v1/{appName}/thesaurus
- Delete thesaurus entry
- Method: deletePath:
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
- Partial update thesaurus
- Method: patchPath:
/gsadmin/v1/{appName}/thesaurus
- Partial update thesaurus entry
- Method: patchPath:
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
- Update thesaurus
- Method: putPath:
/gsadmin/v1/{appName}/thesaurus
- Update thesaurus entry
- Method: putPath:
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
- View thesaurus
- Method: getPath:
/gsadmin/v1/{appName}/thesaurus
- View thesaurus entry
- Method: getPath:
/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Admin/Search Data and Indexing/Delete Record Collection
The Delete Record Collection endpoints enable you to delete a specified record collection and all records in that record collection.
- Delete facet value record collection
- Method: deletePath:
/gsdata/v1/{appName}/facets/{recordCollection}
- Delete record collection
- Method: deletePath:
/gsdata/v1/{appName}/data/{recordCollection}
Admin/Search Data and Indexing/Indexing
Search Administration endpoints
- getSearchIndexingStatus
- Method: getPath:
/ccadmin/v1/search/index
- getSearchPartialSchedule
- Method: getPath:
/ccadmin/v1/search/partialSchedule
- getSearchSchedule
- Method: getPath:
/ccadmin/v1/search/schedule
- requestIndex
- Method: postPath:
/ccadmin/v1/search/index
- setSearchPartialSchedule
- Method: putPath:
/ccadmin/v1/search/partialSchedule
- setSearchSchedule
- Method: putPath:
/ccadmin/v1/search/schedule
Admin/Search Data and Indexing/Insert Records
The Insert Records endpoints enable you to insert records into a specified record collection.
- Insert facet value records into record collection
- Method: postPath:
/gsdata/v1/{appName}/facets/{recordCollection}
- Insert record/records into record collection
- Method: postPath:
/gsdata/v1/{appName}/data/{recordCollection}
Admin/Search Data and Indexing/View Data Records
The operations from the Admin/Search Data and Indexing/View Data Records category.
- View data record collection records
- Method: getPath:
/gsdata/v1/{appName}/data/{recordCollection}
- View facet value record collection records
- Method: getPath:
/gsdata/v1/{appName}/facets/{recordCollection}
- View individual data records
- Method: getPath:
/gsdata/v1/{appName}/data/{recordCollection}/{recordId}
Admin/Search Data and Indexing/View Record Collections
The View Record Collections endpoints enable you to retrieve a list of record collections configured for an application. There are two types of record collections: data record collections and facet value record collections.
- View application record collections
- Method: getPath:
/gsdata/v1/{appName}
- View data record collections
- Method: getPath:
/gsdata/v1/{appName}/data
- View facet value collections
- Method: getPath:
/gsdata/v1/{appName}/facets
Admin/Server Extensions
Server Extensions Endpoints.
- doDeleteSSEFile
- Method: deletePath:
/ccadmin/v1/serverExtensions/{id:.*}
- doDeleteSSEFiles
- Method: postPath:
/ccadmin/v1/serverExtensions/deleteFiles
- doSSEFileUploadMultipart
- Method: postPath:
/ccadmin/v1/serverExtensions
- listSSEFiles
- Method: getPath:
/ccadmin/v1/serverExtensions
Admin/Shipping Methods
Endpoints for operations on shipping methods.
- createShippingMethod
- Method: postPath:
/ccadmin/v1/shippingMethods
- deleteShippingMethod
- Method: deletePath:
/ccadmin/v1/shippingMethods/{id}
- getShippingMethod
- Method: getPath:
/ccadmin/v1/shippingMethods/{id}
- listShippingMethods
- Method: getPath:
/ccadmin/v1/shippingMethods
- updateShippingMethod
- Method: putPath:
/ccadmin/v1/shippingMethods/{id}
Admin/Shipping Regions
Shipping Regions Endpoints.
- createShippingRegion
- Method: postPath:
/ccadmin/v1/shippingRegions
- deleteShippingRegion
- Method: deletePath:
/ccadmin/v1/shippingRegions/{id}
- getShippingRegion
- Method: getPath:
/ccadmin/v1/shippingRegions/{id}
- listShippingRegions
- Method: getPath:
/ccadmin/v1/shippingRegions
- updateShippingRegion
- Method: putPath:
/ccadmin/v1/shippingRegions/{id}
Admin/Shopper Input
Shopper Input endpoints
- addShopperInput
- Method: postPath:
/ccadmin/v1/productTypes/{typeId}/shopperInputs
- createShopperInput
- Method: postPath:
/ccadmin/v1/shopperInputs
- deleteShopperInput
- Method: deletePath:
/ccadmin/v1/shopperInputs/{id}
- getShopperInput
- Method: getPath:
/ccadmin/v1/shopperInputs/{id}
- removeShopperInput
- Method: deletePath:
/ccadmin/v1/productTypes/{typeId}/shopperInputs/{shopperInputId}
- updateShopperInput
- Method: putPath:
/ccadmin/v1/shopperInputs/{id}
Admin/Shopper Types
Shopper Type endpoints
- getShopperType
- Method: getPath:
/ccadmin/v1/shopperTypes/{id}
- listShopperTypes
- Method: getPath:
/ccadmin/v1/shopperTypes
- updateShopperType
- Method: putPath:
/ccadmin/v1/shopperTypes/{id}
Admin/Site Create Forms
Site Create Forms endpoints. Create a site using a specified site as a template.
- createSiteFromForm
- Method: postPath:
/ccadmin/v1/siteCreateForms/{id}
Admin/Sites
Site endpoints
- createSite
- Method: postPath:
/ccadmin/v1/sites
- deleteSite
- Method: deletePath:
/ccadmin/v1/sites/{id}
- getSite
- Method: getPath:
/ccadmin/v1/sites/{id}
- getSites
- Method: getPath:
/ccadmin/v1/sites
- updateSite
- Method: putPath:
/ccadmin/v1/sites/{id}
Admin/Sites Settings
Site Settings endpoints
- getCustomSiteSettings
- Method: getPath:
/ccadmin/v1/sitesettings/{id}
- listSiteSettings
- Method: getPath:
/ccadmin/v1/sitesettings
- setSiteSettingConfigData
- Method: putPath:
/ccadmin/v1/sitesettings/{id}
Admin/Skus
SKU endpoints
- createSku
- Method: postPath:
/ccadmin/v1/skus
- createSkus
- Method: putPath:
/ccadmin/v1/skus
- deleteSku
- Method: deletePath:
/ccadmin/v1/skus/{id}
- deleteSkus
- Method: deletePath:
/ccadmin/v1/skus
- getSku
- Method: getPath:
/ccadmin/v1/skus/{id}
- listSkus
- Method: getPath:
/ccadmin/v1/skus
- updateSku
- Method: putPath:
/ccadmin/v1/skus/{id}
Admin/Slot Descriptors
atg.cloud.rest.endpoints.SlotDescriptorAdminEndpoints description
- getAllSlotDescriptors
- Method: getPath:
/ccadmin/v1/slotDescriptors
- getConfigDefinitionForSlotDescriptor
- Method: getPath:
/ccadmin/v1/slotDescriptors/{id}/config
- updateHiddenSlotTypes
- Method: putPath:
/ccadmin/v1/slotDescriptors/hidden
Admin/Slots
slot endpoints
- getSlot
- Method: getPath:
/ccadmin/v1/slots/{id}
- updateSlot
- Method: putPath:
/ccadmin/v1/slots/{id}
Admin/Stack Descriptor
atg.cloud.rest.endpoints.StackDescriptorAdminEndpoints description
- getAllStackDescriptorsByPageType
- Method: getPath:
/ccadmin/v1/stackDescriptors/pageType/{id}
- getConfigDefinitionForStackDescriptor
- Method: getPath:
/ccadmin/v1/stackDescriptors/{id}/config
- updateHiddenStackTypes
- Method: putPath:
/ccadmin/v1/stackDescriptors/hidden
Admin/StackingRules
Endpoints related to the creation and manipulation of stacking rules.
- createStackingRule
- Method: postPath:
/ccadmin/v1/stackingRules
- deleteStackingRule
- Method: deletePath:
/ccadmin/v1/stackingRules/{id}
- getStackingRule
- Method: getPath:
/ccadmin/v1/stackingRules/{id}
- listStackingRules
- Method: getPath:
/ccadmin/v1/stackingRules
- updateStackingRule
- Method: putPath:
/ccadmin/v1/stackingRules/{id}
Admin/Stacks
stack endpoints
- getStack
- Method: getPath:
/ccadmin/v1/stacks/{id}
- getStackLess
- Method: getPath:
/ccadmin/v1/stacks/{id}/less
- getStackLessVars
- Method: getPath:
/ccadmin/v1/stacks/{id}/lessvars
- getStackSourceCode
- Method: getPath:
/ccadmin/v1/stacks/{id}/code
- listStacks
- Method: getPath:
/ccadmin/v1/stacks
- updateStack
- Method: putPath:
/ccadmin/v1/stacks/{id}
- updateStackLess
- Method: putPath:
/ccadmin/v1/stacks/{id}/less
- updateStackLessVars
- Method: putPath:
/ccadmin/v1/stacks/{id}/lessvars
- updateStackSourceCode
- Method: putPath:
/ccadmin/v1/stacks/{id}/code
Admin/Tax Processor Manager
Endpoints for CRUD operations on tax processors
- createTaxProcessor
- Method: postPath:
/ccadmin/v1/taxProcessors
- deleteTaxProcessor
- Method: deletePath:
/ccadmin/v1/taxProcessors/{id}
- getTaxProcessor
- Method: getPath:
/ccadmin/v1/taxProcessors/{id}
- listTaxProcessors
- Method: getPath:
/ccadmin/v1/taxProcessors
- updateTaxProcessor
- Method: putPath:
/ccadmin/v1/taxProcessors/{id}
Admin/Tenant
for Tenant Service Data
- getTenantServiceData
- Method: getPath:
/ccadmin/v1/tenants/{id}
Admin/Theme Methods
Endpoints for operations on themes.
- cloneTheme
- Method: postPath:
/ccadmin/v1/themes/{id}/clone
- deleteTheme
- Method: deletePath:
/ccadmin/v1/themes/{id}
- getActiveTheme
- Method: getPath:
/ccadmin/v1/themes/active
- getAgentTheme
- Method: getPath:
/ccadmin/v1/themes/agentThemeDetails
- getAgentThemeSource
- Method: getPath:
/ccadmin/v1/themes/agentThemeSource
- getTheme
- Method: getPath:
/ccadmin/v1/themes/{id}
- getThemes
- Method: getPath:
/ccadmin/v1/themes
- getThemeSource
- Method: getPath:
/ccadmin/v1/themes/{id}/source
- restoreThemeSource
- Method: putPath:
/ccadmin/v1/themes/{id}/restoreSource
- setActiveTheme
- Method: postPath:
/ccadmin/v1/themes/{id}/active
- updateAgentThemeDetails
- Method: putPath:
/ccadmin/v1/themes/agentThemeDetails
- updateAgentThemeSource
- Method: putPath:
/ccadmin/v1/themes/agentThemeSource
- updateTheme
- Method: putPath:
/ccadmin/v1/themes/{id}
- updateThemeImage
- Method: putPath:
/ccadmin/v1/themes/{id}/image
- updateThemeSource
- Method: putPath:
/ccadmin/v1/themes/{id}/source
Admin/Timezone
Endpoints for operations on timezones.
- getTimezone
- Method: getPath:
/ccadmin/v1/timezones/{id}
- listTimezones
- Method: getPath:
/ccadmin/v1/timezones
Admin/UI Events
The operations from the Admin/UI Events category.
- logUIEvent
- Method: postPath:
/ccadmin/v1/uiEvents/logUIEvent
Admin/URL Patterns Methods
Endpoints for operations on URL Patterns.
- getURLPatternsLastModified
- Method: getPath:
/ccadmin/v1/urlPatterns/lastModified
- listURLPatterns
- Method: getPath:
/ccadmin/v1/urlPatterns
- updateURLPattern
- Method: putPath:
/ccadmin/v1/urlPatterns/{id}
Admin/Variants
Variant endpoints
- createProductTypeVariant
- Method: postPath:
/ccadmin/v1/productVariants
- deleteProductTypeVariant
- Method: deletePath:
/ccadmin/v1/productVariants/{id}
- getProductTypeVariant
- Method: getPath:
/ccadmin/v1/productVariants/{id}
- listProductTypeVariants
- Method: getPath:
/ccadmin/v1/productVariants
- updateProductTypeVariant
- Method: putPath:
/ccadmin/v1/productVariants/{id}
Admin/Widgets
Widget instance endpoints.
- deleteWidgetInstance
- Method: deletePath:
/ccadmin/v1/widgets/{id}
Admin/widgetDescriptors
Widget descriptors endpoints
- getAllWidgetDescriptors
- Method: getPath:
/ccadmin/v1/widgetDescriptors
- getAllWidgetDescriptorsByPageType
- Method: getPath:
/ccadmin/v1/widgetDescriptors/pageType/{id}
- getAllWidgetInstances
- Method: getPath:
/ccadmin/v1/widgetDescriptors/instances
- getConfigDefinitionForWidgetDescriptor
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/config
- getConfigLocaleContentForWidgetDescriptor
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}
- getConfigMetadataForWidgetDescriptor
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata/config
- getFragmentMetadata
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/element/{tag}/metadata
- getInstancesForWidgetDescriptor
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/instances
- getSchemaForWidgetDescriptor
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/schema
- getWidgetDescriptorBaseLess
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/less
- getWidgetDescriptorBaseLocaleContent
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/locale/{locale}
- getWidgetDescriptorBaseTemplate
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/code
- getWidgetDescriptorById
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}
- getWidgetDescriptorJavascriptInfoById
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/javascript
- getWidgetDescriptorMetadata
- Method: getPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata
- updateConfigLocaleContentForWidgetDescriptor
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}
- updateConfigMetadataForWidgetDescriptor
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata/config
- updateFragmentJavaScript
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/element/{tag}/javascript
- updateFragmentMetadata
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/element/{tag}/metadata
- updateFragmentTemplate
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/element/{tag}/template
- updateHiddenWidgetTypes
- Method: putPath:
/ccadmin/v1/widgetDescriptors/hidden
- updateWidgetDescriptorBaseLess
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/less
- updateWidgetDescriptorBaseLocaleContent
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/locale/{locale}
- updateWidgetDescriptorBaseTemplate
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/code
- updateWidgetDescriptorJavascript
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/javascript/{filename}
- updateWidgetDescriptorMetadata
- Method: putPath:
/ccadmin/v1/widgetDescriptors/{id}/metadata
- updateWidgetDescriptorSites
- Method: postPath:
/ccadmin/v1/widgetDescriptors/{id}/updateSiteAssociations
Agent/Agent Comments
Agent Comments endpoints
- createComment
- Method: postPath:
/ccagent/v1/comments
- getComments
- Method: getPath:
/ccagent/v1/comments
Agent/Agent Metadata Catalog
Metadata Catalog Agent Endpoints
- getMetadataCatalog
- Method: getPath:
/ccagent/v1/metadata-catalog
- getResourceMetadata
- Method: getPath:
/ccagent/v1/metadata-catalog/{id}
Agent/Agent SAML AuthnRequest
The operations from the Agent/Agent SAML AuthnRequest category.
- get SAML AuthnRequest
- Method: getPath:
/ccagent/v1/saml/authnRequest
Agent/Agent SAML LogoutRequest
The operations from the Agent/Agent SAML LogoutRequest category.
- get SAML LogoutRequest
- Method: getPath:
/ccagent/v1/saml/logoutRequest
Agent/Agent Service Provider Entity Descriptor
The operations from the Agent/Agent Service Provider Entity Descriptor category.
- get Service Provider Entity Descriptor XML
- Method: getPath:
/ccagent/v1/saml/metadata/spEntityDescriptor
- get Service Provider Signing Certificate
- Method: getPath:
/ccagent/v1/saml/metadata/spCertificate
Agent/Agent Single Log out
The operations from the Agent/Agent Single Log out category.
- single log out
- Method: postPath:
/ccagent/v1/saml/slo
Agent/Agent Single Sign On
The operations from the Agent/Agent Single Sign On category.
- single sign on
- Method: postPath:
/ccagent/v1/saml/sso
Agent/Appeasement
The operations from the Agent/Appeasement category.
- createAppeasement
- Method: postPath:
/ccagent/v1/appeasements
- deleteAppeasement
- Method: deletePath:
/ccagent/v1/appeasements/{id}
- getAppeasement
- Method: getPath:
/ccagent/v1/appeasements/{id}
- initiateAppeasement
- Method: postPath:
/ccagent/v1/appeasements/initiate
- listAppeasements
- Method: getPath:
/ccagent/v1/appeasements
- submitAppeasement
- Method: postPath:
/ccagent/v1/appeasements/submit
- updateAppeasement
- Method: putPath:
/ccagent/v1/appeasements/{id}
Agent/AppeasementTypes
Agent/Collections
Collections endpoints
- getCollection
- Method: getPath:
/ccagent/v1/collections/{id}
- listCollections
- Method: getPath:
/ccagent/v1/collections
Agent/Currency
Endpoints for operations on currencies.
- getCurrency
- Method: getPath:
/ccagent/v1/currencies/{id}
- listCurrencies
- Method: getPath:
/ccagent/v1/currencies
Agent/Customers
Agent Endpoints for Customers
- addCreditCard
- Method: postPath:
/ccagent/v1/profiles/{id}/creditCards
- addProfileAddress
- Method: postPath:
/ccagent/v1/profiles/{id}/addresses
- createProfile
- Method: postPath:
/ccagent/v1/profiles
- deleteMultipleProfiles
- Method: postPath:
/ccagent/v1/profiles/delete
- deleteProfile
- Method: deletePath:
/ccagent/v1/profiles/{id}
- deleteProfileAddress
- Method: deletePath:
/ccagent/v1/profiles/{id}/addresses/{addressId}
- deleteProfiles
- Method: deletePath:
/ccagent/v1/profiles
- getCreditCard
- Method: getPath:
/ccagent/v1/profiles/{id}/creditCards/{cardId}
- getProfile
- Method: getPath:
/ccagent/v1/profiles/{id}
- getProfileAddress
- Method: getPath:
/ccagent/v1/profiles/{id}/addresses/{addressId}
- listCreditCards
- Method: getPath:
/ccagent/v1/profiles/{id}/creditCards
- listProfileAddresses
- Method: getPath:
/ccagent/v1/profiles/{id}/addresses
- listSiteProperties
- Method: getPath:
/ccagent/v1/profiles/{id}/siteProperties
- removeCreditCard
- Method: deletePath:
/ccagent/v1/profiles/{id}/creditCards/{cardId}
- resetPassword
- Method: postPath:
/ccagent/v1/profiles/{id}
- searchProfiles
- Method: getPath:
/ccagent/v1/profiles
- updateCreditCard
- Method: putPath:
/ccagent/v1/profiles/{id}/creditCards/{cardId}
- updateProfile
- Method: putPath:
/ccagent/v1/profiles/{id}
- updateProfileAddress
- Method: putPath:
/ccagent/v1/profiles/{id}/addresses/{addressId}
- updateSiteProperties
- Method: putPath:
/ccagent/v1/profiles/{id}/siteProperties
Agent/Exchange Order
Exchange Order endpoints
- createExchangeRequest
- Method: postPath:
/ccagent/v1/exchanges
Agent/Files
File endpoints
- doFileSegmentUpload
- Method: postPath:
/ccagent/v1/files/{id}
- getFile
- Method: getPath:
/ccagent/v1/files/{id}
- startFileUpload
- Method: putPath:
/ccagent/v1/files
Agent/Internal Profiles
The operations from the Agent/Internal Profiles category.
- getCurrentAdminProfile
- Method: getPath:
/ccagent/v1/adminProfiles/current
- requestPasswordReset
- Method: postPath:
/ccagent/v1/adminProfiles/requestPasswordReset
- sendPasswordReset
- Method: postPath:
/ccagent/v1/adminProfiles/sendPasswordReset
Agent/Item Types
Item Type endpoints to get item type and base type details
- getItemType
- Method: getPath:
/ccagent/v1/itemTypes/{id}
- listItemTypes
- Method: getPath:
/ccagent/v1/itemTypes
Agent/List Country Region
Endpoints for read operations on configured shippingCountry and its region/provinces for Agent Application
- listShippingCountries
- Method: getPath:
/ccagent/v1/validShippingCountries
Agent/Locations
Endpoints to support operations related to locations.
- getLocation
- Method: getPath:
/ccagent/v1/locations/{id}
- listLocations
- Method: getPath:
/ccagent/v1/locations
Agent/Merchant Settings
Endpoints for merchant settings corresponding to Agent.
- getAgentConfiguration
- Method: getPath:
/ccagent/v1/merchant/agentConfiguration
- getCloudConfiguration
- Method: getPath:
/ccagent/v1/merchant/cloudConfiguration
- getConfigurationSettings
- Method: getPath:
/ccagent/v1/merchant/configurationSettings
- getDispositionReasons
- Method: getPath:
/ccagent/v1/merchant/dispositionReasons
- getOrderStates
- Method: getPath:
/ccagent/v1/merchant/orderStates
- getPaymentTypes
- Method: getPath:
/ccagent/v1/merchant/paymentTypes
- getPriceOverrideReasons
- Method: getPath:
/ccagent/v1/merchant/priceOverrideReasons
- getReturnReasons
- Method: getPath:
/ccagent/v1/merchant/orderReturnReasons
- getReturnStates
- Method: getPath:
/ccagent/v1/merchant/returnStates
- listAllPaymentGateways
- Method: getPath:
/ccagent/v1/merchant/paymentGateways
- listCancelReasons
- Method: getPath:
/ccagent/v1/merchant/orderCancelReasons
- listSelectedBillingCountries
- Method: getPath:
/ccagent/v1/merchant/billingCountries
Agent/Metadata
Metadata endpoints
- getMetadata
- Method: getPath:
/ccagent/v1/metadata/{id}
Agent/OAuth
OAuth Endpoints
- getEndpointAPI
- Method: getPath:
/ccagent/v1/api/{id}
- getEndpointAPIs
- Method: getPath:
/ccagent/v1/api
- getRegistry
- Method: getPath:
/ccagent/v1/registry
- getSSOConfiguration
- Method: getPath:
/ccagent/v1/ssoConfiguration
- login
- Method: postPath:
/ccagent/v1/login
- logout
- Method: postPath:
/ccagent/v1/logout
- mfalogin
- Method: postPath:
/ccagent/v1/mfalogin
- onBehalfOf
- Method: postPath:
/ccagent/v1/onBehalfOf
- refresh
- Method: postPath:
/ccagent/v1/refresh
- verify
- Method: postPath:
/ccagent/v1/verify
Agent/OpenID
The operations from the Agent/OpenID category.
- get OpenID authorization code request
- Method: getPath:
/ccagent/v1/openid/authzCodeRequest
- get OpenID logout request
- Method: getPath:
/ccagent/v1/openid/logoutRequest
- OpenID Single Sign On
- Method: postPath:
/ccagent/v1/openid/sso
Agent/Order Amendment
Order Amendment endpoints
- handleOrderAmendment
- Method: postPath:
/ccagent/v1/orderAmendments/{orderId}
- removeOrderAmendment
- Method: deletePath:
/ccagent/v1/orderAmendments/{orderId}
- submitOrderAmendment
- Method: putPath:
/ccagent/v1/orderAmendments/{orderId}
Agent/Order Types
Order Type endpoints
- getOrderType
- Method: getPath:
/ccagent/v1/orderTypes/{id}
- listOrderTypes
- Method: getPath:
/ccagent/v1/orderTypes
Agent/Orders
Order endpoints
- approveOrder
- Method: postPath:
/ccagent/v1/orders/approve
- checkRequiresApproval
- Method: postPath:
/ccagent/v1/orders/checkRequiresApproval
- copyOrder
- Method: postPath:
/ccagent/v1/orders/copyOrder
- createOrder
- Method: postPath:
/ccagent/v1/orders
- getGiftWithPurchaseChoices
- Method: getPath:
/ccagent/v1/orders/getGiftWithPurchaseChoices
- getOrder
- Method: getPath:
/ccagent/v1/orders/{id}
- getUpsellMessages
- Method: getPath:
/ccagent/v1/orders/getUpsellMessages
- handleOrderActions
- Method: postPath:
/ccagent/v1/orders/{id}
- initiateCancelOrder
- Method: postPath:
/ccagent/v1/orders/initiateCancelOrder
- pickupItems
- Method: postPath:
/ccagent/v1/orders/{id}/shippingGroups/{sgId}/pickupItems
- redactOrder
- Method: postPath:
/ccagent/v1/orders/{id}/redact
- redactOrders
- Method: postPath:
/ccagent/v1/orders/redact
- rejectOrder
- Method: postPath:
/ccagent/v1/orders/reject
- rejectQuote
- Method: postPath:
/ccagent/v1/orders/quote/reject
- removeIncompleteOrderForProfile
- Method: deletePath:
/ccagent/v1/orders
- repriceOrder
- Method: postPath:
/ccagent/v1/orders/reprice
- requestQuote
- Method: postPath:
/ccagent/v1/orders/quote
- searchOrders
- Method: getPath:
/ccagent/v1/orders
- submitCancelOrder
- Method: putPath:
/ccagent/v1/orders/submitCancelOrder
- updateOrder
- Method: putPath:
/ccagent/v1/orders/{id}
Agent/Organization Members
Endpoints for operations on customer profile created for account-based commerce, the customer profile includes email, first name, last name, roles and dynamic properties
- createMember
- Method: postPath:
/ccagent/v1/organizationMembers
- getMember
- Method: getPath:
/ccagent/v1/organizationMembers/{id}
- listMembers
- Method: getPath:
/ccagent/v1/organizationMembers
- updateMember
- Method: putPath:
/ccagent/v1/organizationMembers/{id}
Agent/Organization Request
End points for operations for account based commerce in Oracle Commerce Cloud
- getOrganizationRequests
- Method: getPath:
/ccagent/v1/organizationRequests/{id}
- listOrganizationRequests
- Method: getPath:
/ccagent/v1/organizationRequests
Agent/Organizations
End points for operations for account-based commerce in Oracle Commerce Cloud
- getOrganization
- Method: getPath:
/ccagent/v1/organizations/{id}
- listOrganizations
- Method: getPath:
/ccagent/v1/organizations
- removeContacts
- Method: postPath:
/ccagent/v1/organizations/removeContacts
- updateOrganization
- Method: putPath:
/ccagent/v1/organizations/{id}
Agent/Organizations Address List
End points for operations for paginated list of addresses.
- listAddresses
- Method: getPath:
/ccagent/v1/addresses
Agent/Organizations Addresses
End points for operations for addresses of a Organization/Account in Oracle Commerce Cloud by Delegated Admin
- addAddress
- Method: postPath:
/ccagent/v1/organizationAddresses
- deleteAddress
- Method: deletePath:
/ccagent/v1/organizationAddresses/{id}
- getAddress
- Method: getPath:
/ccagent/v1/organizationAddresses/{id}
- getAddresses
- Method: getPath:
/ccagent/v1/organizationAddresses
- updateAddress
- Method: putPath:
/ccagent/v1/organizationAddresses/{id}
Agent/Pages
Agent/Payment
Payment endpoints.
- addPayments
- Method: postPath:
/ccagent/v1/payment
- authPayment
- Method: postPath:
/ccagent/v1/payment/auth
- calculateRemainingBalance
- Method: postPath:
/ccagent/v1/payment/calculateRemainingBalance
- updatePaymentGroupFromCyberSourceResponse
- Method: postPath:
/ccagent/v1/payment/responses
- voidPayments
- Method: postPath:
/ccagent/v1/payment/void
Agent/Payment Groups
Payment Group endpoints
- getPaymentGroup
- Method: getPath:
/ccagent/v1/paymentGroups/{id}
Agent/PriceListGroup
Endpoints for operations on PriceListGroups.
- getPriceListGroup
- Method: getPath:
/ccagent/v1/priceListGroups/{id}
- getPriceListGroupActivationSummary
- Method: getPath:
/ccagent/v1/priceListGroups/activationSummary/{token}
- listPriceListGroups
- Method: getPath:
/ccagent/v1/priceListGroups
Agent/Prices
Prices endpoints
- getAllPrices
- Method: getPath:
/ccagent/v1/prices/{id}
Agent/Product Variants
Product Variants endpoints
- listProductVariants
- Method: getPath:
/ccagent/v1/variants
Agent/Products
Product endpoints. This endpoint extends ProductAdminEndpoint in order restrict the response not to contain prices of all the available priceListGroups
- getProduct
- Method: getPath:
/ccagent/v1/products/{id}
- listProducts
- Method: getPath:
/ccagent/v1/products
Agent/Profile Request
End points for operations for account based commerce in Oracle Commerce Cloud
- Approve profile request
- Method: postPath:
/ccagent/v1/profileRequests/{id}/approve
- getProfileRequest
- Method: getPath:
/ccagent/v1/profileRequests/{id}
- listProfileRequests
- Method: getPath:
/ccagent/v1/profileRequests
- Reject profile request
- Method: postPath:
/ccagent/v1/profileRequests/{id}/reject
- updateProfileRequest
- Method: putPath:
/ccagent/v1/profileRequests/{id}
Agent/PurchaseLists
End points for operations on Purchase List in Oracle Commerce Cloud
- createPurchaseList
- Method: postPath:
/ccagent/v1/purchaseLists
- deletePurchaseList
- Method: deletePath:
/ccagent/v1/purchaseLists/{id}
- getPurchaseList
- Method: getPath:
/ccagent/v1/purchaseLists/{id}
- listPurchaseLists
- Method: getPath:
/ccagent/v1/purchaseLists
- updateItems
- Method: postPath:
/ccagent/v1/purchaseLists/{id}/updateItems
- updatePurchaseList
- Method: putPath:
/ccagent/v1/purchaseLists/{id}
Agent/Reasons
Reasons Agent endpoints
- getReason
- Method: getPath:
/ccagent/v1/reasons/{id}
- listReasons
- Method: getPath:
/ccagent/v1/reasons
Agent/Reports
Endpoints to handle operations related to reports with information to be displayed in the agent dashboard.
- getReport
- Method: getPath:
/ccagent/v1/agentReports/{id}
Agent/Return Order
Return Order endpoints
- calculateRemainingRefund
- Method: postPath:
/ccagent/v1/returnRequests/{id}/calculateRemainingRefund
- getReturnRequest
- Method: getPath:
/ccagent/v1/returnRequests/{id}
- initiateReturn
- Method: postPath:
/ccagent/v1/returnRequests
- receiveReturnRequest
- Method: putPath:
/ccagent/v1/returnRequests/{id}/receive
- searchReturns
- Method: getPath:
/ccagent/v1/returnRequests
- updateReturnRequest
- Method: putPath:
/ccagent/v1/returnRequests/{id}
Agent/Scheduled Orders
Scheduled Order endpoints
- deleteScheduledOrder
- Method: deletePath:
/ccagent/v1/scheduledOrders/{id}
- getScheduledOrder
- Method: getPath:
/ccagent/v1/scheduledOrders/{id}
- listScheduledOrdersByProfile
- Method: getPath:
/ccagent/v1/scheduledOrders
- updateScheduledOrder
- Method: putPath:
/ccagent/v1/scheduledOrders/{id}
Agent/Search
Search endpoints
- search
- Method: getPath:
/ccagent/v1/search
Agent/Shipping Methods
Endpoints for listing shipping methods, as well as getting individual shipping methods
- getShippingMethod
- Method: getPath:
/ccagent/v1/shippingMethods/{id}
- listShippingMethods
- Method: postPath:
/ccagent/v1/shippingMethods
Agent/Shopper Context Endpoint
The operations from the Agent/Shopper Context Endpoint category.
- setShopperContext
- Method: postPath:
/ccagent/v1/shopperContext
Agent/Shopper Types
Shopper Type endpoints
- getShopperType
- Method: getPath:
/ccagent/v1/shopperTypes/{id}
- listShopperTypes
- Method: getPath:
/ccagent/v1/shopperTypes
Agent/Sites
Agent/Sku
Agent/Stock Status
Stock Status endpoints
- getStockStatus
- Method: getPath:
/ccagent/v1/stockStatus/{id}
- getStockStatuses
- Method: getPath:
/ccagent/v1/stockStatus
Social Wish Lists/comments
API for comment posts in a space
- Create a comment post
- Method: postPath:
/swm/rs/v1/spaces/{spaceId}/comments
- Delete a comment post
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}/comments/{contentId}
- Get a comment post
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/comments/{contentId}
- Update a comment post
- Method: putPath:
/swm/rs/v1/spaces/{spaceId}/comments/{contentId}
Social Wish Lists/content
API for all posts in a space
- Delete a content post
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}/content/{contentId}
- Get a content post
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/content/{contentId}
- List all content posts
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/content
Social Wish Lists/invitations
API for inviting members to a space
- Create an invitation
- Method: postPath:
/swm/rs/v1/spaces/{spaceId}/invitations
Social Wish Lists/media
API for product or user media
- Create media for a product
- Method: postPath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}/media
- Create media for a user
- Method: postPath:
/swm/rs/v1/users/{userId}/media
- Delete media for a product
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}/media/{mediaId}
- Update media for a product
- Method: putPath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}/media/{mediaId}
Social Wish Lists/members
API for members of a space
- Create a member
- Method: postPath:
/swm/rs/v1/members
- Get a member
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/members/{userId}
- List all members
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/members
- Remove a member
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}/members/{userId}
Social Wish Lists/products
API for product posts in a space
- Create a new product post
- Method: postPath:
/swm/rs/v1/spaces/{spaceId}/products
- Delete a product post
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}
- Get a product post
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}
- List all product post IDs
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}/products
- Update a product post
- Method: putPath:
/swm/rs/v1/spaces/{spaceId}/products/{contentId}
Social Wish Lists/sites
API for merchant sites
- Delete site
- Method: deletePath:
/swm/rs/v1/sites/cc/{ccSiteId}
- Update a site with CC site info
- Method: putPath:
/swm/rs/v1/sites/cc/{ccSiteId}
Social Wish Lists/spaces
API for spaces belonging to a user or a site
- Create a space
- Method: postPath:
/swm/rs/v1/spaces
- Delete a space
- Method: deletePath:
/swm/rs/v1/spaces/{spaceId}
- Get a space
- Method: getPath:
/swm/rs/v1/spaces/{spaceId}
- List all spaces
- Method: getPath:
/swm/rs/v1/sites/{siteId}/spaces
- Update a space
- Method: putPath:
/swm/rs/v1/spaces/{spaceId}
Social Wish Lists/users
API for users of spaces
- Create or authenticate a user with CC
- Method: postPath:
/swm/rs/v1/users/cc/{ccProfileId}
- Delete a user
- Method: deletePath:
/swm/rs/v1/users/{userId}
- Delete a user associated with a given CC Profile ID.
- Method: deletePath:
/swm/rs/v1/users/cc/{ccProfileId}
- Get a user
- Method: getPath:
/swm/rs/v1/sites/{siteId}/users/{userId}
- Refresh a user
- Method: postPath:
/swm/rs/v1/users/refresh
- Update a user
- Method: putPath:
/swm/rs/v1/sites/{siteId}/users/{userId}
Social Wish Lists/versions
API for version information
- Describe all versions of SWM API
- Method: getPath:
/swm/rs/
- Describe version v1 of SWM API
- Method: getPath:
/swm/rs/v1
Store/Address Types
Endpoints for operations on address types.
- listAddressTypes
- Method: getPath:
/ccstore/v1/addressTypes
Store/Assembler
Assembler endpoint assembles response from assembler based on the requested service.
- assemble
- Method: getPath:
/ccstore/v1/assembler/assemble
Store/Audience Browsing Data Collection
The operations from the Store/Audience Browsing Data Collection category.
- saveBrowsingEvent
- Method: postPath:
/ccstore/v1/audienceContext/addBrowsingEvent
Store/Audience Context
Endpoints to register and query contextual data for the current user to be used in the evaluation of audiences.
- saveAddThisInterests
- Method: postPath:
/ccstore/v1/audienceContext/addThisInterests
Store/Audience Membership
Endpoint for determining Audience membership
- getAudienceMembership
- Method: getPath:
/ccstore/v1/audienceMembership
Store/Collections
Collections endpoints
- getCollection
- Method: getPath:
/ccstore/v1/collections/{id}
- listCollections
- Method: getPath:
/ccstore/v1/collections
Store/Country Region
Endpoints for read operations on Country and its region/provinces
- getBillingCountries
- Method: getPath:
/ccstore/v1/countries/billingCountries
- getCountryRegions
- Method: getPath:
/ccstore/v1/countries/{id}
- getShippingCountries
- Method: getPath:
/ccstore/v1/countries/shippingCountries
- listCountries
- Method: getPath:
/ccstore/v1/countries
Store/Currency
Endpoints for operations on currencies.
- getCurrency
- Method: getPath:
/ccstore/v1/currencies/{id}
- listCurrencies
- Method: getPath:
/ccstore/v1/currencies
Store/Error Log Entries
Error Log Entry endpoints.
- createErrorlog
- Method: postPath:
/ccstore/v1/errorLogs
Store/Files
File endpoints
- getCurrentVersionStoreFile
- Method: getPath:
/ccstore/v1/files/store/current/{fileName}
- getFile
- Method: getPath:
/ccstore/v1/files/{id}
- getFileURL
- Method: getPath:
/ccstore/v1/files/urlMapping/{id}
- getFileURLs
- Method: putPath:
/ccstore/v1/files/urlMappings
Store/Health Check
Health check endpoints.
- getPaymentGatewayAuthorizationHealthCheck
- Method: getPath:
/ccstore/v1/healthCheck/payments
- updatePaymentGatewayAuthorizationHealth
- Method: putPath:
/ccstore/v1/healthCheck/payments
Store/Images
Dynamic Image endpoints
- getImages
- Method: getPath:
/ccstore/v1/images
Store/Inventory
Inventory endpoints
- getInventory
- Method: getPath:
/ccstore/v1/inventories/{id}
- listInventories
- Method: getPath:
/ccstore/v1/inventories
- listInventoriesForLargeCart
- Method: postPath:
/ccstore/v1/inventories
Store/Item Types
Item Type endpoints to get item type and base type details
- getItemType
- Method: getPath:
/ccstore/v1/itemTypes/{id}
- listItemTypes
- Method: getPath:
/ccstore/v1/itemTypes
Store/Locations
Endpoints to support operations related to locations.
- getLocation
- Method: getPath:
/ccstore/v1/locations/{id}
- listLocations
- Method: getPath:
/ccstore/v1/locations
Store/Logging
Endpoints that interact with the server's log files.
- log
- Method: postPath:
/ccstore/v1/logging/log
- logClientErrors
- Method: postPath:
/ccstore/v1/logging/logClientErrors
- logInfoPost
- Method: postPath:
/ccstore/v1/logging/logInfoPost
- logInfoPostWithHeaders
- Method: postPath:
/ccstore/v1/logging/logInfoPostWithHeaders
- Query the storefront server logs for client side errors
- Method: getPath:
/ccstore/v1/logging
Store/Merchant Settings
Endpoints for merchant settings.
- getCancelReasons
- Method: getPath:
/ccstore/v1/merchant/cancelReasons
- getCloudConfiguration
- Method: getPath:
/ccstore/v1/merchant/cloudConfiguration
- getDefaultPriceListGroup
- Method: getPath:
/ccstore/v1/merchant/defaultPriceListGroup
- getExternalServiceData
- Method: getPath:
/ccstore/v1/merchant/{id}
- getExternalServicesData
- Method: getPath:
/ccstore/v1/merchant
- getMerchantTimezone
- Method: getPath:
/ccstore/v1/merchant/timezone
- getPaymentConfigurations
- Method: getPath:
/ccstore/v1/merchant/paymentConfigurations
- getPriceListCurrency
- Method: getPath:
/ccstore/v1/merchant/priceListCurrency
- getReturnReasons
- Method: getPath:
/ccstore/v1/merchant/returnReasons
- getSamlSettings
- Method: getPath:
/ccstore/v1/merchant/samlSettings
- getShopperSettings
- Method: getPath:
/ccstore/v1/merchant/shopperSettings
Store/Metadata
Metadata endpoints
- getMetadata
- Method: getPath:
/ccstore/v1/metadata/{id}
Store/OAuth
OAuth endpoints
- getEndpointAPI
- Method: getPath:
/ccstore/v1/api/{id}
- getEndpointAPIs
- Method: getPath:
/ccstore/v1/api
- getExtensionRegistry
- Method: getPath:
/ccstore/v1/xregistry
- getRegistry
- Method: getPath:
/ccstore/v1/registry
- login
- Method: postPath:
/ccstore/v1/login
- logout
- Method: postPath:
/ccstore/v1/logout
- refresh
- Method: postPath:
/ccstore/v1/refresh
- verify
- Method: postPath:
/ccstore/v1/verify
Store/Orders
Order endpoints
- approveOrder
- Method: postPath:
/ccstore/v1/orders/approve
- cancelOrder
- Method: postPath:
/ccstore/v1/orders/cancel
- checkRequiresApproval
- Method: postPath:
/ccstore/v1/orders/checkRequiresApproval
- createOrder
- Method: postPath:
/ccstore/v1/orders
- getAllOrdersForProfile
- Method: getPath:
/ccstore/v1/orders
- getGiftWithPurchaseChoices
- Method: getPath:
/ccstore/v1/orders/getGiftWithPurchaseChoices
- getInitialOrder
- Method: postPath:
/ccstore/v1/orders/{id}
- getOrder
- Method: getPath:
/ccstore/v1/orders/{id}
- getOrderConfirmation
- Method: getPath:
/ccstore/v1/orders/confirmation/{uuid}
- getValidActions
- Method: getPath:
/ccstore/v1/orders/validActions/{id}
- initiateCancelOrder
- Method: postPath:
/ccstore/v1/orders/initiateCancelOrder
- listReturnRequests
- Method: getPath:
/ccstore/v1/orders/{id}/returnRequests
- priceOrder
- Method: postPath:
/ccstore/v1/orders/price
- rejectOrder
- Method: postPath:
/ccstore/v1/orders/reject
- rejectQuote
- Method: postPath:
/ccstore/v1/orders/rejectQuote
- removeProfileIncompleteOrderById
- Method: deletePath:
/ccstore/v1/orders/remove/{id}
- requestQuote
- Method: postPath:
/ccstore/v1/orders/requestQuote
- submitCancelOrder
- Method: putPath:
/ccstore/v1/orders/submitCancelOrder
- submitQuotedOrder
- Method: postPath:
/ccstore/v1/orders/{id}/acceptQuote
- switchCurrentOrder
- Method: postPath:
/ccstore/v1/orders/current/switch/
- updateOrder
- Method: putPath:
/ccstore/v1/orders/{id}
- updateQuotedOrder
- Method: postPath:
/ccstore/v1/orders/{id}/updateQuotedOrder
Store/Orders/Current
The operations from the Store/Orders/Current category.
- convertToScheduledOrder
- Method: postPath:
/ccstore/v1/orders/current/convertToScheduledOrder
- getIncompleteOrder
- Method: getPath:
/ccstore/v1/orders/current
- priceCurrentOrder
- Method: postPath:
/ccstore/v1/orders/current/price
- removeCurrentProfileIncompleteOrder
- Method: deletePath:
/ccstore/v1/orders/current
- submitCurrentOrder
- Method: postPath:
/ccstore/v1/orders/current/submit
- updateCurrentProfileOrder
- Method: postPath:
/ccstore/v1/orders/current
- updateIncompleteOrder
- Method: patchPath:
/ccstore/v1/orders/current
Store/Orders/Current/Items
The operations from the Store/Orders/Current/Items category.
- addCartItems
- Method: postPath:
/ccstore/v1/orders/current/items/add
- deleteCartItem
- Method: deletePath:
/ccstore/v1/orders/current/items/{id}
- deleteCartItems
- Method: postPath:
/ccstore/v1/orders/current/items/delete
- getCartItem
- Method: getPath:
/ccstore/v1/orders/current/items/{id}
- getCartItems
- Method: getPath:
/ccstore/v1/orders/current/items
- makeGiftWithPurchaseSelection
- Method: postPath:
/ccstore/v1/orders/current/items/makeGWPSelection
- removeAllSelectableQuantity
- Method: postPath:
/ccstore/v1/orders/current/items/removeAllSelectableQuantity
- removeSelectableQuantity
- Method: postPath:
/ccstore/v1/orders/current/items/removeSelectableQuantity
- updateCartItem
- Method: patchPath:
/ccstore/v1/orders/current/items/{id}
- updateCartItems
- Method: patchPath:
/ccstore/v1/orders/current/items
Store/Orders/Current/Payments
The operations from the Store/Orders/Current/Payments category.
- applyPayments
- Method: postPath:
/ccstore/v1/orders/current/payments
- deletePayment
- Method: deletePath:
/ccstore/v1/orders/current/payments/{id}
- getPayment
- Method: getPath:
/ccstore/v1/orders/current/payments/{id}
- getPayments
- Method: getPath:
/ccstore/v1/orders/current/payments
- updatePayment
- Method: patchPath:
/ccstore/v1/orders/current/payments/{id}
- updatePayments
- Method: patchPath:
/ccstore/v1/orders/current/payments
Store/Orders/Current/Shipping Groups
The operations from the Store/Orders/Current/Shipping Groups category.
- addShippingGroups
- Method: postPath:
/ccstore/v1/orders/current/shippingGroups/add
- deleteShippingGroup
- Method: deletePath:
/ccstore/v1/orders/current/shippingGroups/{id}
- deleteShippingGroups
- Method: postPath:
/ccstore/v1/orders/current/shippingGroups/delete
- getShippingGroup
- Method: getPath:
/ccstore/v1/orders/current/shippingGroups/{id}
- getShippingGroups
- Method: getPath:
/ccstore/v1/orders/current/shippingGroups
- relateToCartItems
- Method: postPath:
/ccstore/v1/orders/current/shippingGroups/relateToItems
- updateShippingGroup
- Method: patchPath:
/ccstore/v1/orders/current/shippingGroups/{id}
- updateShippingGroups
- Method: patchPath:
/ccstore/v1/orders/current/shippingGroups
Store/Organization Members
The details of customer profile created for account-based commerce, the customer profile includes email, first name, last name, and roles.
- createMember
- Method: postPath:
/ccstore/v1/organizationMembers
- getMember
- Method: getPath:
/ccstore/v1/organizationMembers/{id}
- listMembers
- Method: getPath:
/ccstore/v1/organizationMembers
- updateMember
- Method: putPath:
/ccstore/v1/organizationMembers/{id}
Store/Organization Request
End points for operations for account based commerce in Oracle Commerce Cloud
- createOrganizationRequest
- Method: postPath:
/ccstore/v1/organizationRequests
Store/Organizations
End points for operations for account-based commerce in Oracle Commerce Cloud
- getOrganization
- Method: getPath:
/ccstore/v1/organizations/{id}
- listOrganizations
- Method: getPath:
/ccstore/v1/organizations
- removeContacts
- Method: postPath:
/ccstore/v1/organizations/removeContacts
- updateOrganization
- Method: putPath:
/ccstore/v1/organizations/{id}
Store/Organizations Address List
End points for operations for paginated list of addresses of a Organization/Account in Oracle Commerce Cloud by Delegated Admin
- listAddresses
- Method: getPath:
/ccstore/v1/addresses
Store/Organizations Addresses
End points for operations for addresses of a Organization/Account in Oracle Commerce Cloud by Delegated Admin
- addAddress
- Method: postPath:
/ccstore/v1/organizationAddresses
- deleteAddress
- Method: deletePath:
/ccstore/v1/organizationAddresses/{id}
- getAddress
- Method: getPath:
/ccstore/v1/organizationAddresses/{id}
- getAddresses
- Method: getPath:
/ccstore/v1/organizationAddresses
- updateAddress
- Method: putPath:
/ccstore/v1/organizationAddresses/{id}
Store/Pages
Store/Payment
Payment endpoints.
- addPayments
- Method: postPath:
/ccstore/v1/payment
- authPayment
- Method: postPath:
/ccstore/v1/payment/auth
- calculateRemainingBalance
- Method: postPath:
/ccstore/v1/payment/calculateRemainingBalance
- getPaymentTypes
- Method: getPath:
/ccstore/v1/payment/types
- updatePaymentGroupFromCyberSourceResponse
- Method: postPath:
/ccstore/v1/payment/responses
- updatePaymentGroupFromGenericResponse
- Method: postPath:
/ccstore/v1/payment/genericCardResponses
- updatePaymentResponseWithClientError
- Method: putPath:
/ccstore/v1/payment/responses
Store/Payment Groups
Payment Group endpoints
- getPaymentGroup
- Method: getPath:
/ccstore/v1/paymentGroups/{id}
Store/PriceListGroup
Endpoints for operations on PriceListGroups.
- getPriceListGroup
- Method: getPath:
/ccstore/v1/priceListGroups/{id}
- listPriceListGroups
- Method: getPath:
/ccstore/v1/priceListGroups
Store/Prices
Prices endpoints
- getAllPrices
- Method: getPath:
/ccstore/v1/prices/{id}
- getAllProductsPrices
- Method: getPath:
/ccstore/v1/prices/products
- getAllSKUsPrices
- Method: getPath:
/ccstore/v1/prices/skus
Store/Product Notify
Product Notification endpoints
- addProductNotification
- Method: postPath:
/ccstore/v1/productnotify
Store/Product Types
Product Type endpoints.
- getProductType
- Method: getPath:
/ccstore/v1/productTypes/{id}
- listProductTypes
- Method: getPath:
/ccstore/v1/productTypes
Store/Products
Product endpoints
- getProduct
- Method: getPath:
/ccstore/v1/products/{id}
- listProducts
- Method: getPath:
/ccstore/v1/products
- listProductsForLargeCart
- Method: postPath:
/ccstore/v1/products
Store/Profile Request
End points for operations for account based commerce in Oracle Commerce Cloud
- Approve profile request
- Method: postPath:
/ccstore/v1/profileRequests/{id}/approve
- createMultipleProfileRequests
- Method: postPath:
/ccstore/v1/profileRequests/createMultiple
- createProfileRequest
- Method: postPath:
/ccstore/v1/profileRequests
- getProfileRequest
- Method: getPath:
/ccstore/v1/profileRequests/{id}
- listProfileRequests
- Method: getPath:
/ccstore/v1/profileRequests
- Reject profile request
- Method: postPath:
/ccstore/v1/profileRequests/{id}/reject
- updateProfileRequest
- Method: putPath:
/ccstore/v1/profileRequests/{id}
Store/Profiles
Profile endpoints
- addCreditCard
- Method: postPath:
/ccstore/v1/profiles/current/creditCards
- addProfileAddress
- Method: postPath:
/ccstore/v1/profiles/current/addresses
- createProfile
- Method: postPath:
/ccstore/v1/profiles
- deleteProfileAddress
- Method: deletePath:
/ccstore/v1/profiles/current/addresses/{addressId}
- getCreditCard
- Method: getPath:
/ccstore/v1/profiles/current/creditCards/{id}
- getCurrentProfile
- Method: getPath:
/ccstore/v1/profiles/current
- getProfileAddress
- Method: getPath:
/ccstore/v1/profiles/current/addresses/{addressId}
- listCreditCards
- Method: getPath:
/ccstore/v1/profiles/current/creditCards
- listProfileAddresses
- Method: getPath:
/ccstore/v1/profiles/current/addresses
- listSiteProperties
- Method: getPath:
/ccstore/v1/profiles/current/siteProperties
- removeCreditCard
- Method: deletePath:
/ccstore/v1/profiles/current/creditCards/{id}
- resetPassword
- Method: postPath:
/ccstore/v1/profiles/resetPassword
- updateCreditCard
- Method: putPath:
/ccstore/v1/profiles/current/creditCards/{id}
- updateExpiredPassword
- Method: postPath:
/ccstore/v1/profiles/updateExpiredPassword
- updateProfile
- Method: putPath:
/ccstore/v1/profiles/current
- updateProfileAddress
- Method: putPath:
/ccstore/v1/profiles/current/addresses/{addressId}
- updateSiteProperties
- Method: putPath:
/ccstore/v1/profiles/current/siteProperties
Store/Publishing
Publishing endpoints for storefront server
- getLastPublishedTime
- Method: getPath:
/ccstore/v1/publish
- pushPubEvent
- Method: postPath:
/ccstore/v1/publish/event
Store/PurchaseLists
End points for operations on Purchase List in Oracle Commerce Cloud
- checkEditAccess
- Method: postPath:
/ccstore/v1/purchaseLists/checkEditAccess
- createPurchaseList
- Method: postPath:
/ccstore/v1/purchaseLists
- deletePurchaseList
- Method: deletePath:
/ccstore/v1/purchaseLists/{id}
- getPurchaseList
- Method: getPath:
/ccstore/v1/purchaseLists/{id}
- listPurchaseLists
- Method: getPath:
/ccstore/v1/purchaseLists
- updateItems
- Method: postPath:
/ccstore/v1/purchaseLists/{id}/updateItems
- updatePurchaseList
- Method: putPath:
/ccstore/v1/purchaseLists/{id}
Store/RecommendationGlobalRules
The operations from the Store/RecommendationGlobalRules category.
- listRecommendationGlobalRules
- Method: getPath:
/ccstore/v1/recommendationGlobalRules
Store/RecommendationStrategy
The operations from the Store/RecommendationStrategy category.
- getRecommendationStrategy
- Method: getPath:
/ccstore/v1/recommendationStrategies/{id}
Store/Resources
Resource endpoints
- getResourceBundle
- Method: getPath:
/ccstore/v1/resources/{bundle}
Store/Return Requests
Return Request Endpoints
- calculateRefund
- Method: postPath:
/ccstore/v1/returnRequests/calculateRefund
- createReturnRequest
- Method: postPath:
/ccstore/v1/returnRequests
- getReturnRequest
- Method: getPath:
/ccstore/v1/returnRequests/{id}
- initiateReturn
- Method: postPath:
/ccstore/v1/returnRequests/initiate
- validateReturns
- Method: postPath:
/ccstore/v1/returnRequests/validate
Store/SAML AuthnRequest
Endpoint to generate a new SAML AuthnRequest
- samlAuthnRequest
- Method: postPath:
/ccstore/v1/samlAuthnRequest
Store/Scheduled Orders
Endpoints for scheduled orders.
- createScheduledOrder
- Method: postPath:
/ccstore/v1/scheduledOrders
- deleteScheduledOrder
- Method: deletePath:
/ccstore/v1/scheduledOrders/{id}
- getScheduledOrder
- Method: getPath:
/ccstore/v1/scheduledOrders/{id}
- listExecutionStatusForScheduledOrderById
- Method: getPath:
/ccstore/v1/scheduledOrders/status/{id}
- listScheduledOrdersByProfile
- Method: getPath:
/ccstore/v1/scheduledOrders/current/scheduledOrders
- updateScheduledOrder
- Method: putPath:
/ccstore/v1/scheduledOrders/{id}
Store/Search
Search endpoints
- search
- Method: getPath:
/ccstore/v1/search
Store/Services
Services endpoints
- getService
- Method: getPath:
/ccstore/v1/services/{id}
- getServices
- Method: getPath:
/ccstore/v1/services
- modifyService
- Method: postPath:
/ccstore/v1/services/{id}/modify
- renewService
- Method: postPath:
/ccstore/v1/services/{id}/renew
- terminateService
- Method: postPath:
/ccstore/v1/services/{id}/terminate
Store/ShareSettings
End points for operations on Share Settings in Oracle Commerce Cloud
- createEmailConfigs
- Method: postPath:
/ccstore/v1/shareSettings/{id}/createEmailConfigs
- createShareSetting
- Method: postPath:
/ccstore/v1/shareSettings
- deleteEmailConfigs
- Method: postPath:
/ccstore/v1/shareSettings/{id}/deleteEmailConfigs
- deleteShareSetting
- Method: deletePath:
/ccstore/v1/shareSettings/{id}
- getShareSetting
- Method: getPath:
/ccstore/v1/shareSettings/{id}
- listShareSettings
- Method: getPath:
/ccstore/v1/shareSettings
- updateEmailConfigs
- Method: postPath:
/ccstore/v1/shareSettings/{id}/updateEmailConfigs
- updateShareSetting
- Method: putPath:
/ccstore/v1/shareSettings/{id}
Store/Shipping Methods
Endpoints for listing shipping methods, as well as getting individual shipping methods
- getShippingMethod
- Method: getPath:
/ccstore/v1/shippingMethods/{id}
- listShippingMethods
- Method: postPath:
/ccstore/v1/shippingMethods
- listShippingMethodsForCurrentOrder
- Method: getPath:
/ccstore/v1/shippingMethods
Store/Shipping Regions
Shipping Regions Endpoints
- getShippingRegionsByCountry
- Method: getPath:
/ccstore/v1/shippingRegions
Store/Shopper Context Endpoint
The operations from the Store/Shopper Context Endpoint category.
- setShopperContext
- Method: postPath:
/ccstore/v1/shopperContext
Store/Sites
Store/Skus
Sku endpoints
- getSku
- Method: getPath:
/ccstore/v1/skus/{id}
- listSkus
- Method: getPath:
/ccstore/v1/skus
- listSkusForLargeCart
- Method: postPath:
/ccstore/v1/skus
Store/Static Wishlist
Static Wishlist endpoints
- generateStaticWishlistPage
- Method: postPath:
/ccstore/v1/staticWishlistPages/{id}
Store/Stock Status
Stock Status endpoints
- getStockStatus
- Method: getPath:
/ccstore/v1/stockStatus/{id}
- getStockStatuses
- Method: getPath:
/ccstore/v1/stockStatus
- listStockStatusForLargeCart
- Method: postPath:
/ccstore/v1/stockStatus
Store/Store Extension/Orders
The details of order created on the Oracle Commerce Cloud. The order includes item and shipment details
- deleteOrder
- Method: deletePath:
/ccapp/v1/orders/{id}
- deleteOrders
- Method: postPath:
/ccapp/v1/orders/delete
- getOrder
- Method: getPath:
/ccapp/v1/orders/{id}
- getOrders
- Method: getPath:
/ccapp/v1/orders
- syncQuote
- Method: putPath:
/ccapp/v1/orders/syncQuote
- updateOrder
- Method: putPath:
/ccapp/v1/orders/{id}
- updateQuoteStatus
- Method: putPath:
/ccapp/v1/orders/updateQuoteStatus
Store/Store Extension/Organization Request
End points for operations for account based commerce in Oracle Commerce Cloud
- Approve organization request
- Method: postPath:
/ccapp/v1/organizationRequests/{id}/approve
- deleteOrganizationRequest - only for application access
- Method: deletePath:
/ccapp/v1/organizationRequests/{id}
- getOrganizationRequests
- Method: getPath:
/ccapp/v1/organizationRequests/{id}
- listOrganizationRequests
- Method: getPath:
/ccapp/v1/organizationRequests
- Reject organization request
- Method: postPath:
/ccapp/v1/organizationRequests/{id}/reject
- updateOrganizationRequests
- Method: putPath:
/ccapp/v1/organizationRequests/{id}
Store/Store Extension/Organizations
End points for operations for account based commerce in Oracle Commerce Cloud
- add an secondary address to an Organization
- Method: postPath:
/ccapp/v1/organizations/{id}/secondaryAddresses
- createOrganization
- Method: postPath:
/ccapp/v1/organizations
- delete an Address for an Organization
- Method: deletePath:
/ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
- generates the authorization code for an Organization
- Method: postPath:
/ccapp/v1/organizations/{id}/authorizationCode
- get Address for an Organization
- Method: getPath:
/ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
- Get site based Organization properties
- Method: getPath:
/ccapp/v1/organizations/{id}/siteOrganizationProperties
- getOrganization
- Method: getPath:
/ccapp/v1/organizations/{id}
- listOrganizationRoles
- Method: getPath:
/ccapp/v1/organizations/{id}/organizationalRoles
- listOrganizations
- Method: getPath:
/ccapp/v1/organizations
- update address for an Organization
- Method: putPath:
/ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
- update site based Organization properties
- Method: postPath:
/ccapp/v1/organizations/{id}/updateSiteOrganizationProperties
- updateOrganization
- Method: putPath:
/ccapp/v1/organizations/{id}
Store/Store Extension/Profiles
The details of customer profile created on Oracle Commerce Cloud. This includes account based commerce, the customer profile includes email, first name and last name.
- addProfileAddress
- Method: postPath:
/ccapp/v1/profiles/{id}/addresses
- appendSecondaryOrganizations
- Method: postPath:
/ccapp/v1/profiles/{id}/appendSecondaryOrganizations
- createProfile
- Method: postPath:
/ccapp/v1/profiles
- deleteProfileAddress
- Method: deletePath:
/ccapp/v1/profiles/{id}/addresses/{addressId}
- getProfile
- Method: getPath:
/ccapp/v1/profiles/{id}
- getProfileAddress
- Method: getPath:
/ccapp/v1/profiles/{id}/addresses/{addressId}
- listProfileAddresses
- Method: getPath:
/ccapp/v1/profiles/{id}/addresses
- listProfiles
- Method: getPath:
/ccapp/v1/profiles
- removeSecondaryOrganizations
- Method: postPath:
/ccapp/v1/profiles/{id}/removeSecondaryOrganizations
- replaceSecondaryOrganizations
- Method: postPath:
/ccapp/v1/profiles/{id}/replaceSecondaryOrganizations
- resetPassword
- Method: postPath:
/ccapp/v1/profiles/resetPassword
- updateParentOrganization
- Method: postPath:
/ccapp/v1/profiles/{id}/updateParentOrganization
- updateProfile
- Method: putPath:
/ccapp/v1/profiles/{id}
- updateProfileAddress
- Method: putPath:
/ccapp/v1/profiles/{id}/addresses/{addressId}
- updateProfiles
- Method: putPath:
/ccapp/v1/profiles
- updateUserRoles
- Method: postPath:
/ccapp/v1/profiles/{id}/updateUserRoles
Store/Store Metadata Catalog
Metadata Catalog Store Endpoints
- getMetadataCatalog
- Method: getPath:
/ccstore/v1/metadata-catalog
Store/Timezone
Endpoints for operations on timezones.
- getTimezone
- Method: getPath:
/ccstore/v1/timezones/{id}
- listTimezones
- Method: getPath:
/ccstore/v1/timezones
Store/Visitor Info
Endpoints to handle visitor information.
- updateVisitorInfo
- Method: putPath:
/ccstore/v1/visitorInfo/current
Store/Web Analytics
Endpoints for operations related to web analytics like storing visits and visitor counts.
- saveVisitsAndVisitorsMetric
- Method: postPath:
/ccstore/v1/analytics/visitorsMetric
Store/assemblerPages
The operations from the Store/assemblerPages category.
- search
- Method: getPath:
/ccstore/v1/assembler/pages/{path: .*}
Webhook/ASA Additional Properties
The operations from the Webhook/ASA Additional Properties category.
- asaAdditionalProperties
- Method: postPath:
/ccadmin/v1/webhook/asaAdditionalProperties
Webhook/Account Assets
Returns the services associated with a set of customer accounts, or services when the records set is present.
- accountAssets
- Method: postPath:
/ccadmin/v1/webhook/accountAssets
Webhook/Appeasement Submit
The operations from the Webhook/Appeasement Submit category.
- appeasementSubmit
- Method: postPath:
/ccadmin/v1/webhook/appeasementSubmit
Webhook/Appeasement Validation
Function webhook that can be used to perform external validations on an appeasement during its submission. The request payload contains complete details about the current appeasement, agent's profile, order and profile against which the appeasement is being provided, returns related to the order, previous appeasements related to the profile either directly or indirectly through orders, site and organization on which the appeasement is being submitted. Custom validation of the appeasement can be performed by the external system using these details. Response should indicate whether this appeasement is valid and can be submitted in OCC. If the appeasement is invalid, reason for validation failure should be provided.
- appeasementValidation
- Method: postPath:
/ccadmin/v1/webhook/appeasementValidation
Webhook/Asset Actions
Returns action details associated with particular assets.
- assetActions
- Method: postPath:
/ccadmin/v1/webhook/assetActions
Webhook/Calculate Shipping
Webhook for calculating shipping cost
- Call external service to determine available shipping methods and prices.
- Method: postPath:
/ccadmin/v1/webhook/calculateShipping
Webhook/Cancel
The webHook notifies the external system that an order has been cancelled. This doc describes the attributes served by Cancel Order Webhook (Without Payment Details).
- cancel
- Method: postPath:
/ccadmin/v1/webhook/cancel
Webhook/Cancel Order Update
This operation is triggered to update the cancel order details.
- cancelOrderUpdate
- Method: postPath:
/ccadmin/v1/webhook/cancelOrderUpdate
Webhook/Cancel PCI
The webHook notifies the external system that an order has been cancelled. This doc describes the attributes served by Cancel Order Webhook (Without Payment Details).
- cancelPCI
- Method: postPath:
/ccadmin/v1/webhook/cancelPCI
Webhook/Catalog and Price Group Assignment
Assign catalogs and price groups based on rules set in an external system.
- externalPriceGroupAndCatalog
- Method: postPath:
/ccadmin/v1/webhook/externalPriceGroupAndCatalog
Webhook/Contact Accounts
Returns billing, customer and service account information associated with the current profile.
- contactAccounts
- Method: postPath:
/ccadmin/v1/webhook/contactAccounts
Webhook/Custom Currency
This webhook is used for Custom currency Payments
- customCurrency
- Method: postPath:
/ccadmin/v1/webhook/customCurrency
Webhook/Data Export
The data export details in the Oracle Commerce Cloud
- dataExport
- Method: postPath:
/ccadmin/v1/webhook/dataExport
Webhook/Data Import
The data import details in the Oracle Commerce Cloud
- dataImport
- Method: postPath:
/ccadmin/v1/webhook/dataImport
Webhook/Delete Order
The operations from the Webhook/Delete Order category.
- deleteOrder
- Method: postPath:
/ccadmin/v1/webhook/deleteOrder
Webhook/External Price Validation
Validates external prices with an external pricing system.
- External Price Validation
- Method: postPath:
/ccadmin/v1/webhook/externalPricing
Webhook/External Promotions
This operation is triggered during pricing operations to make promotion related adjustments to an order's price, or individual item prices.
- externalPromotions
- Method: postPath:
/ccadmin/v1/webhook/externalPromotions
Webhook/External Tax Calculation
This event is triggered at checkout page to get tax for cart from external service
- externalTaxCalculation
- Method: postPath:
/ccadmin/v1/webhook/externalTaxCalculation
Webhook/Generic Card Payment
Integrates custom payment gateways that let your store accept card payment.
- genericCardPayment
- Method: postPath:
/ccadmin/v1/webhook/genericCardPayment
Webhook/Generic Payment
Integrates custom payment gateways that let your store accept various payment types
- genericPayment
- Method: postPath:
/ccadmin/v1/webhook/genericPayment
Webhook/Idle Cart
The details of idle cart in the Oracle Commerce Cloud
- idleCart
- Method: postPath:
/ccadmin/v1/webhook/idleCart
Webhook/Non PCI Return Request Validation
Functional webhook that can be used to call an OMS or similar system and determine whether the order and/or items in the order are eligible for returns.
- returnRequestValidationForNonPCITargets
- Method: postPath:
/ccadmin/v1/webhook/returnRequestValidationForNonPCITargets
Webhook/Order
The details of order created on the Oracle Commerce Cloud. The order includes item and shipment details
- order
- Method: postPath:
/ccadmin/v1/webhook/order
Webhook/Order Approvals
The operations from the Webhook/Order Approvals category.
- checkOrderApprovalWebhook
- Method: postPath:
/ccadmin/v1/webhook/checkOrderApprovalWebhook
Webhook/Order Qualification
A webhook for preforming order qualification operations prior to the order being submitted. This webhook is fired during the order submit flow.
- orderQualification
- Method: postPath:
/ccadmin/v1/webhook/orderQualification
Webhook/Order Validation
A webhook for validating the contents of an order. This webhook is fired at order submit time and will be executed after final order pricing has been performed.
- orderValidation
- Method: postPath:
/ccadmin/v1/webhook/orderValidation
Webhook/OrderRetryFailed
The webHook notifies the external system that an order which was being retried for submission asynchronously, has failed all the retries.This doc describes the attributes served by Order Retry Failed Webhook.
- Order retry failed
- Method: postPath:
/ccadmin/v1/webhook/orderRetryFailed
Webhook/OrderRetryFailed PCI
The webHook notifies the external system that an order which was being retried for submission asynchronously, has failed all the retries.This doc describes the attributes served by Order Retry Failed Webhook (Without Payment Details).
- Order retry failed PCI
- Method: postPath:
/ccadmin/v1/webhook/orderRetryFailedPCI
Webhook/Organization
The metadata for create/update account webhook.
- organization
- Method: postPath:
/ccadmin/v1/webhook/organization
Webhook/Organization Request
The details of organization request created by Oracle Commerce
- createOrganizationRequest
- Method: postPath:
/ccadmin/v1/webhook/createOrganizationRequest
Webhook/Profile Request
The details of profile request created by Oracle Commerce
- createProfileRequest
- Method: postPath:
/ccadmin/v1/webhook/createProfileRequest
Webhook/Publish Event
The publish event details in the Oracle Commerce Cloud
- publishEvent
- Method: postPath:
/ccadmin/v1/webhook/publishEvent
Webhook/Redact Order
The operations from the Webhook/Redact Order category.
- redactOrder
- Method: postPath:
/ccadmin/v1/webhook/redactOrder
Webhook/Remorse period started for a PCI order
The details of the order created on the Oracle Commerce Cloud for which the remorse period has started
- Remorse period started
- Method: postPath:
/ccadmin/v1/webhook/remorsePeriodStartedPCI
Webhook/Remorse period started for a non PCI order
The details (excluding payment details) of the order created on the Oracle Commerce Cloud for which the remorse period has started
- Remorse period started
- Method: postPath:
/ccadmin/v1/webhook/remorsePeriodStarted
Webhook/Request Quote
The details of quote requested by Oracle Commerce
- requestQuote
- Method: postPath:
/ccadmin/v1/webhook/requestQuote
Webhook/Return
This Event is triggered when a return request is initiated. This doc describes the attributes served by Return Request Update Webhook (Without Payment Details).
- return
- Method: postPath:
/ccadmin/v1/webhook/return
Webhook/Return PCI
This Event is triggered when a return request is initiated. This doc describes the attributes served by Return Request Update Webhook (Without Payment Details).
- returnPCI
- Method: postPath:
/ccadmin/v1/webhook/returnPCI
Webhook/Return Request Validation
Functional webhook that can be used to call an OMS or similar system and determine whether the order and/or items in the order are eligible for returns.
- returnRequestValidation
- Method: postPath:
/ccadmin/v1/webhook/returnRequestValidation
Webhook/Shopper Profile Create
The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.
- Shopper Profile Create
- Method: postPath:
/ccadmin/v1/webhook/profile
Webhook/Shopper Profile Delete
A registered shopper has been removed
- Shopper Profile Delete
- Method: postPath:
/ccadmin/v1/webhook/profileDelete
Webhook/Shopper Profile Update
The details of customer profile being updated on Oracle Commerce Cloud.
- Shopper Profile Update
- Method: postPath:
/ccadmin/v1/webhook/profileUpdate
Webhook/Update Inventory
The operations from the Webhook/Update Inventory category.
- updateInventory
- Method: postPath:
/ccadmin/v1/webhook/updateInventory
Webhook/Update Quote
The details of quote and the operation requested by Oracle Commerce Cloud.
- updateQuote
- Method: postPath:
/ccadmin/v1/webhook/updateQuote