REST API for Oracle Commerce Cloud 21D

All REST Endpoints

Admin/Access Rights

Access Right endpoints

createAccessRight: Method: post
Path: /ccadmin/v1/accessRights
getAccessRight: Method: get
Path: /ccadmin/v1/accessRights/{id}
listAccessRights: Method: get
Path: /ccadmin/v1/accessRights
updateAccessRight: Method: put
Path: /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: get
Path: /ccadmin/v1/addThisInterests

Admin/Address Types

Endpoints for operations on address types.

createAddressType: Method: post
Path: /ccadmin/v1/addressTypes
deleteAddressType: Method: delete
Path: /ccadmin/v1/addressTypes/{id}
listAddressTypes: Method: get
Path: /ccadmin/v1/addressTypes
updateAddressType: Method: put
Path: /ccadmin/v1/addressTypes/{id}

Admin/Addresses

Addresses Endpoints

listAddresses: Method: get
Path: /ccadmin/v1/addresses

Admin/Admin Access Rights

Admin Access Right endpoints

createAdminAccessRight: Method: post
Path: /ccadmin/v1/adminAccessRights
getAdminAccessRight: Method: get
Path: /ccadmin/v1/adminAccessRights/{id}
listAdminAccessRights: Method: get
Path: /ccadmin/v1/adminAccessRights
updateAdminAccessRight: Method: put
Path: /ccadmin/v1/adminAccessRights/{id}

Admin/Admin Metadata Catalog

Metadata Catalog Admin Endpoints

getBulkMetadata: Method: get
Path: /ccadmin/v1/metadata-catalog/bulk
getMetadataCatalog: Method: get
Path: /ccadmin/v1/metadata-catalog
getResourceMetadata: Method: get
Path: /ccadmin/v1/metadata-catalog/{id}
getWebhookMetadata: Method: get
Path: /ccadmin/v1/metadata-catalog/webhook
getWebHookResourceMetadata: Method: get
Path: /ccadmin/v1/metadata-catalog/webhook/{id}

Admin/Admin SAML AuthnRequest

The operations from the Admin/Admin SAML AuthnRequest category.

get SAML AuthnRequest: Method: get
Path: /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: get
Path: /ccadmin/v1/saml/metadata/idpSettings
update Admin SAML IDP settings: Method: put
Path: /ccadmin/v1/saml/metadata/idpSettings

Admin/Admin SAML LogoutRequest

The operations from the Admin/Admin SAML LogoutRequest category.

get SAML LogoutRequest: Method: get
Path: /ccadmin/v1/saml/logoutRequest

Admin/Admin Security Criteria

Admin Security Criteria endpoints

createAdminSecurityCriterion: Method: post
Path: /ccadmin/v1/adminSecurityCriteria
deleteAdminSecurityCriterion: Method: delete
Path: /ccadmin/v1/adminSecurityCriteria/{id}
getAdminSecurityCriterion: Method: get
Path: /ccadmin/v1/adminSecurityCriteria/{id}
listAdminSecurityCriteria: Method: get
Path: /ccadmin/v1/adminSecurityCriteria
updateAdminSecurityCriterion: Method: put
Path: /ccadmin/v1/adminSecurityCriteria/{id}

Admin/Admin Security Criteria Resources

Admin Security Criteria Resources endpoints

getAdminSecurityCriteriaResource: Method: get
Path: /ccadmin/v1/adminSecurityCriteriaResources/{id}
listAdminSecurityCriteriaResources: Method: get
Path: /ccadmin/v1/adminSecurityCriteriaResources

Admin/Admin Service Provider Entity Descriptor

The operations from the Admin/Admin Service Provider Entity Descriptor category.

get Service Provider Entity Descriptor XML: Method: get
Path: /ccadmin/v1/saml/metadata/spEntityDescriptor
get Service Provider Signing Certificate: Method: get
Path: /ccadmin/v1/saml/metadata/spCertificate

Admin/Admin Single Log out

The operations from the Admin/Admin Single Log out category.

single log out: Method: post
Path: /ccadmin/v1/saml/slo

Admin/Admin Single Sign On

The operations from the Admin/Admin Single Sign On category.

single sign on: Method: post
Path: /ccadmin/v1/saml/sso

Admin/Announcement and Quick Links

Announcement and Quick Links endpoint.

createPost: Method: post
Path: /ccadmin/v1/posts
deletePost: Method: delete
Path: /ccadmin/v1/posts/{id}
getPost: Method: get
Path: /ccadmin/v1/posts/{id}
getPosts: Method: get
Path: /ccadmin/v1/posts
handlePostUpdates: Method: put
Path: /ccadmin/v1/posts/{id}

Admin/Appeasement

The operations from the Admin/Appeasement category.

createAppeasement: Method: post
Path: /ccadmin/v1/appeasements
deleteAppeasement: Method: delete
Path: /ccadmin/v1/appeasements/{id}
getAppeasement: Method: get
Path: /ccadmin/v1/appeasements/{id}
listAppeasements: Method: get
Path: /ccadmin/v1/appeasements
updateAppeasement: Method: put
Path: /ccadmin/v1/appeasements/{id}

Admin/AppeasementTypes

Appeasement Types Admin endpoints

createType: Method: post
Path: /ccadmin/v1/appeasementTypes
getType: Method: get
Path: /ccadmin/v1/appeasementTypes/{id}
listTypes: Method: get
Path: /ccadmin/v1/appeasementTypes
updateType: Method: put
Path: /ccadmin/v1/appeasementTypes/{id}

Admin/Application Deployments

Application deployment endpoints.

getApplicationDeployment: Method: get
Path: /ccadmin/v1/applicationDeployment/{id}
getApplicationDeploymentLog: Method: get
Path: /ccadmin/v1/applicationDeployment/{id}/logs
getApplicationDeploymentStatus: Method: get
Path: /ccadmin/v1/applicationDeployment/{id}/status
listApplicationDeployments: Method: get
Path: /ccadmin/v1/applicationDeployment

Admin/Application Level JavaScript

Endpoints for operations on Application Level JavaScript.

getApplicationJavaScript: Method: get
Path: /ccadmin/v1/applicationJavaScript/{name}
listAllApplicationJavaScript: Method: get
Path: /ccadmin/v1/applicationJavaScript
updateApplicationJavaScript: Method: put
Path: /ccadmin/v1/applicationJavaScript/{name}

Admin/Application Stylings

Application Styling Endpoints.

createApplicationStyling: Method: post
Path: /ccadmin/v1/applicationStyling
deleteApplicationStyling: Method: delete
Path: /ccadmin/v1/applicationStyling/{id}
getApplicationStyling: Method: get
Path: /ccadmin/v1/applicationStyling/{id}
getApplicationStylingSource: Method: get
Path: /ccadmin/v1/applicationStyling/{id}/source
listApplicationStylings: Method: get
Path: /ccadmin/v1/applicationStyling
updateApplicationStyling: Method: put
Path: /ccadmin/v1/applicationStyling/{id}
updateApplicationStylingSource: Method: put
Path: /ccadmin/v1/applicationStyling/{id}/source

Admin/Applications

Endpoints for operations on Applications.

appIdOperation: Method: post
Path: /ccadmin/v1/applicationIds/{id}
createApplicationID: Method: post
Path: /ccadmin/v1/applicationIds
deleteApplicationID: Method: delete
Path: /ccadmin/v1/applicationIds/{id}
getApplicationID: Method: get
Path: /ccadmin/v1/applicationIds/{id}
getApplicationIDs: Method: get
Path: /ccadmin/v1/applicationIds
updateApplicationID: Method: put
Path: /ccadmin/v1/applicationIds/{id}

Admin/Asset Import-Export

Asset import/export endpoints

exportAssets: Method: get
Path: /ccadmin/v1/asset/export
getImportProgress: Method: get
Path: /ccadmin/v1/asset/import/{token}
getImportStatus: Method: get
Path: /ccadmin/v1/asset/importStatus
getValidationReport: Method: get
Path: /ccadmin/v1/asset/validationReport/{token}
importAssets: Method: post
Path: /ccadmin/v1/asset/import
uploadAssets: Method: post
Path: /ccadmin/v1/asset/upload
uploadEncodedFileFromUI: Method: post
Path: /ccadmin/v1/asset/uploadFromUI
validateAssets: Method: post
Path: /ccadmin/v1/asset/validate

Admin/Asset Packages

Endpoint operations for asset packages

getAssetPackage: Method: get
Path: /ccadmin/v1/assetPackages/{assetId}

Admin/Audiences

Endpoints for managing Audiences used for personalization.

audienceSizes: Method: post
Path: /ccadmin/v1/audienceSizes
audienceUsage: Method: get
Path: /ccadmin/v1/audienceUsage/{id}
createAudience: Method: post
Path: /ccadmin/v1/audiences
deleteAudience: Method: delete
Path: /ccadmin/v1/audiences/{id}
getAudience: Method: get
Path: /ccadmin/v1/audiences/{id}
listAudienceRuleProperties: Method: get
Path: /ccadmin/v1/audienceRuleProperties
listAudiences: Method: get
Path: /ccadmin/v1/audiences
updateAudience: Method: put
Path: /ccadmin/v1/audiences/{id}

Admin/Blogs

Blogs endpoint

listBlogEntries: Method: get
Path: /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: delete
Path: /ccadmin/v1/browserTypes/{id}
getBrowserType: Method: get
Path: /ccadmin/v1/browserTypes/{id}
setBrowserType: Method: put
Path: /ccadmin/v1/browserTypes/{id}

Admin/CEC Content

CEC Content endpoints

listCECContent: Method: get
Path: /ccadmin/v1/cecContent

Admin/CMS Channel Map Methods

Endpoints for operations on CMS Channel Maps.

createCmsChannelMap: Method: post
Path: /ccadmin/v1/cmsChannelMaps
deleteCmsChannelMap: Method: delete
Path: /ccadmin/v1/cmsChannelMaps/{id}
getCmsChannelMap: Method: get
Path: /ccadmin/v1/cmsChannelMaps/{id}
listCmsChannelMaps: Method: get
Path: /ccadmin/v1/cmsChannelMaps
updateCmsChannelMap: Method: put
Path: /ccadmin/v1/cmsChannelMaps

Admin/CMS Content Map Methods

Endpoints for operations on CMS Content Maps.

createCmsContentMap: Method: post
Path: /ccadmin/v1/cmsContentMaps
deleteCmsContentMap: Method: delete
Path: /ccadmin/v1/cmsContentMaps/{id}
getCmsContentMap: Method: get
Path: /ccadmin/v1/cmsContentMaps/{id}
listCmsContentMaps: Method: get
Path: /ccadmin/v1/cmsContentMaps
updateCmsContentMap: Method: put
Path: /ccadmin/v1/cmsContentMaps

Admin/CMS Publish Notification Processing

Process notifications from external Content Management Systems.

notify: Method: post
Path: /ccadmin/v1/contentnotification/{cmsId}

Admin/Carriers

Endpoints for Carrier Operations.

addCarrier: Method: post
Path: /ccadmin/v1/carriers
getAllCarriers: Method: get
Path: /ccadmin/v1/carriers
getCarrier: Method: get
Path: /ccadmin/v1/carriers/{id}
updateCarrier: Method: put
Path: /ccadmin/v1/carriers/{id}

Admin/Catalogs

Catalog endpoints

createCatalog: Method: post
Path: /ccadmin/v1/catalogs
deleteCatalog: Method: delete
Path: /ccadmin/v1/catalogs/{id}
getCatalog: Method: get
Path: /ccadmin/v1/catalogs/{id}
listCatalogs: Method: get
Path: /ccadmin/v1/catalogs
updateCatalog: Method: put
Path: /ccadmin/v1/catalogs/{id}

Admin/Claimables

Endpoints related to the creation and manipulation of promotion claimables.

createPromotionClaimable: Method: post
Path: /ccadmin/v1/claimables
deletePromotionClaimable: Method: delete
Path: /ccadmin/v1/claimables/{id}
getPromotionClaimable: Method: get
Path: /ccadmin/v1/claimables/{id}
listPromotionClaimables: Method: get
Path: /ccadmin/v1/claimables
updatePromotionClaimable: Method: put
Path: /ccadmin/v1/claimables/{id}

Admin/Collections

Collection endpoints

assignProducts: Method: post
Path: /ccadmin/v1/collections/assignProducts
createCollection: Method: post
Path: /ccadmin/v1/collections
deleteCollection: Method: delete
Path: /ccadmin/v1/collections/{id}
getCollection: Method: get
Path: /ccadmin/v1/collections/{id}
listCollections: Method: get
Path: /ccadmin/v1/collections
moveCollection: Method: put
Path: /ccadmin/v1/collections
updateCollection: Method: put
Path: /ccadmin/v1/collections/{id}

Admin/Component Selection

Component Selection endpoints

getComponentHierarchy: Method: get
Path: /ccadmin/v1/components/{componentType}/{component}/hierarchy
getComponentPageAssociations: Method: get
Path: /ccadmin/v1/components/{componentType}/{component}/pageAssociations
listComponents: Method: get
Path: /ccadmin/v1/components
updateHiddenComponentTypes: Method: put
Path: /ccadmin/v1/components/hidden

Admin/Content Type

The operations from the Admin/Content Type category.

Retrieve list of OCE (CEC) Content Items: Method: get
Path: /ccadmin/v1/cecContentType

Admin/Country Region

Endpoints for read operations on Country and its states and regions

addCountries: Method: post
Path: /ccadmin/v1/countries/addCountries
addRegions: Method: post
Path: /ccadmin/v1/countries/{id}/addRegions
deleteCountries: Method: post
Path: /ccadmin/v1/countries/deleteCountries
deleteCountry: Method: delete
Path: /ccadmin/v1/countries/{id}
deleteRegions: Method: post
Path: /ccadmin/v1/countries/{id}/deleteRegions
getCountryRegions: Method: get
Path: /ccadmin/v1/countries/{id}
listCountries: Method: get
Path: /ccadmin/v1/countries
updateCountryRegions: Method: put
Path: /ccadmin/v1/countries/{id}

Admin/Coupon Batches

Endpoints related to the management of coupon batches for promotions.

createPromotionCouponBatch: Method: post
Path: /ccadmin/v1/couponBatches
deletePromotionCouponBatch: Method: delete
Path: /ccadmin/v1/couponBatches/{id}
getCouponBatch: Method: get
Path: /ccadmin/v1/couponBatches/{id}
listPromotionCouponBatches: Method: get
Path: /ccadmin/v1/couponBatches
updateCouponBatch: Method: put
Path: /ccadmin/v1/couponBatches/{id}

Admin/Currency

Endpoints for operations on currencies.

createCurrency: Method: post
Path: /ccadmin/v1/currencies
deleteCurrency: Method: delete
Path: /ccadmin/v1/currencies/{id}
getCurrency: Method: get
Path: /ccadmin/v1/currencies/{id}
listCurrencies: Method: get
Path: /ccadmin/v1/currencies
updateCurrency: Method: put
Path: /ccadmin/v1/currencies/{id}

Admin/Currency Exchange Rate

Endpoints for operations on currency exchange rates.

createExchangeRate: Method: post
Path: /ccadmin/v1/exchangerates
deleteExchangeRate: Method: delete
Path: /ccadmin/v1/exchangerates/{id}
getExchangeRate: Method: get
Path: /ccadmin/v1/exchangerates/{id}
listExchangeRates: Method: get
Path: /ccadmin/v1/exchangerates
updateExchangeRate: Method: put
Path: /ccadmin/v1/exchangerates/{id}

Admin/Dashboard Report Configuration

Endpoints for the Admin dashboard report configurations.

getDashboardReportConfigurations: Method: get
Path: /ccadmin/v1/dashboardReportConfigurations

Admin/Data Admin

Data Admin endpoints

getAdminData: Method: get
Path: /ccadmin/v1/dataAdmin/{dataKey}

Admin/Elements

Endpoints for operations on Global Elements.

getElements: Method: get
Path: /ccadmin/v1/elements
getGlobalElementJavaScript: Method: get
Path: /ccadmin/v1/elements/{tag}/javascript
getGlobalElementMetadata: Method: get
Path: /ccadmin/v1/elements/{tag}/metadata
getGlobalElementTemplate: Method: get
Path: /ccadmin/v1/elements/{tag}/template
updateGlobalElementJavaScript: Method: put
Path: /ccadmin/v1/elements/{tag}/javascript
updateGlobalElementMetadata: Method: put
Path: /ccadmin/v1/elements/{tag}/metadata
updateGlobalElementTemplate: Method: put
Path: /ccadmin/v1/elements/{tag}/template

Admin/Email

for Email Service Data

Download email templates: Method: get
Path: /ccadmin/v1/email/types/{emailTypeId}/templates
Retrieve email notification types: Method: get
Path: /ccadmin/v1/email/notificationTypes
Retrieve email service data: Method: get
Path: /ccadmin/v1/email
Set email service data: Method: post
Path: /ccadmin/v1/email
Test SMTP connection: Method: post
Path: /ccadmin/v1/email/test
Update email templates: Method: put
Path: /ccadmin/v1/email/types/{emailTypeId}/templates

Admin/Email Notifications

for Email Notifications

sendEmailNotification: Method: post
Path: /ccadmin/v1/emailNotifications

Admin/Enrichment Maps

The operations from the Admin/Enrichment Maps category.

getEnrichmentMap: Method: get
Path: /ccadmin/v1/enrichmentMaps/{id}
listEnrichmentMaps: Method: get
Path: /ccadmin/v1/enrichmentMaps
updateEnrichmentMap: Method: put
Path: /ccadmin/v1/enrichmentMaps/{id}

Admin/Error Log Entries

Error Log Entry endpoints

createErrorlog: Method: post
Path: /ccadmin/v1/errorLogs

Admin/Event WebHooks

Event WebHook endpoints. Event WebHooks send events to one or more external servers.

getWebHook: Method: get
Path: /ccadmin/v1/webhooks/{id}
getWebHooks: Method: get
Path: /ccadmin/v1/webhooks
updateWebHook: Method: put
Path: /ccadmin/v1/webhooks/{id}
updateWebHooks: Method: put
Path: /ccadmin/v1/webhooks
webHookOperation: Method: post
Path: /ccadmin/v1/webhooks/{id}

Admin/Export Operations

Endpoint for export operations

listExportOperations: Method: get
Path: /ccadmin/v1/exportOperations

Admin/Export Process

Endpoints for export process

abortExportProcess: Method: post
Path: /ccadmin/v1/exportProcess/{token}/abort
executeExport: Method: post
Path: /ccadmin/v1/exportProcess
getExportProcess: Method: get
Path: /ccadmin/v1/exportProcess/{token}

Admin/Extension Server Commands

Endpoints for managing the extension servers.

doServerPush: Method: post
Path: /ccadmin/v1/servers/push
doServerRestart: Method: post
Path: /ccadmin/v1/servers/restart

Admin/Extension Server Environment Variables

Extension Server Environment Variables endpoints

doCreateExtensionVariable: Method: post
Path: /ccadmin/v1/extensionEnvironmentVariables
doDeleteExtensionVariable: Method: delete
Path: /ccadmin/v1/extensionEnvironmentVariables/{id}
doGetExtensionVariable: Method: get
Path: /ccadmin/v1/extensionEnvironmentVariables/{id}
doUpdateExtensionVariable: Method: put
Path: /ccadmin/v1/extensionEnvironmentVariables/{id}
listExtensionVariable: Method: get
Path: /ccadmin/v1/extensionEnvironmentVariables

Admin/Extension Server Logs

Endpoints for operations on Extension Server Logs.

getExtensionServerLogs: Method: get
Path: /ccadmin/v1/logs

Admin/Extension Server Tail Logs

The operations from the Admin/Extension Server Tail Logs category.

getExtensionServerTailLogs: Method: get
Path: /ccadmin/v1/logs/tail

Admin/Extension Server Test Jobs

Endpoints for operations related to the execution of Extension Server test jobs.

getCompletedTestJobs: Method: get
Path: /ccadmin/v1/testJobs
getTestJobResults: Method: get
Path: /ccadmin/v1/testJobs/{id}
testJobExecutionRequest: Method: post
Path: /ccadmin/v1/testJobs

Admin/Extension Server Test Status

Endpoints for operations on the status of Extension Server test jobs.

getTestStatus: Method: get
Path: /ccadmin/v1/testStatus/{id}

Admin/Extension Server/Extension Server Commands

The operations from the Admin/Extension Server/Extension Server Commands category.

doServerPush: Method: post
Path: /ccadminx/custom/v1/servers/push
doServerRestart: Method: post
Path: /ccadminx/custom/v1/servers/restart

Admin/Extension Server/Extension Server Logs

The operations from the Admin/Extension Server/Extension Server Logs category.

getExtensionServerLogs: Method: get
Path: /ccadminx/custom/v1/logs

Admin/Extension Server/Extension Server Test Jobs

The operations from the Admin/Extension Server/Extension Server Test Jobs category.

getCompletedTestJobs: Method: get
Path: /ccadminx/custom/v1/testJobs
getTestJobResults: Method: get
Path: /ccadminx/custom/v1/testJobs/{id}
testJobExecutionRequest: Method: post
Path: /ccadminx/custom/v1/testJobs

Admin/Extension Server/Extension Server Test Status

The operations from the Admin/Extension Server/Extension Server Test Status category.

getTestStatus: Method: get
Path: /ccadminx/custom/v1/testStatus/{id}

Admin/Extensions

Endpoints for operations on extensions.

Create an extension: Method: post
Path: /ccadmin/v1/extensions
Delete an extension: Method: delete
Path: /ccadmin/v1/extensions/{id}
Process an extension: Method: post
Path: /ccadmin/v1/extensions/{id}
Retrieve all extensions: Method: get
Path: /ccadmin/v1/extensions

Admin/Failed WebHook Messages

Endpoints for viewing and managing WebHook messages that failed to be sent.

deleteFailedMessage: Method: delete
Path: /ccadmin/v1/webhookFailedMessages/{id}
deleteFailedMessages: Method: post
Path: /ccadmin/v1/webhookFailedMessages/delete
getFailedMessage: Method: get
Path: /ccadmin/v1/webhookFailedMessages/{id}
getFailedMessages: Method: get
Path: /ccadmin/v1/webhookFailedMessages
requeueFailedMessages: Method: post
Path: /ccadmin/v1/webhookFailedMessages/requeue
updateFailedMessage: Method: put
Path: /ccadmin/v1/webhookFailedMessages/{id}
updateFailedMessages: Method: put
Path: /ccadmin/v1/webhookFailedMessages

Admin/Files

File endpoints

createFolder: Method: post
Path: /ccadmin/v1/files/createFolder
deleteFile: Method: post
Path: /ccadmin/v1/files/deleteFile
deleteFiles: Method: post
Path: /ccadmin/v1/files/deleteFiles
deleteMediaItems: Method: post
Path: /ccadmin/v1/files/deleteMediaItems
doFileSegmentUpload: Method: post
Path: /ccadmin/v1/files/{id}
doFileUploadMultipart: Method: post
Path: /ccadmin/v1/files
getFiles: Method: get
Path: /ccadmin/v1/files
getFileURI: Method: get
Path: /ccadmin/v1/files/uriMapping/{id}
getMediaContents: Method: get
Path: /ccadmin/v1/files/mediaContents
getUploadReport: Method: get
Path: /ccadmin/v1/files/mediaUploadReport/{token}
getUploadTypes: Method: get
Path: /ccadmin/v1/files/uploadTypes
resumeFileUpload: Method: put
Path: /ccadmin/v1/files/{id}
startFileUpload: Method: put
Path: /ccadmin/v1/files
updateMediaItem: Method: put
Path: /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: post
Path: /ccadmin/v1/functionWebhooks/{id}
getFunctionWebHook: Method: get
Path: /ccadmin/v1/functionWebhooks/{id}
getFunctionWebHooks: Method: get
Path: /ccadmin/v1/functionWebhooks
updateFunctionWebHook: Method: put
Path: /ccadmin/v1/functionWebhooks/{id}
updateFunctionWebHooks: Method: put
Path: /ccadmin/v1/functionWebhooks

Admin/Health Check

Admin health check endpoints

deletePaymentGatewayAuthorizationResponses: Method: delete
Path: /ccadmin/v1/healthCheck/payments

Admin/Hreflang Groups

The operations from the Admin/Hreflang Groups category.

createGroup: Method: post
Path: /ccadmin/v1/hreflangGroups
deleteGroup: Method: delete
Path: /ccadmin/v1/hreflangGroups/{id}
getGroup: Method: get
Path: /ccadmin/v1/hreflangGroups/{id}
getGroups: Method: get
Path: /ccadmin/v1/hreflangGroups
updateGroup: Method: put
Path: /ccadmin/v1/hreflangGroups/{id}

Admin/Import Operations

Endpoint for import operations

listImportOperations: Method: get
Path: /ccadmin/v1/importOperations

Admin/Import Process

Endpoints for import process

abortImportProcess: Method: post
Path: /ccadmin/v1/importProcess/{token}/abort
executeImport: Method: post
Path: /ccadmin/v1/importProcess
getImportProcess: Method: get
Path: /ccadmin/v1/importProcess/{token}

Admin/Internal Profile Roles

Internal Profile Roles endpoints

createAdminRole: Method: post
Path: /ccadmin/v1/adminRoles
deleteAdminRole: Method: delete
Path: /ccadmin/v1/adminRoles/{id}
getAdminRole: Method: get
Path: /ccadmin/v1/adminRoles/{id}
listInternalProfileRoles: Method: get
Path: /ccadmin/v1/adminRoles
updateAdminRole: Method: put
Path: /ccadmin/v1/adminRoles/{id}

Admin/Internal Profiles

Internal Profile endpoints

createAdminProfile: Method: post
Path: /ccadmin/v1/adminProfiles/
getAdminProfile: Method: get
Path: /ccadmin/v1/adminProfiles/{id}
getAuthenticatorInfo: Method: post
Path: /ccadmin/v1/adminProfiles/getAuthenticatorInfo
getCurrentAdminProfile: Method: get
Path: /ccadmin/v1/adminProfiles/current
getCurrentAdminProfileAssetAccessDetails: Method: post
Path: /ccadmin/v1/adminProfiles/current/assetAccessDetails
listAdminProfiles: Method: get
Path: /ccadmin/v1/adminProfiles
requestPasswordReset: Method: post
Path: /ccadmin/v1/adminProfiles/requestPasswordReset
resetAuthenticatorKey: Method: post
Path: /ccadmin/v1/adminProfiles/resetAuthenticatorKey
sendMFAPasswordReset: Method: post
Path: /ccadmin/v1/adminProfiles/sendMFAPasswordReset
sendNewAdminUserEmail: Method: post
Path: /ccadmin/v1/adminProfiles/sendNewAdminUserEmail
sendPasswordReset: Method: post
Path: /ccadmin/v1/adminProfiles/sendPasswordReset
updateAdminProfile: Method: put
Path: /ccadmin/v1/adminProfiles/{id}
updateCurrentAdminProfile: Method: put
Path: /ccadmin/v1/adminProfiles/current

Admin/Inventory

Inventory endpoints

createInventory: Method: post
Path: /ccadmin/v1/inventories
deleteInventory: Method: delete
Path: /ccadmin/v1/inventories/{id}
getInventory: Method: get
Path: /ccadmin/v1/inventories/{id}
listInventories: Method: get
Path: /ccadmin/v1/inventories
updateInventory: Method: put
Path: /ccadmin/v1/inventories/{id}

Admin/Item Types

Item type admin endpoints

deleteItemTypeProperty: Method: delete
Path: /ccadmin/v1/itemTypes/{itemTypeId}/properties/{propertyId}
getItemType: Method: get
Path: /ccadmin/v1/itemTypes/{id}
updateItemType: Method: put
Path: /ccadmin/v1/itemTypes/{id}

Admin/JsFrameworkAdminEndpoint

The operations from the Admin/JsFrameworkAdminEndpoint category.

Retrieve current Agent version: Method: get
Path: /ccadmin/v1/jsframeworkadmin/agentVersion
Retrieve current version: Method: get
Path: /ccadmin/v1/jsframeworkadmin
Rollback Agent current version: Method: post
Path: /ccadmin/v1/jsframeworkadmin/rollbackAgentVersion
Rollback current version: Method: post
Path: /ccadmin/v1/jsframeworkadmin/rollbackVersion
Upgrade Agent current version: Method: post
Path: /ccadmin/v1/jsframeworkadmin/upgradeAgentVersion
Upgrade current version: Method: post
Path: /ccadmin/v1/jsframeworkadmin/upgradeVersion

Admin/Layouts

Layout endpoints

cloneLayout: Method: post
Path: /ccadmin/v1/layouts/{id}
createComponentLayout: Method: post
Path: /ccadmin/v1/layouts/component/{id}
deleteLayout: Method: delete
Path: /ccadmin/v1/layouts/{id}
getLayout: Method: get
Path: /ccadmin/v1/layouts/{id}
getLayoutStructure: Method: get
Path: /ccadmin/v1/layouts/{id}/structure
listLayouts: Method: get
Path: /ccadmin/v1/layouts
saveLayoutStructure: Method: put
Path: /ccadmin/v1/layouts/{id}/structure
updateLayout: Method: put
Path: /ccadmin/v1/layouts/{id}

Admin/Locales

Endpoints to access application supported locales.

listLocales: Method: get
Path: /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: post
Path: /ccadmin/v1/locations
deleteLocation: Method: delete
Path: /ccadmin/v1/locations/{id}
getLocation: Method: get
Path: /ccadmin/v1/locations/{id}
listLocations: Method: get
Path: /ccadmin/v1/locations
updateLocation: Method: put
Path: /ccadmin/v1/locations/{id}

Admin/Logging

Endpoints that interact with the server's log files.

log: Method: post
Path: /ccadmin/v1/logging/log
logClientErrors: Method: post
Path: /ccadmin/v1/logging/logClientErrors
logInfoPost: Method: post
Path: /ccadmin/v1/logging/logInfoPost
logInfoPostWithHeaders: Method: post
Path: /ccadmin/v1/logging/logInfoPostWithHeaders
Query the storefront server logs for client side errors.: Method: get
Path: /ccadmin/v1/logging

Admin/Media Tag

Endpoints related to the media tags associated with media items.

listMediaTags: Method: get
Path: /ccadmin/v1/mediaTags

Admin/Merchant Settings

Endpoints for merchant settings.

createScheduledJob: Method: post
Path: /ccadmin/v1/merchant/scheduledJobs
getAdminConfiguration: Method: get
Path: /ccadmin/v1/merchant/adminConfiguration
getAgentConfiguration: Method: get
Path: /ccadmin/v1/merchant/agentConfiguration
getAllowedUrls: Method: get
Path: /ccadmin/v1/merchant/allowedUrls
getASASettings: Method: get
Path: /ccadmin/v1/merchant/assistedSellingSettings
getBasicAuthConfiguration: Method: get
Path: /ccadmin/v1/merchant/basicAuth
getCloudConfiguration: Method: get
Path: /ccadmin/v1/merchant/cloudConfiguration
getCollectionEndpointsConfiguration: Method: get
Path: /ccadmin/v1/merchant/collectionEndpointsConfiguration
getDefaultLocale: Method: get
Path: /ccadmin/v1/merchant/defaultLocale
getDefaultPriceListGroup: Method: get
Path: /ccadmin/v1/merchant/defaultPriceListGroup
getDirectEditConfiguration: Method: get
Path: /ccadmin/v1/merchant/directEdit/{name}
getDirectEditConfigurations: Method: get
Path: /ccadmin/v1/merchant/directEdit/
getDirectPriceEditConfiguration: Method: get
Path: /ccadmin/v1/merchant/directPriceEdit
getExtendedRemorsePeriod: Method: get
Path: /ccadmin/v1/merchant/extendedRemorsePeriod
getExternalServiceData: Method: get
Path: /ccadmin/v1/merchant/{id}
getExternalServicesData: Method: get
Path: /ccadmin/v1/merchant
getFallbackShippingConfiguration: Method: get
Path: /ccadmin/v1/merchant/fallbackShippingConfiguration
getGateway: Method: get
Path: /ccadmin/v1/merchant/paymentGateways/{id}
getGateways: Method: get
Path: /ccadmin/v1/merchant/paymentGateways
getInventoryConfiguration: Method: get
Path: /ccadmin/v1/merchant/inventoryConfiguration
getMerchantTimezone: Method: get
Path: /ccadmin/v1/merchant/timezone
getPaymentTypes: Method: get
Path: /ccadmin/v1/merchant/paymentTypes
getPolicies: Method: get
Path: /ccadmin/v1/merchant/profilePolicies
getPriceListCurrency: Method: get
Path: /ccadmin/v1/merchant/priceListCurrency
getRemorsePeriod: Method: get
Path: /ccadmin/v1/merchant/remorsePeriod
getReportingCurrency: Method: get
Path: /ccadmin/v1/merchant/reportingCurrency
getResponseHeaders: Method: get
Path: /ccadmin/v1/merchant/responseHeaders
getRestrictedWords: Method: get
Path: /ccadmin/v1/merchant/profilePolicies/restrictedWords
getRevenueBilling: Method: get
Path: /ccadmin/v1/merchant/revenueBilling
getSamlSettings: Method: get
Path: /ccadmin/v1/merchant/samlSettings
getScheduledJob: Method: get
Path: /ccadmin/v1/merchant/scheduledJobs
getSeoConfig: Method: get
Path: /ccadmin/v1/merchant/seoConfig
getShopperProfileConfiguration: Method: get
Path: /ccadmin/v1/merchant/shopperProfileConfiguration
getStorefrontUrl: Method: get
Path: /ccadmin/v1/merchant/storefrontUrl
getTextSearchSettings: Method: get
Path: /ccadmin/v1/merchant/textSearch
getWhitelistUrls: Method: get
Path: /ccadmin/v1/merchant/whiteListUrls
getXssConfiguration: Method: get
Path: /ccadmin/v1/merchant/xssConfiguration
listSelectedBillingCountries: Method: get
Path: /ccadmin/v1/merchant/billingCountries
renewSamlCertificate: Method: post
Path: /ccadmin/v1/merchant/renewSamlCertificate
saveAdminConfiguration: Method: put
Path: /ccadmin/v1/merchant/adminConfiguration
saveAgentConfiguration: Method: put
Path: /ccadmin/v1/merchant/agentConfiguration
saveExtendedRemorsePeriod: Method: put
Path: /ccadmin/v1/merchant/extendedRemorsePeriod
saveItemPriceOverride: Method: put
Path: /ccadmin/v1/merchant/itemPriceOverride
savePolicies: Method: put
Path: /ccadmin/v1/merchant/profilePolicies
saveRemorsePeriod: Method: put
Path: /ccadmin/v1/merchant/remorsePeriod
saveTextSearchSettings: Method: put
Path: /ccadmin/v1/merchant/textSearch
supportedJobs: Method: get
Path: /ccadmin/v1/merchant/scheduledJobs/supportedJobs
updateAllowedUrls: Method: put
Path: /ccadmin/v1/merchant/allowedUrls
updateASASettings: Method: put
Path: /ccadmin/v1/merchant/assistedSellingSettings
updateBasicAuthConfiguration: Method: put
Path: /ccadmin/v1/merchant/basicAuth
updateClientConfiguration: Method: put
Path: /ccadmin/v1/merchant/clientConfiguration
updateCloudConfiguration: Method: put
Path: /ccadmin/v1/merchant/cloudConfiguration
updateCollectionEndpointsConfiguration: Method: put
Path: /ccadmin/v1/merchant/collectionEndpointsConfiguration
updateDefaultLocale: Method: put
Path: /ccadmin/v1/merchant/defaultLocale
updateDefaultPriceListGroup: Method: put
Path: /ccadmin/v1/merchant/defaultPriceListGroup
updateDirectEditConfiguration: Method: put
Path: /ccadmin/v1/merchant/directEdit/{name}
updateDirectPriceEditConfiguration: Method: put
Path: /ccadmin/v1/merchant/directPriceEdit
updateExternalServiceData: Method: put
Path: /ccadmin/v1/merchant/{id}
updateFallbackShippingConfiguration: Method: put
Path: /ccadmin/v1/merchant/fallbackShippingConfiguration
updateGateway: Method: put
Path: /ccadmin/v1/merchant/paymentGateways
updateInventoryConfiguration: Method: put
Path: /ccadmin/v1/merchant/inventoryConfiguration
updateMerchantTimezone: Method: put
Path: /ccadmin/v1/merchant/timezone
updatePaymentTypes: Method: put
Path: /ccadmin/v1/merchant/paymentTypes
updatePriceLocale: Method: put
Path: /ccadmin/v1/merchant/priceLocale
updateReportingCurrency: Method: put
Path: /ccadmin/v1/merchant/reportingCurrency
updateResponseHeaders: Method: put
Path: /ccadmin/v1/merchant/responseHeaders
updateRestrictedWords: Method: post
Path: /ccadmin/v1/merchant/profilePolicies/updateRestrictedWords
updateRobotsFile: Method: put
Path: /ccadmin/v1/merchant/robots
updateSamlSettings: Method: put
Path: /ccadmin/v1/merchant/samlSettings
updateScheduledJob: Method: put
Path: /ccadmin/v1/merchant/scheduledJobs
updateSelectedBillingCountries: Method: put
Path: /ccadmin/v1/merchant/billingCountries
updateSeoConfig: Method: put
Path: /ccadmin/v1/merchant/seoConfig
updateShopperProfileConfiguration: Method: put
Path: /ccadmin/v1/merchant/shopperProfileConfiguration
updateWhitelistUrls: Method: put
Path: /ccadmin/v1/merchant/whiteListUrls
updateXssConfiguration: Method: put
Path: /ccadmin/v1/merchant/xssConfiguration

Admin/Message Tags

The operations from the Admin/Message Tags category.

createMessageTag: Method: post
Path: /ccadmin/v1/messageTags
deleteMessageTag: Method: delete
Path: /ccadmin/v1/messageTags/{id}
getMessageTag: Method: get
Path: /ccadmin/v1/messageTags/{id}
getMessageTags: Method: get
Path: /ccadmin/v1/messageTags
updateMessageTag: Method: put
Path: /ccadmin/v1/messageTags/{id}

Admin/Metadata

Metadata endpoints

getMetadata: Method: get
Path: /ccadmin/v1/metadata/{id}
updateMetadata: Method: put
Path: /ccadmin/v1/metadata/{id}

Admin/Notification messages

Endpoints to list, read, update and delete notifications

deleteNotification: Method: delete
Path: /ccadmin/v1/notificationMessages/{id}
getMessages: Method: get
Path: /ccadmin/v1/notificationMessages
getNotification: Method: get
Path: /ccadmin/v1/notificationMessages/{id}
updateNotification: Method: put
Path: /ccadmin/v1/notificationMessages/{id}

Admin/Notification settings

Endpoints to read and update notification settings

getSettings: Method: get
Path: /ccadmin/v1/notificationSettings
updateSettings: Method: put
Path: /ccadmin/v1/notificationSettings

Admin/OAuth

OAuth endpoints

generateOAuthToken: Method: post
Path: /ccadmin/v1/token
getEndpointAPI: Method: get
Path: /ccadmin/v1/api/{id}
getEndpointAPIs: Method: get
Path: /ccadmin/v1/api
getRegistry: Method: get
Path: /ccadmin/v1/registry
login: Method: post
Path: /ccadmin/v1/login
logout: Method: post
Path: /ccadmin/v1/logout
mfalogin: Method: post
Path: /ccadmin/v1/mfalogin
refresh: Method: post
Path: /ccadmin/v1/refresh
verify: Method: post
Path: /ccadmin/v1/verify

Admin/OOTB SSE

Endpoints for the OOTB Server Side Extensions

listServerSideExtensions: Method: get
Path: /ccadmin/v1/sse

Admin/OpenID

The operations from the Admin/OpenID category.

get Admin OpenID IDP settings: Method: get
Path: /ccadmin/v1/openid/metadata/idpSettings
get OpenID authorization code request: Method: get
Path: /ccadmin/v1/openid/authzCodeRequest
get OpenID logout request: Method: get
Path: /ccadmin/v1/openid/logoutRequest
OpenID Single Sign On: Method: post
Path: /ccadmin/v1/openid/sso
update Admin OpenID IDP settings: Method: put
Path: /ccadmin/v1/openid/metadata/idpSettings

Admin/Order Types

Order Type endpoints

getOrderType: Method: get
Path: /ccadmin/v1/orderTypes/{id}
listOrderTypes: Method: get
Path: /ccadmin/v1/orderTypes
updateOrderType: Method: put
Path: /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: delete
Path: /ccadmin/v1/orders/{id}
deleteOrders: Method: post
Path: /ccadmin/v1/orders/delete
getOrder: Method: get
Path: /ccadmin/v1/orders/{id}
getOrders: Method: get
Path: /ccadmin/v1/orders
syncQuote: Method: put
Path: /ccadmin/v1/orders/syncQuote
updateOrder: Method: put
Path: /ccadmin/v1/orders/{id}
updateQuoteStatus: Method: put
Path: /ccadmin/v1/orders/updateQuoteStatus

Admin/Organization Request

End points for operations for account based commerce in Oracle Commerce Cloud

Approve organization request: Method: post
Path: /ccadmin/v1/organizationRequests/{id}/approve
deleteOrganizationRequest - only for application access: Method: delete
Path: /ccadmin/v1/organizationRequests/{id}
getOrganizationRequests: Method: get
Path: /ccadmin/v1/organizationRequests/{id}
listOrganizationRequests: Method: get
Path: /ccadmin/v1/organizationRequests
Reject organization request: Method: post
Path: /ccadmin/v1/organizationRequests/{id}/reject
updateOrganizationRequests: Method: put
Path: /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: post
Path: /ccadmin/v1/organizations/{id}/secondaryAddresses
createOrganization: Method: post
Path: /ccadmin/v1/organizations
delete an Address for an Organization: Method: delete
Path: /ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
generates the authorization code for an Organization: Method: post
Path: /ccadmin/v1/organizations/{id}/authorizationCode
get Address for an Organization: Method: get
Path: /ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
Get site based Organization properties: Method: get
Path: /ccadmin/v1/organizations/{id}/siteOrganizationProperties
getOrganization: Method: get
Path: /ccadmin/v1/organizations/{id}
listOrganizationRoles: Method: get
Path: /ccadmin/v1/organizations/{id}/organizationalRoles
listOrganizations: Method: get
Path: /ccadmin/v1/organizations
update address for an Organization: Method: put
Path: /ccadmin/v1/organizations/{id}/secondaryAddresses/{addressId}
update site based Organization properties: Method: post
Path: /ccadmin/v1/organizations/{id}/updateSiteOrganizationProperties
updateOrganization: Method: put
Path: /ccadmin/v1/organizations/{id}

Admin/Page Tags

The operations from the Admin/Page Tags category.

Create a body end page tag.: Method: post
Path: /ccadmin/v1/sites/{siteId}/bodyEndTags
Create a body start page tag.: Method: post
Path: /ccadmin/v1/sites/{siteId}/bodyStartTags
Create a head page tag.: Method: post
Path: /ccadmin/v1/sites/{siteId}/headTags
Delete a body end tag.: Method: delete
Path: /ccadmin/v1/sites/{siteId}/bodyEndTags/{tagId}
Delete a body start tag.: Method: delete
Path: /ccadmin/v1/sites/{siteId}/bodyStartTags/{tagId}
Delete a head tag.: Method: delete
Path: /ccadmin/v1/sites/{siteId}/headTags/{tagId}
Get a body end page tag.: Method: get
Path: /ccadmin/v1/sites/{siteId}/bodyEndTags/{tagId}
Get a body start page tag.: Method: get
Path: /ccadmin/v1/sites/{siteId}/bodyStartTags/{tagId}
Get a head page tag.: Method: get
Path: /ccadmin/v1/sites/{siteId}/headTags/{tagId}
List body end page tags.: Method: get
Path: /ccadmin/v1/sites/{siteId}/bodyEndTags
List body start page tags.: Method: get
Path: /ccadmin/v1/sites/{siteId}/bodyStartTags
List head page tags.: Method: get
Path: /ccadmin/v1/sites/{siteId}/headTags
Update a body end page tag.: Method: put
Path: /ccadmin/v1/sites/{siteId}/bodyEndTags/{tagId}
Update a body start page tag.: Method: put
Path: /ccadmin/v1/sites/{siteId}/bodyStartTags/{tagId}
Update a head page tag.: Method: put
Path: /ccadmin/v1/sites/{siteId}/headTags/{tagId}

Admin/PaymentGateways

Endpoints for Payment Gateway Operations.

addPaymentGateway: Method: post
Path: /ccadmin/v1/paymentGateways
getAllGateways: Method: get
Path: /ccadmin/v1/paymentGateways
getPaymentGateway: Method: get
Path: /ccadmin/v1/paymentGateways/{id}
updatePaymentGateway: Method: put
Path: /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: get
Path: /ccadmin/v1/places

Admin/PriceListGroup

Endpoints for operations on Price List Groups.

createPriceListGroup: Method: post
Path: /ccadmin/v1/priceListGroups
createPriceListGroupActivationRequest: Method: post
Path: /ccadmin/v1/priceListGroups/activationRequest
deletePriceListGroup: Method: delete
Path: /ccadmin/v1/priceListGroups/{id}
getPriceListGroup: Method: get
Path: /ccadmin/v1/priceListGroups/{id}
getPriceListGroupActivationSummary: Method: get
Path: /ccadmin/v1/priceListGroups/activationSummary/{token}
listPriceListGroups: Method: get
Path: /ccadmin/v1/priceListGroups
listPriceListGroupsWithPrices: Method: post
Path: /ccadmin/v1/priceListGroups/listWithPrices
updatePriceListGroup: Method: put
Path: /ccadmin/v1/priceListGroups/{id}

Admin/Prices

Prices endpoints

deletePrice: Method: delete
Path: /ccadmin/v1/prices/{id}
getPrice: Method: get
Path: /ccadmin/v1/prices/{id}
listPrices: Method: get
Path: /ccadmin/v1/prices
setPrice: Method: put
Path: /ccadmin/v1/prices/{id}
updatePrices: Method: put
Path: /ccadmin/v1/prices

Admin/Product Notify

Product Notification endpoints

addProductNotification: Method: post
Path: /ccadmin/v1/productnotify
deleteProductNotification: Method: delete
Path: /ccadmin/v1/productnotify/{id}
deleteProductNotificationByProfileIdOrEmail: Method: delete
Path: /ccadmin/v1/productnotify

Admin/Product Properties

Product Properties endpoints

createProductTypeSpecification: Method: post
Path: /ccadmin/v1/productProperties
updateProductTypeSpecification: Method: put
Path: /ccadmin/v1/productProperties/{id}

Admin/Product Types

Product Type endpoints

addShopperInput: Method: post
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs
createProductType: Method: post
Path: /ccadmin/v1/productTypes
deleteProductType: Method: delete
Path: /ccadmin/v1/productTypes/{id}
getProductType: Method: get
Path: /ccadmin/v1/productTypes/{id}
listProductTypes: Method: get
Path: /ccadmin/v1/productTypes
removeShopperInput: Method: delete
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs/{shopperInputId}
updateProductType: Method: put
Path: /ccadmin/v1/productTypes/{id}

Admin/Products

Product endpoints

createProduct: Method: post
Path: /ccadmin/v1/products
createProductAssignmentToCollections: Method: post
Path: /ccadmin/v1/products/{id}/addToCollections
deleteProduct: Method: delete
Path: /ccadmin/v1/products/{id}
getProduct: Method: get
Path: /ccadmin/v1/products/{id}
listProducts: Method: get
Path: /ccadmin/v1/products
updateProduct: Method: put
Path: /ccadmin/v1/products/{id}
updateProductMembership: Method: post
Path: /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: get
Path: /ccadmin/v1/profileContextLists/{id}
getProfileContextLists: Method: get
Path: /ccadmin/v1/profileContextLists
updateProfileContextList: Method: put
Path: /ccadmin/v1/profileContextLists/{id}

Admin/Profile Request

End points for operations for account based commerce in Oracle Commerce Cloud

Approve profile request: Method: post
Path: /ccadmin/v1/profileRequests/{id}/approve
deleteProfileRequest - only for application access: Method: delete
Path: /ccadmin/v1/profileRequests/{id}
getProfileRequest: Method: get
Path: /ccadmin/v1/profileRequests/{id}
listProfileRequests: Method: get
Path: /ccadmin/v1/profileRequests
Reject Profile request: Method: post
Path: /ccadmin/v1/profileRequests/{id}/reject
updateProfileRequest: Method: put
Path: /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: post
Path: /ccadmin/v1/profiles/{id}/addresses
appendSecondaryOrganizations: Method: post
Path: /ccadmin/v1/profiles/{id}/appendSecondaryOrganizations
batchGrantPromotions: Method: post
Path: /ccadmin/v1/profiles/batchGrantPromotions
createProfile: Method: post
Path: /ccadmin/v1/profiles
deleteProfileAddress: Method: delete
Path: /ccadmin/v1/profiles/{id}/addresses/{addressId}
getProfile: Method: get
Path: /ccadmin/v1/profiles/{id}
getProfileAddress: Method: get
Path: /ccadmin/v1/profiles/{id}/addresses/{addressId}
listProfileAddresses: Method: get
Path: /ccadmin/v1/profiles/{id}/addresses
listProfiles: Method: get
Path: /ccadmin/v1/profiles
removeSecondaryOrganizations: Method: post
Path: /ccadmin/v1/profiles/{id}/removeSecondaryOrganizations
replaceSecondaryOrganizations: Method: post
Path: /ccadmin/v1/profiles/{id}/replaceSecondaryOrganizations
resetPassword: Method: post
Path: /ccadmin/v1/profiles/resetPassword
updateParentOrganization: Method: post
Path: /ccadmin/v1/profiles/{id}/updateParentOrganization
updateProfile: Method: put
Path: /ccadmin/v1/profiles/{id}
updateProfileAddress: Method: put
Path: /ccadmin/v1/profiles/{id}/addresses/{addressId}
updateProfiles: Method: put
Path: /ccadmin/v1/profiles
updateUserRoles: Method: post
Path: /ccadmin/v1/profiles/{id}/updateUserRoles

Admin/Promotion Folders

Endpoints related to the creation and manipulation of promotion folders

createPromotionFolder: Method: post
Path: /ccadmin/v1/promotionFolders
deletePromotionFolder: Method: delete
Path: /ccadmin/v1/promotionFolders/{id}
getPromotionFolder: Method: get
Path: /ccadmin/v1/promotionFolders/{id}
listPromotionFolders: Method: get
Path: /ccadmin/v1/promotionFolders
updatePromotionFolder: Method: put
Path: /ccadmin/v1/promotionFolders/{id}

Admin/Promotion Templates

Endpoints related to getting information about promotion templates.

getPromotionTemplate: Method: get
Path: /ccadmin/v1/promotionTemplates/{id}
listPromotionTemplates: Method: get
Path: /ccadmin/v1/promotionTemplates

Admin/Promotions

Endpoints related to the creation and manipulation of promotions.

createPromotion: Method: post
Path: /ccadmin/v1/promotions
deletePromotion: Method: delete
Path: /ccadmin/v1/promotions/{id}
getPromotion: Method: get
Path: /ccadmin/v1/promotions/{id}
listPromotions: Method: get
Path: /ccadmin/v1/promotions
updatePromotion: Method: put
Path: /ccadmin/v1/promotions/{id}

Admin/Publishing

Endpoints for publishing

deleteScheduledPublish: Method: delete
Path: /ccadmin/v1/publish/schedules/{id}
getPublishChanges: Method: get
Path: /ccadmin/v1/publish/changes
getPublishSchedule: Method: get
Path: /ccadmin/v1/publish/schedules
getPublishStatus: Method: get
Path: /ccadmin/v1/publish
publish: Method: post
Path: /ccadmin/v1/publish
purgeSchedulePublish: Method: delete
Path: /ccadmin/v1/publish/schedules

Admin/Publishing Change Applications

Endpoints for publishing change applications

getAllPublishingChangeApplications: Method: get
Path: /ccadmin/v1/publishingChangeApplications

Admin/Publishing Change Authors

Endpoints for publishing change authors

getAllPublishingChangeAuthors: Method: get
Path: /ccadmin/v1/publishingChangeAuthors

Admin/Publishing Change Lists

Endpoints for publishing change lists.

assignPublishingChangeList: Method: post
Path: /ccadmin/v1/publishingChangeLists/assignPublishingChangeList
getPublishingDependencies: Method: get
Path: /ccadmin/v1/publishingChangeLists/{changeListId}
getPublishingWorksetDependencies: Method: get
Path: /ccadmin/v1/publishingChangeLists/worksets/{worksetId}
publishChangeLists: Method: post
Path: /ccadmin/v1/publishingChangeLists/publish
storePublishingChangeList: Method: post
Path: /ccadmin/v1/publishingChangeLists

Admin/Publishing Changes

Endpoint for publishing changes

getPublishingChanges: Method: get
Path: /ccadmin/v1/publishingChanges

Admin/Reasons

Reasons lookup endpoints

createReason: Method: post
Path: /ccadmin/v1/reasons
deleteReason: Method: delete
Path: /ccadmin/v1/reasons
getReasons: Method: get
Path: /ccadmin/v1/reasons
updateReason: Method: put
Path: /ccadmin/v1/reasons

Admin/Recommendations

The operations from the Admin/Recommendations category.

createRecommendationGlobalRule: Method: post
Path: /ccadmin/v1/recommendationGlobalRules
createRecommendationStrategy: Method: post
Path: /ccadmin/v1/recommendationStrategies
deleteRecommendationGlobalRule: Method: delete
Path: /ccadmin/v1/recommendationGlobalRules/{id}
deleteRecommendationStrategy: Method: delete
Path: /ccadmin/v1/recommendationStrategies/{id}
getRecommendationGlobalRule: Method: get
Path: /ccadmin/v1/recommendationGlobalRules/{id}
getRecommendationGlobalRuleConditions: Method: get
Path: /ccadmin/v1/recommendationGlobalRuleConditions
getRecommendationStrategy: Method: get
Path: /ccadmin/v1/recommendationStrategies/{id}
getRecommendationStrategyConditions: Method: get
Path: /ccadmin/v1/recommendationStrategyConditions
listRecommendationGlobalRules: Method: get
Path: /ccadmin/v1/recommendationGlobalRules
listRecommendationStrategies: Method: get
Path: /ccadmin/v1/recommendationStrategies
updateRecommendationGlobalRule: Method: put
Path: /ccadmin/v1/recommendationGlobalRules/{id}
updateRecommendationStrategy: Method: put
Path: /ccadmin/v1/recommendationStrategies/{id}

Admin/Redirects

Endpoints for managing redirection rules on the Oracle Commerce Cloud.

createRedirect: Method: post
Path: /ccadmin/v1/redirects
deleteRedirect: Method: delete
Path: /ccadmin/v1/redirects/{id}
getRedirects: Method: get
Path: /ccadmin/v1/redirects
updateRedirect: Method: put
Path: /ccadmin/v1/redirects/{id}

Admin/Register Admin

Endpoints to handle operations related to registering admin users.

registerAdmin: Method: post
Path: /ccadmin/v1/adminRegister
resend: Method: post
Path: /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: put
Path: /ccadmin/v1/reportCaches

Admin/Report Filter Configuration

Report Filter Configuration Endpoint

listReportFilterConfigurations: Method: get
Path: /ccadmin/v1/reportFilterConfigurations
saveReportFilterConfiguration: Method: post
Path: /ccadmin/v1/reportFilterConfigurations
updateReportFilterConfiguration: Method: put
Path: /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: get
Path: /ccadmin/v1/reports/export
getReportData: Method: post
Path: /ccadmin/v1/reports/{id}

Admin/Resources

Resource Admin endpoints

getResourceStrings: Method: get
Path: /ccadmin/v1/resources/{bundle}
updateCustomTranslations: Method: put
Path: /ccadmin/v1/resources/{bundle}

Admin/Response Filters

Endpoints to configure response filters

createFilter: Method: post
Path: /ccadmin/v1/responseFilters
deleteFilter: Method: delete
Path: /ccadmin/v1/responseFilters/{id}
getFilter: Method: get
Path: /ccadmin/v1/responseFilters/{id}
listFilters: Method: get
Path: /ccadmin/v1/responseFilters
updateFilter: Method: put
Path: /ccadmin/v1/responseFilters/{id}

Admin/Return Requests

The operations from the Admin/Return Requests category.

getReturnRequest: Method: get
Path: /ccadmin/v1/returnRequests/{id}
updateReturnRequest: Method: put
Path: /ccadmin/v1/returnRequests/{id}

Admin/Roles

Roles endpoints

createRole: Method: post
Path: /ccadmin/v1/roles
getRole: Method: get
Path: /ccadmin/v1/roles/{id}
listRoles: Method: get
Path: /ccadmin/v1/roles
updateRole: Method: put
Path: /ccadmin/v1/roles/{id}

Admin/SAML IdP Settings

Endpoints to read and update Identity Provider settings

getSamlIdPSettings: Method: get
Path: /ccadmin/v1/samlIdentityProviders/{id}
updateSamlIdPSettings: Method: put
Path: /ccadmin/v1/samlIdentityProviders/{id}

Admin/SKU Properties

SKU properties endpoints

createSkuProperty: Method: post
Path: /ccadmin/v1/skuProperties
getSkuProperties: Method: get
Path: /ccadmin/v1/skuProperties
getSkuProperty: Method: get
Path: /ccadmin/v1/skuProperties/{id}
reorderSkuProperties: Method: post
Path: /ccadmin/v1/skuProperties/reorder
updateSkuProperty: Method: put
Path: /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: post
Path: /gsadmin/v1/{appName}/{resourcePath}
Delete a resource configuration: Method: delete
Path: /gsadmin/v1/{appName}/{resourcePath}
Delete application configuration: Method: delete
Path: /gsadmin/v1/{appName}
Download application configuration: Method: get
Path: /gsadmin/v1/{appName}.zip
Download resource configuration: Method: get
Path: /gsadmin/v1/{appName}/{resourcePath}.zip
Import application configuration: Method: post
Path: /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: get
Path: /gsadmin/v1/{appName}/tasks/{taskId}
Start operation: Method: post
Path: /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: get
Path: /gsadmin/v1/{appName}/dimvals/{dimValKey}/children
View dimension value for {dimValKey}.: Method: get
Path: /gsadmin/v1/{appName}/dimvals/{dimValKey}
View list of Dimensions.: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
deleteFacetList: Method: delete
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
getFacetList: Method: get
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
listFacetLists: Method: get
Path: /gsadmin/v1/{appName}/content/facets
updateFacetList: Method: put
Path: /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: post
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Create index attributes: Method: post
Path: /gsadmin/v1/{appName}/attributes
Create owner attributes: Method: post
Path: /gsadmin/v1/{appName}/attributes/{owner}
Delete an index attribute: Method: delete
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Delete index Attributes: Method: delete
Path: /gsadmin/v1/{appName}/attributes
Delete owner index attributes: Method: delete
Path: /gsadmin/v1/{appName}/attributes/{owner}
Partial update an index attribute: Method: patch
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Partial update owner attributes: Method: patch
Path: /gsadmin/v1/{appName}/attributes/{owner}
Partially update index attributes: Method: patch
Path: /gsadmin/v1/{appName}/attributes
Update an index attribute: Method: put
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Update index attributes: Method: put
Path: /gsadmin/v1/{appName}/attributes
Update owner attributes: Method: put
Path: /gsadmin/v1/{appName}/attributes/{owner}
View index attribute: Method: get
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
View index attributes: Method: get
Path: /gsadmin/v1/{appName}/attributes
View owner attributes: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Create Keyword Redirect Group.: Method: post
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Create Keyword Redirects Configuration: Method: post
Path: /gsadmin/v1/{appName}/redirects
Delete Keyword Redirect Entry: Method: delete
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Delete Keyword Redirect Group: Method: delete
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Delete Keyword Redirects: Method: delete
Path: /gsadmin/v1/{appName}/redirects
Partial update Keyword Redirect Entry.: Method: patch
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Partial update Keyword Redirect Group.: Method: patch
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Partial update Keyword Redirects Configuration: Method: patch
Path: /gsadmin/v1/{appName}/redirects
Update an Keyword Redirect Entry.: Method: put
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Update Keyword Redirect Group.: Method: put
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Update Keyword Redirects configuration: Method: put
Path: /gsadmin/v1/{appName}/redirects
View Keyword Redirect Entry.: Method: get
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
View Keyword Redirect Group.: Method: get
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
View Keyword Redirects: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Creates a page root for a application: Method: post
Path: /gsadmin/v1/{appName}/pages
Creates a site for a application: Method: post
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Delete page root of a application: Method: delete
Path: /gsadmin/v1/{appName}/pages
Deletes the page.: Method: delete
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Deletes the site.: Method: delete
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Gets a list of immediate pages defined under site home: Method: get
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Gets a Page configuration or lists down immediate pages under requested page.: Method: get
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Updates a page configuration: Method: put
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
View all sites defined in a application: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/content/rankingRules/{Rule}
Deletes a Rule.: Method: delete
Path: /gsadmin/v1/{appName}/content/rankingRules/{Rule}
Retrieve a rule configuration.: Method: get
Path: /gsadmin/v1/{appName}/content/rankingRules/{Rule}
Updates a rule configuration.: Method: put
Path: /gsadmin/v1/{appName}/content/rankingRules/{Rule}
View a ranking Rule with expanded information.: Method: get
Path: /gsadmin/v1/{appName}/content/rankingRules/{Rule}.ccadminui.json
View list of ranking rules with expanded information.: Method: get
Path: /gsadmin/v1/{appName}/content/rankingRules.ccadminui.json
View list of ranking rules.: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Creates content collection folder at specified location.: Method: post
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}
Creates content node for a application: Method: post
Path: /gsadmin/v1/{appName}/content
Delete content node of a application: Method: delete
Path: /gsadmin/v1/{appName}/content
Deletes a content collection folder.: Method: delete
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}
Deletes a Rule.: Method: delete
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Updates a rule configuration.: Method: put
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View content collection folders under 'content' root node.: Method: get
Path: /gsadmin/v1/{appName}/content
View rule definition: Method: get
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View rules and content collection folders under specified content collection folder.: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/searchIndexConfig
Delete search index configuration: Method: delete
Path: /gsadmin/v1/{appName}/searchIndexConfig
Partial update search index configuration: Method: patch
Path: /gsadmin/v1/{appName}/searchIndexConfig
Update search index configuration: Method: put
Path: /gsadmin/v1/{appName}/searchIndexConfig
View search index configuration: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Create a search interface folder: Method: post
Path: /gsadmin/v1/{appName}/searchInterfaces
Delete a search interface: Method: delete
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Delete a search interface folder: Method: delete
Path: /gsadmin/v1/{appName}/searchInterfaces
Partial update a search interface: Method: patch
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Partial update a search interface folder: Method: patch
Path: /gsadmin/v1/{appName}/searchInterfaces
Update a search interface: Method: put
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Update a search interface folder: Method: put
Path: /gsadmin/v1/{appName}/searchInterfaces
View a search interface: Method: get
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
View a search interface folder: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/configuration/services/{serviceName}
Get Service Configuration: Method: get
Path: /gsadmin/v1/{appName}/configuration/services/{serviceName}
Updates Service configuration: Method: put
Path: /gsadmin/v1/{appName}/configuration/services/{serviceName}
View list of all configuration blocks: Method: get
Path: /gsadmin/v1/{appName}/configuration
View list of all service configurations: Method: get
Path: /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: post
Path: /gsadmin/v1/{appName}/thesaurus
Create thesaurus entry: Method: post
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Delete thesaurus: Method: delete
Path: /gsadmin/v1/{appName}/thesaurus
Delete thesaurus entry: Method: delete
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Partial update thesaurus: Method: patch
Path: /gsadmin/v1/{appName}/thesaurus
Partial update thesaurus entry: Method: patch
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Update thesaurus: Method: put
Path: /gsadmin/v1/{appName}/thesaurus
Update thesaurus entry: Method: put
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
View thesaurus: Method: get
Path: /gsadmin/v1/{appName}/thesaurus
View thesaurus entry: Method: get
Path: /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: delete
Path: /gsdata/v1/{appName}/facets/{recordCollection}
Delete record collection: Method: delete
Path: /gsdata/v1/{appName}/data/{recordCollection}

Admin/Search Data and Indexing/Indexing

Search Administration endpoints

getSearchIndexingStatus: Method: get
Path: /ccadmin/v1/search/index
getSearchPartialSchedule: Method: get
Path: /ccadmin/v1/search/partialSchedule
getSearchSchedule: Method: get
Path: /ccadmin/v1/search/schedule
requestIndex: Method: post
Path: /ccadmin/v1/search/index
setSearchPartialSchedule: Method: put
Path: /ccadmin/v1/search/partialSchedule
setSearchSchedule: Method: put
Path: /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: post
Path: /gsdata/v1/{appName}/facets/{recordCollection}
Insert record/records into record collection: Method: post
Path: /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: get
Path: /gsdata/v1/{appName}/data/{recordCollection}
View facet value record collection records: Method: get
Path: /gsdata/v1/{appName}/facets/{recordCollection}
View individual data records: Method: get
Path: /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: get
Path: /gsdata/v1/{appName}
View data record collections: Method: get
Path: /gsdata/v1/{appName}/data
View facet value collections: Method: get
Path: /gsdata/v1/{appName}/facets

Admin/Server Extensions

Server Extensions Endpoints.

doDeleteSSEFile: Method: delete
Path: /ccadmin/v1/serverExtensions/{id:.*}
doDeleteSSEFiles: Method: post
Path: /ccadmin/v1/serverExtensions/deleteFiles
doSSEFileUploadMultipart: Method: post
Path: /ccadmin/v1/serverExtensions
listSSEFiles: Method: get
Path: /ccadmin/v1/serverExtensions

Admin/Shipping Methods

Endpoints for operations on shipping methods.

createShippingMethod: Method: post
Path: /ccadmin/v1/shippingMethods
deleteShippingMethod: Method: delete
Path: /ccadmin/v1/shippingMethods/{id}
getShippingMethod: Method: get
Path: /ccadmin/v1/shippingMethods/{id}
listShippingMethods: Method: get
Path: /ccadmin/v1/shippingMethods
updateShippingMethod: Method: put
Path: /ccadmin/v1/shippingMethods/{id}

Admin/Shipping Regions

Shipping Regions Endpoints.

createShippingRegion: Method: post
Path: /ccadmin/v1/shippingRegions
deleteShippingRegion: Method: delete
Path: /ccadmin/v1/shippingRegions/{id}
getShippingRegion: Method: get
Path: /ccadmin/v1/shippingRegions/{id}
listShippingRegions: Method: get
Path: /ccadmin/v1/shippingRegions
updateShippingRegion: Method: put
Path: /ccadmin/v1/shippingRegions/{id}

Admin/Shopper Input

Shopper Input endpoints

addShopperInput: Method: post
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs
createShopperInput: Method: post
Path: /ccadmin/v1/shopperInputs
deleteShopperInput: Method: delete
Path: /ccadmin/v1/shopperInputs/{id}
getShopperInput: Method: get
Path: /ccadmin/v1/shopperInputs/{id}
removeShopperInput: Method: delete
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs/{shopperInputId}
updateShopperInput: Method: put
Path: /ccadmin/v1/shopperInputs/{id}

Admin/Shopper Types

Shopper Type endpoints

getShopperType: Method: get
Path: /ccadmin/v1/shopperTypes/{id}
listShopperTypes: Method: get
Path: /ccadmin/v1/shopperTypes
updateShopperType: Method: put
Path: /ccadmin/v1/shopperTypes/{id}

Admin/Site Create Forms

Site Create Forms endpoints. Create a site using a specified site as a template.

createSiteFromForm: Method: post
Path: /ccadmin/v1/siteCreateForms/{id}

Admin/SiteGroups

The operations from the Admin/SiteGroups category.

createSiteGroup: Method: post
Path: /ccadmin/v1/siteGroups
deleteSiteGroup: Method: delete
Path: /ccadmin/v1/siteGroups/{id}
getSiteGroup: Method: get
Path: /ccadmin/v1/siteGroups/{id}
getSiteGroups: Method: get
Path: /ccadmin/v1/siteGroups
updateSiteGroup: Method: put
Path: /ccadmin/v1/siteGroups/{id}

Admin/Sites

Site endpoints

createSite: Method: post
Path: /ccadmin/v1/sites
deleteSite: Method: delete
Path: /ccadmin/v1/sites/{id}
getSite: Method: get
Path: /ccadmin/v1/sites/{id}
getSites: Method: get
Path: /ccadmin/v1/sites
updateSite: Method: put
Path: /ccadmin/v1/sites/{id}

Admin/Sites Settings

Site Settings endpoints

getCustomSiteSettings: Method: get
Path: /ccadmin/v1/sitesettings/{id}
listSiteSettings: Method: get
Path: /ccadmin/v1/sitesettings
setSiteSettingConfigData: Method: put
Path: /ccadmin/v1/sitesettings/{id}

Admin/Skus

SKU endpoints

createSku: Method: post
Path: /ccadmin/v1/skus
createSkus: Method: put
Path: /ccadmin/v1/skus
deleteSku: Method: delete
Path: /ccadmin/v1/skus/{id}
deleteSkus: Method: delete
Path: /ccadmin/v1/skus
getSku: Method: get
Path: /ccadmin/v1/skus/{id}
listSkus: Method: get
Path: /ccadmin/v1/skus
updateSku: Method: put
Path: /ccadmin/v1/skus/{id}

Admin/Slot Descriptors

Slot Descriptor Admin Endpoints, used to view and transform information regarding Slot Descriptor on an Oracle Commerce Cloud instance.

See Customize slots for more information on slots.

Retrieve all slot descriptors: Method: get
Path: /ccadmin/v1/slotDescriptors
Retrieve config definition for a slot descriptor: Method: get
Path: /ccadmin/v1/slotDescriptors/{id}/config
Update hidden slot descriptors: Method: put
Path: /ccadmin/v1/slotDescriptors/hidden

Admin/Slots

slot endpoints

getSlot: Method: get
Path: /ccadmin/v1/slots/{id}
updateSlot: Method: put
Path: /ccadmin/v1/slots/{id}

Admin/Stack Descriptor

atg.cloud.rest.endpoints.StackDescriptorAdminEndpoints description

getAllStackDescriptorsByPageType: Method: get
Path: /ccadmin/v1/stackDescriptors/pageType/{id}
getConfigDefinitionForStackDescriptor: Method: get
Path: /ccadmin/v1/stackDescriptors/{id}/config
updateHiddenStackTypes: Method: put
Path: /ccadmin/v1/stackDescriptors/hidden

Admin/StackingRules

Endpoints related to the creation and manipulation of stacking rules.

createStackingRule: Method: post
Path: /ccadmin/v1/stackingRules
deleteStackingRule: Method: delete
Path: /ccadmin/v1/stackingRules/{id}
getStackingRule: Method: get
Path: /ccadmin/v1/stackingRules/{id}
listStackingRules: Method: get
Path: /ccadmin/v1/stackingRules
updateStackingRule: Method: put
Path: /ccadmin/v1/stackingRules/{id}

Admin/Stacks

stack endpoints

getStack: Method: get
Path: /ccadmin/v1/stacks/{id}
getStackLess: Method: get
Path: /ccadmin/v1/stacks/{id}/less
getStackLessVars: Method: get
Path: /ccadmin/v1/stacks/{id}/lessvars
getStackSourceCode: Method: get
Path: /ccadmin/v1/stacks/{id}/code
listStacks: Method: get
Path: /ccadmin/v1/stacks
updateStack: Method: put
Path: /ccadmin/v1/stacks/{id}
updateStackLess: Method: put
Path: /ccadmin/v1/stacks/{id}/less
updateStackLessVars: Method: put
Path: /ccadmin/v1/stacks/{id}/lessvars
updateStackSourceCode: Method: put
Path: /ccadmin/v1/stacks/{id}/code

Admin/Tax Processor Manager

Endpoints for CRUD operations on tax processors

createTaxProcessor: Method: post
Path: /ccadmin/v1/taxProcessors
deleteTaxProcessor: Method: delete
Path: /ccadmin/v1/taxProcessors/{id}
getTaxProcessor: Method: get
Path: /ccadmin/v1/taxProcessors/{id}
listTaxProcessors: Method: get
Path: /ccadmin/v1/taxProcessors
updateTaxProcessor: Method: put
Path: /ccadmin/v1/taxProcessors/{id}

Admin/Tenant

for Tenant Service Data

getTenantServiceData: Method: get
Path: /ccadmin/v1/tenants/{id}

Admin/Themes

Theme Endpoints. See Customize Your Store's Design Theme for more information on themes.

Clone a theme by ID: Method: post
Path: /ccadmin/v1/themes/{id}/clone
Compile Agent Theme.: Method: post
Path: /ccadmin/v1/themes/compileAgentTheme
Compile theme for asset.: Method: post
Path: /ccadmin/v1/themes/compile
Compile theme.: Method: post
Path: /ccadmin/v1/themes/{id}/compile
Compiles a Block of Less Code.: Method: post
Path: /ccadmin/v1/themes/compileLess
Deletes a theme by its ID: Method: delete
Path: /ccadmin/v1/themes/{id}
Link an image to a theme section.: Method: post
Path: /ccadmin/v1/themes/themeImagePath
Parse theme.: Method: get
Path: /ccadmin/v1/themes/parse
Recompile active theme.: Method: post
Path: /ccadmin/v1/themes/recompileActive
Restore a theme's source by ID: Method: put
Path: /ccadmin/v1/themes/{id}/restoreSource
Retrieve a theme by ID: Method: get
Path: /ccadmin/v1/themes/{id}
Retrieve a theme's source by ID: Method: get
Path: /ccadmin/v1/themes/{id}/source
Retrieve an active theme: Method: get
Path: /ccadmin/v1/themes/active
Retrieve the Agent theme source: Method: get
Path: /ccadmin/v1/themes/agentThemeSource
Retrieve the compilation settings for themes: Method: get
Path: /ccadmin/v1/themes/compilationSettings
Retrieve themes: Method: get
Path: /ccadmin/v1/themes
Retrieves the Agent theme: Method: get
Path: /ccadmin/v1/themes/agentThemeDetails
Set theme as the active agent theme.: Method: post
Path: /ccadmin/v1/themes/{id}/setAsAgentTheme
Sets a particular these as active.: Method: post
Path: /ccadmin/v1/themes/{id}/active
Update a theme by its ID: Method: put
Path: /ccadmin/v1/themes/{id}/
Update a theme image: Method: put
Path: /ccadmin/v1/themes/{id}/image
Update a theme's source by its ID: Method: put
Path: /ccadmin/v1/themes/{id}/source
Update the Agent theme: Method: put
Path: /ccadmin/v1/themes/agentThemeDetails
Update the Agent theme source: Method: put
Path: /ccadmin/v1/themes/agentThemeSource
Update the compilation settings for themes: Method: put
Path: /ccadmin/v1/themes/compilationSettings

Admin/Timezone

Endpoints for operations on timezones.

getTimezone: Method: get
Path: /ccadmin/v1/timezones/{id}
listTimezones: Method: get
Path: /ccadmin/v1/timezones

Admin/Token Cache

Endpoints for caching token.

cacheToken: Method: post
Path: /ccadmin/v1/tokenCache
deleteToken: Method: delete
Path: /ccadmin/v1/tokenCache/{id}
getToken: Method: get
Path: /ccadmin/v1/tokenCache/{id}
updateToken: Method: put
Path: /ccadmin/v1/tokenCache/{id}

Admin/UI Events

The operations from the Admin/UI Events category.

logUIEvent: Method: post
Path: /ccadmin/v1/uiEvents/logUIEvent

Admin/URL Patterns

Endpoints for operations on URL patterns.

destroyURLSlugMap: Method: delete
Path: /ccadmin/v1/urlPatterns/destroy
generateURLSlugMap: Method: put
Path: /ccadmin/v1/urlPatterns/{id}/generate
getURLPatternsLastModified: Method: get
Path: /ccadmin/v1/urlPatterns/lastModified
listURLPatterns: Method: get
Path: /ccadmin/v1/urlPatterns
updateURLPattern: Method: put
Path: /ccadmin/v1/urlPatterns/{id}
validateURLSlugMap: Method: get
Path: /ccadmin/v1/urlPatterns/{id}/validate

Admin/Variants

Variant endpoints

createProductTypeVariant: Method: post
Path: /ccadmin/v1/productVariants
deleteProductTypeVariant: Method: delete
Path: /ccadmin/v1/productVariants/{id}
getProductTypeVariant: Method: get
Path: /ccadmin/v1/productVariants/{id}
listProductTypeVariants: Method: get
Path: /ccadmin/v1/productVariants
updateProductTypeVariant: Method: put
Path: /ccadmin/v1/productVariants/{id}

Admin/Widgets

Widget instance endpoints.

deleteWidgetInstance: Method: delete
Path: /ccadmin/v1/widgets/{id}

Admin/Worksets

Endpoints for CRUD operations on worksets.

createWorkset: Method: post
Path: /ccadmin/v1/worksets
deleteWorkset: Method: delete
Path: /ccadmin/v1/worksets/{id}
getWorkset: Method: get
Path: /ccadmin/v1/worksets/{id}
listWorksets: Method: get
Path: /ccadmin/v1/worksets
updateWorkset: Method: put
Path: /ccadmin/v1/worksets/{id}

Admin/widgetDescriptors

Widget descriptors endpoints

getAllWidgetDescriptors: Method: get
Path: /ccadmin/v1/widgetDescriptors
getAllWidgetDescriptorsByPageType: Method: get
Path: /ccadmin/v1/widgetDescriptors/pageType/{id}
getAllWidgetInstances: Method: get
Path: /ccadmin/v1/widgetDescriptors/instances
getConfigDefinitionForWidgetDescriptor: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/config
getConfigLocaleContentForWidgetDescriptor: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}
getConfigMetadataForWidgetDescriptor: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata/config
getFragmentMetadata: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/element/{tag}/metadata
getInstancesForWidgetDescriptor: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/instances
getSchemaForWidgetDescriptor: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/schema
getWidgetDescriptorBaseLess: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/less
getWidgetDescriptorBaseLocaleContent: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/locale/{locale}
getWidgetDescriptorBaseTemplate: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/code
getWidgetDescriptorById: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}
getWidgetDescriptorJavascriptInfoById: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/javascript
getWidgetDescriptorMetadata: Method: get
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata
updateConfigLocaleContentForWidgetDescriptor: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata/config/locale/{locale}
updateConfigMetadataForWidgetDescriptor: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata/config
updateFragmentJavaScript: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/element/{tag}/javascript
updateFragmentMetadata: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/element/{tag}/metadata
updateFragmentTemplate: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/element/{tag}/template
updateHiddenWidgetTypes: Method: put
Path: /ccadmin/v1/widgetDescriptors/hidden
updateWidgetDescriptorBaseLess: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/less
updateWidgetDescriptorBaseLocaleContent: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/locale/{locale}
updateWidgetDescriptorBaseTemplate: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/code
updateWidgetDescriptorJavascript: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/javascript/{filename}
updateWidgetDescriptorMetadata: Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/metadata
updateWidgetDescriptorSites: Method: post
Path: /ccadmin/v1/widgetDescriptors/{id}/updateSiteAssociations

Agent/Agent Comments

Agent Comments endpoints

createComment: Method: post
Path: /ccagent/v1/comments
getComments: Method: get
Path: /ccagent/v1/comments

Agent/Agent Metadata Catalog

Metadata Catalog Agent Endpoints

getMetadataCatalog: Method: get
Path: /ccagent/v1/metadata-catalog
getResourceMetadata: Method: get
Path: /ccagent/v1/metadata-catalog/{id}

Agent/Agent SAML AuthnRequest

The operations from the Agent/Agent SAML AuthnRequest category.

get SAML AuthnRequest: Method: get
Path: /ccagent/v1/saml/authnRequest

Agent/Agent SAML LogoutRequest

The operations from the Agent/Agent SAML LogoutRequest category.

get SAML LogoutRequest: Method: get
Path: /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: get
Path: /ccagent/v1/saml/metadata/spEntityDescriptor
get Service Provider Signing Certificate: Method: get
Path: /ccagent/v1/saml/metadata/spCertificate

Agent/Agent Single Log out

The operations from the Agent/Agent Single Log out category.

single log out: Method: post
Path: /ccagent/v1/saml/slo

Agent/Agent Single Sign On

The operations from the Agent/Agent Single Sign On category.

single sign on: Method: post
Path: /ccagent/v1/saml/sso

Agent/Appeasement

The operations from the Agent/Appeasement category.

createAppeasement: Method: post
Path: /ccagent/v1/appeasements
deleteAppeasement: Method: delete
Path: /ccagent/v1/appeasements/{id}
getAppeasement: Method: get
Path: /ccagent/v1/appeasements/{id}
initiateAppeasement: Method: post
Path: /ccagent/v1/appeasements/initiate
listAppeasements: Method: get
Path: /ccagent/v1/appeasements
submitAppeasement: Method: post
Path: /ccagent/v1/appeasements/submit
updateAppeasement: Method: put
Path: /ccagent/v1/appeasements/{id}

Agent/AppeasementTypes

Appeasement Types Agent endpoints

getType: Method: get
Path: /ccagent/v1/appeasementTypes/{id}
listTypes: Method: get
Path: /ccagent/v1/appeasementTypes

Agent/Collections

Collections endpoints

getCollection: Method: get
Path: /ccagent/v1/collections/{id}
listCollections: Method: get
Path: /ccagent/v1/collections

Agent/Currency

Endpoints for operations on currencies.

getCurrency: Method: get
Path: /ccagent/v1/currencies/{id}
listCurrencies: Method: get
Path: /ccagent/v1/currencies

Agent/Customers

Agent Endpoints for Customers

addCreditCard: Method: post
Path: /ccagent/v1/profiles/{id}/creditCards
addProfileAddress: Method: post
Path: /ccagent/v1/profiles/{id}/addresses
createProfile: Method: post
Path: /ccagent/v1/profiles
deleteMultipleProfiles: Method: post
Path: /ccagent/v1/profiles/delete
deleteProfile: Method: delete
Path: /ccagent/v1/profiles/{id}
deleteProfileAddress: Method: delete
Path: /ccagent/v1/profiles/{id}/addresses/{addressId}
deleteProfiles: Method: delete
Path: /ccagent/v1/profiles
getCreditCard: Method: get
Path: /ccagent/v1/profiles/{id}/creditCards/{cardId}
getProfile: Method: get
Path: /ccagent/v1/profiles/{id}
getProfileAddress: Method: get
Path: /ccagent/v1/profiles/{id}/addresses/{addressId}
listCreditCards: Method: get
Path: /ccagent/v1/profiles/{id}/creditCards
listProfileAddresses: Method: get
Path: /ccagent/v1/profiles/{id}/addresses
listSiteProperties: Method: get
Path: /ccagent/v1/profiles/{id}/siteProperties
removeCreditCard: Method: delete
Path: /ccagent/v1/profiles/{id}/creditCards/{cardId}
resetPassword: Method: post
Path: /ccagent/v1/profiles/{id}
searchProfiles: Method: get
Path: /ccagent/v1/profiles
updateCreditCard: Method: put
Path: /ccagent/v1/profiles/{id}/creditCards/{cardId}
updateProfile: Method: put
Path: /ccagent/v1/profiles/{id}
updateProfileAddress: Method: put
Path: /ccagent/v1/profiles/{id}/addresses/{addressId}
updateSiteProperties: Method: put
Path: /ccagent/v1/profiles/{id}/siteProperties

Agent/Exchange Order

Exchange Order endpoints

createExchangeRequest: Method: post
Path: /ccagent/v1/exchanges

Agent/Files

File endpoints

doFileSegmentUpload: Method: post
Path: /ccagent/v1/files/{id}
getFile: Method: get
Path: /ccagent/v1/files/{id}
startFileUpload: Method: put
Path: /ccagent/v1/files

Agent/Internal Profiles

The operations from the Agent/Internal Profiles category.

getCurrentAdminProfile: Method: get
Path: /ccagent/v1/adminProfiles/current
requestPasswordReset: Method: post
Path: /ccagent/v1/adminProfiles/requestPasswordReset
sendPasswordReset: Method: post
Path: /ccagent/v1/adminProfiles/sendPasswordReset

Agent/Item Types

Item Type endpoints to get item type and base type details

getItemType: Method: get
Path: /ccagent/v1/itemTypes/{id}
listItemTypes: Method: get
Path: /ccagent/v1/itemTypes

Agent/List Country Region

Endpoints for read operations on configured shippingCountry and its region/provinces for Agent Application

listShippingCountries: Method: get
Path: /ccagent/v1/validShippingCountries

Agent/Locations

Endpoints to support operations related to locations.

getLocation: Method: get
Path: /ccagent/v1/locations/{id}
listLocations: Method: get
Path: /ccagent/v1/locations

Agent/Merchant Settings

Endpoints for merchant settings corresponding to Agent.

getAgentConfiguration: Method: get
Path: /ccagent/v1/merchant/agentConfiguration
getCloudConfiguration: Method: get
Path: /ccagent/v1/merchant/cloudConfiguration
getConfigurationSettings: Method: get
Path: /ccagent/v1/merchant/configurationSettings
getDispositionReasons: Method: get
Path: /ccagent/v1/merchant/dispositionReasons
getOrderStates: Method: get
Path: /ccagent/v1/merchant/orderStates
getPaymentTypes: Method: get
Path: /ccagent/v1/merchant/paymentTypes
getPriceOverrideReasons: Method: get
Path: /ccagent/v1/merchant/priceOverrideReasons
getReturnReasons: Method: get
Path: /ccagent/v1/merchant/orderReturnReasons
getReturnStates: Method: get
Path: /ccagent/v1/merchant/returnStates
listAllPaymentGateways: Method: get
Path: /ccagent/v1/merchant/paymentGateways
listCancelReasons: Method: get
Path: /ccagent/v1/merchant/orderCancelReasons
listSelectedBillingCountries: Method: get
Path: /ccagent/v1/merchant/billingCountries

Agent/Metadata

Metadata endpoints

getMetadata: Method: get
Path: /ccagent/v1/metadata/{id}

Agent/OAuth

OAuth Endpoints

getEndpointAPI: Method: get
Path: /ccagent/v1/api/{id}
getEndpointAPIs: Method: get
Path: /ccagent/v1/api
getRegistry: Method: get
Path: /ccagent/v1/registry
getSSOConfiguration: Method: get
Path: /ccagent/v1/ssoConfiguration
login: Method: post
Path: /ccagent/v1/login
logout: Method: post
Path: /ccagent/v1/logout
mfalogin: Method: post
Path: /ccagent/v1/mfalogin
onBehalfOf: Method: post
Path: /ccagent/v1/onBehalfOf
refresh: Method: post
Path: /ccagent/v1/refresh
verify: Method: post
Path: /ccagent/v1/verify

Agent/OpenID

The operations from the Agent/OpenID category.

get OpenID authorization code request: Method: get
Path: /ccagent/v1/openid/authzCodeRequest
get OpenID logout request: Method: get
Path: /ccagent/v1/openid/logoutRequest
OpenID Single Sign On: Method: post
Path: /ccagent/v1/openid/sso

Agent/Order Amendment

Order Amendment endpoints

handleOrderAmendment: Method: post
Path: /ccagent/v1/orderAmendments/{orderId}
removeOrderAmendment: Method: delete
Path: /ccagent/v1/orderAmendments/{orderId}
submitOrderAmendment: Method: put
Path: /ccagent/v1/orderAmendments/{orderId}

Agent/Order Types

Order Type endpoints

getOrderType: Method: get
Path: /ccagent/v1/orderTypes/{id}
listOrderTypes: Method: get
Path: /ccagent/v1/orderTypes

Agent/Orders

Order endpoints

approveOrder: Method: post
Path: /ccagent/v1/orders/approve
checkRequiresApproval: Method: post
Path: /ccagent/v1/orders/checkRequiresApproval
copyOrder: Method: post
Path: /ccagent/v1/orders/copyOrder
createOrder: Method: post
Path: /ccagent/v1/orders
getGiftWithPurchaseChoices: Method: get
Path: /ccagent/v1/orders/getGiftWithPurchaseChoices
getOrder: Method: get
Path: /ccagent/v1/orders/{id}
getUpsellMessages: Method: get
Path: /ccagent/v1/orders/getUpsellMessages
handleOrderActions: Method: post
Path: /ccagent/v1/orders/{id}
initiateCancelOrder: Method: post
Path: /ccagent/v1/orders/initiateCancelOrder
pickupItems: Method: post
Path: /ccagent/v1/orders/{id}/shippingGroups/{sgId}/pickupItems
redactOrder: Method: post
Path: /ccagent/v1/orders/{id}/redact
redactOrders: Method: post
Path: /ccagent/v1/orders/redact
rejectOrder: Method: post
Path: /ccagent/v1/orders/reject
rejectQuote: Method: post
Path: /ccagent/v1/orders/quote/reject
removeIncompleteOrderForProfile: Method: delete
Path: /ccagent/v1/orders
repriceOrder: Method: post
Path: /ccagent/v1/orders/reprice
requestQuote: Method: post
Path: /ccagent/v1/orders/quote
searchOrders: Method: get
Path: /ccagent/v1/orders
submitCancelOrder: Method: put
Path: /ccagent/v1/orders/submitCancelOrder
updateOrder: Method: put
Path: /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: post
Path: /ccagent/v1/organizationMembers
getMember: Method: get
Path: /ccagent/v1/organizationMembers/{id}
listMembers: Method: get
Path: /ccagent/v1/organizationMembers
updateMember: Method: put
Path: /ccagent/v1/organizationMembers/{id}

Agent/Organization Request

End points for operations for account based commerce in Oracle Commerce Cloud

getOrganizationRequests: Method: get
Path: /ccagent/v1/organizationRequests/{id}
listOrganizationRequests: Method: get
Path: /ccagent/v1/organizationRequests

Agent/Organizations

End points for operations for account-based commerce in Oracle Commerce Cloud

getOrganization: Method: get
Path: /ccagent/v1/organizations/{id}
listOrganizations: Method: get
Path: /ccagent/v1/organizations
removeContacts: Method: post
Path: /ccagent/v1/organizations/removeContacts
updateOrganization: Method: put
Path: /ccagent/v1/organizations/{id}

Agent/Organizations Address List

End points for operations for paginated list of addresses.

listAddresses: Method: get
Path: /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: post
Path: /ccagent/v1/organizationAddresses
deleteAddress: Method: delete
Path: /ccagent/v1/organizationAddresses/{id}
getAddress: Method: get
Path: /ccagent/v1/organizationAddresses/{id}
getAddresses: Method: get
Path: /ccagent/v1/organizationAddresses
updateAddress: Method: put
Path: /ccagent/v1/organizationAddresses/{id}

Agent/Pages

Page endpoints

getLayout: Method: get
Path: /ccagent/v1/pages/layout/{path: .*}
getPage: Method: get
Path: /ccagent/v1/pages/{path: .*}

Agent/Payment

Payment endpoints.

addPayments: Method: post
Path: /ccagent/v1/payment
authPayment: Method: post
Path: /ccagent/v1/payment/auth
calculateRemainingBalance: Method: post
Path: /ccagent/v1/payment/calculateRemainingBalance
updatePaymentGroupFromCyberSourceResponse: Method: post
Path: /ccagent/v1/payment/responses
voidPayments: Method: post
Path: /ccagent/v1/payment/void

Agent/Payment Groups

Payment Group endpoints

getPaymentGroup: Method: get
Path: /ccagent/v1/paymentGroups/{id}

Agent/PriceListGroup

Endpoints for operations on PriceListGroups.

getPriceListGroup: Method: get
Path: /ccagent/v1/priceListGroups/{id}
getPriceListGroupActivationSummary: Method: get
Path: /ccagent/v1/priceListGroups/activationSummary/{token}
listPriceListGroups: Method: get
Path: /ccagent/v1/priceListGroups

Agent/Prices

Prices endpoints

getAllPrices: Method: get
Path: /ccagent/v1/prices/{id}

Agent/Privacy

The operations from the Agent/Privacy category.

createClickstreamRequest: Method: post
Path: /ccagent/v1/personalDataReports/requests
getClickstreamRequest: Method: get
Path: /ccagent/v1/personalDataReports/requests/{id}
listClickstreamRequests: Method: get
Path: /ccagent/v1/personalDataReports/requests

Agent/Product Variants

Product Variants endpoints

listProductVariants: Method: get
Path: /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: get
Path: /ccagent/v1/products/{id}
listProducts: Method: get
Path: /ccagent/v1/products

Agent/Profile Request

End points for operations for account based commerce in Oracle Commerce Cloud

Approve profile request: Method: post
Path: /ccagent/v1/profileRequests/{id}/approve
getProfileRequest: Method: get
Path: /ccagent/v1/profileRequests/{id}
listProfileRequests: Method: get
Path: /ccagent/v1/profileRequests
Reject profile request: Method: post
Path: /ccagent/v1/profileRequests/{id}/reject
updateProfileRequest: Method: put
Path: /ccagent/v1/profileRequests/{id}

Agent/PurchaseLists

End points for operations on Purchase List in Oracle Commerce Cloud

createPurchaseList: Method: post
Path: /ccagent/v1/purchaseLists
deletePurchaseList: Method: delete
Path: /ccagent/v1/purchaseLists/{id}
getPurchaseList: Method: get
Path: /ccagent/v1/purchaseLists/{id}
listPurchaseLists: Method: get
Path: /ccagent/v1/purchaseLists
updateItems: Method: post
Path: /ccagent/v1/purchaseLists/{id}/updateItems
updatePurchaseList: Method: put
Path: /ccagent/v1/purchaseLists/{id}

Agent/Reasons

Reasons Agent endpoints

getReason: Method: get
Path: /ccagent/v1/reasons/{id}
listReasons: Method: get
Path: /ccagent/v1/reasons

Agent/Reports

Endpoints to handle operations related to reports with information to be displayed in the agent dashboard.

getReport: Method: get
Path: /ccagent/v1/agentReports/{id}

Agent/Return Order

Return Order endpoints

calculateRemainingRefund: Method: post
Path: /ccagent/v1/returnRequests/{id}/calculateRemainingRefund
getReturnRequest: Method: get
Path: /ccagent/v1/returnRequests/{id}
initiateReturn: Method: post
Path: /ccagent/v1/returnRequests
receiveReturnRequest: Method: put
Path: /ccagent/v1/returnRequests/{id}/receive
searchReturns: Method: get
Path: /ccagent/v1/returnRequests
updateReturnRequest: Method: put
Path: /ccagent/v1/returnRequests/{id}

Agent/Scheduled Orders

Scheduled Order endpoints

deleteScheduledOrder: Method: delete
Path: /ccagent/v1/scheduledOrders/{id}
getScheduledOrder: Method: get
Path: /ccagent/v1/scheduledOrders/{id}
listScheduledOrdersByProfile: Method: get
Path: /ccagent/v1/scheduledOrders
updateScheduledOrder: Method: put
Path: /ccagent/v1/scheduledOrders/{id}

Agent/Search

Search endpoints

search: Method: get
Path: /ccagent/v1/search

Agent/Shipping Methods

Endpoints for listing shipping methods, as well as getting individual shipping methods

getShippingMethod: Method: get
Path: /ccagent/v1/shippingMethods/{id}
listShippingMethods: Method: post
Path: /ccagent/v1/shippingMethods

Agent/Shopper Context Endpoint

The operations from the Agent/Shopper Context Endpoint category.

setShopperContext: Method: post
Path: /ccagent/v1/shopperContext

Agent/Shopper Types

Shopper Type endpoints

getShopperType: Method: get
Path: /ccagent/v1/shopperTypes/{id}
listShopperTypes: Method: get
Path: /ccagent/v1/shopperTypes

Agent/Sites

Site endpoints

getCartSharingSites: Method: get
Path: /ccagent/v1/sites/{id}/cartSharingSites
getSite: Method: get
Path: /ccagent/v1/sites/{id}
getSites: Method: get
Path: /ccagent/v1/sites

Agent/Sku

Sku operations

getSku: Method: get
Path: /ccagent/v1/skus/{id}
listSkus: Method: get
Path: /ccagent/v1/skus

Agent/Stock Status

Stock Status endpoints

getStockStatus: Method: get
Path: /ccagent/v1/stockStatus/{id}
getStockStatuses: Method: get
Path: /ccagent/v1/stockStatus

Social Wish Lists/comments

API for comment posts in a space

Create a comment post: Method: post
Path: /swm/rs/v1/spaces/{spaceId}/comments
Delete a comment post: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}/comments/{contentId}
Get a comment post: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/comments/{contentId}
Update a comment post: Method: put
Path: /swm/rs/v1/spaces/{spaceId}/comments/{contentId}

Social Wish Lists/content

API for all posts in a space

Delete a content post: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}/content/{contentId}
Get a content post: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/content/{contentId}
List all content posts: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/content

Social Wish Lists/invitations

API for inviting members to a space

Create an invitation: Method: post
Path: /swm/rs/v1/spaces/{spaceId}/invitations

Social Wish Lists/media

API for product or user media

Create media for a product: Method: post
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}/media
Create media for a user: Method: post
Path: /swm/rs/v1/users/{userId}/media
Delete media for a product: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}/media/{mediaId}
Update media for a product: Method: put
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}/media/{mediaId}

Social Wish Lists/members

API for members of a space

Create a member: Method: post
Path: /swm/rs/v1/members
Get a member: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/members/{userId}
List all members: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/members
Remove a member: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}/members/{userId}

Social Wish Lists/products

API for product posts in a space

Create a new product post: Method: post
Path: /swm/rs/v1/spaces/{spaceId}/products
Delete a product post: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}
Get a product post: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}
List all product post IDs: Method: get
Path: /swm/rs/v1/spaces/{spaceId}/products
Update a product post: Method: put
Path: /swm/rs/v1/spaces/{spaceId}/products/{contentId}

Social Wish Lists/sites

API for merchant sites

Delete site: Method: delete
Path: /swm/rs/v1/sites/cc/{ccSiteId}
Update a site with CC site info: Method: put
Path: /swm/rs/v1/sites/cc/{ccSiteId}

Social Wish Lists/spaces

API for spaces belonging to a user or a site

Create a space: Method: post
Path: /swm/rs/v1/spaces
Delete a space: Method: delete
Path: /swm/rs/v1/spaces/{spaceId}
Get a space: Method: get
Path: /swm/rs/v1/spaces/{spaceId}
List all spaces: Method: get
Path: /swm/rs/v1/sites/{siteId}/spaces
Update a space: Method: put
Path: /swm/rs/v1/spaces/{spaceId}

Social Wish Lists/users

API for users of spaces

Create or authenticate a user with CC: Method: post
Path: /swm/rs/v1/users/cc/{ccProfileId}
Delete a user: Method: delete
Path: /swm/rs/v1/users/{userId}
Delete a user associated with a given CC Profile ID.: Method: delete
Path: /swm/rs/v1/users/cc/{ccProfileId}
Get a user: Method: get
Path: /swm/rs/v1/sites/{siteId}/users/{userId}
Refresh a user: Method: post
Path: /swm/rs/v1/users/refresh
Update a user: Method: put
Path: /swm/rs/v1/sites/{siteId}/users/{userId}

Social Wish Lists/versions

API for version information

Describe all versions of SWM API: Method: get
Path: /swm/rs/
Describe version v1 of SWM API: Method: get
Path: /swm/rs/v1

Store/Access Rights

Access Right endpoints

listAccessRights: Method: get
Path: /ccstore/v1/accessRights

Store/Address Types

Endpoints for operations on address types.

listAddressTypes: Method: get
Path: /ccstore/v1/addressTypes

Store/Assembler

Assembler endpoint assembles response from assembler based on the requested service.

assemble: Method: get
Path: /ccstore/v1/assembler/assemble

Store/Audience Browsing Data Collection

The operations from the Store/Audience Browsing Data Collection category.

saveBrowsingEvent: Method: post
Path: /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: post
Path: /ccstore/v1/audienceContext/addThisInterests

Store/Audience Membership

Endpoint for determining Audience membership

getAudienceMembership: Method: get
Path: /ccstore/v1/audienceMembership

Store/Client Applications

Client Application Endpoints

getApplicationPage: Method: get
Path: /ccstore/v1/clientApplications/{application}/page/{path: .*}
getPageContext: Method: get
Path: /ccstore/v1/clientApplications/page/{path: .*}

Store/Collections

Collections endpoints

getCollection: Method: get
Path: /ccstore/v1/collections/{id}
listCollections: Method: get
Path: /ccstore/v1/collections

Store/Country Region

Endpoints for read operations on Country and its region/provinces

getBillingCountries: Method: get
Path: /ccstore/v1/countries/billingCountries
getCountryRegions: Method: get
Path: /ccstore/v1/countries/{id}
getShippingCountries: Method: get
Path: /ccstore/v1/countries/shippingCountries
listCountries: Method: get
Path: /ccstore/v1/countries

Store/Currency

Endpoints for operations on currencies.

getCurrency: Method: get
Path: /ccstore/v1/currencies/{id}
listCurrencies: Method: get
Path: /ccstore/v1/currencies

Store/Error Log Entries

Error Log Entry endpoints.

createErrorlog: Method: post
Path: /ccstore/v1/errorLogs

Store/Files

File endpoints

getCurrentVersionStoreFile: Method: get
Path: /ccstore/v1/files/store/current/{fileName}
getFile: Method: get
Path: /ccstore/v1/files/{id}
getFileURL: Method: get
Path: /ccstore/v1/files/urlMapping/{id}
getFileURLs: Method: put
Path: /ccstore/v1/files/urlMappings

Store/Health Check

Health check endpoints.

getPaymentGatewayAuthorizationHealthCheck: Method: get
Path: /ccstore/v1/healthCheck/payments
updatePaymentGatewayAuthorizationHealth: Method: put
Path: /ccstore/v1/healthCheck/payments

Store/Images

Dynamic Image endpoints, which are used to retrieve an image and optionally transform it.

Get an image: Method: get
Path: /ccstore/v1/images

Store/Inventory

Inventory endpoints

getInventory: Method: get
Path: /ccstore/v1/inventories/{id}
listInventories: Method: get
Path: /ccstore/v1/inventories
listInventoriesForLargeCart: Method: post
Path: /ccstore/v1/inventories

Store/Item Types

Item Type endpoints to get item type and base type details

getItemType: Method: get
Path: /ccstore/v1/itemTypes/{id}
listItemTypes: Method: get
Path: /ccstore/v1/itemTypes

Store/Locations

Endpoints to support operations related to locations.

getLocation: Method: get
Path: /ccstore/v1/locations/{id}
listLocations: Method: get
Path: /ccstore/v1/locations

Store/Logging

Endpoints that interact with the server's log files.

log: Method: post
Path: /ccstore/v1/logging/log
logClientErrors: Method: post
Path: /ccstore/v1/logging/logClientErrors
logInfoPost: Method: post
Path: /ccstore/v1/logging/logInfoPost
logInfoPostWithHeaders: Method: post
Path: /ccstore/v1/logging/logInfoPostWithHeaders
Query the storefront server logs for client side errors: Method: get
Path: /ccstore/v1/logging

Store/Merchant Settings

Endpoints for merchant settings.

getCancelReasons: Method: get
Path: /ccstore/v1/merchant/cancelReasons
getCloudConfiguration: Method: get
Path: /ccstore/v1/merchant/cloudConfiguration
getDefaultPriceListGroup: Method: get
Path: /ccstore/v1/merchant/defaultPriceListGroup
getExternalServiceData: Method: get
Path: /ccstore/v1/merchant/{id}
getExternalServicesData: Method: get
Path: /ccstore/v1/merchant
getMerchantTimezone: Method: get
Path: /ccstore/v1/merchant/timezone
getPaymentConfigurations: Method: get
Path: /ccstore/v1/merchant/paymentConfigurations
getPriceListCurrency: Method: get
Path: /ccstore/v1/merchant/priceListCurrency
getReturnReasons: Method: get
Path: /ccstore/v1/merchant/returnReasons
getSamlSettings: Method: get
Path: /ccstore/v1/merchant/samlSettings
getShopperSettings: Method: get
Path: /ccstore/v1/merchant/shopperSettings

Store/Metadata

Metadata endpoints

getMetadata: Method: get
Path: /ccstore/v1/metadata/{id}

Store/OAuth

OAuth endpoints

getEndpointAPI: Method: get
Path: /ccstore/v1/api/{id}
getEndpointAPIs: Method: get
Path: /ccstore/v1/api
getExtensionRegistry: Method: get
Path: /ccstore/v1/xregistry
getRegistry: Method: get
Path: /ccstore/v1/registry
login: Method: post
Path: /ccstore/v1/login
logout: Method: post
Path: /ccstore/v1/logout
refresh: Method: post
Path: /ccstore/v1/refresh
verify: Method: post
Path: /ccstore/v1/verify

Store/Orders

Order endpoints

Approve an order: Method: post
Path: /ccstore/v1/orders/approve
Cancel an order: Method: post
Path: /ccstore/v1/orders/cancel
Check an order requires approval: Method: post
Path: /ccstore/v1/orders/checkRequiresApproval
copyOrder: Method: post
Path: /ccstore/v1/orders/copyOrder
Create an order: Method: post
Path: /ccstore/v1/orders
Get all orders for profile: Method: get
Path: /ccstore/v1/orders
Get an order: Method: get
Path: /ccstore/v1/orders/{id}
Get valid actions: Method: get
Path: /ccstore/v1/orders/validActions/{id}
Initiate cancel of an order: Method: post
Path: /ccstore/v1/orders/initiateCancelOrder
Price an order: Method: post
Path: /ccstore/v1/orders/price
Reject a quote: Method: post
Path: /ccstore/v1/orders/rejectQuote
Reject an order: Method: post
Path: /ccstore/v1/orders/reject
Remove profile's incomplete order by ID: Method: delete
Path: /ccstore/v1/orders/remove/{id}
Request a quote: Method: post
Path: /ccstore/v1/orders/requestQuote
Retrieve an initial order by payment type: Method: post
Path: /ccstore/v1/orders/{id}
Retrieve an order confirmation by UUID: Method: get
Path: /ccstore/v1/orders/confirmation/{uuid}
Retrieve return requests: Method: get
Path: /ccstore/v1/orders/{id}/returnRequests
Retrieve the Gift-With-Purchase choices: Method: get
Path: /ccstore/v1/orders/getGiftWithPurchaseChoices
Submit cancel of an order: Method: put
Path: /ccstore/v1/orders/submitCancelOrder
Submit the quoted order: Method: post
Path: /ccstore/v1/orders/{id}/acceptQuote
Switch the current order: Method: post
Path: /ccstore/v1/orders/current/switch/
Update an order: Method: put
Path: /ccstore/v1/orders/{id}
Update the quoted order: Method: post
Path: /ccstore/v1/orders/{id}/updateQuotedOrder

Store/Orders/Current

The operations from the Store/Orders/Current category.

Convert to a scheduled order: Method: post
Path: /ccstore/v1/orders/current/convertToScheduledOrder
Get current incomplete order: Method: get
Path: /ccstore/v1/orders/current
Price the current order: Method: post
Path: /ccstore/v1/orders/current/price
Remove current profile's incomplete order: Method: delete
Path: /ccstore/v1/orders/current
Submit the current order (cart): Method: post
Path: /ccstore/v1/orders/current/submit
Update an incomplete order: Method: patch
Path: /ccstore/v1/orders/current
Update current profile's order: Method: post
Path: /ccstore/v1/orders/current

Store/Orders/Current/Items

The operations from the Store/Orders/Current/Items category.

Add cart items: Method: post
Path: /ccstore/v1/orders/current/items/add
Delete a cart item by ID: Method: delete
Path: /ccstore/v1/orders/current/items/{id}
Delete cart items: Method: post
Path: /ccstore/v1/orders/current/items/delete
Get a cart item by ID: Method: get
Path: /ccstore/v1/orders/current/items/{id}
Get all cart items: Method: get
Path: /ccstore/v1/orders/current/items
Make a Gift-With-Purchase selection: Method: post
Path: /ccstore/v1/orders/current/items/makeGWPSelection
Remove a selectable quantity: Method: post
Path: /ccstore/v1/orders/current/items/removeSelectableQuantity
Remove all selectable quantities: Method: post
Path: /ccstore/v1/orders/current/items/removeAllSelectableQuantity
Update a cart item by ID: Method: patch
Path: /ccstore/v1/orders/current/items/{id}
Update cart items: Method: patch
Path: /ccstore/v1/orders/current/items

Store/Orders/Current/Payments

The operations from the Store/Orders/Current/Payments category.

Apply payments: Method: post
Path: /ccstore/v1/orders/current/payments
Delete a payment by ID: Method: delete
Path: /ccstore/v1/orders/current/payments/{id}
Get payment by ID: Method: get
Path: /ccstore/v1/orders/current/payments/{id}
Retrieve all payments: Method: get
Path: /ccstore/v1/orders/current/payments
Update payment by ID: Method: patch
Path: /ccstore/v1/orders/current/payments/{id}
Update payments: Method: patch
Path: /ccstore/v1/orders/current/payments

Store/Orders/Current/Shipping Groups

The operations from the Store/Orders/Current/Shipping Groups category.

Add shipping groups: Method: post
Path: /ccstore/v1/orders/current/shippingGroups/add
Delete a shipping group by ID: Method: delete
Path: /ccstore/v1/orders/current/shippingGroups/{id}
Delete shipping groups: Method: post
Path: /ccstore/v1/orders/current/shippingGroups/delete
Get a shipping group by ID: Method: get
Path: /ccstore/v1/orders/current/shippingGroups/{id}
Get all shipping groups: Method: get
Path: /ccstore/v1/orders/current/shippingGroups
Manage shipping groups relationship to cart items: Method: post
Path: /ccstore/v1/orders/current/shippingGroups/relateToItems
Update a shipping group by ID: Method: patch
Path: /ccstore/v1/orders/current/shippingGroups/{id}
Update shipping groups: Method: patch
Path: /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: post
Path: /ccstore/v1/organizationMembers
getMember: Method: get
Path: /ccstore/v1/organizationMembers/{id}
listMembers: Method: get
Path: /ccstore/v1/organizationMembers
updateMember: Method: put
Path: /ccstore/v1/organizationMembers/{id}

Store/Organization Request

End points for operations for account based commerce in Oracle Commerce Cloud

createOrganizationRequest: Method: post
Path: /ccstore/v1/organizationRequests

Store/Organizations

End points for operations for account-based commerce in Oracle Commerce Cloud

getOrganization: Method: get
Path: /ccstore/v1/organizations/{id}
listOrganizations: Method: get
Path: /ccstore/v1/organizations
removeContacts: Method: post
Path: /ccstore/v1/organizations/removeContacts
updateOrganization: Method: put
Path: /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: get
Path: /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: post
Path: /ccstore/v1/organizationAddresses
deleteAddress: Method: delete
Path: /ccstore/v1/organizationAddresses/{id}
getAddress: Method: get
Path: /ccstore/v1/organizationAddresses/{id}
getAddresses: Method: get
Path: /ccstore/v1/organizationAddresses
updateAddress: Method: put
Path: /ccstore/v1/organizationAddresses/{id}

Store/Pages

Page endpoints. A web store is made up of multiple pages.

Get a layout: Method: get
Path: /ccstore/v1/pages/layout/{path: .*}
Get a page: Method: get
Path: /ccstore/v1/pages/{path: .*}
Get all pages: Method: get
Path: /ccstore/v1/pages

Store/Payment

Payment endpoints.

addPayments: Method: post
Path: /ccstore/v1/payment
authPayment: Method: post
Path: /ccstore/v1/payment/auth
calculateRemainingBalance: Method: post
Path: /ccstore/v1/payment/calculateRemainingBalance
getPaymentTypes: Method: get
Path: /ccstore/v1/payment/types
updatePaymentGroupFromCyberSourceResponse: Method: post
Path: /ccstore/v1/payment/responses
updatePaymentGroupFromGenericResponse: Method: post
Path: /ccstore/v1/payment/genericCardResponses
updatePaymentResponseWithClientError: Method: put
Path: /ccstore/v1/payment/responses

Store/Payment Groups

Payment Group endpoints

getPaymentGroup: Method: get
Path: /ccstore/v1/paymentGroups/{id}

Store/PriceListGroup

Endpoints for operations on PriceListGroups.

getPriceListGroup: Method: get
Path: /ccstore/v1/priceListGroups/{id}
listPriceListGroups: Method: get
Path: /ccstore/v1/priceListGroups

Store/Prices

Prices endpoints

getAllPrices: Method: get
Path: /ccstore/v1/prices/{id}
getAllProductsPrices: Method: get
Path: /ccstore/v1/prices/products
getAllSKUsPrices: Method: get
Path: /ccstore/v1/prices/skus

Store/Product Notify

Product Notification endpoints

addProductNotification: Method: post
Path: /ccstore/v1/productnotify

Store/Product Types

Product Type endpoints.

getProductType: Method: get
Path: /ccstore/v1/productTypes/{id}
listProductTypes: Method: get
Path: /ccstore/v1/productTypes

Store/Products

Product endpoints

getProduct: Method: get
Path: /ccstore/v1/products/{id}
listProducts: Method: get
Path: /ccstore/v1/products
listProductsForLargeCart: Method: post
Path: /ccstore/v1/products

Store/Profile Request

End points for operations for account based commerce in Oracle Commerce Cloud

Approve profile request: Method: post
Path: /ccstore/v1/profileRequests/{id}/approve
createMultipleProfileRequests: Method: post
Path: /ccstore/v1/profileRequests/createMultiple
createProfileRequest: Method: post
Path: /ccstore/v1/profileRequests
getProfileRequest: Method: get
Path: /ccstore/v1/profileRequests/{id}
listProfileRequests: Method: get
Path: /ccstore/v1/profileRequests
Reject profile request: Method: post
Path: /ccstore/v1/profileRequests/{id}/reject
updateProfileRequest: Method: put
Path: /ccstore/v1/profileRequests/{id}

Store/Profiles

Profile endpoints

addCreditCard: Method: post
Path: /ccstore/v1/profiles/current/creditCards
addProfileAddress: Method: post
Path: /ccstore/v1/profiles/current/addresses
createProfile: Method: post
Path: /ccstore/v1/profiles
deleteProfileAddress: Method: delete
Path: /ccstore/v1/profiles/current/addresses/{addressId}
getCreditCard: Method: get
Path: /ccstore/v1/profiles/current/creditCards/{id}
getCurrentProfile: Method: get
Path: /ccstore/v1/profiles/current
getProfileAddress: Method: get
Path: /ccstore/v1/profiles/current/addresses/{addressId}
listCreditCards: Method: get
Path: /ccstore/v1/profiles/current/creditCards
listProfileAddresses: Method: get
Path: /ccstore/v1/profiles/current/addresses
listSiteProperties: Method: get
Path: /ccstore/v1/profiles/current/siteProperties
removeCreditCard: Method: delete
Path: /ccstore/v1/profiles/current/creditCards/{id}
resetPassword: Method: post
Path: /ccstore/v1/profiles/resetPassword
updateCreditCard: Method: put
Path: /ccstore/v1/profiles/current/creditCards/{id}
updateExpiredPassword: Method: post
Path: /ccstore/v1/profiles/updateExpiredPassword
updateProfile: Method: put
Path: /ccstore/v1/profiles/current
updateProfileAddress: Method: put
Path: /ccstore/v1/profiles/current/addresses/{addressId}
updateSiteProperties: Method: put
Path: /ccstore/v1/profiles/current/siteProperties

Store/Publishing

Publishing endpoints for storefront server

getLastPublishedTime: Method: get
Path: /ccstore/v1/publish
pushPubEvent: Method: post
Path: /ccstore/v1/publish/event

Store/PurchaseLists

End points for operations on Purchase List in Oracle Commerce Cloud

checkEditAccess: Method: post
Path: /ccstore/v1/purchaseLists/checkEditAccess
createPurchaseList: Method: post
Path: /ccstore/v1/purchaseLists
deletePurchaseList: Method: delete
Path: /ccstore/v1/purchaseLists/{id}
getPurchaseList: Method: get
Path: /ccstore/v1/purchaseLists/{id}
listPurchaseLists: Method: get
Path: /ccstore/v1/purchaseLists
updateItems: Method: post
Path: /ccstore/v1/purchaseLists/{id}/updateItems
updatePurchaseList: Method: put
Path: /ccstore/v1/purchaseLists/{id}

Store/Resources

Resource endpoints

getResourceBundle: Method: get
Path: /ccstore/v1/resources/{bundle}

Store/Return Requests

Return Request Endpoints

calculateRefund: Method: post
Path: /ccstore/v1/returnRequests/calculateRefund
createReturnRequest: Method: post
Path: /ccstore/v1/returnRequests
getReturnRequest: Method: get
Path: /ccstore/v1/returnRequests/{id}
initiateReturn: Method: post
Path: /ccstore/v1/returnRequests/initiate
validateReturns: Method: post
Path: /ccstore/v1/returnRequests/validate

Store/Roles

Roles endpoints

createRole: Method: post
Path: /ccstore/v1/roles
getRole: Method: get
Path: /ccstore/v1/roles/{id}
listRoles: Method: get
Path: /ccstore/v1/roles
updateRole: Method: put
Path: /ccstore/v1/roles/{id}

Store/SAML AuthnRequest

Endpoint to generate a new SAML AuthnRequest

samlAuthnRequest: Method: post
Path: /ccstore/v1/samlAuthnRequest

Store/Save Current Geolocation Session Context Data

The operations from the Store/Save Current Geolocation Session Context Data category.

saveCurrentGeolocationSessionContext: Method: put
Path: /ccstore/v1/audienceContext/currentSession/geolocation/current

Store/Save Current Session Context Data

The operations from the Store/Save Current Session Context Data category.

saveCurrentSessionContext: Method: put
Path: /ccstore/v1/audienceContext/currentSession

Store/Save Current Session Device Type Data

The operations from the Store/Save Current Session Device Type Data category.

saveDeviceTypeSessionContext: Method: put
Path: /ccstore/v1/audienceContext/currentSession/deviceType/current

Store/Save Current Session Entry Page Data

The operations from the Store/Save Current Session Entry Page Data category.

addEntryPageSessionContext: Method: put
Path: /ccstore/v1/audienceContext/currentSession/entryPage/current

Store/Scheduled Orders

Endpoints for scheduled orders.

createScheduledOrder: Method: post
Path: /ccstore/v1/scheduledOrders
deleteScheduledOrder: Method: delete
Path: /ccstore/v1/scheduledOrders/{id}
getScheduledOrder: Method: get
Path: /ccstore/v1/scheduledOrders/{id}
listExecutionStatusForScheduledOrderById: Method: get
Path: /ccstore/v1/scheduledOrders/status/{id}
listScheduledOrdersByProfile: Method: get
Path: /ccstore/v1/scheduledOrders/current/scheduledOrders
updateScheduledOrder: Method: put
Path: /ccstore/v1/scheduledOrders/{id}

Store/Search

Search endpoints

search: Method: get
Path: /ccstore/v1/search

Store/Services

Services endpoints

getService: Method: get
Path: /ccstore/v1/services/{id}
getServices: Method: get
Path: /ccstore/v1/services
modifyService: Method: post
Path: /ccstore/v1/services/{id}/modify
renewService: Method: post
Path: /ccstore/v1/services/{id}/renew
terminateService: Method: post
Path: /ccstore/v1/services/{id}/terminate

Store/ShareSettings

End points for operations on Share Settings in Oracle Commerce Cloud

createEmailConfigs: Method: post
Path: /ccstore/v1/shareSettings/{id}/createEmailConfigs
createShareSetting: Method: post
Path: /ccstore/v1/shareSettings
deleteEmailConfigs: Method: post
Path: /ccstore/v1/shareSettings/{id}/deleteEmailConfigs
deleteShareSetting: Method: delete
Path: /ccstore/v1/shareSettings/{id}
getShareSetting: Method: get
Path: /ccstore/v1/shareSettings/{id}
listShareSettings: Method: get
Path: /ccstore/v1/shareSettings
updateEmailConfigs: Method: post
Path: /ccstore/v1/shareSettings/{id}/updateEmailConfigs
updateShareSetting: Method: put
Path: /ccstore/v1/shareSettings/{id}

Store/Shipping Methods

Endpoints for listing shipping methods, as well as getting individual shipping methods

getShippingMethod: Method: get
Path: /ccstore/v1/shippingMethods/{id}
listShippingMethods: Method: post
Path: /ccstore/v1/shippingMethods
listShippingMethodsForCurrentOrder: Method: get
Path: /ccstore/v1/shippingMethods

Store/Shipping Regions

Shipping Regions Endpoints

getShippingRegionsByCountry: Method: get
Path: /ccstore/v1/shippingRegions

Store/Shopper Context Endpoint

The operations from the Store/Shopper Context Endpoint category.

setShopperContext: Method: post
Path: /ccstore/v1/shopperContext

Store/Sites

Site endpoints

getSite: Method: get
Path: /ccstore/v1/sites/{id}
listSites: Method: get
Path: /ccstore/v1/sites

Store/Skus

Sku endpoints

getSku: Method: get
Path: /ccstore/v1/skus/{id}
listSkus: Method: get
Path: /ccstore/v1/skus
listSkusForLargeCart: Method: post
Path: /ccstore/v1/skus

Store/Static Wishlist

Static Wishlist endpoints

generateStaticWishlistPage: Method: post
Path: /ccstore/v1/staticWishlistPages/{id}

Store/Stock Status

Stock Status Endpoints used to retrieve information about products that are part of a catalog. Information includes the product's quantity, availability and its current stock status

List stock status for large cart: Method: post
Path: /ccstore/v1/stockStatus
Retrieve stock status by ID: Method: get
Path: /ccstore/v1/stockStatus/{id}
Retrieve stock statuses: Method: get
Path: /ccstore/v1/stockStatus

Store/Store Extension/Admin/Orders

The operations from the Store/Store Extension/Admin/Orders category.

deleteOrder: Method: delete
Path: /ccapp/v1/orders/{id}
deleteOrders: Method: post
Path: /ccapp/v1/orders/delete
getOrder: Method: get
Path: /ccapp/v1/orders/{id}
getOrders: Method: get
Path: /ccapp/v1/orders
syncQuote: Method: put
Path: /ccapp/v1/orders/syncQuote
updateOrder: Method: put
Path: /ccapp/v1/orders/{id}
updateQuoteStatus: Method: put
Path: /ccapp/v1/orders/updateQuoteStatus

Store/Store Extension/Admin/Organization Request

The operations from the Store/Store Extension/Admin/Organization Request category.

Approve organization request: Method: post
Path: /ccapp/v1/organizationRequests/{id}/approve
deleteOrganizationRequest - only for application access: Method: delete
Path: /ccapp/v1/organizationRequests/{id}
getOrganizationRequests: Method: get
Path: /ccapp/v1/organizationRequests/{id}
listOrganizationRequests: Method: get
Path: /ccapp/v1/organizationRequests
Reject organization request: Method: post
Path: /ccapp/v1/organizationRequests/{id}/reject
updateOrganizationRequests: Method: put
Path: /ccapp/v1/organizationRequests/{id}

Store/Store Extension/Admin/Organizations

The operations from the Store/Store Extension/Admin/Organizations category.

add an secondary address to an Organization: Method: post
Path: /ccapp/v1/organizations/{id}/secondaryAddresses
createOrganization: Method: post
Path: /ccapp/v1/organizations
delete an Address for an Organization: Method: delete
Path: /ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
generates the authorization code for an Organization: Method: post
Path: /ccapp/v1/organizations/{id}/authorizationCode
get Address for an Organization: Method: get
Path: /ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
Get site based Organization properties: Method: get
Path: /ccapp/v1/organizations/{id}/siteOrganizationProperties
getOrganization: Method: get
Path: /ccapp/v1/organizations/{id}
listOrganizationRoles: Method: get
Path: /ccapp/v1/organizations/{id}/organizationalRoles
listOrganizations: Method: get
Path: /ccapp/v1/organizations
update address for an Organization: Method: put
Path: /ccapp/v1/organizations/{id}/secondaryAddresses/{addressId}
update site based Organization properties: Method: post
Path: /ccapp/v1/organizations/{id}/updateSiteOrganizationProperties
updateOrganization: Method: put
Path: /ccapp/v1/organizations/{id}

Store/Store Extension/Admin/Profiles

The operations from the Store/Store Extension/Admin/Profiles category.

addProfileAddress: Method: post
Path: /ccapp/v1/profiles/{id}/addresses
appendSecondaryOrganizations: Method: post
Path: /ccapp/v1/profiles/{id}/appendSecondaryOrganizations
createProfile: Method: post
Path: /ccapp/v1/profiles
deleteProfileAddress: Method: delete
Path: /ccapp/v1/profiles/{id}/addresses/{addressId}
getProfile: Method: get
Path: /ccapp/v1/profiles/{id}
getProfileAddress: Method: get
Path: /ccapp/v1/profiles/{id}/addresses/{addressId}
listProfileAddresses: Method: get
Path: /ccapp/v1/profiles/{id}/addresses
listProfiles: Method: get
Path: /ccapp/v1/profiles
removeSecondaryOrganizations: Method: post
Path: /ccapp/v1/profiles/{id}/removeSecondaryOrganizations
replaceSecondaryOrganizations: Method: post
Path: /ccapp/v1/profiles/{id}/replaceSecondaryOrganizations
resetPassword: Method: post
Path: /ccapp/v1/profiles/resetPassword
updateParentOrganization: Method: post
Path: /ccapp/v1/profiles/{id}/updateParentOrganization
updateProfile: Method: put
Path: /ccapp/v1/profiles/{id}
updateProfileAddress: Method: put
Path: /ccapp/v1/profiles/{id}/addresses/{addressId}
updateProfiles: Method: put
Path: /ccapp/v1/profiles
updateUserRoles: Method: post
Path: /ccapp/v1/profiles/{id}/updateUserRoles

Store/Store Extension/Admin/Token Cache

The operations from the Store/Store Extension/Admin/Token Cache category.

cacheToken: Method: post
Path: /ccapp/v1/tokenCache
deleteToken: Method: delete
Path: /ccapp/v1/tokenCache/{id}
getToken: Method: get
Path: /ccapp/v1/tokenCache/{id}
updateToken: Method: put
Path: /ccapp/v1/tokenCache/{id}

Store/Store Extension/Agent/Customers

The operations from the Store/Store Extension/Agent/Customers category.

addCreditCard: Method: post
Path: /ccappagent/v1/profiles/{id}/creditCards
addProfileAddress: Method: post
Path: /ccappagent/v1/profiles/{id}/addresses
createProfile: Method: post
Path: /ccappagent/v1/profiles
deleteMultipleProfiles: Method: post
Path: /ccappagent/v1/profiles/delete
deleteProfile: Method: delete
Path: /ccappagent/v1/profiles/{id}
deleteProfileAddress: Method: delete
Path: /ccappagent/v1/profiles/{id}/addresses/{addressId}
deleteProfiles: Method: delete
Path: /ccappagent/v1/profiles
getCreditCard: Method: get
Path: /ccappagent/v1/profiles/{id}/creditCards/{cardId}
getProfile: Method: get
Path: /ccappagent/v1/profiles/{id}
getProfileAddress: Method: get
Path: /ccappagent/v1/profiles/{id}/addresses/{addressId}
listCreditCards: Method: get
Path: /ccappagent/v1/profiles/{id}/creditCards
listProfileAddresses: Method: get
Path: /ccappagent/v1/profiles/{id}/addresses
listSiteProperties: Method: get
Path: /ccappagent/v1/profiles/{id}/siteProperties
removeCreditCard: Method: delete
Path: /ccappagent/v1/profiles/{id}/creditCards/{cardId}
resetPassword: Method: post
Path: /ccappagent/v1/profiles/{id}
searchProfiles: Method: get
Path: /ccappagent/v1/profiles
updateCreditCard: Method: put
Path: /ccappagent/v1/profiles/{id}/creditCards/{cardId}
updateProfile: Method: put
Path: /ccappagent/v1/profiles/{id}
updateProfileAddress: Method: put
Path: /ccappagent/v1/profiles/{id}/addresses/{addressId}
updateSiteProperties: Method: put
Path: /ccappagent/v1/profiles/{id}/siteProperties

Store/Store Extension/Agent/Orders

The operations from the Store/Store Extension/Agent/Orders category.

copyOrder: Method: post
Path: /ccappagent/v1/orders/copyOrder
createOrder: Method: post
Path: /ccappagent/v1/orders
getOrder: Method: get
Path: /ccappagent/v1/orders/{id}
updateOrder: Method: put
Path: /ccappagent/v1/orders/{id}

Store/Store Metadata Catalog

Metadata Catalog Store Endpoints

getMetadataCatalog: Method: get
Path: /ccstore/v1/metadata-catalog

Store/Timezone

Endpoints for operations on timezones.

getTimezone: Method: get
Path: /ccstore/v1/timezones/{id}
listTimezones: Method: get
Path: /ccstore/v1/timezones

Store/Visitor Info

Endpoints to handle visitor information.

updateVisitorInfo: Method: put
Path: /ccstore/v1/visitorInfo/current

Store/Web Analytics

Endpoints for operations related to web analytics like storing visits and visitor counts.

saveVisitsAndVisitorsMetric: Method: post
Path: /ccstore/v1/analytics/visitorsMetric

Store/assemblerPages

The operations from the Store/assemblerPages category.

search: Method: get
Path: /ccstore/v1/assembler/pages/{path: .*}

Webhook/ASA Additional Properties

The operations from the Webhook/ASA Additional Properties category.

asaAdditionalProperties: Method: post
Path: /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: post
Path: /ccadmin/v1/webhook/accountAssets

Webhook/Appeasement Submit

The operations from the Webhook/Appeasement Submit category.

appeasementSubmit: Method: post
Path: /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: post
Path: /ccadmin/v1/webhook/appeasementValidation

Webhook/Asset Actions

Returns action details associated with particular assets.

assetActions: Method: post
Path: /ccadmin/v1/webhook/assetActions

Webhook/Calculate Shipping

Webhook for calculating shipping cost

Call external service to determine available shipping methods and prices.: Method: post
Path: /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: post
Path: /ccadmin/v1/webhook/cancel

Webhook/Cancel Order Update

This operation is triggered to update the cancel order details.

cancelOrderUpdate: Method: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/externalPriceGroupAndCatalog

Webhook/Contact Accounts

Returns billing, customer and service account information associated with the current profile.

contactAccounts: Method: post
Path: /ccadmin/v1/webhook/contactAccounts

Webhook/Custom Currency

This webhook is used for Custom currency Payments

customCurrency: Method: post
Path: /ccadmin/v1/webhook/customCurrency

Webhook/Data Export

The data export details in the Oracle Commerce Cloud

dataExport: Method: post
Path: /ccadmin/v1/webhook/dataExport

Webhook/Data Import

The data import details in the Oracle Commerce Cloud

dataImport: Method: post
Path: /ccadmin/v1/webhook/dataImport

Webhook/Delete Order

The operations from the Webhook/Delete Order category.

deleteOrder: Method: post
Path: /ccadmin/v1/webhook/deleteOrder

Webhook/External Price Validation

Validates external prices with an external pricing system.

External Price Validation: Method: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/externalTaxCalculation

Webhook/Generic Card Payment

Integrates custom payment gateways that let your store accept card payment.

genericCardPayment: Method: post
Path: /ccadmin/v1/webhook/genericCardPayment

Webhook/Generic Payment

Integrates custom payment gateways that let your store accept various payment types

genericPayment: Method: post
Path: /ccadmin/v1/webhook/genericPayment

Webhook/Idle Cart

The details of idle cart in the Oracle Commerce Cloud

idleCart: Method: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/order

Webhook/Order Approvals

The operations from the Webhook/Order Approvals category.

checkOrderApprovalWebhook: Method: post
Path: /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: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/orderRetryFailed

Webhook/OrderRetryFailed PCI

Order retry failed PCI: Method: post
Path: /ccadmin/v1/webhook/orderRetryFailedPCI

Webhook/Organization

The metadata for create/update account webhook.

organization: Method: post
Path: /ccadmin/v1/webhook/organization

Webhook/Organization Request

The details of organization request created by Oracle Commerce

createOrganizationRequest: Method: post
Path: /ccadmin/v1/webhook/createOrganizationRequest

Webhook/Profile Request

The details of profile request created by Oracle Commerce

createProfileRequest: Method: post
Path: /ccadmin/v1/webhook/createProfileRequest

Webhook/Publish Event

The publish event details in the Oracle Commerce Cloud

publishEvent: Method: post
Path: /ccadmin/v1/webhook/publishEvent

Webhook/Redact Order

The operations from the Webhook/Redact Order category.

redactOrder: Method: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/remorsePeriodStarted

Webhook/Request Quote

The details of quote requested by Oracle Commerce

requestQuote: Method: post
Path: /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: post
Path: /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: post
Path: /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: post
Path: /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: post
Path: /ccadmin/v1/webhook/profile

Webhook/Shopper Profile Delete

A registered shopper has been removed

Shopper Profile Delete: Method: post
Path: /ccadmin/v1/webhook/profileDelete

Webhook/Shopper Profile Update

The details of customer profile being updated on Oracle Commerce Cloud.

Shopper Profile Update: Method: post
Path: /ccadmin/v1/webhook/profileUpdate

Webhook/Update Inventory

The operations from the Webhook/Update Inventory category.

updateInventory: Method: post
Path: /ccadmin/v1/webhook/updateInventory

Webhook/Update Quote

The details of quote and the operation requested by Oracle Commerce Cloud.

updateQuote: Method: post
Path: /ccadmin/v1/webhook/updateQuote