Use the SCAPI Admin APIs

This section contains guidance and information for specific APIs in the SCAPI Admin API family.

Admin API Overview

The SCAPI Admin APIs enable backend operations, integrations, and automation for your B2C Commerce implementation. All Admin APIs require Account Manager authentication.

For the full, current list of Admin APIs and endpoint details, use the B2C Commerce API references.

Authentication Prerequisites

Before using SCAPI Admin APIs, ensure you have:

Account Manager credentials - Set up through Account Manager in Business Manager
Appropriate permissions - Admin APIs require specific role-based permissions
API client configuration - Some Admin APIs require dedicated API client setup
Base URL and organization ID - Obtain from your Business Manager instance

For authentication setup details, see Authorization.

Common Automation Scenarios

These scenarios are implementation patterns you can adapt. API capabilities and surfaces evolve over time, so always validate endpoint details against the B2C Commerce API references.

Scenario 1: Automated Inventory Synchronization

Goal: Sync inventory levels from an external warehouse management system (WMS) to B2C Commerce

Implementation:

Extract: Retrieve inventory data from your WMS
Transform: Map WMS data to OCI inventory record format
Load: Use Admin Inventory API to bulk update availability
Monitor: Track sync status and handle errors

Key APIs: Admin Inventory

Scenario 2: CDN Configuration Management

Goal: Automate CDN zone configuration across multiple environments

Implementation:

Define: Create CDN zone configuration templates
Deploy: Use Admin CDN API to create and configure zones
Configure: Set up WAF rules, SSL certificates, and cache policies
Monitor: Enable log forwarding for CDN analytics

Key APIs: Admin CDN

Scenario 3: Product Catalog Updates

Goal: Automate daily product data synchronization from a Product Information Management (PIM) system

Implementation:

Extract: Get product updates from PIM system
Validate: Verify product data format and required fields
Update: Use Admin Product API to update product attributes, prices, and availability
Verify: Confirm updates through Shopper Product API

Key APIs: Admin Product, Admin Pricing, Admin Inventory

Scenario 4: Customer Data Integration

Goal: Sync customer profiles between B2C Commerce and a Customer Data Platform (CDP)

Implementation:

Identify changes: Detect customer profile updates in either system
Sync: Use Admin Customer API for bulk updates or individual profile changes
Reconcile: Handle conflicts and maintain data consistency
Audit: Log all sync operations for compliance

Key APIs: Admin Customer

Scenario 5: Multi-Site Configuration Deployment

Goal: Deploy consistent site settings across multiple B2C Commerce sites

Implementation:

Define: Create configuration templates for site preferences
Deploy: Use Admin Site API to apply settings across sites
Validate: Verify configurations through API calls
Document: Track configuration changes for audit purposes

Key APIs: Admin Site, Admin Configuration

Additional Resources

For ongoing API additions and changes, monitor the Commerce API release notes.
For Storefront Next operational context, see Managed Runtime in Storefront Next.
CDN zones: Configure content delivery settings, including web application firewall (WAF) rules, and log forwarding, and also configure certificates.
Omnichannel Inventory (OCI): Manage product inventory for products.
The Shopper Login Admin API information is categorized as part of the Shopper APIs. For details, see SLAS Admin.

Next Steps

Use the following links to optimize your storefront’s performance and security: