Build with the Storefront API
Connect your app to live inventory and pickup ordering. Bring the menu into your product and follow each order from cart to pickup.
InventoryExample response
GET /api/v1/inventory
{
"locationId": "downtown",
"items": [{
"productId": "product-123",
"name": "House Blend",
"price": 20,
"availableQuantity": 12
}],
"nextCursor": null
}
Download OpenAPI
What you can build
Keep your catalog in sync
Read store locations, products, and available quantities to keep your app's menu current.
Take pickup orders
Create a cart, set item quantities, submit an order, and check its status. Customers pay at pickup.
Manage your customers
Create and update customer records for your integration with permissions granted by the store.
Apply for API access
Tell us what you plan to build and which API capabilities you need. The store team reviews each request and can issue a key with the appropriate permissions.
Preview the quickstartApplication received
The store team can now review your request.
Reference
