j
Scripts
1.0.0
API Overview
The Scripts API provides endpoints for managing code versions on a Commerce Cloud instance.
Overview
Code versions represent deployable bundles of cartridge code. This API allows administrators to list, create, read, update, and delete code versions on their Commerce Cloud instance.
Key Features
- List Code Versions: Retrieve all code versions available on the instance
- Get Code Version: Get detailed information about a specific code version
- Create Code Version: Create or replace a code version using PUT
- Update Code Version: Modify code version properties, such as activating a code version
- Delete Code Version: Remove a code version (the active code version cannot be deleted)
Authentication
This API requires OAuth 2.0 authentication with the appropriate scopes:
sfcc.scripts- Read access to code version resourcessfcc.scripts.rw- Read and write access to code version resources
Best Practices
- Always verify which code version is active before making changes
- Use PATCH to update specific properties like activating a code version
- Avoid deleting the active code version - deactivate it first
- Use the GET list endpoint to discover available code versions before performing operations
https://{shortCode}.api.commercecloud.salesforce.com/dx/scripts/v1
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!