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/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
get SAML AuthnRequest
Method: get
Path: /ccadmin/v1/saml/authnRequest
Admin/Admin SAML IdP Settings
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
get SAML LogoutRequest
Method: get
Path: /ccadmin/v1/saml/logoutRequest
Admin/Admin Service Provider Entity Descriptor
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
single log out
Method: post
Path: /ccadmin/v1/saml/slo
Admin/Admin Single Sign On
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/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/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
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/Audience Rule Properties
Endpoint for querying the properties available for building Audience rules
listAudienceRuleProperties
Method: get
Path: /ccadmin/v1/audienceRuleProperties
Admin/Audience Sizes
This endpoint produces a list of shopper counts for a given list of Audience rules. The endpoint also returns the total estimated number of registered shoppers in the system.
audienceSizes
Method: post
Path: /ccadmin/v1/audienceSizes
Admin/Audience Usage
Retrieve the list of Audience consumers. The items in the response will have the following fields: id, displayName, assetType, assetTypeDisplayName, description. Items may also have an optional additionalMetaData property.
audienceUsage
Method: get
Path: /ccadmin/v1/audienceUsage/{id}
Admin/Audiences
Endpoints for managing Audiences used for personalization.
createAudience
Method: post
Path: /ccadmin/v1/audiences
deleteAudience
Method: delete
Path: /ccadmin/v1/audiences/{id}
getAudience
Method: get
Path: /ccadmin/v1/audiences/{id}
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/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
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/Country Region
Endpoints for read operations on Country and its states and regions
getCountryRegions
Method: get
Path: /ccadmin/v1/countries/{id}
listCountries
Method: get
Path: /ccadmin/v1/countries
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
getGlobalElementTemplate
Method: get
Path: /ccadmin/v1/elements/{tag}/template
updateGlobalElementJavaScript
Method: put
Path: /ccadmin/v1/elements/{tag}/javascript
updateGlobalElementTemplate
Method: put
Path: /ccadmin/v1/elements/{tag}/template
Admin/Email
for Email Service Data
downloadEmailTemplates
Method: get
Path: /ccadmin/v1/email/types/{emailTypeId}/templates
getEmailNotificationTypes
Method: get
Path: /ccadmin/v1/email/notificationTypes
getEmailServiceData
Method: get
Path: /ccadmin/v1/email
setEmailServiceData
Method: post
Path: /ccadmin/v1/email
testSmtpConnection
Method: post
Path: /ccadmin/v1/email/test
updateEmailTemplates
Method: put
Path: /ccadmin/v1/email/types/{emailTypeId}/templates
Admin/Email Notifications
for Email Notifications
sendEmailNotification
Method: post
Path: /ccadmin/v1/emailNotifications
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 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/Lint Jobs
Endpoints for operations related to the execution of Extension Server Lint jobs.
getCompletedLintJobs
Method: get
Path: /ccadminx/v1/lintJobs
getLintJobResults
Method: get
Path: /ccadminx/v1/lintJobs/{id}
lintJobExecutionRequest
Method: post
Path: /ccadminx/v1/lintJobs
Admin/Extension Server/Lint Status
Endpoints for operations on the status of Extension Server Lint jobs.
getLintStatus
Method: get
Path: /ccadminx/v1/lintStatus/{id}
Admin/Extension Server/Server Commands
Endpoints for managing the extension servers.
doServerPush
Method: post
Path: /ccadminx/v1/servers/push
doServerRestart
Method: post
Path: /ccadminx/v1/servers/restart
Admin/Extension Server/Test Jobs
Endpoints for operations related to the execution of Extension Server test jobs.
getCompletedTestJobs
Method: get
Path: /ccadminx/v1/testJobs
testJobExecutionRequest
Method: post
Path: /ccadminx/v1/testJobs
Admin/Extension Server/Test Status
Endpoints for operations on the status of Extension Server test jobs.
getTestStatus
Method: get
Path: /ccadminx/v1/testStatus/{id}
Admin/Extensions
Endpoints for operations on Extensions.
createExtension
Method: post
Path: /ccadmin/v1/extensions
deleteExtension
Method: delete
Path: /ccadmin/v1/extensions/{id}
getAllExtensions
Method: get
Path: /ccadmin/v1/extensions
processExtension
Method: post
Path: /ccadmin/v1/extensions/{id}
Admin/Failed WebHook Messages
Endpoints for viewing and managing WebHook messages that failed to be sent.
deleteFailedMessage
Method: delete
Path: /ccadmin/v1/webhookFailedMessages/{id}
getFailedMessage
Method: get
Path: /ccadmin/v1/webhookFailedMessages/{id}
getFailedMessages
Method: get
Path: /ccadmin/v1/webhookFailedMessages
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/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
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
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
getItemType
Method: get
Path: /ccadmin/v1/itemTypes/{id}
updateItemType
Method: put
Path: /ccadmin/v1/itemTypes/{id}
Admin/JsFrameworkAdminEndpoint
JS Framework Admin Endpoints allow the administrator to upgrade to the latest storefront framework or roll back to the previous Storefront
getCurrentVersionDetails
Method: get
Path: /ccadmin/v1/jsframeworkadmin
rollbackCurrentVersion
Method: post
Path: /ccadmin/v1/jsframeworkadmin/rollbackVersion
upgradeCurrentVersion
Method: post
Path: /ccadmin/v1/jsframeworkadmin/upgradeVersion
Admin/Layouts
Layout endpoints
cloneLayout
Method: post
Path: /ccadmin/v1/layouts/{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 for working with locale information.
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
getASASettings
Method: get
Path: /ccadmin/v1/merchant/assistedSellingSettings
getBasicAuthConfiguration
Method: get
Path: /ccadmin/v1/merchant/basicAuth
getCloudConfiguration
Method: get
Path: /ccadmin/v1/merchant/cloudConfiguration
getDefaultLocale
Method: get
Path: /ccadmin/v1/merchant/defaultLocale
getDefaultPriceListGroup
Method: get
Path: /ccadmin/v1/merchant/defaultPriceListGroup
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
getRestrictedWords
Method: get
Path: /ccadmin/v1/merchant/profilePolicies/restrictedWords
getSamlSettings
Method: get
Path: /ccadmin/v1/merchant/samlSettings
getScheduledJob
Method: get
Path: /ccadmin/v1/merchant/scheduledJobs
getShopperProfileConfiguration
Method: get
Path: /ccadmin/v1/merchant/shopperProfileConfiguration
getStorefrontUrl
Method: get
Path: /ccadmin/v1/merchant/storefrontUrl
getTextSearchSettings
Method: get
Path: /ccadmin/v1/merchant/textSearch
listSelectedBillingCountries
Method: get
Path: /ccadmin/v1/merchant/billingCountries
saveAdminConfiguration
Method: put
Path: /ccadmin/v1/merchant/adminConfiguration
saveAgentConfiguration
Method: put
Path: /ccadmin/v1/merchant/agentConfiguration
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
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
updateDefaultLocale
Method: put
Path: /ccadmin/v1/merchant/defaultLocale
updateDefaultPriceListGroup
Method: put
Path: /ccadmin/v1/merchant/defaultPriceListGroup
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
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
updateShopperProfileConfiguration
Method: put
Path: /ccadmin/v1/merchant/shopperProfileConfiguration
Admin/Metadata
Metadata endpoints
getMetadata
Method: get
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/OpenID
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
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/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}
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/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.
appendSecondaryOrganizations
Method: post
Path: /ccadmin/v1/profiles/{id}/appendSecondaryOrganizations
createProfile
Method: post
Path: /ccadmin/v1/profiles
getProfile
Method: get
Path: /ccadmin/v1/profiles/{id}
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}
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 Authors
Endpoints for publishing change authors
getAllPublishingChangeAuthors
Method: get
Path: /ccadmin/v1/publishingChangeAuthors
Admin/Publishing Change Lists
Endpoints for publishing change lists.
getPublishingDependencies
Method: get
Path: /ccadmin/v1/publishingChangeLists/{changeListId}
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/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
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/Search Admin
Search Administration endpoints
getSearchIndexingStatus
Method: get
Path: /ccadmin/v1/search/index
getSearchSchedule
Method: get
Path: /ccadmin/v1/search/schedule
requestIndex
Method: post
Path: /ccadmin/v1/search/index
setSearchSchedule
Method: put
Path: /ccadmin/v1/search/schedule
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/{resourcePath}
Delete a resource configuration
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/{resourcePath}
Delete application configuration
Method: delete
Path: /ifcr/gsadmin/v1/{appName}
Download application configuration
Method: get
Path: /ifcr/gsadmin/v1/{appName}.zip
Download resource configuration
Method: get
Path: /ifcr/gsadmin/v1/{appName}/{resourcePath}.zip
Import application configuration
Method: post
Path: /ifcr/gsadmin/v1/{appName}
Admin/Search And Navigation/Dimension Value Service
Service for retrieving information about dimension values.
listDimensions
Method: get
Path: /ifcr/gsadmin/v1/{appName}/dimvals
listDimensions
Method: get
Path: /ifcr/gsadmin/v1/{appName}/dimvals/{dimValKey}
listDimensions
Method: get
Path: /ifcr/gsadmin/v1/{appName}/dimvals/{dimValKey}/children
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/content/facets/{facetListName}
deleteFacetList
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/content/facets/{facetListName}
getFacetList
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/facets/{facetListName}
listFacetLists
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/facets
updateFacetList
Method: put
Path: /ifcr/gsadmin/v1/{appName}/content/facets/{facetListName}
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Create index attributes
Method: post
Path: /ifcr/gsadmin/v1/{appName}/attributes
Create owner attributes
Method: post
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}
Delete an index attribute
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Delete index Attributes
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/attributes
Delete owner index attributes
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}
Partial update an index attribute
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Partial update index attributes
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/attributes
Partial update owner attributes
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}
Update an index attribute
Method: put
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Update index attributes
Method: put
Path: /ifcr/gsadmin/v1/{appName}/attributes
Update owner attributes
Method: put
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}
View index attribute
Method: get
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
View index attributes
Method: get
Path: /ifcr/gsadmin/v1/{appName}/attributes
View owner attributes
Method: get
Path: /ifcr/gsadmin/v1/{appName}/attributes/{owner}
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Create Keyword Redirect Group.
Method: post
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}
Create Keyword Redirects Configuration
Method: post
Path: /ifcr/gsadmin/v1/{appName}/redirects
Delete Keyword Redirect Entry
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Delete Keyword Redirect Group
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}
Delete Keyword Redirects
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/redirects
Partial update Keyword Redirect Entry.
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Partial update Keyword Redirect Group.
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}
Partial update Keyword Redirects Configuration
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/redirects
Update an Keyword Redirect Entry.
Method: put
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Update Keyword Redirect Group.
Method: put
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}
Update Keyword Redirects configuration
Method: put
Path: /ifcr/gsadmin/v1/{appName}/redirects
View Keyword Redirect Entry.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
View Keyword Redirect Group.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/redirects/{redirectGroup}
View Keyword Redirects
Method: get
Path: /ifcr/gsadmin/v1/{appName}/redirects
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}/{page}
Creates a page root for a application
Method: post
Path: /ifcr/gsadmin/v1/{appName}/pages
Creates a site for a application
Method: post
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}
Delete page root of a application
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/pages
Deletes the page.
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}/{page}
Deletes the site.
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}
Gets a list of immediate pages defined under site home
Method: get
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}
Gets a Page configuration or lists down immediate pages under requested page.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}/{page}
Updates a page configuration
Method: put
Path: /ifcr/gsadmin/v1/{appName}/pages/{siteHome}/{page}
View all sites defined in a application
Method: get
Path: /ifcr/gsadmin/v1/{appName}/pages
Admin/Search And Navigation/Ranking Rules Configuration
These endpoints are a subset of the /rules endpoints with clarification on formats for Blended Ranker configuration. As well as a new selector to work better with ccadmin.
Creates a rule configuration.
Method: post
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules/{Rule}
Deletes a Rule.
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules/{Rule}
listRankingRules
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules
listRankingRules
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules.ccadminui.json
listRankingRules
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules/{Rule}.ccadminui.json
Retrieve a rule configuration.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules/{Rule}
Updates a rule configuration.
Method: put
Path: /ifcr/gsadmin/v1/{appName}/content/rankingRules/{Rule}
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Creates content collection folder at specified location.
Method: post
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}
Creates content node for a application
Method: post
Path: /ifcr/gsadmin/v1/{appName}/content
Delete content node of a application
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/content
Deletes a content collection folder.
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}
Deletes a Rule.
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Updates a rule configuration.
Method: put
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View content collection folders under 'content' root node.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content
View rule definition
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View rules and content collection folders under specified content collection folder.
Method: get
Path: /ifcr/gsadmin/v1/{appName}/content/{contentCollectionFolder}
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/searchIndexConfig
Delete search index configuration
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/searchIndexConfig
Partial update search index configuration
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/searchIndexConfig
Update search index configuration
Method: put
Path: /ifcr/gsadmin/v1/{appName}/searchIndexConfig
View search index configuration
Method: get
Path: /ifcr/gsadmin/v1/{appName}/searchIndexConfig
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Create a search interface folder
Method: post
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces
Delete a search interface
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Delete a search interface folder
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces
Partial update a search interface
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Partial update a search interface folder
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces
Update a search interface
Method: put
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Update a search interface folder
Method: put
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces
View a search interface
Method: get
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
View a search interface folder
Method: get
Path: /ifcr/gsadmin/v1/{appName}/searchInterfaces
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/configuration/services/{serviceName}
Get Service Configuration
Method: get
Path: /ifcr/gsadmin/v1/{appName}/configuration/services/{serviceName}
Updates Service configuration
Method: put
Path: /ifcr/gsadmin/v1/{appName}/configuration/services/{serviceName}
View list of all configuration blocks
Method: get
Path: /ifcr/gsadmin/v1/{appName}/configuration
View list of all service configurations
Method: get
Path: /ifcr/gsadmin/v1/{appName}/configuration/services
Admin/Search And Navigation/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: /ifcr/gsadmin/v1/{appName}/thesaurus
Create thesaurus entry
Method: post
Path: /ifcr/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Delete thesaurus
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/thesaurus
Delete thesaurus entry
Method: delete
Path: /ifcr/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Partial update thesaurus
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/thesaurus
Partial update thesaurus entry
Method: patch
Path: /ifcr/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Update thesaurus
Method: put
Path: /ifcr/gsadmin/v1/{appName}/thesaurus
Update thesaurus entry
Method: put
Path: /ifcr/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
View thesaurus
Method: get
Path: /ifcr/gsadmin/v1/{appName}/thesaurus
View thesaurus entry
Method: get
Path: /ifcr/gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
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/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/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/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
atg.cloud.rest.endpoints.SlotDescriptorAdminEndpoints description
getAllSlotDescriptors
Method: get
Path: /ccadmin/v1/slotDescriptors
getConfigDefinitionForSlotDescriptor
Method: get
Path: /ccadmin/v1/slotDescriptors/{id}/config
updateHiddenSlotTypes
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
restoreStackSourceCode
Method: put
Path: /ccadmin/v1/stacks/{id}/code/restore
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/Theme Methods
Endpoints for operations on themes.
cloneTheme
Method: post
Path: /ccadmin/v1/themes/{id}/clone
deleteTheme
Method: delete
Path: /ccadmin/v1/themes/{id}
getActiveTheme
Method: get
Path: /ccadmin/v1/themes/active
getTheme
Method: get
Path: /ccadmin/v1/themes/{id}
getThemes
Method: get
Path: /ccadmin/v1/themes
getThemeSource
Method: get
Path: /ccadmin/v1/themes/{id}/source
restoreThemeSource
Method: put
Path: /ccadmin/v1/themes/{id}/restoreSource
setActiveTheme
Method: post
Path: /ccadmin/v1/themes/{id}/active
updateTheme
Method: put
Path: /ccadmin/v1/themes/{id}
updateThemeImage
Method: put
Path: /ccadmin/v1/themes/{id}/image
updateThemeSource
Method: put
Path: /ccadmin/v1/themes/{id}/source
Admin/Timezone
Endpoints for operations on timezones.
getTimezone
Method: get
Path: /ccadmin/v1/timezones/{id}
listTimezones
Method: get
Path: /ccadmin/v1/timezones
Admin/URL Patterns Methods
Endpoints for operations on URL Patterns.
listURLPatterns
Method: get
Path: /ccadmin/v1/urlPatterns
updateURLPattern
Method: put
Path: /ccadmin/v1/urlPatterns/{id}
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/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
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
restoreAllWidgetDescriptorJavascript
Method: put
Path: /ccadmin/v1/widgetDescriptors/{id}/javascript/restore
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
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
get SAML AuthnRequest
Method: get
Path: /ccagent/v1/saml/authnRequest
Agent/Agent SAML LogoutRequest
get SAML LogoutRequest
Method: get
Path: /ccagent/v1/saml/logoutRequest
Agent/Agent Service Provider Entity Descriptor
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
single log out
Method: post
Path: /ccagent/v1/saml/slo
Agent/Agent Single Sign On
single sign on
Method: post
Path: /ccagent/v1/saml/sso
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
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
getProfile
Method: get
Path: /ccagent/v1/profiles/{id}
getProfileAddress
Method: get
Path: /ccagent/v1/profiles/{id}/addresses/{addressId}
listProfileAddresses
Method: get
Path: /ccagent/v1/profiles/{id}/addresses
listSiteProperties
Method: get
Path: /ccagent/v1/profiles/{id}/siteProperties
resetPassword
Method: post
Path: /ccagent/v1/profiles/{id}
searchProfiles
Method: get
Path: /ccagent/v1/profiles
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}
startFileUpload
Method: put
Path: /ccagent/v1/files
Agent/Internal Profiles
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/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
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}
handleOrderActions
Method: post
Path: /ccagent/v1/orders/{id}
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
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/Payment
Payment endpoints.
addPayments
Method: post
Path: /ccagent/v1/payment
authPayment
Method: post
Path: /ccagent/v1/payment/auth
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/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/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/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
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
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
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
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/Assembler
Assembler endpoint assembles response from assembler based on the requested service.
assemble
Method: get
Path: /ccstore/v1/assembler/assemble
Store/Audience Membership
Endpoint for determining Audience membership
getAudienceMembership
Method: get
Path: /ccstore/v1/audienceMembership
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/Customers
Customer endpoints
addProfileAddress
Method: post
Path: /ccstore/v1/profiles/current/addresses
deleteProfileAddress
Method: delete
Path: /ccstore/v1/profiles/current/addresses/{addressId}
getProfileAddress
Method: get
Path: /ccstore/v1/profiles/current/addresses/{addressId}
listProfileAddresses
Method: get
Path: /ccstore/v1/profiles/current/addresses
updateProfileAddress
Method: put
Path: /ccstore/v1/profiles/current/addresses/{addressId}
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
getImages
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
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
getPriceListCurrency
Method: get
Path: /ccstore/v1/merchant/priceListCurrency
getReturnReasons
Method: get
Path: /ccstore/v1/merchant/returnReasons
getSamlSettings
Method: get
Path: /ccstore/v1/merchant/samlSettings
Store/Metadata
Metadata endpoints
getMetadata
Method: get
Path: /ccstore/v1/metadata/{id}
Store/Metadata Catalog
Metadata Catalog Store Endpoints
getMetadataCatalog
Method: get
Path: /ccstore/v1/metadata-catalog
Store/OAuth
OAuth endpoints
getEndpointAPI
Method: get
Path: /ccstore/v1/api/{id}
getEndpointAPIs
Method: get
Path: /ccstore/v1/api
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
approveOrder
Method: post
Path: /ccstore/v1/orders/approve
cancelOrder
Method: post
Path: /ccstore/v1/orders/cancel
checkRequiresApproval
Method: post
Path: /ccstore/v1/orders/checkRequiresApproval
createOrder
Method: post
Path: /ccstore/v1/orders
getAllOrdersForProfile
Method: get
Path: /ccstore/v1/orders
getGiftWithPurchaseChoices
Method: get
Path: /ccstore/v1/orders/getGiftWithPurchaseChoices
getIncompleteOrder
Method: get
Path: /ccstore/v1/orders/current
getInitialOrder
Method: post
Path: /ccstore/v1/orders/{id}
getOrder
Method: get
Path: /ccstore/v1/orders/{id}
getOrderConfirmation
Method: get
Path: /ccstore/v1/orders/confirmation/{uuid}
getValidActions
Method: get
Path: /ccstore/v1/orders/validActions/{id}
listReturnRequests
Method: get
Path: /ccstore/v1/orders/{id}/returnRequests
priceOrder
Method: post
Path: /ccstore/v1/orders/price
rejectOrder
Method: post
Path: /ccstore/v1/orders/reject
rejectQuote
Method: post
Path: /ccstore/v1/orders/rejectQuote
removeCurrentProfileIncompleteOrder
Method: delete
Path: /ccstore/v1/orders/current
removeProfileIncompleteOrderById
Method: delete
Path: /ccstore/v1/orders/remove/{id}
requestQuote
Method: post
Path: /ccstore/v1/orders/requestQuote
updateCurrentProfileOrder
Method: post
Path: /ccstore/v1/orders/current
updateOrder
Method: put
Path: /ccstore/v1/orders/{id}
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
getLayout
Method: get
Path: /ccstore/v1/pages/layout/{path: .*}
getPage
Method: get
Path: /ccstore/v1/pages/{path: .*}
getPages
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
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
Store/Profiles
Profile endpoints
createProfile
Method: post
Path: /ccstore/v1/profiles
getCurrentProfile
Method: get
Path: /ccstore/v1/profiles/current
listSiteProperties
Method: get
Path: /ccstore/v1/profiles/current/siteProperties
resetPassword
Method: post
Path: /ccstore/v1/profiles/resetPassword
updateExpiredPassword
Method: post
Path: /ccstore/v1/profiles/updateExpiredPassword
updateProfile
Method: put
Path: /ccstore/v1/profiles/current
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
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/SAML AuthnRequest
Endpoint to generate a new SAML AuthnRequest
samlAuthnRequest
Method: post
Path: /ccstore/v1/samlAuthnRequest
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/SearchSeo
SearchSeo endpoints
search
Method: get
Path: /ccstore/v1/assembler/pages/{path: .*}
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/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
Store/Shipping Regions
Shipping Regions Endpoints
getShippingRegionsByCountry
Method: get
Path: /ccstore/v1/shippingRegions
Store/Shopper Context Endpoint
Shopper Context endpoints
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
Store/Static Wishlist
Static Wishlist endpoints
generateStaticWishlistPage
Method: post
Path: /ccstore/v1/staticWishlistPages/{id}
Store/Stock Status
Stock Status endpoints
getStockStatus
Method: get
Path: /ccstore/v1/stockStatus/{id}
getStockStatuses
Method: get
Path: /ccstore/v1/stockStatus
Store/Timezone
Endpoints for operations on timezones.
getTimezone
Method: get
Path: /ccstore/v1/timezones/{id}
listTimezones
Method: get
Path: /ccstore/v1/timezones
Store/Web Analytics
Endpoints for operations related to web analytics like storing page counts, visits and visitor counts.
savePageViewsCount
Method: post
Path: /ccstore/v1/analytics/pageViews
saveVisitsAndVisitorsMetric
Method: post
Path: /ccstore/v1/analytics/visitorsMetric
Webhooks/ASA Additional Properties
asaAdditionalProperties
Method: post
Path: /ccadmin/v1/webhook/asaAdditionalProperties
Webhooks/Account Assets
Returns the services associated with a set of accounts, or a single service when the recordId is present.
accountAssets
Method: post
Path: /ccadmin/v1/webhook/accountAssets
Webhooks/Asset Actions
Returns action details associated with particular assets.
assetActions
Method: post
Path: /ccadmin/v1/webhook/assetActions
Webhooks/Calculate Shipping
Webhook for calculating shipping cost
Call external service to determine available shipping methods and prices.
Method: post
Path: /ccadmin/v1/webhook/calculateShipping
Webhooks/Cancel
The webHook notifies the external system that an order has been cancelled. This doc describes the attributes served by Cancel Order Webhook (for Non-PCI Compliant Target Systems).
cancel
Method: post
Path: /ccadmin/v1/webhook/cancel
Webhooks/Cancel PCI
The webHook notifies the external system that an order has been cancelled. This doc describes the attributes served by Cancel Order Webhook (for PCI Compliant Target Systems).
cancelPCI
Method: post
Path: /ccadmin/v1/webhook/cancelPCI
Webhooks/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
Webhooks/Contact Accounts
Returns billing, customer and service account information associated with the current profile.
contactAccounts
Method: post
Path: /ccadmin/v1/webhook/contactAccounts
Webhooks/Custom Currency
This webhook is used for Custom currency Payments
customCurrency
Method: post
Path: /ccadmin/v1/webhook/customCurrency
Webhooks/Data Export
The data export details in the Oracle Commerce Cloud
dataExport
Method: post
Path: /ccadmin/v1/webhook/dataExport
Webhooks/Data Import
The data import details in the Oracle Commerce Cloud
dataImport
Method: post
Path: /ccadmin/v1/webhook/dataImport
Webhooks/External Pricing
This event is triggered at 'add to cart' page requesting validation of external pricing details for products with external prices
externalPricing
Method: post
Path: /ccadmin/v1/webhook/externalPricing
Webhooks/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
Webhooks/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
Webhooks/Generic Card Payment
Integrates custom payment gateways that let your store accept card payment.
genericCardPayment
Method: post
Path: /ccadmin/v1/webhook/genericCardPayment
Webhooks/Generic Payment
Integrates custom payment gateways that let your store accept various payment types
genericPayment
Method: post
Path: /ccadmin/v1/webhook/genericPayment
Webhooks/Idle Cart
The details of idle cart in the Oracle Commerce Cloud
idleCart
Method: post
Path: /ccadmin/v1/webhook/idleCart
Webhooks/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
Webhooks/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
Webhooks/Order Approvals
checkOrderApprovalWebhook
Method: post
Path: /ccadmin/v1/webhook/checkOrderApprovalWebhook
Webhooks/Organization
The metadata for create/update account webhook.
organization
Method: post
Path: /ccadmin/v1/webhook/organization
Webhooks/Organization Request
The details of organization request created by Oracle Commerce
createOrganizationRequest
Method: post
Path: /ccadmin/v1/webhook/createOrganizationRequest
Webhooks/Publish Event
The publish event details in the Oracle Commerce Cloud
publishEvent
Method: post
Path: /ccadmin/v1/webhook/publishEvent
Webhooks/Redact Order
redactOrder
Method: post
Path: /ccadmin/v1/webhook/redactOrder
Webhooks/Remorse period started for a PCI order
The details of the PCI order created on the Oracle Commerce Cloud for which the remorse period has started
Remorse period started for a PCI order
Method: post
Path: /ccadmin/v1/webhook/remorsePeriodStartedPCI
Webhooks/Remorse period started for a non PCI order
The details of the non PCI order created on the Oracle Commerce Cloud for which the remorse period has started
Remorse period started for a non PCI order
Method: post
Path: /ccadmin/v1/webhook/remorsePeriodStarted
Webhooks/Request Quote
The details of quote requested by Oracle Commerce
requestQuote
Method: post
Path: /ccadmin/v1/webhook/requestQuote
Webhooks/Return
This Event is triggered when a return request is initiated. This doc describes the attributes served by Return Request Update Webhook (for Non-PCI Compliant Target Systems).
return
Method: post
Path: /ccadmin/v1/webhook/return
Webhooks/Return PCI
This Event is triggered when a return request is initiated. This doc describes the attributes served by Return Request Update Webhook (for PCI Compliant Target Systems).
returnPCI
Method: post
Path: /ccadmin/v1/webhook/returnPCI
Webhooks/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
Webhooks/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
Webhooks/Shopper Profile Delete
A registered shopper has been removed
Shopper Profile Delete
Method: post
Path: /ccadmin/v1/webhook/profileDelete
Webhooks/Shopper Profile Update
The details of customer profile being updated on Oracle Commerce Cloud.
Shopper Profile Update
Method: post
Path: /ccadmin/v1/webhook/profileUpdate
Webhooks/Update Quote
The details of quote and the operation requested by Oracle Commerce Cloud.
updateQuote
Method: post
Path: /ccadmin/v1/webhook/updateQuote