All REST Endpoints

Admin/Addresses
The operations from the Admin/Addresses category.
listAddresses
Method: get
Path: /ccadmin/v1/addresses
Admin/Admin Metadata Catalog
The operations from the Admin/Admin Metadata Catalog category.
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/Announcement and Quick Links
The operations from the Admin/Announcement and Quick Links category.
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/Applications
The operations from the Admin/Applications category.
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
The operations from the Admin/Asset Import-Export category.
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
The operations from the Admin/Asset Packages category.
getAssetPackage
Method: get
Path: /ccadmin/v1/assetPackages/{assetId}
Admin/Audience Rule Properties
The operations from the Admin/Audience Rule Properties category.
listAudienceRuleProperties
Method: get
Path: /ccadmin/v1/audienceRuleProperties
Admin/Audience Sizes
The operations from the Admin/Audience Sizes category.
audienceSizes
Method: post
Path: /ccadmin/v1/audienceSizes
Admin/Audience Usage
The operations from the Admin/Audience Usage category.
audienceUsage
Method: get
Path: /ccadmin/v1/audienceUsage/{id}
Admin/Audiences
The operations from the Admin/Audiences category.
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
The operations from the Admin/Blogs category.
listBlogEntries
Method: get
Path: /ccadmin/v1/blogs
Admin/Browser Types
The operations from the Admin/Browser Types category.
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
The operations from the Admin/Carriers category.
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
The operations from the Admin/Catalogs category.
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
The operations from the Admin/Claimables category.
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
The operations from the Admin/Collections category.
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
The operations from the Admin/Country Region category.
getCountryRegions
Method: get
Path: /ccadmin/v1/countries/{id}
listCountries
Method: get
Path: /ccadmin/v1/countries
Admin/Coupon Batches
The operations from the Admin/Coupon Batches category.
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
The operations from the Admin/Currency category.
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
The operations from the Admin/Currency Exchange Rate category.
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/Data Admin
The operations from the Admin/Data Admin category.
getAdminData
Method: get
Path: /ccadmin/v1/dataAdmin/{dataKey}
Admin/Elements
The operations from the Admin/Elements category.
getElements
Method: get
Path: /ccadmin/v1/elements
Admin/Email
The operations from the Admin/Email category.
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
The operations from the Admin/Email Notifications category.
sendEmailNotification
Method: post
Path: /ccadmin/v1/emailNotifications
Admin/Event WebHooks
The operations from the Admin/Event WebHooks category.
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
The operations from the Admin/Export Operations category.
listExportOperations
Method: get
Path: /ccadmin/v1/exportOperations
Admin/Export Process
The operations from the Admin/Export Process category.
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/Lint Jobs
The operations from the Admin/Extension Server/Lint Jobs category.
getCompletedLintJobs
Method: get
Path: /ccadminx/v1/lintJobs
lintJobExecutionRequest
Method: post
Path: /ccadminx/v1/lintJobs
Admin/Extension Server/Lint Status
The operations from the Admin/Extension Server/Lint Status category.
getLintStatus
Method: get
Path: /ccadminx/v1/lintStatus/{id}
Admin/Extension Server/Server Commands
The operations from the Admin/Extension Server/Server Commands category.
doServerPush
Method: post
Path: /ccadminx/v1/servers/push
doServerRestart
Method: post
Path: /ccadminx/v1/servers/restart
Admin/Extension Server/Test Jobs
The operations from the Admin/Extension Server/Test Jobs category.
getCompletedTestJobs
Method: get
Path: /ccadminx/v1/testJobs
testJobExecutionRequest
Method: post
Path: /ccadminx/v1/testJobs
Admin/Extension Server/Test Status
The operations from the Admin/Extension Server/Test Status category.
getTestStatus
Method: get
Path: /ccadminx/v1/testStatus/{id}
Admin/Extensions
The operations from the Admin/Extensions category.
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
The operations from the Admin/Failed WebHook Messages category.
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
The operations from the Admin/Files category.
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
The operations from the Admin/Function WebHooks category.
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
The operations from the Admin/Health Check category.
deletePaymentGatewayAuthorizationResponses
Method: delete
Path: /ccadmin/v1/healthCheck/payments
Admin/Import Operations
The operations from the Admin/Import Operations category.
listImportOperations
Method: get
Path: /ccadmin/v1/importOperations
Admin/Import Process
The operations from the Admin/Import Process category.
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
The operations from the Admin/Internal Profile Roles category.
listInternalProfileRoles
Method: get
Path: /ccadmin/v1/adminRoles
Admin/Internal Profiles
The operations from the Admin/Internal Profiles category.
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
The operations from the Admin/Inventory category.
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
The operations from the Admin/Item Types category.
getItemType
Method: get
Path: /ccadmin/v1/itemTypes/{id}
updateItemType
Method: put
Path: /ccadmin/v1/itemTypes/{id}
Admin/JsFrameworkAdminEndpoint
The operations from the Admin/JsFrameworkAdminEndpoint category.
getCurrentVersionDetails
Method: get
Path: /ccadmin/v1/jsframeworkadmin
rollbackCurrentVersion
Method: post
Path: /ccadmin/v1/jsframeworkadmin/rollbackVersion
upgradeCurrentVersion
Method: post
Path: /ccadmin/v1/jsframeworkadmin/upgradeVersion
Admin/Locales
The operations from the Admin/Locales category.
listLocales
Method: get
Path: /ccadmin/v1/locales
Admin/Locations
The operations from the Admin/Locations category.
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
The operations from the Admin/Logging category.
logClientErrors
Method: post
Path: /ccadmin/v1/logging/logClientErrors
Query the storefront server logs for client side errors.
Method: get
Path: /ccadmin/v1/logging
Admin/Media Tag
The operations from the Admin/Media Tag category.
listMediaTags
Method: get
Path: /ccadmin/v1/mediaTags
Admin/Merchant Settings
The operations from the Admin/Merchant Settings category.
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
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
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/Notification messages
The operations from the Admin/Notification messages category.
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
The operations from the Admin/Notification settings category.
getSettings
Method: get
Path: /ccadmin/v1/notificationSettings
updateSettings
Method: put
Path: /ccadmin/v1/notificationSettings
Admin/OAuth
The operations from the Admin/OAuth category.
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/Order Types
The operations from the Admin/Order Types category.
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 operations from the Admin/Orders category.
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
The operations from the Admin/Organization Request category.
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
The operations from the Admin/Organizations category.
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}
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
The operations from the Admin/PriceListGroup category.
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
updatePriceListGroup
Method: put
Path: /ccadmin/v1/priceListGroups/{id}
Admin/Prices
The operations from the Admin/Prices category.
listPrices
Method: get
Path: /ccadmin/v1/prices
updatePrices
Method: put
Path: /ccadmin/v1/prices
Admin/Product Types
The operations from the Admin/Product Types category.
addShopperInput
Method: post
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs
removeShopperInput
Method: delete
Path: /ccadmin/v1/productTypes/{typeId}/shopperInputs/{shopperInputId}
Admin/Products
The operations from the Admin/Products category.
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
The operations from the Admin/Profile Context List category.
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 operations from the Admin/Profiles category.
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}
updateUserRoles
Method: post
Path: /ccadmin/v1/profiles/{id}/updateUserRoles
Admin/Promotion Folders
The operations from the Admin/Promotion Folders category.
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
The operations from the Admin/Promotion Templates category.
getPromotionTemplate
Method: get
Path: /ccadmin/v1/promotionTemplates/{id}
listPromotionTemplates
Method: get
Path: /ccadmin/v1/promotionTemplates
Admin/Promotions
The operations from the Admin/Promotions category.
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
The operations from the Admin/Publishing category.
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
The operations from the Admin/Publishing Change Authors category.
getAllPublishingChangeAuthors
Method: get
Path: /ccadmin/v1/publishingChangeAuthors
Admin/Publishing Change Lists
The operations from the Admin/Publishing Change Lists category.
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
The operations from the Admin/Publishing Changes category.
getPublishingChanges
Method: get
Path: /ccadmin/v1/publishingChanges
Admin/Reasons
The operations from the Admin/Reasons category.
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/Report Filter Configuration
The operations from the Admin/Report Filter Configuration category.
listReportFilterConfigurations
Method: get
Path: /ccadmin/v1/reportFilterConfigurations
saveReportFilterConfiguration
Method: post
Path: /ccadmin/v1/reportFilterConfigurations
updateReportFilterConfiguration
Method: put
Path: /ccadmin/v1/reportFilterConfigurations/{id}
Admin/Reports
The operations from the Admin/Reports category.
exportReportData
Method: get
Path: /ccadmin/v1/reports/export
getReportData
Method: post
Path: /ccadmin/v1/reports/{id}
Admin/Response Filters
The operations from the Admin/Response Filters category.
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/SAML IdP Settings
The operations from the Admin/SAML IdP Settings category.
getSamlIdPSettings
Method: get
Path: /ccadmin/v1/samlIdentityProviders/{id}
updateSamlIdPSettings
Method: put
Path: /ccadmin/v1/samlIdentityProviders/{id}
Admin/Search Admin
The operations from the Admin/Search Admin category.
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: /gsadmin/v1/{appName}/{resourcePath}
Delete a resource configuration
Method: delete
Path: /gsadmin/v1/{appName}/{resourcePath}
Delete application configuration
Method: delete
Path: /gsadmin/v1/{appName}
Download application configuration
Method: get
Path: /gsadmin/v1/{appName}.zip
Download resource configuration
Method: get
Path: /gsadmin/v1/{appName}/{resourcePath}.zip
Import application configuration
Method: post
Path: /gsadmin/v1/{appName}
Admin/Search 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: /gsadmin/v1/{appName}/content/facets/{facetListName}
deleteFacetList
Method: delete
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
getFacetList
Method: get
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
listFacetLists
Method: get
Path: /gsadmin/v1/{appName}/content/facets
updateFacetList
Method: put
Path: /gsadmin/v1/{appName}/content/facets/{facetListName}
Admin/Search 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: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Create index attributes
Method: post
Path: /gsadmin/v1/{appName}/attributes
Create owner attributes
Method: post
Path: /gsadmin/v1/{appName}/attributes/{owner}
Delete an index attribute
Method: delete
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Delete index Attributes
Method: delete
Path: /gsadmin/v1/{appName}/attributes
Delete owner index attributes
Method: delete
Path: /gsadmin/v1/{appName}/attributes/{owner}
Partial update an index attribute
Method: patch
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Partial update index attributes
Method: patch
Path: /gsadmin/v1/{appName}/attributes
Partial update owner attributes
Method: patch
Path: /gsadmin/v1/{appName}/attributes/{owner}
Update an index attribute
Method: put
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
Update index attributes
Method: put
Path: /gsadmin/v1/{appName}/attributes
Update owner attributes
Method: put
Path: /gsadmin/v1/{appName}/attributes/{owner}
View index attribute
Method: get
Path: /gsadmin/v1/{appName}/attributes/{owner}/{attributeName}
View index attributes
Method: get
Path: /gsadmin/v1/{appName}/attributes
View owner attributes
Method: get
Path: /gsadmin/v1/{appName}/attributes/{owner}
Admin/Search 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: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Create Keyword Redirect Group.
Method: post
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Create Keyword Redirects Configuration
Method: post
Path: /gsadmin/v1/{appName}/redirects
Delete Keyword Redirect Entry
Method: delete
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Delete Keyword Redirect Group
Method: delete
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Delete Keyword Redirects
Method: delete
Path: /gsadmin/v1/{appName}/redirects
Partial update Keyword Redirect Entry.
Method: patch
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Partial update Keyword Redirect Group.
Method: patch
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Partial update Keyword Redirects Configuration
Method: patch
Path: /gsadmin/v1/{appName}/redirects
Update an Keyword Redirect Entry.
Method: put
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
Update Keyword Redirect Group.
Method: put
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
Update Keyword Redirects configuration
Method: put
Path: /gsadmin/v1/{appName}/redirects
View Keyword Redirect Entry.
Method: get
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}/{redirectEntry}
View Keyword Redirect Group.
Method: get
Path: /gsadmin/v1/{appName}/redirects/{redirectGroup}
View Keyword Redirects
Method: get
Path: /gsadmin/v1/{appName}/redirects
Admin/Search 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: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Creates a page root for a application
Method: post
Path: /gsadmin/v1/{appName}/pages
Creates a site for a application
Method: post
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Delete page root of a application
Method: delete
Path: /gsadmin/v1/{appName}/pages
Deletes the page.
Method: delete
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Deletes the site.
Method: delete
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Gets a list of immediate pages defined under site home
Method: get
Path: /gsadmin/v1/{appName}/pages/{siteHome}
Gets a Page configuration or lists down immediate pages under requested page.
Method: get
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
Updates a page configuration
Method: put
Path: /gsadmin/v1/{appName}/pages/{siteHome}/{page}
View all sites defined in a application
Method: get
Path: /gsadmin/v1/{appName}/pages
Admin/Search 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: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Creates content collection folder at specified location.
Method: post
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}
Creates content node for a application
Method: post
Path: /gsadmin/v1/{appName}/content
Delete content node of a application
Method: delete
Path: /gsadmin/v1/{appName}/content
Deletes a content collection folder.
Method: delete
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}
Deletes a Rule.
Method: delete
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
Updates a rule configuration.
Method: put
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View content collection folders under 'content' root node.
Method: get
Path: /gsadmin/v1/{appName}/content
View rule definition
Method: get
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}/{Rule}
View rules and content collection folders under specified content collection folder.
Method: get
Path: /gsadmin/v1/{appName}/content/{contentCollectionFolder}
Admin/Search 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: /gsadmin/v1/{appName}/searchIndexConfig
Delete search index configuration
Method: delete
Path: /gsadmin/v1/{appName}/searchIndexConfig
Partial update search index configuration
Method: patch
Path: /gsadmin/v1/{appName}/searchIndexConfig
Update search index configuration
Method: put
Path: /gsadmin/v1/{appName}/searchIndexConfig
View search index configuration
Method: get
Path: /gsadmin/v1/{appName}/searchIndexConfig
Admin/Search 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: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Create a search interface folder
Method: post
Path: /gsadmin/v1/{appName}/searchInterfaces
Delete a search interface
Method: delete
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Delete a search interface folder
Method: delete
Path: /gsadmin/v1/{appName}/searchInterfaces
Partial update a search interface
Method: patch
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Partial update a search interface folder
Method: patch
Path: /gsadmin/v1/{appName}/searchInterfaces
Update a search interface
Method: put
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Update a search interface folder
Method: put
Path: /gsadmin/v1/{appName}/searchInterfaces
View a search interface
Method: get
Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
View a search interface folder
Method: get
Path: /gsadmin/v1/{appName}/searchInterfaces
Admin/Search 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: /gsadmin/v1/{appName}/configuration/services/{serviceName}
Get Service Configuration
Method: get
Path: /gsadmin/v1/{appName}/configuration/services/{serviceName}
Updates Service configuration
Method: put
Path: /gsadmin/v1/{appName}/configuration/services/{serviceName}
View list of all configuration blocks
Method: get
Path: /gsadmin/v1/{appName}/configuration
View list of all service configurations
Method: get
Path: /gsadmin/v1/{appName}/configuration/services
Admin/Search 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: /gsadmin/v1/{appName}/thesaurus
Create thesaurus entry
Method: post
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Delete thesaurus
Method: delete
Path: /gsadmin/v1/{appName}/thesaurus
Delete thesaurus entry
Method: delete
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Partial update thesaurus
Method: patch
Path: /gsadmin/v1/{appName}/thesaurus
Partial update thesaurus entry
Method: patch
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Update thesaurus
Method: put
Path: /gsadmin/v1/{appName}/thesaurus
Update thesaurus entry
Method: put
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
View thesaurus
Method: get
Path: /gsadmin/v1/{appName}/thesaurus
View thesaurus entry
Method: get
Path: /gsadmin/v1/{appName}/thesaurus/{thesaurusEntryId}
Admin/Server Extensions
The operations from the Admin/Server Extensions category.
doDeleteSSEFile
Method: delete
Path: /ccadmin/v1/serverExtensions/{id:.*}
doDeleteSSEFiles
Method: post
Path: /ccadmin/v1/serverExtensions/deleteFiles
doDeploySSEFiles
Method: post
Path: /ccadmin/v1/serverExtensions/deployFiles
listSSEFiles
Method: get
Path: /ccadmin/v1/serverExtensions
Admin/Shipping Methods
The operations from the Admin/Shipping Methods category.
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
The operations from the Admin/Shipping Regions category.
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
The operations from the Admin/Shopper Input category.
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
The operations from the Admin/Shopper Types category.
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
The operations from the Admin/Site Create Forms category.
createSiteFromForm
Method: post
Path: /ccadmin/v1/siteCreateForms/{id}
Admin/Sites
The operations from the Admin/Sites category.
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
The operations from the Admin/Sites Settings category.
getCustomSiteSettings
Method: get
Path: /ccadmin/v1/sitesettings/{id}
listSiteSettings
Method: get
Path: /ccadmin/v1/sitesettings
setSiteSettingConfigData
Method: put
Path: /ccadmin/v1/sitesettings/{id}
Admin/Skus
The operations from the Admin/Skus category.
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/StackingRules
The operations from the Admin/StackingRules category.
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/Tax Processor Manager
The operations from the Admin/Tax Processor Manager category.
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/Timezone
The operations from the Admin/Timezone category.
getTimezone
Method: get
Path: /ccadmin/v1/timezones/{id}
listTimezones
Method: get
Path: /ccadmin/v1/timezones
Admin/URL Patterns Methods
The operations from the Admin/URL Patterns Methods category.
listURLPatterns
Method: get
Path: /ccadmin/v1/urlPatterns
updateURLPattern
Method: put
Path: /ccadmin/v1/urlPatterns/{id}
Admin/Variants
The operations from the Admin/Variants category.
createProductTypeVariant
Method: post
Path: /ccadmin/v1/productVariants
updateProductTypeVariant
Method: put
Path: /ccadmin/v1/productVariants/{id}
Agent/Agent Comments
The operations from the Agent/Agent Comments category.
createComment
Method: post
Path: /ccagent/v1/comments
getComments
Method: get
Path: /ccagent/v1/comments
Agent/Agent Metadata Catalog
The operations from the Agent/Agent Metadata Catalog category.
getMetadataCatalog
Method: get
Path: /ccagent/v1/metadata-catalog
getResourceMetadata
Method: get
Path: /ccagent/v1/metadata-catalog/{id}
Agent/Collections
The operations from the Agent/Collections category.
getCollection
Method: get
Path: /ccagent/v1/collections/{id}
listCollections
Method: get
Path: /ccagent/v1/collections
Agent/Currency
The operations from the Agent/Currency category.
getCurrency
Method: get
Path: /ccagent/v1/currencies/{id}
listCurrencies
Method: get
Path: /ccagent/v1/currencies
Agent/Customers
The operations from the Agent/Customers category.
addProfileAddress
Method: post
Path: /ccagent/v1/profiles/{id}/addresses
createProfile
Method: post
Path: /ccagent/v1/profiles
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
The operations from the Agent/Exchange Order category.
createExchangeRequest
Method: post
Path: /ccagent/v1/exchanges
Agent/Files
The operations from the Agent/Files category.
doFileSegmentUpload
Method: post
Path: /ccagent/v1/files/{id}
startFileUpload
Method: put
Path: /ccagent/v1/files
Agent/Item Types
The operations from the Agent/Item Types category.
getItemType
Method: get
Path: /ccagent/v1/itemTypes/{id}
listItemTypes
Method: get
Path: /ccagent/v1/itemTypes
Agent/List Country Region
The operations from the Agent/List Country Region category.
listShippingCountries
Method: get
Path: /ccagent/v1/validShippingCountries
Agent/Merchant Settings
The operations from the Agent/Merchant Settings category.
getAgentConfiguration
Method: get
Path: /ccagent/v1/merchant/agentConfiguration
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
The operations from the Agent/Metadata category.
getMetadata
Method: get
Path: /ccagent/v1/metadata/{id}
Agent/OAuth
The operations from the Agent/OAuth category.
getEndpointAPI
Method: get
Path: /ccagent/v1/api/{id}
getEndpointAPIs
Method: get
Path: /ccagent/v1/api
getRegistry
Method: get
Path: /ccagent/v1/registry
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/Order Amendment
The operations from the Agent/Order Amendment category.
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
The operations from the Agent/Order Types category.
getOrderType
Method: get
Path: /ccagent/v1/orderTypes/{id}
listOrderTypes
Method: get
Path: /ccagent/v1/orderTypes
Agent/Orders
The operations from the Agent/Orders category.
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
The operations from the Agent/Organization Members category.
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
The operations from the Agent/Organization Request category.
getOrganizationRequests
Method: get
Path: /ccagent/v1/organizationRequests/{id}
listOrganizationRequests
Method: get
Path: /ccagent/v1/organizationRequests
Agent/Organizations
The operations from the Agent/Organizations category.
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
The operations from the Agent/Organizations Address List category.
listAddresses
Method: get
Path: /ccagent/v1/addresses
Agent/Organizations Addresses
The operations from the Agent/Organizations Addresses category.
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
The operations from the Agent/Payment category.
addPayments
Method: post
Path: /ccagent/v1/payment
Agent/Payment Groups
The operations from the Agent/Payment Groups category.
getPaymentGroup
Method: get
Path: /ccagent/v1/paymentGroups/{id}
Agent/Prices
The operations from the Agent/Prices category.
getAllPrices
Method: get
Path: /ccagent/v1/prices/{id}
Agent/Product Variants
The operations from the Agent/Product Variants category.
listProductVariants
Method: get
Path: /ccagent/v1/variants
Agent/Products
The operations from the Agent/Products category.
getProduct
Method: get
Path: /ccagent/v1/products/{id}
listProducts
Method: get
Path: /ccagent/v1/products
Agent/PurchaseLists
The operations from the Agent/PurchaseLists category.
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
The operations from the Agent/Reports category.
getReport
Method: get
Path: /ccagent/v1/agentReports/{id}
Agent/Return Order
The operations from the Agent/Return Order category.
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
The operations from the Agent/Scheduled Orders category.
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
The operations from the Agent/Search category.
search
Method: get
Path: /ccagent/v1/search
Agent/Shipping Methods
The operations from the Agent/Shipping Methods category.
getShippingMethod
Method: get
Path: /ccagent/v1/shippingMethods/{id}
listShippingMethods
Method: post
Path: /ccagent/v1/shippingMethods
Agent/Shopper Context Endpoint
The operations from the Agent/Shopper Context Endpoint category.
setShopperContext
Method: post
Path: /ccagent/v1/shopperContext
Agent/Shopper Types
The operations from the Agent/Shopper Types category.
getShopperType
Method: get
Path: /ccagent/v1/shopperTypes/{id}
listShopperTypes
Method: get
Path: /ccagent/v1/shopperTypes
Agent/Sites
The operations from the Agent/Sites category.
getSite
Method: get
Path: /ccagent/v1/sites/{id}
getSites
Method: get
Path: /ccagent/v1/sites
Agent/Sku
The operations from the Agent/Sku category.
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
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}
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
The operations from the Store/Assembler category.
assemble
Method: get
Path: /ccstore/v1/assembler/assemble
Store/Audience Membership
The operations from the Store/Audience Membership category.
getAudienceMembership
Method: get
Path: /ccstore/v1/audienceMembership
Store/Collections
The operations from the Store/Collections category.
getCollection
Method: get
Path: /ccstore/v1/collections/{id}
listCollections
Method: get
Path: /ccstore/v1/collections
Store/Country Region
The operations from the Store/Country Region category.
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
The operations from the Store/Currency category.
getCurrency
Method: get
Path: /ccstore/v1/currencies/{id}
listCurrencies
Method: get
Path: /ccstore/v1/currencies
Store/Customers
The operations from the Store/Customers category.
addProfileAddress
Method: post
Path: /ccstore/v1/profiles/current/addresses
deleteProfileAddress
Method: delete
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
The operations from the Store/Error Log Entries category.
createErrorlog
Method: post
Path: /ccstore/v1/errorLogs
Store/Files
The operations from the Store/Files category.
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
The operations from the Store/Health Check category.
getPaymentGatewayAuthorizationHealthCheck
Method: get
Path: /ccstore/v1/healthCheck/payments
updatePaymentGatewayAuthorizationHealth
Method: put
Path: /ccstore/v1/healthCheck/payments
Store/Images
The operations from the Store/Images category.
getImages
Method: get
Path: /ccstore/v1/images
Store/Inventory
The operations from the Store/Inventory category.
getInventory
Method: get
Path: /ccstore/v1/inventories/{id}
listInventories
Method: get
Path: /ccstore/v1/inventories
Store/Item Types
The operations from the Store/Item Types category.
getItemType
Method: get
Path: /ccstore/v1/itemTypes/{id}
listItemTypes
Method: get
Path: /ccstore/v1/itemTypes
Store/Locations
The operations from the Store/Locations category.
getLocation
Method: get
Path: /ccstore/v1/locations/{id}
listLocations
Method: get
Path: /ccstore/v1/locations
Store/Logging
The operations from the Store/Logging category.
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
The operations from the Store/Merchant Settings category.
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
The operations from the Store/Metadata category.
getMetadata
Method: get
Path: /ccstore/v1/metadata/{id}
Store/OAuth
The operations from the Store/OAuth category.
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
The operations from the Store/Orders category.
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
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 operations from the Store/Organization Members category.
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
The operations from the Store/Organization Request category.
createOrganizationRequest
Method: post
Path: /ccstore/v1/organizationRequests
Store/Organizations
The operations from the Store/Organizations category.
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
The operations from the Store/Organizations Address List category.
listAddresses
Method: get
Path: /ccstore/v1/addresses
Store/Organizations Addresses
The operations from the Store/Organizations Addresses category.
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
The operations from the Store/Pages category.
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
The operations from the Store/Payment category.
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
The operations from the Store/Payment Groups category.
getPaymentGroup
Method: get
Path: /ccstore/v1/paymentGroups/{id}
Store/PriceListGroup
The operations from the Store/PriceListGroup category.
getPriceListGroup
Method: get
Path: /ccstore/v1/priceListGroups/{id}
listPriceListGroups
Method: get
Path: /ccstore/v1/priceListGroups
Store/Prices
The operations from the Store/Prices category.
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 Types
The operations from the Store/Product Types category.
getProductType
Method: get
Path: /ccstore/v1/productTypes/{id}
listProductTypes
Method: get
Path: /ccstore/v1/productTypes
Store/Products
The operations from the Store/Products category.
getProduct
Method: get
Path: /ccstore/v1/products/{id}
listProducts
Method: get
Path: /ccstore/v1/products
Store/Profiles
The operations from the Store/Profiles category.
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
The operations from the Store/Publishing category.
getLastPublishedTime
Method: get
Path: /ccstore/v1/publish
pushPubEvent
Method: post
Path: /ccstore/v1/publish/event
Store/PurchaseLists
The operations from the Store/PurchaseLists category.
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
The operations from the Store/Resources category.
getResourceBundle
Method: get
Path: /ccstore/v1/resources/{bundle}
Store/Return Requests
The operations from the Store/Return Requests category.
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
The operations from the Store/SAML AuthnRequest category.
samlAuthnRequest
Method: post
Path: /ccstore/v1/samlAuthnRequest
Store/Scheduled Orders
The operations from the Store/Scheduled Orders category.
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
The operations from the Store/Search category.
search
Method: get
Path: /ccstore/v1/search
Store/Services
The operations from the Store/Services category.
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
The operations from the Store/Shipping Methods category.
getShippingMethod
Method: get
Path: /ccstore/v1/shippingMethods/{id}
listShippingMethods
Method: post
Path: /ccstore/v1/shippingMethods
Store/Shipping Regions
The operations from the Store/Shipping Regions category.
getShippingRegionsByCountry
Method: get
Path: /ccstore/v1/shippingRegions
Store/Shopper Context Endpoint
The operations from the Store/Shopper Context Endpoint category.
setShopperContext
Method: post
Path: /ccstore/v1/shopperContext
Store/Sites
The operations from the Store/Sites category.
getSite
Method: get
Path: /ccstore/v1/sites/{id}
listSites
Method: get
Path: /ccstore/v1/sites
Store/Skus
The operations from the Store/Skus category.
getSku
Method: get
Path: /ccstore/v1/skus/{id}
listSkus
Method: get
Path: /ccstore/v1/skus
Store/Static Wishlist
The operations from the Store/Static Wishlist category.
generateStaticWishlistPage
Method: post
Path: /ccstore/v1/staticWishlistPages/{id}
Store/Stock Status
The operations from the Store/Stock Status category.
getStockStatus
Method: get
Path: /ccstore/v1/stockStatus/{id}
getStockStatuses
Method: get
Path: /ccstore/v1/stockStatus
Store/Store Metadata Catalog
The operations from the Store/Store Metadata Catalog category.
getMetadataCatalog
Method: get
Path: /ccstore/v1/metadata-catalog
Store/Timezone
The operations from the Store/Timezone category.
getTimezone
Method: get
Path: /ccstore/v1/timezones/{id}
listTimezones
Method: get
Path: /ccstore/v1/timezones
Store/Web Analytics
The operations from the Store/Web Analytics category.
savePageViewsCount
Method: post
Path: /ccstore/v1/analytics/pageViews
saveVisitsAndVisitorsMetric
Method: post
Path: /ccstore/v1/analytics/visitorsMetric
Webhooks/ASA Additional Properties
The operations from the Webhooks/ASA Additional Properties category.
asaAdditionalProperties
Method: post
Path: /ccadmin/v1/webhook/asaAdditionalProperties
Webhooks/Account Assets
The operations from the Webhooks/Account Assets category.
accountAssets
Method: post
Path: /ccadmin/v1/webhook/accountAssets
Webhooks/Asset Actions
The operations from the Webhooks/Asset Actions category.
assetActions
Method: post
Path: /ccadmin/v1/webhook/assetActions
Webhooks/Calculate Shipping
The operations from the Webhooks/Calculate Shipping category.
calculateShipping
Method: post
Path: /ccadmin/v1/webhook/calculateShipping
Webhooks/Catalog and Price Group Assignment
The operations from the Webhooks/Catalog and Price Group Assignment category.
externalPriceGroupAndCatalog
Method: post
Path: /ccadmin/v1/webhook/externalPriceGroupAndCatalog
Webhooks/Contact Accounts
The operations from the Webhooks/Contact Accounts category.
contactAccounts
Method: post
Path: /ccadmin/v1/webhook/contactAccounts
Webhooks/Custom Currency
The operations from the Webhooks/Custom Currency category.
customCurrency
Method: post
Path: /ccadmin/v1/webhook/customCurrency
Webhooks/Data Export
The operations from the Webhooks/Data Export category.
dataExport
Method: post
Path: /ccadmin/v1/webhook/dataExport
Webhooks/Data Import
The operations from the Webhooks/Data Import category.
dataImport
Method: post
Path: /ccadmin/v1/webhook/dataImport
Webhooks/External Pricing
The operations from the Webhooks/External Pricing category.
externalPricing
Method: post
Path: /ccadmin/v1/webhook/externalPricing
Webhooks/External Tax Calculation
The operations from the Webhooks/External Tax Calculation category.
externalTaxCalculation
Method: post
Path: /ccadmin/v1/webhook/externalTaxCalculation
Webhooks/Generic Card Payment
The operations from the Webhooks/Generic Card Payment category.
genericCardPayment
Method: post
Path: /ccadmin/v1/webhook/genericCardPayment
Webhooks/Generic Payment
The operations from the Webhooks/Generic Payment category.
genericPayment
Method: post
Path: /ccadmin/v1/webhook/genericPayment
Webhooks/Idle Cart
The operations from the Webhooks/Idle Cart category.
idleCart
Method: post
Path: /ccadmin/v1/webhook/idleCart
Webhooks/Non PCI Return Request Validation
The operations from the Webhooks/Non PCI Return Request Validation category.
returnRequestValidationForNonPCITargets
Method: post
Path: /ccadmin/v1/webhook/returnRequestValidationForNonPCITargets
Webhooks/Order
The operations from the Webhooks/Order category.
order
Method: post
Path: /ccadmin/v1/webhook/order
Webhooks/Order Approvals
The operations from the Webhooks/Order Approvals category.
checkOrderApprovalWebhook
Method: post
Path: /ccadmin/v1/webhook/checkOrderApprovalWebhook
Webhooks/Organization
The operations from the Webhooks/Organization category.
organization
Method: post
Path: /ccadmin/v1/webhook/organization
Webhooks/Organization Request
The operations from the Webhooks/Organization Request category.
createOrganizationRequest
Method: post
Path: /ccadmin/v1/webhook/createOrganizationRequest
Webhooks/Publish Event
The operations from the Webhooks/Publish Event category.
publishEvent
Method: post
Path: /ccadmin/v1/webhook/publishEvent
Webhooks/Redact Order
The operations from the Webhooks/Redact Order category.
redactOrder
Method: post
Path: /ccadmin/v1/webhook/redactOrder
Webhooks/Request Quote
The operations from the Webhooks/Request Quote category.
requestQuote
Method: post
Path: /ccadmin/v1/webhook/requestQuote
Webhooks/Return
The operations from the Webhooks/Return category.
return
Method: post
Path: /ccadmin/v1/webhook/return
Webhooks/Return PCI
The operations from the Webhooks/Return PCI category.
returnPCI
Method: post
Path: /ccadmin/v1/webhook/returnPCI
Webhooks/Return Request Validation
The operations from the Webhooks/Return Request Validation category.
returnRequestValidation
Method: post
Path: /ccadmin/v1/webhook/returnRequestValidation
Webhooks/Shopper Profile Create
The operations from the Webhooks/Shopper Profile Create category.
Shopper Profile Create
Method: post
Path: /ccadmin/v1/webhook/profile
Webhooks/Shopper Profile Delete
The operations from the Webhooks/Shopper Profile Delete category.
Shopper Profile Delete
Method: post
Path: /ccadmin/v1/webhook/profileDelete
Webhooks/Shopper Profile Update
The operations from the Webhooks/Shopper Profile Update category.
Shopper Profile Update
Method: post
Path: /ccadmin/v1/webhook/profileUpdate
Webhooks/Update Quote
The operations from the Webhooks/Update Quote category.
updateQuote
Method: post
Path: /ccadmin/v1/webhook/updateQuote