Storefront API
Build custom storefronts with the Cartly public REST API. No authentication required — just pass the Shop ID header.
Key Endpoints
All storefront endpoints are public and require the X-Shop-ID header.
{shop_id} / X-Shop-ID is your Store ID — the shop UUID shown in the admin under Settings → Store Information (with a copy button).
GET
/shops/{shopId}/productsList all published products with variants, images, and pricing
Parameters
| limit | integer | Max results (default 20, max 100) | |
| offset | integer | Pagination offset | |
| collection | string | Filter by collection slug |
POST
/shops/{shopId}/cart/addAdd item to cart
Request Body
json
{
"quantity": 1,
"variant_id": "uuid"
}