Oracle Commerce Cloud REST API

https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/
Admin
Oracle Commerce Cloud REST API provides comprehensive endpoints for managing commerce operations...
Tokens:3,980,967
Snippets:43,083
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Response for Text Search Setup

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-merchant-textsearch-put.html

Example JSON response indicating the successful initiation of the text search setup with scheduled jobs.

```json
{
    "setUpRunning":true,
    "scheduledJobsInputData":[
        {
            "schedule":{
                "period":1000000,
                "catchUp":false
            },
            "scheduledJobName":"profileIncrementalIndexingSchedule",
            "scheduleType":"periodic",
            "scheduleDescription":"every 1000 seconds without catch up"
        },
        {
            "schedule":{
                "daysInMonth":[
                ],
                "weeksInMonth":[
                    1,
                    2,
                    3,
                    4,
                    5
                ],
                "monthsInYear":[
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10,
                    11
                ],
                "daysOfWeek":[
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7
                ],
                "occurrenceInDay":2
            },
            "scheduledJobName":"orderOptimizationSchedule",
            "scheduleType":"calendar",
            "scheduleDescription":"months:Jan-Dec dates: daysOfWeek:Sun-Sat occurrencesInMonth:1-last hours:11,23 minutes:0"
        },
        {
            "schedule":{
                "daysInMonth":[
                ],
                "weeksInMonth":[
                    1,
                    2,
                    3
                ],
                "monthsInYear":[
                    1,
                    3
                ],
                "daysOfWeek":[
                    1,
                    2,
                    3
                ],
                "occurrenceInDay":2
            },
            "scheduledJobName":"profileOptimizationSchedule",
            "scheduleType":"calendar",
            "scheduleDescription":"months:Feb,Apr dates: daysOfWeek:Sun-Tue occurrencesInMonth:1-3 hours:11,23 minutes:0"
        },
        {
            "schedule":{
                "period":1000000,
                "catchUp":false
            },
            "scheduledJobName":"orderIncrementalIndexingSchedule",
            "scheduleType":"periodic",
            "scheduleDescription":"every 1000 seconds without catch up"
        }
    ],
    "errorMessage":"",
    "enabled":false,
    "statusMessage":"Text Search setup has been successfully initiated with the given scheduledJobs input data. Once the setup is completed 'enabled' will be true."
}
```

--------------------------------

### Example GET Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-recommendationstrategies-get.html

A sample JSON response returned by the recommendation strategies endpoint.

```json
{
    "totalResults":4,
    "endingIndex":250,
    "offset":0,
    "totalResultsParam":true,
    "count":4,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/recommendationStrategies"
        }
    ],
    "sort":{
        "collator":null,
        "localeSensitiveSorting":false,
        "numDirectives":1,
        "empty":false
    },
    "items":[
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"browsedTogether"
                        }
                    ]
                }
            ],
            "displayName":"browsedTogether",
            "description":"This is a description of browsedTogether",
            "id":"browsedTogether"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"mostRecentlyViewed"
                        }
                    ]
                }
            ],
            "displayName":"mostRecentlyViewed",
            "description":"This is a description of mostRecentlyViewed",
            "id":"mostRecentlyViewed"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"purchasedTogether"
                        }
                    ]
                }
            ],
            "displayName":"purchasedTogether",
            "description":"This is a description of purchasedTogether",
            "id":"purchasedTogether"
        },
        {
            "recommendationGroups":[
                {
                    "numRecs":5,
                    "conditions":[
                        {
                            "id":"topSellers"
                        }
                    ]
                }
            ],
            "displayName":"topSellers",
            "description":"This is a description of topSellers",
            "id":"topSellers"
        }
    ],
    "collectionPaged":true,
    "listingRequest":null,
    "startingIndex":0,
    "totalNumberOfItems":4
}
```

--------------------------------

### Product GET Response Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-products-id-get.html

Sample JSON response for a product retrieval request.

```json
{
    "dynamicPropertyMapLong":{
    },
    "productSource":"CPQ",
    "catalogsCount":2,
    "largeImage":{
        "repositoryId":"m2502",
        "url":"/cloudlakeimages/crsdocroot/content/images/products/full/HOME_ArmyRadio_full.jpg"
    },
    "keywords":[
        "offers",
        "batteries",
        "traditional",
        "requires",
        "army",
        "fm",
        "life",
        "battery",
        "radio",
        "included",
        "styling",
        "vintage-style",
        "inspired",
        "sounds"
    ],
    "orderable":null,
    "relatedProducts":[
        {
            "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=100&width=100",
            "largeImage":null,
            "listVolumePrice":null,
            "nonreturnable":false,
            "displayName":"A-Line Skirt",
            "description":"The simple perfect A line",
            "primaryFullImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg",
            "type":"1102",
            "largeImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=940&width=940"
            ],
            "listVolumePrices":{
            },
            "primaryLargeImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=940&width=940",
            "smallImageURLs":[
                "/ccstore/v1/images/?source=http://localhost:9080/file/products/APP_A-lineSkirt_full.jpg&height=300&width=300"
            ],
            "derivedShippingSurchargeFrom":"UsDollar",
            "derivedSalePriceFrom":"UsDollar",
            "id":"xprod2535",
            "brand":"CricketClub",
            "salePriceEndDate":null,
            "clonedFrom":null,
            "childSKUs":[
                {
                    "dynamicPropertyMapLong":{
                        "sku-WomensApparel_color":13,
                        "sku-WomensApparel_size":0
```

--------------------------------

### Request Schema and Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-servers-restartworkrequeststatus-get.html

JSON schema for the request and a sample GET request URL.

```json
{
    "properties":{
    },
    "example":"GET /ccadminx/custom/v1/servers/restartWorkRequestStatus?workRequestId=mblNhrQ2D2"
}
```

```http
GET /ccadminx/custom/v1/servers/restartWorkRequestStatus?workRequestId=mblNhrQ2D2
```

--------------------------------

### Start File Upload Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-files-put.html

A basic request body example for starting a file upload.

```json
{
    "filename":"sampleFile.png",
    "segments":4
}
```

--------------------------------

### Full Site Configuration Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-sites-post.html

A complete JSON object representing a site configuration with price lists, inventory locations, and timezone settings.

```json
{
    "properties":{
        "priceListGroupList":[
            {
                "id":"EURO"
            },
            {
                "id":"defaultPriceGroup"
            }
        ],
        "timeToLive":5000,
        "inventoryLocationId":"SiteUS-GlenAllen187",
        "inventoryLocations":[
            "SiteUS-GlenAllen187",
            "SiteUS-GlenAllen188"
        ],
        "timezone":"europe_london",
        "name":"CloudLake US Site test",
        "allowedOriginMethods":{
            "https://somemoresecurehost":"GET",
            "https://someHost:9080":"GET,PUT,DELETE,POST,OPTIONS"
        },
        "siteTypes":[
            "b2bCommerce"
        ]
    }
}
```

--------------------------------

### Get member request example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-swm-rs-v1-spaces-spaceid-members-userid-get.html

Example of a GET request to retrieve a specific user member by space and user ID.

```http
GET swm/rs/v1/spaces/k63vRjBbEud91V8ZBzEsO2Y5/members/HPybeVQn86WSRkc9
```

--------------------------------

### Configure In System Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-cpq-configurations-configureinsystem-post.html

Example JSON payload for configuring a product in the system.

```json
{
    "productFamily":"mobile",
    "productLine":"phones",
    "expand":"layoutCache",
    "excludeLayoutProperties":[
        "labelAlignment",
        "labelSeparator",
        "showLabel",
        "labelWidth",
        "labelWidthUnits",
        "valuePosition",
        "valueWidth",
        "valueWidthUnits",
        "valueAlignment",
        "helpIconAlignment",
        "msgPlacement",
        "msgWidthUnits",
        "msgWidth",
        "menuImagePosition",
        "pricePosition",
        "language",
        "fieldAutoWidth",
        "showCalculator",
        "showRecMsg",
        "showConMsg",
        "showPrevValueMsg",
        "showDataTooltip",
        "showMenuImage",
        "setTypeOverridden",
        "defaultValueOverridden",
        "displayTypeOverridden",
        "jetDisplayTypeOverridden",
        "helpIcon",
        "showHelpIcon",
        "columnWidths",
        "fieldAlignment",
        "showTitleIcon",
        "showDescription",
        "titleIcon",
        "cssClass"
    ],
    "populatePickListItems":true,
    "model":"telco70001",
    "currency":"USD",
    "targetModelPath":"_root:::mobile:phones:telco70001::0::0",
    "locale":"en_US"
}
```

--------------------------------

### Initiate Reconfigure Response Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-cpq-configurations-initiatereconfiguration-post.html

Partial example of the Initiate Reconfigure response.

```json
{
    "layout":{
        "arraySetVariableNames":[
        ],
        "attributes":[
            {
                "items":[
                    {

```

--------------------------------

### Get Legal Approvers Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-organizations-id-legalapprovers-get.html

Example JSON response for a successful GET request to the legal approvers endpoint.

```json
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizations/or-100001/legalApprovers"
        }
    ],
    "sort":[
        {
            "property":"firstName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"Dilliard",
            "firstName":"Leota",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100001"
                    },
                    "repositoryId":"100002",
                    "name":"Buyer",
                    "id":"100002",
                    "type":"organizationalRole"
                },
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "repositoryId":"ora.legalApprover",
                    "name":"Legal Approver",
                    "id":"ora.legalApprover",
                    "type":"role"
                }
            ],
            "repositoryId":"bb-110006",
            "id":"bb-110006",
            "email":"leota@example.com",
            "secondaryOrganizations":[
            ]
        }
    ]
}
```

--------------------------------

### Assembler Assemble GET Response Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-assembler-assemble-get.html

Example JSON response body returned by the Assembler assemble GET endpoint.

```json
{
    "resultsList":{
        "pagingActionTemplate":{
            "contentPath":"/guidedsearch",
            "@class":"com.endeca.infront.cartridge.model.NavigationAction",
            "navigationState":"?No=%7Boffset%7D&Nr=AND%28product.active%3A1%2Cproduct.priceListPair%3AsalePrices_listPrices%2Cproduct.language%3Aen%29&Nrpp=%7BrecordsPerPage%7D&Ntl=en&Ntt=clo*&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null",
            "siteRootPath":"/services",
            "label":null
        },
        "lastRecNum":3,
        "totalNumRecs":3,
        "sortOptions":[
        ],
        "records":[
            {
                "@class":"com.endeca.infront.cartridge.model.Record",
                "detailsAction":{
                    "contentPath":"/recorddetails",
                    "@class":"com.endeca.infront.cartridge.model.RecordAction",
                    "siteRootPath":"/services",
                    "label":null,
                    "recordState":"?A=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                },
                "records":[
                    {
                        "@class":"com.endeca.infront.cartridge.model.Record",
                        "detailsAction":{
                            "contentPath":"/recorddetails",
                            "@class":"com.endeca.infront.cartridge.model.RecordAction",
                            "siteRootPath":"/services",
                            "label":null,
                            "recordState":"?R=sku-xsku2005..xprod2005.en.salePrices__listPrices&language=en&path=%2Ftypeahead&redirects=yes&searchType=typeahead&site=default&visitId=null&visitorId=null"
                        },
                        "records":null,
                        "numRecords":0,
                        "attributes":{
                            "product.repositoryId":[
                                "xprod2005"
                            ],
                            "sku.listPrice":[
                                "99.000000"
                            ],
                            "product.route":[
                                "/elliot-classic-wall-clock/product/xprod2005"
                            ],
                            "product.listPrice":[
                                "99.000000"
                            ],
                            "product.displayName":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryImageTitle":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryImageAltText":[
                                "Elliot Classic Wall Clock"
                            ],
                            "product.primaryThumbImageURL":[
                                "/ccstore/v1/images/?source=http://localhost:8080/file/products/HOME_ElliotClassicClock_full.jpg&height=100&width=100"
                            ]
                        }
                    }
                ],
                "numRecords":1,
                "attributes":{
                    "product.repositoryId":[
                        "xprod2005"
                    ],
                    "sku.listPrice":[
                        "99.000000"
                    ],
                    "product.route":[
                        "/elliot-classic-wall-clock/product/xprod2005"
                    ],
                    "sku.maxActivePrice":[
                        "99.000000"
                    ],
                    "product.listPrice":[
                        "99.000000"
                    ],
                    "product.displayName":[
                        "Elliot Classic Wall Clock"
                    ],
                    "product.primaryImageTitle":[
                        "Elliot Classic Wall Clock"
                    ],
                    "product.primaryImageAltText":[
                        "Elliot Classic Wall Clock"
                    ]
```

--------------------------------

### Get Product Request

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-swm-rs-v1-spaces-spaceid-products-contentid-get.html

Example of a GET request to retrieve product content.

```http
GET swm/rs/v1/spaces/cTthHaOtDAz7u3xS5PLZaGa1/products/2269693
```

--------------------------------

### Site Creation Response Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-sitecreateforms-id-post.html

A sample JSON response returned upon successful site creation.

```json
{
    "priceListGroupList":[
        {
            "deleted":false,
            "repositoryId":"defaultPriceGroup",
            "active":false,
            "id":"defaultPriceGroup"
        },
        {
            "deleted":false,
            "repositoryId":"EURO",
            "active":false,
            "id":"EURO"
        }
    ],
    "inventoryLocationId":"SiteUS-GlenAllen187",
    "defaultLocaleId":"1",
    "inventoryLocations":[
        "SiteUS-GlenAllen187",
        "SiteUS-GlenAllen188"
    ],
    "name":"CloudLake US Site",
    "repositoryId":"siteUS",
    "id":"siteUS",
    "defaultBillingCountryId":"US",
    "defaultShippingCountryId":"US",
    "additionalLocaleIds":[
        "1"
    ],
    "siteTypes":[
        "b2bCommerce"
    ]
}
```

--------------------------------

### Preview Enable Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-serverextensions-preview-enable-post.html

A concrete example of a successful response when preview is already enabled.

```json
{
    "progress":"provisioning_complete",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
        }
    ],
    "message":"Preview is already enabled.",
    "previewEnabled":true
}
```

--------------------------------

### Get Contact Metadata Example Payload

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-selfservice-contacts-metadata-get.html

A standalone example of the successful response body returned by the endpoint.

```json
{
    "metadata":{
        "firstName":{
            "editable":true
        },
        "lastName":{
            "editable":true
        },
        "email":{
            "editable":false
        }
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/selfservice/contacts/metadata"
        }
    ]
}
```

--------------------------------

### Configure In System Response Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-cpq-configurations-configureinsystem-post.html

Example JSON response for the configureInSystem invocation.

```json
{
    "arraySetVariableNames":[
    ],
    "configData":{
        "planType":{
            "displayValue":"Unlimited Data and Talk",
            "value":"Unlimited Data and Talk"
        },
        "_recmdModels":{
            "items":[
            ]
        },
        "addOns":{
            "items":[
            ]
        },
        "selectDevice":{
            "displayValue":"iPhone 8",
            "value":"iPhone 8"
        },
        "protectionPlan":{
            "displayValue":"",
            "value":""
        },
        "_bom":{
            "items":[
                {
                    "extendedDescription1":null,
                    "_part_custom_field3":"",
                    "extendedDescription2":null,
```

--------------------------------

### Get Changelist Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-publishingchangelists-changelistid-get.html

Example JSON response returned when successfully retrieving changelist details.

```json
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "changeListId":"ijUCLwsUEiXLLuDjGWmrQriHM_10000",
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"Amber",
            "itemType":"repository",
            "worksets":[
                {
                    "repositoryId":"default"
                }
            ],
            "author":"admin",
            "displayName":"Men",
            "changeType":0,
            "assetType":"category",
            "changeDetails":[
                {
                    "changeTime":"2016-05-10T13:06:06.075Z",
                    "author":"admin",
                    "repositoryId":"100005"
                }
            ],
            "assetTypeDisplayName":"Collection",
            "changeTime":"2016-05-10T13:06:06.075Z",
            "firstName":"Admin",
            "componentPath":"/atg/commerce/catalog/ProductCatalog",
            "assetId":"catMen",
            "repositoryId":"change44444",
            "id":"change44444",
            "parentAssetType":"",
            "scheduledPublishItem":{
                "dateTime":"2018-01-26T08:00:00.000Z",
                "firstName":"Admin",
                "lastName":"User",
                "profileId":"admin",
                "eventName":"Men's clothing publish",
                "id":"900001",
                "eventType":1
            },
            "authors":[
                "admin:Amber,Admin",
                "admin:Weber,Damon"
            ]
        }
    ]
}
```

--------------------------------

### Initiate Return Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccagent-v1-returnrequests-post.html

A minimal JSON payload example for initiating a return request.

```json
{
    "orderId":"o10400"
}
```

--------------------------------

### Get Comment Request

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-swm-rs-v1-spaces-spaceid-comments-contentid-get.html

Example of a GET request to retrieve a specific comment by its ID within a space.

```http
GET swm/rs/v1/spaces/cTthHaOtDAz7u3xS5PLZaGa1/comments/2083924
```

--------------------------------

### Get a body start page tag

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-mediatags-get.html

Retrieves the details of a specific body start page tag.

```APIDOC
## GET /ccadmin/v1/pageTags/bodyStart

### Description
Retrieves the details of a specific body start page tag.

### Method
GET

### Endpoint
/ccadmin/v1/pageTags/bodyStart
```

--------------------------------

### Get Last Published Time Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-publish-get.html

Example of a successful JSON response body for the getLastPublishedTime operation.

```json
{
    "lastPublishedTimeStamp":"1456230000"
}
```

--------------------------------

### Basic Authentication Configuration Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-merchant-basicauth-get.html

A sample JSON payload demonstrating the configuration of host names, IP ranges, browser types, and credentials.

```json
{
    "neverAuthenticateTargetHostNames":[
        "example.com",
        "www.example.com"
    ],
    "ipRangesWhitelist":[
        "192.168.1.1 - 192.168.1.15"
    ],
    "nonBasicAuthBrowserTypes":[
        "MSIE",
        "Safari",
        "Edge",
        "Trident"
    ],
    "headersWhitelist":null,
    "passwords":{
        "admin":"admin"
    },
    "pathWhitelist":null,
    "realm":"Oracle Cloud Commerce Testing"
}
```

--------------------------------

### Application Styling Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-applicationstyling-get.html

Provides a sample JSON response for application styling configurations.

```json
[
    {
        "filename":"customStyling1.css",
        "repositoryId":"500001",
        "ranking":0,
        "sites":[
        ],
        "applicationId":"cloudlake"
    },
    {
        "filename":"customStyling2.css",
        "repositoryId":"500002",
        "ranking":20,
        "sites":[
            {
                "repositoryId":"siteUS"
            }
        ],
        "applicationId":"cloudlake"
    }
]
```

--------------------------------

### Shopper Profile Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccapp-v1-profiles-id-get.html

Example JSON response body returned by the shopper profile GET endpoint.

```json
{
    "derivedPriceListGroup":null,
    "lastPurchaseDate":null,
    "lastName":"K",
    "GDPRProfileP13nConsentDate":null,
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "catalog":null,
    "roles":[
        {
            "function":"buyer",
            "relativeTo":{
                "id":"100001"
            },
            "repositoryId":"100006",
            "name":"Buyer",
            "type":"organizationalRole"
        }
    ],
    "parentOrganization":{
        "name":"Oracle",
        "repositoryId":"100001",
        "description":"Oracle Org",
        "active":true,
        "shippingAddress":{
        },
        "secondaryAddresses":[
            {
                "firstName":"Harry",
                "lastName":"Potter",
                "country":"United States",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "phoneNumber":"9088988999",
                "city":"Arcadia",
                "address2":"Suite 400",
                "address1":"Grundy Lane",
                "postalCode":"91006",
                "repositoryId":"110033",
                "state":"CA"
            }
        ],
        "id":"100001",
        "billingAddress":{
        },
        "externalOrganizationId":"EXT_ORG_1"
    },
    "locale":"en",
    "shippingSurchargePriceList":null,
    "receiveEmailDate":null,
    "firstPurchaseDate":null,
    "profileType":"b2b_user",
    "translations":{
    },
    "loyaltyPrograms":[
        {
            "programName":"XTRAREWARDS",
            "repositoryId":100001,
            "membershipId":"abc123",
            "programId":"prog1",
            "status":"Enrolled"
        },
        {
            "programName":"XTRAMILES",
            "repositoryId":100002,
            "membershipId":"xyz123",
            "programId":"prog2",
            "status":"Enrolled"
        }
    ],
    "registrationDate":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/shopperProfiles/110006?offset=0&limit=2&sort=firstName%3Adesc"
        }
    ],
    "id":"110006",
    "email":"abc@example.com",
    "derivedSalePriceList":null,
    "daytimeTelephoneNumber":"212-555-1977",
    "taxExempt":false,
    "customerContactId":"CRMID_12345",
    "receiveEmail":"no",
    "priceListGroup":null,
    "active":"true",
    "dateOfBirth":null,
    "lastVisitDate":null,
    "previousVisitDate":null,
    "firstName":"bcd",
    "creditCards":[
        {
            "expirationYear":"2017",
            "tokenExpiryDate":null,
            "gatewayConfigId":null,
            "expirationMonth":"1",
            "creditCardType":"Visa",
            "source":null,
            "iin":null,
            "token":null,
            "cardProps":{
            },
            "nameOnCard":null,
            "creditCardNumber":"4539082039396288",
            "repositoryId":"se-usercc110031",
            "nickname":"Visa",
            "tokenCreatedDate":"2018-10-01T09:02:10.181Z",
            "cardSavedDate":null,
            "billingAddress":{
                "country":"US",
                "lastName":"Anderson",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "address3":null,
                "city":"Buffalo",
                "address2":null,
                "address1":"451 Brooks Ave",
                "postalCode":"14201",
                "county":null,
                "firstName":"Kim",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"212-555-2150",
                "repositoryId":"se-990031",
                "state":"NY"
            },
            "id":"se-usercc110031",
            "expirationDayOfMonth":null
        }
    ],
    "repositoryId":"110006",
    "firstVisitDate":null,
    "shippingAddress":{
    },
    "billingAddress":{
    },
    "userType":null,
    "derivedShippingSurchargePriceList":null,
    "secondaryOrganizations":[
    ],
    "shippingAddresses":[
    ]
}
```

--------------------------------

### Get Space Request

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-swm-rs-v1-spaces-spaceid-get.html

Example of a GET request to retrieve space details using a specific space ID.

```http
GET swm/rs/v1/spaces/7go4VjU2dK5MkTfHWQHV1l39
```

--------------------------------

### Recommendations Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-v4-sessions-click-post.html

Example JSON structure for requesting multiple sets of product recommendations.

```json
{
    "recommendations":{
        "first":{
            "numRecs":6,
            "strategyId":"inCategoryShoes"
        },
        "second":{
            "numRecs":6
```

--------------------------------

### Site Creation Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-sites-post.html

Example JSON payload for creating a new site, demonstrating the structure of properties like priceListGroupList and inventoryLocations.

```json
{
    "properties":{
        "priceListGroupList":[
            {
                "id":"EURO"
            },
            {
                "id":"defaultPriceGroup"
            }
        ],
        "timeToLive":5000,
        "inventoryLocationId":"SiteUS-GlenAllen187",
        "inventoryLocations":[
            "SiteUS-GlenAllen187",
            "SiteUS-GlenAllen188"
        ],
        "timezone":"europe_london",
        "name":"CloudLake US Site test"
```

--------------------------------

### Get Stacking Rules Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-stackingrules-get.html

A sample response body returned by the GET stacking rules API.

```json
{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":2,
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "type":"promotion",
    "items":[
        {
            "maxPromotions":10,
            "displayName":"A new staking rule for item stacking rule",
            "repositoryId":"stack20009",
            "id":"stack20009"
        },
        {
            "maxPromotions":5,
            "displayName":"Brand new stacking rule  ",
            "repositoryId":"stack20011",
            "id":"stack20011"
        }
    ]
}
```

--------------------------------

### GET Profile Context Lists Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-profilecontextlists-get.html

Example JSON response for a successful GET request to the profileContextLists endpoint.

```json
{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/profileContextLists"
        }
    ],
    "autoWrap":true,
    "items":[
        {
            "profileContexts":[
            ],
            "id":"defaultProfileContextList"
        }
    ]
}
```

--------------------------------

### Example Profile Creation Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-profiles-post.html

A sample JSON response body returned upon successful profile creation.

```json
{
    "id":"110026"
}
```

--------------------------------

### Get Notification Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-notificationmessages-id-get.html

A sample JSON response body returned upon a successful GET request.

```json
{
    "viewedDate":null,
    "rolledUp":false,
    "pinned":false,
    "createdDate":"2016-10-19T19:46:11.754Z",
    "count":1,
    "details":"{\"Type\":\"test\",\"rate\":2.55,\"http code\":500,\"Date\":\"2016-10-19T19:46:11.753Z\"}",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/notificationMessages/931269"
        }
    ],
    "id":"931269",
    "message":"This is Failing",
    "key":"test"
}
```

--------------------------------

### Response Schema and Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-serverextensions-preview-enable-post.html

The response provides the current provisioning status, a status message, and navigation links.

```json
{
    "properties":{
        "progress":{
            "description":"It specifies the status of the preview server(pod). It can be either 'none', or 'provisioning', or 'provisioning_complete'. These values signify that the preview server is either not provisioned or under-provisioning or provisioned respectively.",
            "type":"string"
        },
        "links":{
            "description":"List of navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The link's relation to the current page of results: next, prev or self.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The URL of the link.",
                        "type":"string"
                    }
                }
            }
        },
        "message":{
            "description":"It gives more details about preview status.",
            "type":"string"
        },
        "previewEnabled":{
            "description":"It specifies that preview is enabled or not for server side extension.",
            "type":"boolean"
        }
    },
    "example":{
        "progress":"provisioning_complete",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
            }
        ],
        "message":"Preview is enabled.",
        "previewEnabled":true
    }
}
```

```json
{
    "progress":"provisioning_complete",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/serverExtensions/preview/enable"
        }
    ],
    "message":"Preview is enabled.",
    "previewEnabled":true
}
```

--------------------------------

### Example Import Progress Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-asset-import-token-get.html

A sample JSON response showing the current and total asset counts.

```json
{
    "total":5000,
    "current":3450
}
```

--------------------------------

### Get Completed Test Jobs Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-testjobs-get.html

An example of the JSON response body returned upon a successful request.

```json
[
    {
        "resultsUrls":[
            "/ccadminx/custom/v1/testJobs/201612151618?extensionName=externalShippingCalculator",
            "/ccadminx/custom/v1/testJobs/201612151620?extensionName=externalShippingCalculator",
            "/ccadminx/custom/v1/testJobs/201612161546?extensionName=externalShippingCalculator"
        ]
    }
]
```

--------------------------------

### Get Item Types 200 Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-itemtypes-get.html

Example of the JSON response body returned by the Get Item Types endpoint.

```json
{
    "itemType":"sku",
    "hidden":false,
    "length":1,
    "variantBasedDisplay":false,
    "label":"Active",
    "type":"checkbox",
    "required":false,
    "writable":true,
    "uiEditorType":null,
    "default":true,
    "listingVariant":false,
    "localizable":false,
    "id":"active",
    "order":"50"
}
]
},
{
    "id":"sku-MensApparel",
    "specifications":[
        {
            "itemType":"sku-MensApparel",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"customLevelSkuProperty",
            "type":"shortText",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "propertyType":"sku-custom",
            "localizable":false,
            "id":"customLevelSkuProperty",
            "order":null
        },
        {
            "itemType":"sku-MensApparel",
            "localizedValues":null,
            "hidden":false,
            "values":[
                "Beige",
                "Black",
                "Blue",
                "Brown",
                "Camo",
                "Dark Worn",
                "Gray",
                "Green",
                "Medium Worn",
                "Navy",
                "Orange",
                "Red",
                "Tan",
                "White"
            ],
            "length":19,
            "variantBasedDisplay":false,
            "label":"Color",
            "type":"enumerated",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "propertyType":"variant",
            "localizable":false,
            "id":"color",
            "order":null
        },
        {
            "itemType":"sku-MensApparel",
            "localizedValues":null,
            "hidden":false,
            "values":[
                "Small",
                "Medium",
                "Large",
                "X-Large"
            ],
            "length":19,
            "variantBasedDisplay":false,
            "label":"Size",
            "type":"enumerated",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "propertyType":"variant",
            "localizable":false,
            "id":"size",
            "order":null
        }
    ],
    "base":[
        {
            "itemType":"sku",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Name",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"displayName",
            "order":"-11"
        },
        {
            "itemType":"sku",
            "hidden":false,
            "length":165,
            "variantBasedDisplay":false,
            "label":"Id",
            "type":"shortText",
            "required":false,
            "writable":false,
            "uiEditorType":null,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"id",
            "order":"-4"
        },
        {
            "itemType":"sku",
            "hidden":false,
            "length":1,
            "variantBasedDisplay":false,
            "label":"Active",
            "type":"checkbox",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "default":true,
```

--------------------------------

### Create Folder Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-files-createfolder-post.html

A minimal example of the JSON payload required to create a folder.

```json
{
    "folder":"/thirdparty/.well-known"
}
```

--------------------------------

### Get Stack Less Example Response

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-stacks-id-get.html

An example of a successful 200 response containing the 'less' source code for a stack instance.

```json
{
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/stacks/re100002/less?source=stack%20source"
        }
    ],
    "source":"#progressTracker-re100002 {\n  #progressTracker-vars-re100002 > .loadVariables();\n/* ---------------------------------------------------------------------- */\n/*  Progress Tacker Stack Styles\n/* ---------------------------------------------------------------------- */\n\n.progressTracker {\n\n  .progressTracker-navigation {\n    display: flex;\n    margin: 0 0 10px;\n    padding: 0;\n    list-style: none;\n\n    li {\n      flex: 1 0 auto;\n      width: 0;\n\n      a, a:hover {\n        background: @remainingBackgroundColor;\n        color: @remainingTextColor;\n        text-align: @stepNameAlignment;\n        text-decoration: none;\n        display: block;\n        position: relative;\n        height: 3em;\n        padding: 0.8em 1.5em;\n        border-radius:0;\n        margin-left: 0.25em;\n\n        span {\n          overflow: hidden;\n          text-overflow: ellipsis;\n          white-space: nowrap;\n          display: block;\n        }\n\n        &:before {\n          content: \"\";\n          position: absolute;\n          left: 0;\n          top: 0;\n          width: 0;\n          height: 0;\n          border-top: 1.5em solid transparent;\n          border-left: 1em solid @SitePageBackgroundColor;\n          border-bottom: 1.5em solid transparent;\n        }\n\n        &:after {\n          z-index:5;\n          content: \"\";\n          position: absolute;\n          left: 100%;\n          top: 0;\n          width: 0;\n          height: 0;\n          border-top: 1.5em solid transparent;\n          border-left: 1em solid @remainingBackgroundColor;\n          border-bottom: 1.5em solid transparent;\n        }\n      }\n\n      &.active {\n        a, a:hover {\n          background: @activeBackgroundColor;\n          color: @activeTextColor;\n\n\n          &:after {\n            border-left: 1em solid @activeBackgroundColor;\n          }\n        }\n      }\n\n      &.done {\n        a {\n          background: @completedBackgroundColor;\n          color: @completedTextColor;\n          cursor: pointer;\n\n          &:after {\n            border-left: 1em solid  @completedBackgroundColor;\n          }\n        }\n        a:hover {\n          background: @activeBackgroundColor;\n          color: @activeTextColor;\n          cursor: pointer;\n\n          &:after {\n            border-left: 1em solid  @activeBackgroundColor;\n          }\n        }\n      }\n\n      &:first-child {\n        a {\n          margin-left: 0;\n\n          &:before {\n            border: none;\n          }\n        }\n      }\n\n      &:last-child {\n        a {\n          &:after {\n            border: none;\n          }\n        }\n      }\n    }\n  }\n\n  .progressTracker-button-row {\n    margin-top: 1em;\n  }\n\n  .showButton(@a) when (@a = false) {\n    display: none;\n  }\n\n  .progressTracker-button-previous {\n    .showButton(@showPreviousButton);\n  }\n\n  .progressTracker-button-next {\n    text-align: right;\n  }\n}\n}"
}
```

--------------------------------

### Preview Subscription Products Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-selfservice-subscriptionproducts-preview-post.html

A sample JSON request body for the preview subscription products endpoint.

```json
[
    {
        "cart":{
            "items":[
                {
                    "output":[
                        {
                            "numberOfBillingCycles":2
                        }
                    ],
                    "subscriptionNumber":"PreviewSubsciption_Amend",
                    "closedDate":"2025-03-10",
                    "actionCode":"CLOSE",
                    "productPuId":"PreviewSubsciption_Amend-PRDT-176040"
                }
            ]
        }
    }
]
```
Tokens:
Raw