j1.0.7
API Overview
The Replications API provides tools for managing content replication and synchronization across your Commerce Cloud instance. Use this API to control replication throughout your commerce infrastructure.
The API currently supports:
- Granular Replication: Publishing individual items
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
This API uses OAuth 2.0 authentication via Account Manager (AmOAuth2). You must include the relevant scope(s) in the client ID used to generate the token. For details, see the Authorization Scopes Catalog.
sfcc.granular-replications.rw- Enables the triggering of publish processes and access to details about publish processes, for example: monitoring purposes.sfcc.granular-replications- Enables access to details about publish processes, for example: monitoring purposes.
For detailed setup instructions, see the Authorization for Admin APIs guide.
Use Cases
Granular Replication
The granular replication feature addresses the need to make small updates to existing content in production on an as-needed basis. You can make granular data updates for these three replication groups:
- Products: Update specific products from staging to production.
- Price Books: Update specific price table entries from staging to production.
- Content Assets: Update specific content assets from staging to production. Page Designer pages replicate as content assets with all their components.
Granular Replication is meant to complement and enhance existing data replications, not replace it.
All granular replication related endpoints are available using:
https://{shortCode}.api.commercecloud.salesforce.com/operation/replications/v1/organizations/{organizationId}/granular-processes
Publish Items (POST /granular-processes)
Queues an item, such as products, price tables, and content assets, for the upcoming publish operation.
:::note The published price table is always the table with the continuously valid period. :::
List Publish Processes (GET /granular-processes)
Retrieve a list of all publish processes with pagination support.
Get Publish Process (GET /granular-processes/{id})
Retrieve details of a specific publish process using its ID.
Publish Process Lifecycle
All publish processes follow this lifecycle:
queued: Publish process initiated and waiting for publish operation to run.in_progress: Publish operation is running.completed: Publish operation completed and the item was successfully published.failed: The publish operation completed, but an error was detected.
Let us know so we can improve!