Docs
  • Get started
  • Guides
  • API reference
  • Plans
Start free
Introduction

For merchants

For developers

Machine access
API reference
Add cart item POSTApply coupon POSTCreate cart POSTGet cart GETHealth check GETResolved caller (tenant + scopes) GETGet order by id GETGet product by id GETGet product by URL slug GETStore metadata GETList payment methods for cart GETList shipping methods for cart GETList categories GETCountries (shared reference data) GETList customer orders GETSearch / list products GETPlace order from cart POSTRemove coupon DELETERemove cart item DELETESet billing address PUTSet shipping address PUTSelect shipping method PATCHUpdate cart item quantity PATCH

For contributors

Deployment
API referenceStorefront

Health check

GET
/health

Response Body

Success

application/json
  1. response
  1. response
  2. …
status*string
Example Request
curl -X GET 'https://api-prood.vercel.app/v1/health'
Example Response
{  "status": "ok"}

Get cart GET

Previous Page

Resolved caller (tenant + scopes) GET

Next Page

Example Request
curl -X GET 'https://api-prood.vercel.app/v1/health'
{
  "status": "ok"
}