Admin API
Manage catalog, inventory, customers, orders, fulfillment, payments, and store settings.
Last updated:
Use Admin API to automate an organization's internal operations. Protected operations require a token with the corresponding permissions.
API areas
Platform & Identity
Organizations, stores, domains, settings, and API keys.
Catalog
Products, variants, categories, pricing, and catalog enrichment.
Inventory
Stock, reservations, availability, and inventory movements.
Customers
Customer profiles, addresses, groups, and activity.
Orders
Orders, drafts, statuses, and post-purchase operations.
Fulfillment & Shipping
Fulfillment, shipping, rates, zones, pickup, and coverage.
Payments & Finance
Billing, credits, payment operations, sellers, and commissions.
Promotions
Discounts, coupons, and promotional pricing rules.
Storage
Files, directories, and the media library for catalog and content.
Webhooks
Subscriptions, events, deliveries, retries, and operational control.
Version and downloads
Version 1.0.0 of the published contract.