Skip to content

Storefront API ​

Use the Storefront API to build the customer-facing pages of a store: the product list, the product page, related products, and the payment options at checkout.

These endpoints are public. They do not need a customer token. Send the X-MerchantApiKey header so that the API can find the store. The storefront product endpoints return only products that are not archived. They return the public product data and do not return cost price or profit.

Endpoints ​

EndpointMethodPath
Get Storefront ProductsGET/v1/storefront/products
Get Storefront ProductGET/v1/storefront/products/{productId}
Get Storefront Product by SlugGET/v1/storefront/products/slug/{slug}
Get Similar Storefront ProductsGET/v1/storefront/products/similar/by/category/{productId}
Get Top Selling Storefront ProductsGET/v1/storefront/products/top-selling
Get Storefront Payment GatewaysGET/v1/storefront/payment-gateways

Typical storefront flow ​

  1. Show the product list: Get Storefront Products.
  2. Show a product page: Get Storefront Product.
  3. Add the product to the cart: Cart V2.
  4. Show the payment options: Get Storefront Payment Gateways.
  5. Create the order: Checkout (V2).

Errors ​

StatusMessageCause
400'PRODUCT' is no longer available.The product is archived.
404Product not foundThe product ID or slug does not exist.

Build with joy