Admin basics
Use the Admin APIs to create to manage your site, products available on your storefront, and subscriptions.
Last updated
Was this helpful?
Use the Admin APIs to create to manage your site, products available on your storefront, and subscriptions.
Last updated
Was this helpful?
Explore the Admin APIs within the Commerce API suite designed to offer a comprehensive end-to-end administrator experience. These APIs empower administrators to programmatically manage various aspects of eCommerce operations, from order and inventory management to customer relations and subscription services. With these tools, administrators can streamline operations, implement dynamic promotional strategies, and enhance customer satisfaction while maintaining compliance and operational efficiency. Whether managing order details, deploying offers, handling refunds, or customizing site settings, the Admin APIs provide the necessary flexibility and control to optimize your eCommerce platform.
Order management: This feature allows administrators to efficiently retrieve order details and download invoices, streamlining the order management process.
Offer management: This feature enables the creation and deployment of offers, allowing for dynamic promotional strategies.
Refund management: This feature includes creating refunds, accessing available and specific order refunds, managing refunds for a shopper's order, obtaining a JSON schema for order refunds, and handling refunds for delayed payment methods and various refund scenarios.
Subscription management: Administrators have comprehensive control over subscription handling, including updating expiration dates, modifying renewal products and prices, changing external reference identifiers, and adjusting billing and shipping details. Additionally, the ability to assign perpetual pricing, apply midterm price overrides, and send out subscription notifications enhances the flexibility and management of subscription services. See the section for additional information on managing subscriptions.
Customer management: This feature enables administrators to access and manage customer information, including retrieving detailed customer profiles and handling requests to remove personal information (PII).
Site management: This feature enables administrators to customize and configure site-related settings, specifically focusing on managing which authorized countries for shipping and billing. This function is critical for tailoring the eCommerce operations to specific markets and compliance requirements.
Product management: This feature allows you to manage products, retrieve product details, and monitor product task status, streamlining product oversight and catalog operations.
File management: This feature allows you to download files, aiding in the handling and distributing of digital assets within the eCommerce framework.