Use the SCAPI Admin APIs

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

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.

Before using SCAPI Admin APIs, ensure you have:

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

For authentication setup details, see Authorization.

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.

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

Implementation:

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

Key APIs: Admin Inventory

Goal: Automate CDN zone configuration across multiple environments

Implementation:

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

Key APIs: Admin CDN

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

Implementation:

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

Key APIs: Admin Product, Admin Pricing, Admin Inventory

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

Implementation:

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

Key APIs: Admin Customer

Goal: Deploy consistent site settings across multiple B2C Commerce sites

Implementation:

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

Key APIs: Admin Site, Admin Configuration

• 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.

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

• Test and Measure Your APIs
• Security