### Get Started - Quick Start

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-componentinstances-id-locale-locale-put

A quick guide to help you get started with the Oracle Commerce Cloud REST API, covering initial setup and a basic request.

```APIDOC
## Get Started - Quick Start

### Description
The Quick Start guide provides the essential steps to begin using the Oracle Commerce Cloud REST API. This typically includes setting up authentication, making a simple API call, and understanding the basic request-response cycle.

### Method
N/A (Informational section)

### Endpoint
N/A (Informational section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started: Quick Start

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

Begin your integration with the Oracle Commerce Cloud REST API using this quick start guide, designed for rapid setup.

```APIDOC
## Get Started: Quick Start

### Description
The Quick Start guide provides a streamlined approach to begin interacting with the Oracle Commerce Cloud REST API. It covers the essential steps to get you up and running quickly.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started - Quick Start

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

A quick guide to help you get started with using the Oracle Commerce Cloud REST API.

```APIDOC
## Get Started - Quick Start

### Description
Provides a simplified guide to begin making requests to the Oracle Commerce Cloud REST API.

### Method
N/A (Informational Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-urlpatterns-id-generate-put

Guides on getting started with the REST API, including authentication, making requests, and handling query parameters and status codes.

```APIDOC
## Get Started

This section covers essential information for beginning to use the Oracle Commerce Cloud REST API.

### Quick Start
A concise guide to help you make your first API call.

### REST API authentication
Details on how to authenticate your requests to the Oracle Commerce Cloud REST API.

### Send Requests
Instructions and best practices for sending requests to the API endpoints.

### Query Parameters
Explanation of how to use query parameters to filter and refine your API requests.

### Status Codes
Information about the HTTP status codes returned by the API and their meanings.

### Error Messages
A guide to understanding and handling error messages returned by the API.
```

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

### Get Started

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

Guides for getting started with the REST API, including authentication, sending requests, and understanding parameters and status codes.

```APIDOC
## Get Started

### Quick Start
A guide to help you begin using the REST API quickly.

### REST API Authentication
Details on how to authenticate your requests to the REST API.

### Send Requests
Instructions on how to send requests to the Oracle Commerce Cloud REST API.

### Query Parameters
Explanation of common query parameters used in API requests.

### Status Codes
A reference for HTTP status codes returned by the API.

### Error Messages
Information on common error messages and how to handle them.
```

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

### Get Started: Quick Start

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

A guide to help developers quickly begin using the Oracle Commerce Cloud REST API, covering initial setup and basic usage.

```APIDOC
## GET /websites/oracle_en_cloud_saas_cx-commerce_cxocc/get-started/quick-start

### Description
A guide to help developers quickly begin using the Oracle Commerce Cloud REST API, covering initial setup and basic usage.

### Method
GET

### Endpoint
/websites/oracle_en_cloud_saas_cx-commerce_cxocc/get-started/quick-start

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Specifies which fields to return in the response.

### Response
#### Success Response (200)
- **title** (string) - The title of the quick start guide.
- **steps** (array) - A list of steps to get started.
  - **description** (string) - Description of the step.

#### Response Example
```json
{
  "title": "Quick Start Guide",
  "steps": [
    "1. Obtain API credentials.",
    "2. Set up your development environment.",
    "3. Make your first API call."
  ]
}
```
```

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

### Get Started

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

Guides on how to get started with the Oracle Commerce Cloud REST API, including authentication and making requests.

```APIDOC
## Get Started

### Description
This section provides essential guides for developers to begin using the Oracle Commerce Cloud REST API. It covers initial setup, authentication methods, and how to format and send requests.

### Method
N/A (Informational Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started with REST API

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

Guides on how to get started with the REST API, including authentication and making requests.

```APIDOC
## Get Started with REST API

### Description
This section covers the essential steps to begin using the Oracle Commerce Cloud REST API. It includes information on authentication, sending requests, and understanding query parameters and status codes.

### Topics
- Quick Start
- REST API authentication
- Send Requests
- Query Parameters
- Status Codes
- Error Messages
```

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

### Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-elements-tag-javascript-put

Guides and information to help you get started with the Oracle Commerce Cloud REST API.

```APIDOC
## Get Started

### Description
Guides and information to help you begin using the Oracle Commerce Cloud REST API.

### Method
N/A (Informational)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-gsadmin-v1-appname-thesaurus-thesaurusentryid-patch

Guides on how to get started with the Oracle Commerce Cloud REST API, including authentication, sending requests, and understanding parameters and status codes.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

### Description
This section covers the essential steps and concepts needed to start using the Oracle Commerce Cloud REST API effectively.

### Topics
* Quick Start guide
* REST API authentication methods
* How to send requests
* Understanding Query Parameters
* Common Status Codes
* Error Messages format
```

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

### Get Started

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

Guides users on how to get started with the Oracle Commerce Cloud REST API, covering authentication, request sending, and query parameters.

```APIDOC
## Get Started

### Description
This section provides essential information for developers to begin using the Oracle Commerce Cloud REST API. It covers key topics such as authentication methods, how to send requests, and the use of query parameters for filtering and sorting data.

### Method
N/A (Informational Section)

### Endpoint
N/A (Informational Section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Getting Started with the REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-message-tags

Guides on how to get started with the REST API, including authentication, sending requests, and understanding query parameters and status codes.

```APIDOC
## Getting Started with the REST API

This section guides you through the initial steps of using the Oracle Commerce Cloud REST API.

### Key Topics

*   **Quick Start**: A beginner-friendly guide to making your first API calls.
*   **REST API Authentication**: Learn how to authenticate your requests to access protected resources.
*   **Send Requests**: Understand the best practices and methods for sending requests to the API.
*   **Query Parameters**: Discover how to use query parameters to filter, sort, and paginate API responses.
*   **Status Codes**: Familiarize yourself with the HTTP status codes returned by the API to understand the outcome of your requests.
*   **Error Messages**: Learn how to interpret and handle error messages returned by the API.
```

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

### Get Started with REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-store-timezone

Guides developers on how to begin using the Oracle Commerce Cloud REST API, covering initial setup and essential concepts.

```APIDOC
## Get Started

### Description
This section provides essential information to help developers get started with the Oracle Commerce Cloud REST API. It covers the initial steps required to make successful API calls.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Quick Start

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-store-store-extension-admin-organization-request

A guide to get you started quickly with the Oracle Commerce Cloud REST API.

```APIDOC
## Quick Start

### Description
This guide provides the essential steps to begin using the Oracle Commerce Cloud REST API. It covers initial setup, making your first request, and understanding basic responses.

### Method
N/A (Informational Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started

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

Information on how to get started with the Oracle Commerce Cloud REST API.

```APIDOC
## Get Started

### Description
Provides guidance on how to begin using the Oracle Commerce Cloud REST API, including authentication and making requests.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

**Key sub-sections include:**
*   **Quick Start**: A brief introduction to making your first API call.
*   **REST API authentication**: Details on how to authenticate your requests.
*   **Send Requests**: Instructions on how to structure and send API requests.
*   **Query Parameters**: Information on using query parameters to filter and sort data.
*   **Status Codes**: Explanation of common HTTP status codes returned by the API.
*   **Error Messages**: Guidance on interpreting and handling error responses.
```

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

### Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-agent-openid

Guides users on how to begin using the REST API, covering authentication, sending requests, query parameters, and understanding status and error codes.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

### Description
This section provides essential information to help you get started with the Oracle Commerce Cloud REST API. It covers authentication methods, how to send requests, and details about query parameters, status codes, and error messages.

### Key Areas
* Quick Start guide
* REST API authentication methods
* How to send requests
* Understanding query parameters
* Common status codes
* Error message formats
```

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

### Get Started - Send Requests

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-componentinstances-id-locale-locale-put

Instructions and examples on how to send requests to the Oracle Commerce Cloud REST API.

```APIDOC
## Get Started - Send Requests

### Description
This guide provides practical instructions on how to format and send requests to the Oracle Commerce Cloud REST API endpoints. It covers aspects like HTTP methods, request headers, and constructing the request body.

### Method
N/A (Informational section)

### Endpoint
N/A (Informational section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Getting Started with REST API

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

Guides on how to begin using the REST API, including authentication methods, sending requests, and understanding common API elements.

```APIDOC
## Getting Started with the REST API

### Description
This section guides users on how to start using the Oracle Commerce Cloud REST API. It covers essential topics such as authentication, sending requests, and understanding API conventions.

### Key Areas:

*   **Quick Start**: A brief guide to get you up and running quickly with the API.
*   **REST API Authentication**: Details on how to authenticate your API requests.
*   **Send Requests**: Instructions on how to make successful API calls.
*   **Query Parameters**: Explanation of how to use query parameters to filter and refine results.
*   **Status Codes**: Understanding the meaning of different HTTP status codes returned by the API.
*   **Error Messages**: Guidance on interpreting and handling API error responses.
```

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

### Getting Started with REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-error-log-entries

Guides users on how to get started with the REST API, including authentication, sending requests, and understanding query parameters, status codes, and error messages.

```APIDOC
## Getting Started with REST API

### Description
This section guides users through the initial steps of using the Oracle Commerce Cloud REST API. It covers essential topics like authentication, making your first request, and understanding API responses.

### Key Topics

- **Quick Start**: A concise guide to begin using the API quickly.
- **REST API Authentication**: Details on how to authenticate your requests.
- **Send Requests**: Instructions on how to send requests to the API.
- **Query Parameters**: Information on available query parameters for filtering and sorting data.
- **Status Codes**: Explanation of HTTP status codes used in API responses.
- **Error Messages**: Guidance on understanding and handling API error messages.
```

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

### Get Started with REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-audiencecontext-currentsession-put

Guides for getting started with the Oracle Commerce Cloud REST API, including quick start, authentication, sending requests, query parameters, status codes, and error messages.

```APIDOC
## Get Started

This section outlines the essential steps and concepts for using the Oracle Commerce Cloud REST API effectively.

### Quick Start

Provides a concise guide to begin making your first API calls.

### REST API Authentication

Details on how to authenticate your requests to ensure secure access to the API.

### Send Requests

Instructions on how to format and send requests to the API endpoints.

### Query Parameters

Explanation of how to use query parameters to filter and refine your API requests.

### Status Codes

Description of common HTTP status codes returned by the API and their meanings.

### Error Messages

Information on how to interpret and handle error messages returned by the API.

```

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

### Get Started

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

This section guides you through the initial steps of using the Oracle Commerce Cloud REST API, including authentication and making your first requests.

```APIDOC
## Get Started

### Description
This section guides you through the initial steps of using the Oracle Commerce Cloud REST API, including authentication and making your first requests.

### Method
N/A (Informational Section)

### Endpoint
N/A (Informational Section)

### Parameters
N/A (Informational Section)

### Request Example
N/A (Informational Section)

### Response
N/A (Informational Section)
```

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

### Quick Start

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-widgetdescriptors-id-element-tag-javascript-put

A quick start guide to begin using the REST API for Oracle Commerce Cloud.

```APIDOC
## Quick Start

### Description
This guide provides a streamlined introduction to get you started with making requests to the Oracle Commerce Cloud REST API quickly.

### Method
N/A (Guide)

### Endpoint
N/A (Guide)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Oracle Commerce Cloud REST API - Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-agent-payment-groups

Guides users on how to get started with the Oracle Commerce Cloud REST API, including authentication and making requests.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

This section guides you through the initial steps of using the Oracle Commerce Cloud REST API.

#### Quick Start

A streamlined guide to help you make your first API calls quickly.

#### REST API Authentication

Information on how to authenticate your requests to the Oracle Commerce Cloud REST API.

#### Send Requests

Instructions and best practices for sending requests to the API.

#### Query Parameters

Details on how to use query parameters to filter and refine your API requests.

#### Status Codes

An explanation of the HTTP status codes returned by the API and their meanings.

#### Error Messages

Information on common error messages and how to handle them.
```

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

### Getting Started with REST API

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

Guides on how to authenticate, send requests, and understand parameters and status codes for the REST API.

```APIDOC
## Getting Started with the REST API

### Description
This section provides essential information for developers to begin using the Oracle Commerce Cloud REST API. It covers authentication methods, how to construct and send requests, and understanding common API elements.

### Key Topics
- **Quick Start**: A concise guide to begin making API calls.
- **REST API Authentication**: Details on how to authenticate your API requests.
- **Send Requests**: Instructions on how to properly format and send requests.
- **Query Parameters**: Information on using query parameters to filter and sort data.
- **Status Codes**: Explanation of common HTTP status codes returned by the API.
- **Error Messages**: Guidance on interpreting and handling API error responses.
```

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

### Getting Started with REST API

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

Guides users through the initial steps of using the REST API, including authentication, sending requests, and understanding query parameters.

```APIDOC
## Getting Started with the REST API

### Description
This section covers the essential steps to begin integrating with the Oracle Commerce Cloud REST API. It includes information on authentication, making your first requests, and utilizing query parameters for data filtering and manipulation.

### Key Topics
*   **Quick Start**: A streamlined guide to get you making basic API calls quickly.
*   **REST API Authentication**: Details on how to authenticate your requests to access protected resources.
*   **Send Requests**: Instructions and examples on how to construct and send HTTP requests to the API.
*   **Query Parameters**: Explanation of common query parameters used for filtering, sorting, and paginating results.
*   **Status Codes**: A reference for understanding the HTTP status codes returned by the API.
*   **Error Messages**: Guidance on interpreting and handling error responses from the API.
```

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

### Oracle Commerce Cloud REST API - Get Started

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

Guides for getting started with the Oracle Commerce Cloud REST API, including authentication, sending requests, query parameters, and understanding status and error codes.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

### Description
This section guides users on how to begin using the Oracle Commerce Cloud REST API.

### Quick Start
A simplified guide to quickly start making requests to the API.

### REST API Authentication
Information on how to authenticate your requests to the Oracle Commerce Cloud REST API.

### Send Requests
Instructions and examples on how to send requests to the API endpoints.

### Query Parameters
Explanation of available query parameters and how to use them to filter and sort results.

### Status Codes
A reference for HTTP status codes returned by the API, indicating the success or failure of a request.

### Error Messages
Details on common error messages and their meanings to help with troubleshooting.
```

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

### Quick Start

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

A rapid guide to help you start using the Oracle Commerce Cloud REST API quickly.

```APIDOC
## Quick Start

### Description
A streamlined guide to help you get up and running with the Oracle Commerce Cloud REST API in the shortest possible time.

### Method
N/A (Informational Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Getting Started with REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-jsframeworkadminendpoint

Guides and information on how to begin using the Oracle Commerce Cloud REST API, including authentication and sending requests.

```APIDOC
## Getting Started with REST API

### Description
This section guides you through the initial steps of using the Oracle Commerce Cloud REST API. It covers essential topics like authentication, sending your first requests, and understanding common parameters and status codes.

### Topics
* Quick Start
* REST API authentication
* Send Requests
* Query Parameters
* Status Codes
* Error Messages
```

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

### Get Started: Send Requests

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

Guidance on how to construct and send requests to the Oracle Commerce Cloud REST API, including best practices and examples.

```APIDOC
## Get Started: Send Requests

### Description
This guide provides instructions and best practices for constructing and sending HTTP requests to the Oracle Commerce Cloud REST API. It covers aspects like request formatting and common HTTP methods.

### Method
N/A (Guide Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Example Product Data Instances (JSON)

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

Illustrates several examples of product data as represented in JSON format. These examples showcase different combinations of stock status, quantities, and location details for products.

```json
[
    {
        "catalogId": "cloudLakeCatalog",
        "productId": "prod10011",
        "preOrderableQuantity": 0,
        "orderableQuantity": 95,
        "stockStatus": "IN_STOCK",
        "availabilityDate": null,
        "backOrderableQuantity": 50,
        "catRefId": "sku10024",
        "inStockQuantity": 25
    },
    {
        "catalogId": "cloudLakeCatalog",
        "productId": "Product_9E",
        "preOrderableQuantity": 50,
        "orderableQuantity": 95,
        "locationId": "CRSHome-GlenAllen186",
        "stockStatus": "IN_STOCK",
        "availabilityDate": null,
        "backOrderableQuantity": 0,
        "catRefId": "Sku_9F",
        "inStockQuantity": 25
    },
    {
        "catalogId": "cloudLakeCatalog",
        "productId": "Product_9E",
        "preOrderableQuantity": 50,
        "orderableQuantity": 95,
        "locationId": "CRSHome-GlenAllen187",
        "stockStatus": "IN_STOCK",
        "availabilityDate": null,
        "backOrderableQuantity": 0,
        "catRefId": "Sku_9F",
        "inStockQuantity": 25
    },
    {
        "catalogId": "null",
        "productId": "Product_9E",
        "locationId": "CRSHome-GlenAllen186",
        "stockStatus": "OUT_OF_STOCK",
        "catRefId": "Sku_9F"
    }
]
```

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

### Get Started - Error Messages

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

Information on how to interpret and handle error messages from the API.

```APIDOC
## Get Started - Error Messages

### Description
Provides guidance on understanding and resolving common error messages returned by the Oracle Commerce Cloud REST API.

### Method
N/A (Informational Section)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Sample GET Member Response (Success)

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

Example of a successful JSON response when retrieving a user member, indicating the member resource was found.

```JSON
{"response":{"code":"200.0","developerMessage":"member resource found"},
        "userId":"HPybeVQn86WSRkc9",
        "mediaUrl":""
       }
```

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

### Getting Started with Oracle Commerce Cloud REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-gsadmin-v1-appname-content-rankingrules-rule-post

This section covers the essential steps to begin using the Oracle Commerce Cloud REST API, including authentication and making your first request.

```APIDOC
## Get Started

### Description
This section covers the essential steps to begin using the Oracle Commerce Cloud REST API, including authentication and making your first request.

### Topics

- **Quick Start**: A brief guide to get you up and running quickly.
- **REST API authentication**: Details on how to authenticate your API requests.
- **Send Requests**: Instructions on how to send requests to the API.
- **Query Parameters**: Information on using query parameters to filter and sort data.
- **Status Codes**: An explanation of common HTTP status codes returned by the API.
- **Error Messages**: Guidance on understanding and handling API error messages.

```

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

### Update Site Properties Request Example

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccstore-v1-profiles-current-siteproperties-put

Provides a concrete example of the JSON payload for updating site properties. This example demonstrates how to structure the data, including the site ID and specific property values like personalization consent and email subscription status. It serves as a practical guide for implementing the API call.

```json
{
    "siteProperties":[
        {
            "site":{
                "id":"SiteA"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes"
            }
        }
    ]
}
```

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

### Getting Started with Oracle Commerce Cloud REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-tokencache-id-delete

Guides users on how to get started with the Oracle Commerce Cloud REST API, including authentication and making requests.

```APIDOC
## Get Started

### Quick Start
This guide provides a quick introduction to setting up and making your first requests to the Oracle Commerce Cloud REST API.

### REST API Authentication
Details on how to authenticate your requests to the Oracle Commerce Cloud REST API, including required credentials and methods.

### Send Requests
Instructions and examples on how to send various types of requests (GET, POST, PUT, DELETE) to the Oracle Commerce Cloud REST API.

### Query Parameters
Information about available query parameters that can be used to filter, sort, and paginate results from the API.

### Status Codes
A reference for HTTP status codes returned by the API, indicating the success or failure of a request.

### Error Messages
Details on common error messages and their meanings, helping to troubleshoot issues with API requests.
```

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

### Getting Started with REST API

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

Guides users on how to get started with the Oracle Commerce Cloud REST API, covering authentication, sending requests, and understanding query parameters and status codes.

```APIDOC
## Getting Started with the REST API

### Description
This section covers the essential steps to begin using the Oracle Commerce Cloud REST API. It includes details on authentication methods, how to send requests, common query parameters, and an explanation of status codes and error messages.

### Topics
* Quick Start
* REST API authentication
* Send Requests
* Query Parameters
* Status Codes
* Error Messages
```

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

### Example Configuration Options Response (JSON)

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-widgetdescriptors-id-element-tag-metadata-get

An example JSON response showcasing the configuration options for an element. This specific example lists 'fontPicker' as an available option.

```json
[
    "fontPicker"
]
```

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

### Getting Started with Oracle Commerce Cloud REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-application-level-javascript

This section guides users on how to get started with the REST API, covering authentication, sending requests, query parameters, and understanding status and error codes.

```APIDOC
## Getting Started with Oracle Commerce Cloud REST API

### Description
Guides users on how to get started with the Oracle Commerce Cloud REST API, including authentication, making requests, and handling responses.

### Topics

*   **Quick Start**: A concise guide to begin using the API.
*   **REST API authentication**: Details on how to authenticate your requests.
*   **Send Requests**: Instructions on how to send requests to the API.
*   **Query Parameters**: Information about available query parameters for filtering and sorting.
*   **Status Codes**: Explanation of HTTP status codes returned by the API.
*   **Error Messages**: Details on potential error messages and their meanings.
```

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

### Example Configuration Settings (JSON)

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

An example JSON object demonstrating the application of the defined schemas for various settings, including image configurations and display options for custom properties.

```json
{
    "settings":{
        "companyLogo":{
            "path":"/general/companyLogo.jpg",
            "url":"http://localhost:9080/file/general/companyLogo.jpg"
        },
        "backgroundImage":{
            "path":"/general/backgroundImage.jpg",
            "url":"http://localhost:9080/file/general/backgroundImage.jpg"
        }
    },
    "isInternalCustomPropertiesDisplayEnabled":true,
    "isInternalProfilePropertiesDisplayEnabled":true,
    "isExternalCustomPropertiesDisplayEnabled":false,
    "dashboardSettings":{
        "dashboardPromotionalText":"Sample promo Text",
        "heroImage":{
            "path":"/general/heroImage.jpg",
            "url":"http://localhost:9080/file/general/heroImage.jpg"
        },
        "collectionForFeaturedProductsId":"cat80051"
    },
    "isExternalProfilePropertiesDisplayEnabled":false
}
```

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

### Getting Started with Oracle Commerce Cloud REST API

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-notification-messages

Guides users on how to get started with the Oracle Commerce Cloud REST API, covering authentication, sending requests, and understanding query parameters and status codes.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

### Description
This section provides essential information to help you get started with the Oracle Commerce Cloud REST API. Learn how to authenticate your requests, send requests, utilize query parameters, and understand the various status and error codes.

### Key Topics
- **Quick Start:** A streamlined guide to begin making API calls.
- **REST API Authentication:** Details on how to authenticate your requests to access the API.
- **Send Requests:** Instructions on how to structure and send requests to the API endpoints.
- **Query Parameters:** Information on how to use query parameters to filter and sort data.
- **Status Codes:** Explanation of common HTTP status codes returned by the API.
- **Error Messages:** Guidance on understanding and handling error responses.
```

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

### Oracle Commerce Cloud REST API - Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-orders

Guides and information to help developers get started with the Oracle Commerce Cloud REST API, including authentication, making requests, and understanding parameters and status codes.

```APIDOC
## Get Started with Oracle Commerce Cloud REST API

### Description
This section provides essential guides for developers to begin using the Oracle Commerce Cloud REST API effectively. It covers crucial aspects such as authentication, constructing requests, and interpreting responses.

### Guides
- **Quick Start**: A brief guide to get you up and running with the API quickly.
- **REST API Authentication**: Learn how to authenticate your requests to access the API.
- **Send Requests**: Instructions on how to format and send requests to the API endpoints.
- **Query Parameters**: Details on using query parameters to filter and refine your API requests.
- **Status Codes**: Understand the meaning of different HTTP status codes returned by the API.
- **Error Messages**: Information on how to interpret and handle error responses from the API.
```

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

### Get Started - Send Requests

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

Guidance on how to send requests to the Oracle Commerce Cloud REST API.

```APIDOC
## Get Started - Send Requests

### Description
Instructions and best practices for sending HTTP requests to the Oracle Commerce Cloud REST API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started with REST API Authentication

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

Guides users through the process of authenticating their requests to the Oracle Commerce Cloud REST API.

```APIDOC
## REST API Authentication

### Description
This section details the authentication mechanisms required to access the Oracle Commerce Cloud REST API. It covers the necessary steps and credentials to ensure secure access to your data and services.

### Method
N/A (Informational)

### Endpoint
N/A (Informational)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started - Query Parameters

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/op-ccadmin-v1-componentinstances-id-locale-locale-put

Information about how to use query parameters to filter and sort data in API requests.

```APIDOC
## Get Started - Query Parameters

### Description
This section details the usage of query parameters within the Oracle Commerce Cloud REST API. Learn how to append parameters to your URLs to filter, sort, or paginate results, customizing the data you receive.

### Method
N/A (Informational section)

### Endpoint
N/A (Informational section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Started

Source: https://docs.oracle.com/en/cloud/saas/cx-commerce/cxocc/api-admin-publishing

Information to help you begin using the Oracle Commerce Cloud REST API, including authentication and making requests.

```APIDOC
## Get Started

### Description
This section guides new users through the initial steps of using the Oracle Commerce Cloud REST API. It covers essential topics like setting up authentication, sending your first requests, and understanding common query parameters and status codes.

### Quick Start
Details on how to quickly begin making API calls.

### REST API authentication
Information on how to authenticate your requests to the Oracle Commerce Cloud API.

### Send Requests
Guidance on how to construct and send requests to the API endpoints.

### Query Parameters
Explanation of available query parameters for filtering, sorting, and paginating results.

### Status Codes
List and explanation of HTTP status codes returned by the API.

### Error Messages
Details on common error messages and how to handle them.

### Endpoint
N/A (Conceptual section)

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Create Site Request Example (JSON)

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

An example JSON payload demonstrating the structure for creating a new site. This example includes a list of price list groups and site types, along with a site name.

```json
{
    "properties":{
        "priceListGroupList":[
            {
                "id":"EURO"
            },
            {
                "id":"defaultPriceGroup"
            }
        ],
        "name":"CloudLake US Site test",
        "siteTypes":[
            "b2bCommerce"
        ]
    }
}

```