For the complete documentation index, see llms.txt. This page is also available as Markdown.

Oracle Commerce Cloud

This guide is intended for Oracle Commerce Cloud (OCC) merchants who are connecting their store to Violet. During this process, you will register a server-side integration in your OCC admin dashboard and then provide the generated application key to Violet through the Violet Connect onboarding tool. You will retain full control of the registered integration and can remove it at any time from within your OCC admin. Total time for completion is around 5 minutes.

Prerequisites

  • An active Oracle Commerce Cloud instance with admin access.

  • Permission to register server-side integrations in the OCC admin UI.

Step 1: Registering a Server-Side Integration

  1. Sign in to the OCC Admin UI for your store (typically at https://your-store.oracleoutsourcing.com/occs-admin).

  2. Navigate to Settings > Integrations (or Settings > Web APIs, depending on your OCC version).

  3. Click Register a New Integration (or Add Application).

  4. Enter a Name for the integration that will help you identify it later (e.g. Violet or the name of the channel you are connecting to).

  5. Select Server as the integration type. This generates a JWT application key for server-to-server communication.

  6. Once saved, the Application Key will be displayed. Copy this value and keep it available for Step 3 of this guide.

Step 2: Locating Your Store URL

  1. Your OCC store URL is the hostname of your Oracle Commerce Cloud instance (e.g. https://mystore.oracle.com or https://your-store.oracleoutsourcing.com).

  2. You can confirm this by checking the address bar in your OCC admin dashboard.

  3. Have this URL ready — you will paste it into Violet in Step 3. Violet will normalize the value, so trailing slashes or mixed casing are fine.

Step 3: Provide Credentials to Violet

  1. In the Violet Connect onboarding tool, select Oracle Commerce Cloud as your platform.

  2. Enter your Store URL from Step 2 and click Next.

  3. Paste the Application Key from Step 1 into the Application Key field.

  4. Submit the form. Violet will immediately validate the credentials by authenticating against your OCC instance. If the credentials are valid, you will be redirected to the next step of onboarding; if they are rejected, you will see an error message and can retry with corrected values.

Upon success you will be redirected back to the channel who first sent you to Violet.

Credential Summary

Credential
Required
Where to find it
Example

Application Key

Yes

OCC Admin UI > Settings > Integrations (server-side key)

eyJhbGciOiJSUzI1NiIs...

Store URL

Yes

OCC Admin dashboard address bar

https://mystore.oracle.com

How Violet Uses Your Credentials

Violet uses the Application Key to authenticate with your OCC instance via the /ccadmin/v1/login endpoint using the client_credentials grant type. This returns a short-lived access token (valid for 5 minutes) that Violet uses to:

  • Read your product catalog to make your items available for purchase through connected channels.

  • Read and create orders when a purchase is made through a connected channel.

  • Read inventory to ensure accurate availability information.

  • Read shipping methods to present shipping options during checkout.

Access tokens are automatically refreshed as needed. Your Application Key itself is stored securely and encrypted at rest.

Special Considerations

Credential Security

Your OCC Application Key grants server-level access to your store's Admin API, including products, orders, and customer data. Treat it like a password:

  • Never share it outside of the secure Violet onboarding form.

  • Do not embed it in client-side code, screenshots, or support tickets.

  • If you suspect the Application Key has been compromised, revoke it immediately (see below) and generate a new one.

Token Expiration

OCC access tokens expire after 5 minutes. Violet handles token refresh automatically in the background — no action is required on your part. The underlying Application Key does not expire unless you revoke it.

Revoking Credentials

To revoke your credentials at any time:

  1. Sign in to the OCC Admin UI.

  2. Navigate to Settings > Integrations.

  3. Locate the integration you created for Violet.

  4. Delete or deactivate the integration.

Once revoked, all subsequent Violet API calls to your store will fail with an authorization error. Register a new integration and provide the new Application Key to Violet to restore the connection.

Permissions

OCC effective permissions are derived from the role membership assigned to the integration at registration time, not from per-call requested scopes. Ensure that the integration has sufficient permissions to read products, orders, inventory, and shipping methods. If in doubt, consult your OCC administrator or Oracle's documentation on server-side integration roles.

Last updated

Was this helpful?