{ "openapi": "3.1.0", "info": { "title": "Sellora REST API", "version": "1.0.0", "description": "Headless / mobile access to the Sellora store.\n\n**Envelope.** Successful responses are `{data, meta?, links?}` (plus an optional `message`). Errors are `{message, errors?}` with the proper HTTP status (401, 403, 404, 422, 429, 503).\n\n**Authentication.** `POST /auth/login` returns a Bearer token (Laravel Sanctum): send `Authorization: Bearer `.\n\n**Guest cart.** The first cart write returns `X-Cart-Token`; send it on every cart / checkout call until the customer signs in.\n\n**Localisation.** `Accept-Language` selects the language, `X-Currency` the display currency; all money values are `{amount, formatted, currency}`.\n\n**Rate limits.** 60 requests/minute for guests (per IP), 120 for authenticated tokens (per user); credential and public-write endpoints allow 10/minute per IP. Limit headers: `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `Retry-After` on 429." }, "servers": [ { "url": "/api/v1", "description": "This store" } ], "tags": [ { "name": "Bootstrap", "description": "Everything a client needs to start." }, { "name": "Auth", "description": "Sanctum personal access tokens." }, { "name": "Catalog", "description": "Browse and search the catalog." }, { "name": "Reviews", "description": "Customer reviews." }, { "name": "Cart", "description": "Guest (X-Cart-Token) or customer cart." }, { "name": "Checkout", "description": "Place an order and pay." }, { "name": "Orders", "description": "Order history and tracking." }, { "name": "Account", "description": "Signed-in customer data." }, { "name": "Content", "description": "Pages, blog, contact and newsletter." } ], "paths": { "/bootstrap": { "get": { "tags": [ "Bootstrap" ], "summary": "App bootstrap", "operationId": "getBootstrap", "description": "Store info, active theme key and design tokens, languages, currencies, menus (main, categories, footer), the category tree, enabled features, public payment-method info and countries. Call it once at start-up and whenever the user changes language or currency.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "store": { "type": "object", "properties": { "name": { "type": "string" }, "tagline": { "type": "string" }, "logo": { "type": "string" }, "logo_dark": { "type": "string" }, "favicon": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "country": { "type": "string" }, "version": { "type": "string" } } }, "theme": { "type": "object", "properties": { "key": { "type": "string" }, "tokens": { "type": "object", "properties": { "--mk-bg": { "type": "string" }, "--mk-text": { "type": "string" }, "--mk-body": { "type": "string" }, "--mk-line": { "type": "string" }, "--mk-surface": { "type": "string" }, "--mk-card": { "type": "string" }, "--mk-media": { "type": "string" }, "--mk-header": { "type": "string" }, "--mk-header-glass": { "type": "string" }, "--mk-dark": { "type": "string" }, "--mk-dark-2": { "type": "string" }, "--mk-on-dark": { "type": "string" }, "--mk-btn": { "type": "string" }, "--mk-btn-hover": { "type": "string" }, "--mk-on-btn": { "type": "string" }, "--mk-accent": { "type": "string" }, "--mk-accent-rgb": { "type": "string" }, "--mk-accent-dark": { "type": "string" }, "--mk-accent-soft": { "type": "string" }, "--mk-accent-bright": { "type": "string" }, "--mk-on-accent": { "type": "string" }, "--mk-pop": { "type": "string" }, "--mk-sale": { "type": "string" }, "--mk-sale-soft": { "type": "string" }, "--mk-sale-text": { "type": "string" }, "--mk-star": { "type": "string" }, "--mk-radius": { "type": "string" }, "--mk-radius-lg": { "type": "string" }, "--mk-radius-sm": { "type": "string" }, "--mk-radius-xl": { "type": "string" }, "--mk-media-ratio": { "type": "string" }, "--mk-media-inset": { "type": "string" }, "--mk-display": { "type": "string" }, "--mk-sans": { "type": "string" }, "--mk-news-bg": { "type": "string" }, "color-scheme": { "type": "string" } } } } }, "locale": { "type": "string" }, "default_locale": { "type": "string" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "native_name": { "type": "string" }, "direction": { "type": "string" }, "is_default": { "type": "boolean" } } } }, "currency": { "type": "string" }, "default_currency": { "type": "string" }, "currencies": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "symbol_position": { "type": "string" }, "decimals": { "type": "integer" }, "rate": { "type": "integer" }, "is_default": { "type": "boolean" }, "example": { "type": "string" } } } }, "menus": { "type": "object", "properties": { "main": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "badge": { "type": "string" }, "new_tab": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "badge": { "type": [ "string", "null" ] }, "new_tab": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } }, "footer": { "type": "object", "properties": { "column_1": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "badge": { "type": [ "string", "null" ] }, "new_tab": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } }, "column_2": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "icon": { "type": [ "string", "null" ] }, "badge": { "type": [ "string", "null" ] }, "new_tab": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } } } } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } } } } }, "features": { "type": "object", "properties": { "reviews": { "type": "boolean" }, "guest_reviews": { "type": "boolean" }, "wishlist": { "type": "boolean" }, "guest_wishlist": { "type": "boolean" }, "compare": { "type": "boolean" }, "questions": { "type": "boolean" }, "stock_alerts": { "type": "boolean" }, "coupons": { "type": "boolean" }, "guest_checkout": { "type": "boolean" }, "newsletter": { "type": "boolean" }, "reward_points": { "type": "boolean" }, "email_verification": { "type": "boolean" } } }, "checkout": { "type": "object", "properties": { "min_order_amount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "phone_required": { "type": "boolean" }, "terms_required": { "type": "boolean" }, "order_note": { "type": "boolean" } } }, "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "offline": { "type": "boolean" } } } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "store": { "name": "Loom", "tagline": "Clothes worth keeping", "logo": "http://localhost/assets/images/sellora/logo.svg", "logo_dark": "http://localhost/assets/images/sellora/logo-white.svg", "favicon": "http://localhost/assets/images/sellora/icon-32.png", "email": "hello@loom.store", "phone": "1-800-555-0199", "country": "US", "version": "1.0.0" }, "theme": { "key": "fashion", "tokens": { "--mk-bg": "#ffffff", "--mk-text": "#151412", "--mk-body": "#75706a", "--mk-line": "#e8e3dc", "--mk-surface": "#f5f2ed", "--mk-card": "#ffffff", "--mk-media": "#f2eee8", "--mk-header": "#ffffff", "--mk-header-glass": "rgba(255, 255, 255, 0.9)", "--mk-dark": "#151412", "--mk-dark-2": "#26231f", "--mk-on-dark": "#ffffff", "--mk-btn": "#151412", "--mk-btn-hover": "#2f2b27", "--mk-on-btn": "#ffffff", "--mk-accent": "#b5532f", "--mk-accent-rgb": "181 83 47", "--mk-accent-dark": "#97411f", "--mk-accent-soft": "#f7ebe3", "--mk-accent-bright": "#f0a07d", "--mk-on-accent": "#ffffff", "--mk-pop": "#f5c7a9", "--mk-sale": "#b5532f", "--mk-sale-soft": "#f7ebe3", "--mk-sale-text": "#97411f", "--mk-star": "#151412", "--mk-radius": "14px", "--mk-radius-lg": "18px", "--mk-radius-sm": "10px", "--mk-radius-xl": "0px", "--mk-media-ratio": "3 / 4", "--mk-media-inset": "9%", "--mk-display": "\"Helvetica Now Display\", \"Inter\", sans-serif", "--mk-sans": "\"Inter\", \"Helvetica Now Display\", system-ui, sans-serif", "--mk-news-bg": "linear-gradient(120deg, #151412 0%, #2c2621 100%)", "color-scheme": "light" } }, "locale": "en", "default_locale": "en", "languages": [ { "code": "en", "name": "English", "native_name": "English", "direction": "ltr", "is_default": true } ], "currency": "USD", "default_currency": "USD", "currencies": [ { "code": "USD", "name": "US Dollar", "symbol": "$", "symbol_position": "before", "decimals": 2, "rate": 1, "is_default": true, "example": "$1,234.50" }, { "code": "EUR", "name": "Euro", "symbol": "€", "symbol_position": "after_sp", "decimals": 2, "rate": 0.92, "is_default": false, "example": "1.135,74 €" } ], "menus": { "main": [ { "id": 19, "title": "New in", "type": "custom", "url": "http://localhost/shop?sort=newest", "icon": null, "badge": "New", "new_tab": false, "children": [] }, { "id": 20, "title": "Women", "type": "category", "url": "http://localhost/category/women", "icon": null, "badge": null, "new_tab": false, "children": [] } ], "categories": [ { "id": 24, "title": "Coats", "type": "category", "url": "http://localhost/category/coats-jackets", "icon": null, "badge": null, "new_tab": false, "children": [] }, { "id": 25, "title": "Knitwear", "type": "category", "url": "http://localhost/category/knitwear", "icon": null, "badge": null, "new_tab": false, "children": [] } ], "footer": { "column_1": [ { "id": 35, "title": "New in", "type": "custom", "url": "http://localhost/shop?sort=newest", "icon": null, "badge": null, "new_tab": false, "children": [] }, { "id": 36, "title": "Shop the look", "type": "custom", "url": "http://localhost/#look", "icon": null, "badge": null, "new_tab": false, "children": [] } ], "column_2": [ { "id": 40, "title": "Track an order", "type": "custom", "url": "http://localhost/track-order", "icon": null, "badge": null, "new_tab": false, "children": [] }, { "id": 41, "title": "Delivery", "type": "page", "url": "http://localhost/page/shipping-policy", "icon": null, "badge": null, "new_tab": false, "children": [] } ] } }, "categories": [ { "id": 1, "parent_id": null, "slug": "women", "name": "Women", "description": "Dresses, knitwear, coats and everyday separates from independent womenswear labels. Cut for real bodies and built to be worn for years.", "url": "http://localhost/category/women", "image": { "url": "http://localhost/assets/images/product/product-fashion-23.png", "alt": "Women", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-23.png", "small": "http://localhost/assets/images/product/product-fashion-23.png", "medium": "http://localhost/assets/images/product/product-fashion-23.png", "large": "http://localhost/assets/images/product/product-fashion-23.png" } }, "banner": null, "icon": "i-hanger", "is_featured": false, "children": [ { "id": 2, "parent_id": 1, "slug": "dresses", "name": "Dresses", "description": "Slip dresses, knit dresses and shirt dresses for work, weekends and everything in between. Fluid fabrics that move with you.", "url": "http://localhost/category/dresses", "image": { "url": "http://localhost/assets/images/product/product-fashion-35.png", "alt": "Dresses", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-35.png", "small": "http://localhost/assets/images/product/product-fashion-35.png", "medium": "http://localhost/assets/images/product/product-fashion-35.png", "large": "http://localhost/assets/images/product/product-fashion-35.png" } }, "banner": null, "icon": "i-hanger", "is_featured": true, "children": [] }, { "id": 3, "parent_id": 1, "slug": "knitwear", "name": "Knitwear", "description": "Chunky turtlenecks, cable jumpers and cropped cardigans in wool, merino and recycled blends. Warm, soft and made to layer.", "url": "http://localhost/category/knitwear", "image": { "url": "http://localhost/assets/images/product/product-fashion-27.png", "alt": "Knitwear", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-27.png", "small": "http://localhost/assets/images/product/product-fashion-27.png", "medium": "http://localhost/assets/images/product/product-fashion-27.png", "large": "http://localhost/assets/images/product/product-fashion-27.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true, "children": [] } ] }, { "id": 5, "parent_id": null, "slug": "men", "name": "Men", "description": "Overshirts, hoodies, outerwear and relaxed tailoring for the modern wardrobe. Honest fabrics, simple shapes and a considered fit.", "url": "http://localhost/category/men", "image": { "url": "http://localhost/assets/images/articles/article-fashion-06.png", "alt": "Men", "sizes": { "thumb": "http://localhost/assets/images/articles/article-fashion-06.png", "small": "http://localhost/assets/images/articles/article-fashion-06.png", "medium": "http://localhost/assets/images/articles/article-fashion-06.png", "large": "http://localhost/assets/images/articles/article-fashion-06.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true, "children": [ { "id": 6, "parent_id": 5, "slug": "shirts", "name": "Shirts", "description": "Chambray, flannel, silk-blend and oxford shirts in easy fits. Wear them buttoned up or open over a tee.", "url": "http://localhost/category/shirts", "image": { "url": "http://localhost/assets/images/articles/article-fashion-08.png", "alt": "Shirts", "sizes": { "thumb": "http://localhost/assets/images/articles/article-fashion-08.png", "small": "http://localhost/assets/images/articles/article-fashion-08.png", "medium": "http://localhost/assets/images/articles/article-fashion-08.png", "large": "http://localhost/assets/images/articles/article-fashion-08.png" } }, "banner": null, "icon": "i-shirt", "is_featured": false, "children": [] } ] } ], "features": { "reviews": true, "guest_reviews": true, "wishlist": true, "guest_wishlist": true, "compare": true, "questions": true, "stock_alerts": true, "coupons": true, "guest_checkout": true, "newsletter": true, "reward_points": false, "email_verification": false }, "checkout": { "min_order_amount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "phone_required": true, "terms_required": true, "order_note": true }, "payment_methods": [ { "key": "cod", "title": "Cash on Delivery", "description": "Pay with cash when your order is delivered.", "instructions": "Please have the exact amount ready when the courier arrives.", "offline": true }, { "key": "bank_transfer", "title": "Bank Transfer", "description": "Transfer the order total to our bank account. Your order ships once the payment is received.", "instructions": "Bank: Example Bank\nAccount name: Sellora Store\nIBAN: XX00 0000 0000 0000 0000\nUse your order number as the payment reference.", "offline": true } ], "countries": [ { "code": "AF", "name": "Afghanistan" }, { "code": "AX", "name": "Åland Islands" } ] } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/home": { "get": { "tags": [ "Bootstrap" ], "summary": "Home screen sections", "operationId": "getHome", "description": "The active home sections of the storefront theme (hero, carousels, category strips ...) in display order, each with `type`, `variant`, `settings` and resolved `items`. Empty sections are omitted.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "variant": { "type": "string" }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "slider_key": { "type": "string" }, "aria_label": { "type": "string" }, "side_blocks": { "type": "array", "items": {} }, "left_blocks": { "type": "array", "items": {} }, "right_blocks": { "type": "array", "items": {} }, "row_blocks": { "type": "array", "items": {} }, "sidebar_title": { "type": "string" }, "sidebar_all_text": { "type": "string" }, "sidebar_limit": { "type": "integer" }, "slider_id": { "type": "integer" } } }, "items": { "type": "object", "properties": { "slides": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slider_id": { "type": "integer" }, "title": { "type": "object", "properties": { "en": { "type": "string" } } }, "subtitle": { "type": "object", "properties": { "en": { "type": "string" } } }, "description": { "type": "object", "properties": { "en": { "type": "string" } } }, "badge": { "type": "object", "properties": { "en": { "type": "string" } } }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": [ "string", "null" ] }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "mobile_image": { "type": "string" }, "button_text": { "type": "object", "properties": { "en": { "type": "string" } } }, "button_url": { "type": "string" }, "button_2_text": { "type": [ "string", "null" ] }, "button_2_url": { "type": [ "string", "null" ] }, "settings": { "type": "object", "properties": { "bg": { "type": "string" }, "button_style": { "type": "string" }, "dark": { "type": "boolean" }, "image_alt": { "type": "string" } } }, "position": { "type": "integer" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } } }, "sideBlocks": { "type": "array", "items": {} }, "leftBlocks": { "type": "array", "items": {} }, "rightBlocks": { "type": "array", "items": {} }, "rowBlocks": { "type": "array", "items": {} }, "sidebarCategories": { "type": "array", "items": {} } } } } } }, "meta": { "type": "object", "properties": { "theme": { "type": "string" } } } } }, "example": { "data": [ { "id": 1, "type": "hero", "variant": "full", "title": "Hero slider", "settings": { "slider_key": "home-hero", "aria_label": "Featured collections", "side_blocks": [], "left_blocks": [], "right_blocks": [], "row_blocks": [], "sidebar_title": "Categories", "sidebar_all_text": "Browse all categories", "sidebar_limit": 9, "slider_id": 1 }, "items": { "slides": [ { "id": 1, "slider_id": 1, "title": { "en": "Statement *shades* & sharp outerwear" }, "subtitle": { "en": "From *$69*" }, "description": { "en": "Oversized frames, double-breasted coats and the knits to wear underneath." }, "badge": { "en": "New season" }, "image": { "url": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "alt": null, "sizes": { "thumb": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "small": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "medium": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "large": "http://localhost/assets/images/other/image-fashion-eight-01.jpg" } }, "mobile_image": "assets/images/other/image-fashion-eight-01.jpg", "button_text": { "en": "Shop the edit" }, "button_url": "route:front.shop?sort=newest", "button_2_text": null, "button_2_url": null, "settings": { "bg": "#ece5da", "button_style": "ink", "dark": false, "image_alt": "Two models in white oval sunglasses, a black coat and a graphic yellow top" }, "position": 1, "is_active": true, "created_at": "2026-10-02T12:56:53.000000Z", "updated_at": "2026-10-02T12:56:53.000000Z" }, { "id": 2, "slider_id": 1, "title": { "en": "Soft knits in *warm* tones" }, "subtitle": { "en": "Now *-25%*" }, "description": { "en": "Cable knits, turtlenecks and cardigans in wool you'll wear for years." }, "badge": { "en": "Knitwear week" }, "image": { "url": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "alt": null, "sizes": { "thumb": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "small": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "medium": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "large": "http://localhost/assets/images/other/image-fashion-eight-03.jpg" } }, "mobile_image": "assets/images/other/image-fashion-eight-03.jpg", "button_text": { "en": "Shop knitwear" }, "button_url": "category:knitwear", "button_2_text": null, "button_2_url": null, "settings": { "bg": "#211d1a", "class": "lm-slide-dark", "button_style": "light", "dark": true, "image_alt": "Model pulling an ecru cable-knit jumper over her face" }, "position": 2, "is_active": true, "created_at": "2026-10-02T12:56:53.000000Z", "updated_at": "2026-10-02T12:56:53.000000Z" } ], "sideBlocks": [], "leftBlocks": [], "rightBlocks": [], "rowBlocks": [], "sidebarCategories": [] } }, { "id": 2, "type": "category_strip", "variant": "portraits", "title": "Shop the edit", "settings": { "anchor": "shop-by", "eyebrow": "Departments", "eyebrow_icon": "", "title": "Shop the edit", "link_text": "All categories", "link_url": "route:front.shop", "source": "featured", "category_slug": null, "category_slugs": [], "limit": 6, "count_label": ":count styles", "key": "", "tiles": [] }, "items": { "categories": [ { "id": 2, "parent_id": 1, "slug": "dresses", "name": "Dresses", "description": "Slip dresses, knit dresses and shirt dresses for work, weekends and everything in between. Fluid fabrics that move with you.", "url": "http://localhost/category/dresses", "image": { "url": "http://localhost/assets/images/product/product-fashion-35.png", "alt": "Dresses", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-35.png", "small": "http://localhost/assets/images/product/product-fashion-35.png", "medium": "http://localhost/assets/images/product/product-fashion-35.png", "large": "http://localhost/assets/images/product/product-fashion-35.png" } }, "banner": null, "icon": "i-hanger", "is_featured": true, "products_count": 2 }, { "id": 3, "parent_id": 1, "slug": "knitwear", "name": "Knitwear", "description": "Chunky turtlenecks, cable jumpers and cropped cardigans in wool, merino and recycled blends. Warm, soft and made to layer.", "url": "http://localhost/category/knitwear", "image": { "url": "http://localhost/assets/images/product/product-fashion-27.png", "alt": "Knitwear", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-27.png", "small": "http://localhost/assets/images/product/product-fashion-27.png", "medium": "http://localhost/assets/images/product/product-fashion-27.png", "large": "http://localhost/assets/images/product/product-fashion-27.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true, "products_count": 6 } ] } } ], "meta": { "theme": "fashion" } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/auth/register": { "post": { "tags": [ "Auth" ], "summary": "Create an account", "operationId": "postAuth/register", "description": "Rate limit: 10/min per IP.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "first_name", "email", "password", "password_confirmation", "terms" ], "properties": { "first_name": { "type": "string", "description": "First name" }, "last_name": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Unique e-mail address" }, "phone": { "type": "string", "description": "Phone (required when the store requires it)" }, "password": { "type": "string", "description": "Min. 8 characters" }, "password_confirmation": { "type": "string", "description": "Must match password" }, "terms": { "type": "boolean", "description": "Must be true" }, "newsletter": { "type": "boolean", "description": "Subscribe to the newsletter" }, "device_name": { "type": "string", "description": "Label of the token, e.g. the device" } } }, "example": { "first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com", "phone": "+1 555 0100", "password": "Secret123", "password_confirmation": "Secret123", "terms": true, "newsletter": false, "device_name": "iPhone 15" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string" }, "token_type": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "currency": { "type": "string" }, "dob": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "newsletter": { "type": "boolean" }, "points_balance": { "type": "integer" }, "email_verified": { "type": "boolean" }, "created_at": { "type": "string" } } } } }, "message": { "type": "string" } } }, "example": { "data": { "token": "10|xyMenAO09kOjJvHfAgYVoQ8ewfC3VkSFhucTeoQ917867a79", "token_type": "Bearer", "user": { "id": 6, "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "+1 555 0100", "avatar": null, "locale": "en", "currency": "USD", "dob": null, "gender": null, "newsletter": false, "points_balance": 0, "email_verified": false, "created_at": "2026-10-02T13:01:39+00:00" } }, "message": "Welcome, Jane! Your account is ready." } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Sign in and get a Bearer token", "operationId": "postAuth/login", "description": "Send `X-Cart-Token` to merge the guest cart into the account cart on sign-in. Failed attempts are throttled per e-mail and IP.\n\nRate limit: 10/min per IP.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "description": "E-mail address" }, "password": { "type": "string", "description": "Password" }, "device_name": { "type": "string", "description": "Label of the token" } } }, "example": { "email": "jane.doe@example.com", "password": "Secret123", "device_name": "iPhone 15" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string" }, "token_type": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "currency": { "type": "string" }, "dob": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "newsletter": { "type": "boolean" }, "points_balance": { "type": "integer" }, "email_verified": { "type": "boolean" }, "created_at": { "type": "string" } } } } }, "message": { "type": "string" } } }, "example": { "data": { "token": "11|K1SYozn7DZe4qAJNQ5HEhatRunW3xbPdXUWDndfU5a5857de", "token_type": "Bearer", "user": { "id": 6, "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "+1 555 0100", "avatar": null, "locale": "en", "currency": "USD", "dob": null, "gender": null, "newsletter": false, "points_balance": 0, "email_verified": false, "created_at": "2026-10-02T13:01:39+00:00" } }, "message": "Welcome back, Jane!" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "Revoke the current token", "operationId": "postAuth/logout", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "You have been signed out." } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/auth/me": { "get": { "tags": [ "Auth" ], "summary": "Current customer", "operationId": "getAuth/me", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "currency": { "type": "string" }, "dob": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "newsletter": { "type": "boolean" }, "points_balance": { "type": "integer" }, "email_verified": { "type": "boolean" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 6, "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "email": "jane.doe@example.com", "phone": "+1 555 0100", "avatar": null, "locale": "en", "currency": "USD", "dob": null, "gender": null, "newsletter": false, "points_balance": 0, "email_verified": false, "created_at": "2026-10-02T13:01:39+00:00" } } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "put": { "tags": [ "Auth" ], "summary": "Update the profile", "operationId": "putAuth/me", "description": "Every field is optional. Changing the e-mail or the password requires `current_password`.", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "First name" }, "last_name": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "New e-mail (needs current_password)" }, "phone": { "type": "string", "description": "Phone" }, "dob": { "type": "string", "description": "Date of birth (YYYY-MM-DD)" }, "gender": { "type": "string", "description": "female, male, other or prefer_not" }, "locale": { "type": "string", "description": "Preferred language code" }, "currency": { "type": "string", "description": "Preferred currency code" }, "newsletter": { "type": "boolean", "description": "Newsletter opt-in" }, "current_password": { "type": "string", "description": "Required with email / password changes" }, "password": { "type": "string", "description": "New password (with password_confirmation)" } } }, "example": { "first_name": "Janet", "last_name": "Doe", "newsletter": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "avatar": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "currency": { "type": "string" }, "dob": { "type": [ "string", "null" ] }, "gender": { "type": [ "string", "null" ] }, "newsletter": { "type": "boolean" }, "points_balance": { "type": "integer" }, "email_verified": { "type": "boolean" }, "created_at": { "type": "string" } } }, "message": { "type": "string" } } }, "example": { "data": { "id": 6, "first_name": "Janet", "last_name": "Doe", "name": "Janet Doe", "email": "jane.doe@example.com", "phone": "+1 555 0100", "avatar": null, "locale": "en", "currency": "USD", "dob": null, "gender": null, "newsletter": true, "points_balance": 0, "email_verified": false, "created_at": "2026-10-02T13:01:39+00:00" }, "message": "Your profile has been updated." } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/auth/password/forgot": { "post": { "tags": [ "Auth" ], "summary": "Send a password-reset e-mail", "operationId": "postAuth/password/forgot", "description": "Always answers 200, so it cannot be used to discover registered addresses.\n\nRate limit: 10/min per IP.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "Account e-mail" } } }, "example": { "email": "jane.doe@example.com" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "If an account exists for that e-mail address, a password reset link is on its way. Please check your inbox." } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/categories": { "get": { "tags": [ "Catalog" ], "summary": "Category tree", "operationId": "getCategories", "parameters": [ { "name": "flat", "in": "query", "required": false, "description": "Return a flat list with products_count instead of the tree", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" }, "children": { "type": "array", "items": {} } } } } } } } } }, "example": { "data": [ { "id": 1, "parent_id": null, "slug": "women", "name": "Women", "description": "Dresses, knitwear, coats and everyday separates from independent womenswear labels. Cut for real bodies and built to be worn for years.", "url": "http://localhost/category/women", "image": { "url": "http://localhost/assets/images/product/product-fashion-23.png", "alt": "Women", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-23.png", "small": "http://localhost/assets/images/product/product-fashion-23.png", "medium": "http://localhost/assets/images/product/product-fashion-23.png", "large": "http://localhost/assets/images/product/product-fashion-23.png" } }, "banner": null, "icon": "i-hanger", "is_featured": false, "children": [ { "id": 2, "parent_id": 1, "slug": "dresses", "name": "Dresses", "description": "Slip dresses, knit dresses and shirt dresses for work, weekends and everything in between. Fluid fabrics that move with you.", "url": "http://localhost/category/dresses", "image": { "url": "http://localhost/assets/images/product/product-fashion-35.png", "alt": "Dresses", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-35.png", "small": "http://localhost/assets/images/product/product-fashion-35.png", "medium": "http://localhost/assets/images/product/product-fashion-35.png", "large": "http://localhost/assets/images/product/product-fashion-35.png" } }, "banner": null, "icon": "i-hanger", "is_featured": true, "children": [] }, { "id": 3, "parent_id": 1, "slug": "knitwear", "name": "Knitwear", "description": "Chunky turtlenecks, cable jumpers and cropped cardigans in wool, merino and recycled blends. Warm, soft and made to layer.", "url": "http://localhost/category/knitwear", "image": { "url": "http://localhost/assets/images/product/product-fashion-27.png", "alt": "Knitwear", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-27.png", "small": "http://localhost/assets/images/product/product-fashion-27.png", "medium": "http://localhost/assets/images/product/product-fashion-27.png", "large": "http://localhost/assets/images/product/product-fashion-27.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true, "children": [] } ] }, { "id": 5, "parent_id": null, "slug": "men", "name": "Men", "description": "Overshirts, hoodies, outerwear and relaxed tailoring for the modern wardrobe. Honest fabrics, simple shapes and a considered fit.", "url": "http://localhost/category/men", "image": { "url": "http://localhost/assets/images/articles/article-fashion-06.png", "alt": "Men", "sizes": { "thumb": "http://localhost/assets/images/articles/article-fashion-06.png", "small": "http://localhost/assets/images/articles/article-fashion-06.png", "medium": "http://localhost/assets/images/articles/article-fashion-06.png", "large": "http://localhost/assets/images/articles/article-fashion-06.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true, "children": [ { "id": 6, "parent_id": 5, "slug": "shirts", "name": "Shirts", "description": "Chambray, flannel, silk-blend and oxford shirts in easy fits. Wear them buttoned up or open over a tee.", "url": "http://localhost/category/shirts", "image": { "url": "http://localhost/assets/images/articles/article-fashion-08.png", "alt": "Shirts", "sizes": { "thumb": "http://localhost/assets/images/articles/article-fashion-08.png", "small": "http://localhost/assets/images/articles/article-fashion-08.png", "medium": "http://localhost/assets/images/articles/article-fashion-08.png", "large": "http://localhost/assets/images/articles/article-fashion-08.png" } }, "banner": null, "icon": "i-shirt", "is_featured": false, "children": [] } ] } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/categories/{slug}": { "get": { "tags": [ "Catalog" ], "summary": "Category detail", "operationId": "getCategories/slug", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Category slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": [ "string", "null" ] }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" }, "products_count": { "type": "integer" }, "children": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "parent_id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "banner": { "type": [ "string", "null" ] }, "icon": { "type": "string" }, "is_featured": { "type": "boolean" } } } }, "breadcrumbs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } } }, "seo": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } } } } }, "example": { "data": { "id": 1, "parent_id": null, "slug": "women", "name": "Women", "description": "Dresses, knitwear, coats and everyday separates from independent womenswear labels. Cut for real bodies and built to be worn for years.", "url": "http://localhost/category/women", "image": { "url": "http://localhost/assets/images/product/product-fashion-23.png", "alt": "Women", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-23.png", "small": "http://localhost/assets/images/product/product-fashion-23.png", "medium": "http://localhost/assets/images/product/product-fashion-23.png", "large": "http://localhost/assets/images/product/product-fashion-23.png" } }, "banner": null, "icon": "i-hanger", "is_featured": false, "products_count": 5, "children": [ { "id": 2, "parent_id": 1, "slug": "dresses", "name": "Dresses", "description": "Slip dresses, knit dresses and shirt dresses for work, weekends and everything in between. Fluid fabrics that move with you.", "url": "http://localhost/category/dresses", "image": { "url": "http://localhost/assets/images/product/product-fashion-35.png", "alt": "Dresses", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-35.png", "small": "http://localhost/assets/images/product/product-fashion-35.png", "medium": "http://localhost/assets/images/product/product-fashion-35.png", "large": "http://localhost/assets/images/product/product-fashion-35.png" } }, "banner": null, "icon": "i-hanger", "is_featured": true }, { "id": 3, "parent_id": 1, "slug": "knitwear", "name": "Knitwear", "description": "Chunky turtlenecks, cable jumpers and cropped cardigans in wool, merino and recycled blends. Warm, soft and made to layer.", "url": "http://localhost/category/knitwear", "image": { "url": "http://localhost/assets/images/product/product-fashion-27.png", "alt": "Knitwear", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-27.png", "small": "http://localhost/assets/images/product/product-fashion-27.png", "medium": "http://localhost/assets/images/product/product-fashion-27.png", "large": "http://localhost/assets/images/product/product-fashion-27.png" } }, "banner": null, "icon": "i-shirt", "is_featured": true } ], "breadcrumbs": [ { "name": "", "url": "http://localhost/category/women" } ], "seo": { "title": "Women", "description": "Dresses, knitwear, coats and everyday separates from independent womenswear labels. Cut for real bodies and built to be worn for years." } } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/brands": { "get": { "tags": [ "Catalog" ], "summary": "Brands", "operationId": "getBrands", "parameters": [ { "name": "featured", "in": "query", "required": false, "description": "Only featured brands", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "logo": { "type": [ "string", "null" ] }, "banner": { "type": [ "string", "null" ] }, "website": { "type": "string" }, "is_featured": { "type": "boolean" }, "products_count": { "type": "integer" } } } } } }, "example": { "data": [ { "id": 1, "slug": "sable", "name": "Sable", "description": "Sable designs evening-ready knitwear and dresses with a soft, body-skimming silhouette. Everything is cut and finished in small runs in Porto.", "logo": null, "banner": null, "website": "https://sable.example.com", "is_featured": true, "products_count": 5 }, { "id": 2, "slug": "maison-arlo", "name": "Maison Arlo", "description": "Maison Arlo makes coats and tailoring with a Parisian ease: wool blends, clean lapels and linings worth turning inside out. Each piece is designed to outlast...", "logo": null, "banner": null, "website": "https://maisonarlo.example.com", "is_featured": true, "products_count": 4 } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/products": { "get": { "tags": [ "Catalog" ], "summary": "Product listing with filters", "operationId": "getProducts", "description": "Same filters as the storefront. Price filters are expressed in the request currency (`X-Currency`). Append `facets=1` to receive `meta.facets` (categories, brands, attributes, price range, rating counts) computed on the current search/category context.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Search term", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "Category slug or id (includes sub-categories)", "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": false, "description": "Brand slug/id; repeat as brand[] or comma-separate", "schema": { "type": "string" } }, { "name": "attr[{attribute-slug}]", "in": "query", "required": false, "description": "Attribute value slugs/ids, e.g. attr[color]=red,blue", "schema": { "type": "string" } }, { "name": "min_price", "in": "query", "required": false, "description": "Minimum price", "schema": { "type": "number" } }, { "name": "max_price", "in": "query", "required": false, "description": "Maximum price", "schema": { "type": "number" } }, { "name": "rating", "in": "query", "required": false, "description": "Minimum average rating (1-5)", "schema": { "type": "integer" } }, { "name": "in_stock", "in": "query", "required": false, "description": "Only in-stock products", "schema": { "type": "boolean" } }, { "name": "on_sale", "in": "query", "required": false, "description": "Only discounted products", "schema": { "type": "boolean" } }, { "name": "new", "in": "query", "required": false, "description": "Only new arrivals", "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "description": "featured, newest, price_asc, price_desc, rating, bestselling, name_asc, name_desc", "schema": { "type": "string" }, "example": "price_asc" }, { "name": "per_page", "in": "query", "required": false, "description": "1-96", "schema": { "type": "integer" }, "example": 2 }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer" } }, { "name": "facets", "in": "query", "required": false, "description": "Include meta.facets", "schema": { "type": "boolean" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "hover_image": { "type": [ "string", "null" ] }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "old_price": { "type": [ "string", "null" ] }, "price_range": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "rating": { "type": "object", "properties": { "average": { "type": "number" }, "count": { "type": "integer" } } }, "in_stock": { "type": "boolean" }, "stock_status": { "type": "string" }, "has_variants": { "type": "boolean" }, "badges": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" } } } }, "is_new": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "brand": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": [ "string", "null" ] }, "next": { "type": "string" } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "page": { "type": [ "string", "null" ] }, "active": { "type": "boolean" } } } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" }, "facets": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "count": { "type": "integer" } } } }, "brands": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "logo_url": { "type": [ "string", "null" ] }, "count": { "type": "integer" } } } }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "string" }, "image": { "type": [ "string", "null" ] }, "count": { "type": "integer" } } } } } } }, "price": { "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" }, "currency": { "type": "string" }, "symbol": { "type": "string" } } }, "ratings": { "type": "object", "properties": { "4": { "type": "integer" }, "3": { "type": "integer" }, "2": { "type": "integer" }, "1": { "type": "integer" } } }, "in_stock": { "type": "integer" }, "on_sale": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "example": { "data": [ { "id": 51, "slug": "hair-tie-set-neutrals", "type": "simple", "name": "Hair Tie Set, Neutrals", "sku": "LM-ACC-0150", "url": "http://localhost/product/hair-tie-set-neutrals", "image": { "url": "http://localhost/assets/images/product/product-fashion-45.png", "alt": "Hair Tie Set, Neutrals", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-45.png", "small": "http://localhost/assets/images/product/product-fashion-45.png", "medium": "http://localhost/assets/images/product/product-fashion-45.png", "large": "http://localhost/assets/images/product/product-fashion-45.png" } }, "hover_image": null, "price": { "amount": 12, "formatted": "$12", "currency": "USD" }, "old_price": null, "price_range": null, "discount_percent": 0, "rating": { "average": 4.6, "count": 1840 }, "in_stock": true, "stock_status": "in_stock", "has_variants": false, "badges": [ { "key": "bestseller", "label": "Bestseller", "color": "primary" } ], "is_new": false, "is_featured": true, "brand": { "id": 8, "name": "Hollis", "slug": "hollis" }, "categories": [ { "id": 14, "name": "Accessories", "slug": "accessories" } ] }, { "id": 62, "slug": "mini-huggie-hoops", "type": "simple", "name": "Mini Huggie Hoops", "sku": "LM-ERR-0161", "url": "http://localhost/product/mini-huggie-hoops", "image": { "url": "http://localhost/assets/images/product/product-fashion-40.png", "alt": "Mini Huggie Hoops", "sizes": { "thumb": "http://localhost/assets/images/product/product-fashion-40.png", "small": "http://localhost/assets/images/product/product-fashion-40.png", "medium": "http://localhost/assets/images/product/product-fashion-40.png", "large": "http://localhost/assets/images/product/product-fashion-40.png" } }, "hover_image": "http://localhost/assets/images/product/product-modal-05.png", "price": { "amount": 35, "formatted": "$35", "currency": "USD" }, "old_price": null, "price_range": null, "discount_percent": 0, "rating": { "average": 4.8, "count": 1106 }, "in_stock": true, "stock_status": "in_stock", "has_variants": false, "badges": [ { "key": "new", "label": "New", "color": "success" } ], "is_new": true, "is_featured": true, "brand": { "id": 7, "name": "Alukas & Co", "slug": "alukas-and-co" }, "categories": [ { "id": 13, "name": "Earrings & rings", "slug": "earrings-rings" } ] } ], "links": { "first": "http://localhost/api/v1/products?per_page=2&sort=price_asc&facets=1&page=1", "last": "http://localhost/api/v1/products?per_page=2&sort=price_asc&facets=1&page=34", "prev": null, "next": "http://localhost/api/v1/products?per_page=2&sort=price_asc&facets=1&page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 34, "links": [ { "url": null, "label": "pagination.previous", "page": null, "active": false }, { "url": "http://localhost/api/v1/products?per_page=2&sort=price_asc&facets=1&page=1", "label": "1", "page": 1, "active": true } ], "path": "http://localhost/api/v1/products", "per_page": 2, "to": 2, "total": 68, "facets": { "categories": [ { "id": 1, "name": "Women", "slug": "women", "url": "http://localhost/category/women", "count": 18 }, { "id": 5, "name": "Men", "slug": "men", "url": "http://localhost/category/men", "count": 15 } ], "brands": [ { "id": 7, "name": "Alukas & Co", "slug": "alukas-and-co", "logo_url": null, "count": 17 }, { "id": 5, "name": "Atelier Noon", "slug": "atelier-noon", "logo_url": null, "count": 10 } ], "attributes": [ { "id": 1, "name": "Color", "slug": "color", "type": "swatch", "values": [ { "id": 6, "label": "Forest", "slug": "forest", "color": "#1f5a45", "image": null, "count": 1 }, { "id": 7, "label": "Ink blue", "slug": "ink-blue", "color": "#233f73", "image": null, "count": 1 } ] }, { "id": 2, "name": "Size", "slug": "size", "type": "button", "values": [ { "id": 22, "label": "XS", "slug": "xs", "color": null, "image": null, "count": 33 }, { "id": 23, "label": "S", "slug": "s", "color": null, "image": null, "count": 33 } ] } ], "price": { "min": 12, "max": 299, "currency": "USD", "symbol": "$" }, "ratings": { "4": 68, "3": 68, "2": 68, "1": 68 }, "in_stock": 65, "on_sale": 30, "total": 68 } } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/products/{slug}": { "get": { "tags": [ "Catalog" ], "summary": "Product detail", "operationId": "getProducts/slug", "description": "Full detail: gallery, variants with their attribute values and prices, custom options, specifications, rating distribution, related product ids, stock and flash-sale information. Cost prices are never exposed.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Product slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "hover_image": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "old_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "price_range": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "rating": { "type": "object", "properties": { "average": { "type": "number" }, "count": { "type": "integer" } } }, "in_stock": { "type": "boolean" }, "stock_status": { "type": "string" }, "has_variants": { "type": "boolean" }, "badges": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" } } } }, "is_new": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "brand": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } }, "short_description": { "type": "string" }, "description": { "type": "string" }, "specifications": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "images": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } } }, "video_url": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] } } } } } } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "sku": { "type": "string" }, "value_ids": { "type": "array", "items": { "type": "integer" } }, "values": { "type": "array", "items": { "type": "object", "properties": { "attribute": { "type": "string" }, "attribute_id": { "type": "integer" }, "id": { "type": "integer" }, "label": { "type": "string" } } } }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "old_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount_percent": { "type": "integer" }, "in_stock": { "type": "boolean" }, "available_qty": { "type": "integer" }, "image": { "type": [ "string", "null" ] }, "is_default": { "type": "boolean" } } } }, "options": { "type": "array", "items": {} }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } }, "stock": { "type": "object", "properties": { "status": { "type": "string" }, "label": { "type": "string" }, "available_qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": [ "string", "null" ] } } }, "shipping": { "type": "object", "properties": { "requires_shipping": { "type": "boolean" }, "weight": { "type": "number" } } }, "flash_sale": { "type": "object", "properties": { "ends_at": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "quantity": { "type": "integer" }, "sold": { "type": "integer" } } }, "rating_distribution": { "type": "object", "properties": { "average": { "type": "number" }, "total": { "type": "integer" }, "counts": { "type": "array", "items": { "type": "integer" } }, "percents": { "type": "array", "items": { "type": "integer" } } } }, "related_ids": { "type": "array", "items": { "type": "integer" } }, "seo": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } } } } }, "example": { "data": { "id": 1, "slug": "double-breasted-wool-blend-coat", "type": "variable", "name": "Double-Breasted Wool-Blend Coat", "sku": "LM-COT-0100", "url": "http://localhost/product/double-breasted-wool-blend-coat", "image": { "url": "http://localhost/assets/images/product/product-modal-02.png", "alt": "Double-Breasted Wool-Blend Coat", "sizes": { "thumb": "http://localhost/assets/images/product/product-modal-02.png", "small": "http://localhost/assets/images/product/product-modal-02.png", "medium": "http://localhost/assets/images/product/product-modal-02.png", "large": "http://localhost/assets/images/product/product-modal-02.png" } }, "hover_image": "http://localhost/assets/images/product/product-modal-01.png", "price": { "amount": 189, "formatted": "$189", "currency": "USD" }, "old_price": { "amount": 249, "formatted": "$249", "currency": "USD" }, "price_range": null, "discount_percent": 24, "rating": { "average": 4.8, "count": 412 }, "in_stock": true, "stock_status": "in_stock", "has_variants": true, "badges": [ { "key": "sale", "label": "-24%", "color": "danger" }, { "key": "hot", "label": "Hot", "color": "primary" } ], "is_new": false, "is_featured": false, "brand": { "id": 2, "name": "Maison Arlo", "slug": "maison-arlo" }, "categories": [ { "id": 4, "name": "Coats & jackets", "slug": "coats-jackets" } ], "short_description": "Warm, structured and easy to layer. Details: wool blend, dropped shoulders and relaxed, hip-length fit.", "description": "Double-Breasted Wool-Blend Coat: Maison Arlo's take on the one coat you'll reach for from the first frost to the last. The wool blend gives it structure with...", "specifications": [ { "key": "Material", "value": "Wool blend" }, { "key": "Fit", "value": "Dropped shoulders" } ], "images": [ { "url": "http://localhost/assets/images/product/product-modal-02.png", "alt": "Double-Breasted Wool-Blend Coat", "sizes": { "thumb": "http://localhost/assets/images/product/product-modal-02.png", "small": "http://localhost/assets/images/product/product-modal-02.png", "medium": "http://localhost/assets/images/product/product-modal-02.png", "large": "http://localhost/assets/images/product/product-modal-02.png" } }, { "url": "http://localhost/assets/images/product/product-modal-01.png", "alt": "Double-Breasted Wool-Blend Coat", "sizes": { "thumb": "http://localhost/assets/images/product/product-modal-01.png", "small": "http://localhost/assets/images/product/product-modal-01.png", "medium": "http://localhost/assets/images/product/product-modal-01.png", "large": "http://localhost/assets/images/product/product-modal-01.png" } } ], "video_url": null, "attributes": [ { "id": 2, "name": "Size", "slug": "size", "type": "button", "values": [ { "id": 22, "label": "XS", "slug": "xs", "color": null, "image": null }, { "id": 23, "label": "S", "slug": "s", "color": null, "image": null } ] } ], "variants": [ { "id": 1, "name": "XS", "sku": "LM-COT-0100-XS", "value_ids": [ 22 ], "values": [ { "attribute": "Size", "attribute_id": 2, "id": 22, "label": "XS" } ], "price": { "amount": 189, "formatted": "$189", "currency": "USD" }, "old_price": { "amount": 249, "formatted": "$249", "currency": "USD" }, "discount_percent": 24, "in_stock": false, "available_qty": 0, "image": null, "is_default": false }, { "id": 2, "name": "S", "sku": "LM-COT-0100-S", "value_ids": [ 23 ], "values": [ { "attribute": "Size", "attribute_id": 2, "id": 23, "label": "S" } ], "price": { "amount": 189, "formatted": "$189", "currency": "USD" }, "old_price": { "amount": 249, "formatted": "$249", "currency": "USD" }, "discount_percent": 24, "in_stock": true, "available_qty": 12, "image": null, "is_default": true } ], "options": [], "tags": [ { "id": 19, "name": "Outerwear", "slug": "outerwear" }, { "id": 20, "name": "Sale", "slug": "sale" } ], "stock": { "status": "in_stock", "label": "In stock", "available_qty": 72, "min_qty": 1, "max_qty": null }, "shipping": { "requires_shipping": true, "weight": 1.1 }, "flash_sale": { "ends_at": "2026-10-04T12:56:53+00:00", "price": { "amount": 189, "formatted": "$189", "currency": "USD" }, "quantity": 40, "sold": 21 }, "rating_distribution": { "average": 4.8, "total": 8, "counts": [ 7, 0 ], "percents": [ 88, 0 ] }, "related_ids": [ 3, 5 ], "seo": { "title": "Double-Breasted Wool-Blend Coat | Loom", "description": "Warm, structured and easy to layer. Details: wool blend, dropped shoulders and relaxed, hip-length fit." } } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/search/suggest": { "get": { "tags": [ "Catalog" ], "summary": "Live search suggestions", "operationId": "getSearch/suggest", "parameters": [ { "name": "q", "in": "query", "required": true, "description": "At least 2 characters", "schema": { "type": "string" }, "example": "shirt" }, { "name": "limit", "in": "query", "required": false, "description": "1-24 products", "schema": { "type": "integer" }, "example": 8 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "price": { "type": "string" }, "old_price": { "type": "string" }, "in_stock": { "type": "boolean" }, "rating": { "type": "number" }, "brand": { "type": "string" }, "category": { "type": "string" }, "sku": { "type": "string" } } } }, "categories": { "type": "array", "items": {} }, "brands": { "type": "array", "items": {} }, "total": { "type": "integer" }, "term": { "type": "string" } } } } }, "example": { "data": { "products": [ { "id": 2, "name": "Belted Cotton Trench Coat", "url": "http://localhost/product/belted-cotton-trench-coat", "image": "http://localhost/assets/images/product/product-modal-01.png", "price": "$159", "old_price": "$199", "in_stock": true, "rating": 4.7, "brand": "Northe", "category": "Coats & jackets", "sku": "LM-COT-0101" }, { "id": 19, "name": "Herringbone Wool Overcoat", "url": "http://localhost/product/herringbone-wool-overcoat", "image": "http://localhost/assets/images/product/product-fashion-11.png", "price": "$219", "old_price": "$279", "in_stock": true, "rating": 4.8, "brand": "Atelier Noon", "category": "Men", "sku": "LM-MEN-0118" } ], "categories": [], "brands": [], "total": 4, "term": "Belted" } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/flash-sales/current": { "get": { "tags": [ "Catalog" ], "summary": "Running flash sale", "operationId": "getFlashSales/current", "description": "`data` is null when no flash sale is running.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "starts_at": { "type": "string" }, "ends_at": { "type": "string" }, "seconds_left": { "type": "integer" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "hover_image": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "old_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "price_range": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "rating": { "type": "object", "properties": { "average": { "type": "number" }, "count": { "type": "integer" } } }, "in_stock": { "type": "boolean" }, "stock_status": { "type": "string" }, "has_variants": { "type": "boolean" }, "badges": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" } } } }, "is_new": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "brand": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } } } } } }, "example": { "data": { "id": 1, "slug": "flash-deals", "name": "Mid-season sale", "starts_at": "2026-10-01T16:56:53+00:00", "ends_at": "2026-10-04T12:56:53+00:00", "seconds_left": 172513, "products": [ { "id": 1, "slug": "double-breasted-wool-blend-coat", "type": "variable", "name": "Double-Breasted Wool-Blend Coat", "sku": "LM-COT-0100", "url": "http://localhost/product/double-breasted-wool-blend-coat", "image": { "url": "http://localhost/assets/images/product/product-modal-02.png", "alt": "Double-Breasted Wool-Blend Coat", "sizes": { "thumb": "http://localhost/assets/images/product/product-modal-02.png", "small": "http://localhost/assets/images/product/product-modal-02.png", "medium": "http://localhost/assets/images/product/product-modal-02.png", "large": "http://localhost/assets/images/product/product-modal-02.png" } }, "hover_image": "http://localhost/assets/images/product/product-modal-01.png", "price": { "amount": 189, "formatted": "$189", "currency": "USD" }, "old_price": { "amount": 249, "formatted": "$249", "currency": "USD" }, "price_range": null, "discount_percent": 24, "rating": { "average": 4.8, "count": 412 }, "in_stock": true, "stock_status": "in_stock", "has_variants": true, "badges": [ { "key": "sale", "label": "-24%", "color": "danger" }, { "key": "hot", "label": "Hot", "color": "primary" } ], "is_new": false, "is_featured": false, "brand": { "id": 2, "name": "Maison Arlo", "slug": "maison-arlo" }, "categories": [ { "id": 4, "name": "Coats & jackets", "slug": "coats-jackets" } ] }, { "id": 2, "slug": "belted-cotton-trench-coat", "type": "variable", "name": "Belted Cotton Trench Coat", "sku": "LM-COT-0101", "url": "http://localhost/product/belted-cotton-trench-coat", "image": { "url": "http://localhost/assets/images/product/product-modal-01.png", "alt": "Belted Cotton Trench Coat", "sizes": { "thumb": "http://localhost/assets/images/product/product-modal-01.png", "small": "http://localhost/assets/images/product/product-modal-01.png", "medium": "http://localhost/assets/images/product/product-modal-01.png", "large": "http://localhost/assets/images/product/product-modal-01.png" } }, "hover_image": "http://localhost/assets/images/product/product-comparison-05.png", "price": { "amount": 159, "formatted": "$159", "currency": "USD" }, "old_price": { "amount": 199, "formatted": "$199", "currency": "USD" }, "price_range": null, "discount_percent": 20, "rating": { "average": 4.7, "count": 688 }, "in_stock": true, "stock_status": "in_stock", "has_variants": true, "badges": [ { "key": "sale", "label": "-20%", "color": "danger" } ], "is_new": false, "is_featured": true, "brand": { "id": 4, "name": "Northe", "slug": "northe" }, "categories": [ { "id": 4, "name": "Coats & jackets", "slug": "coats-jackets" } ] } ] } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/products/{slug}/reviews": { "get": { "tags": [ "Reviews" ], "summary": "Approved reviews of a product", "operationId": "getProducts/slug/reviews", "description": "`meta.summary` carries the average, total and per-star counts.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Product slug", "schema": { "type": "string" } }, { "name": "rating", "in": "query", "required": false, "description": "Only this star rating", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "newest, helpful, highest or lowest", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "description": "1-100", "schema": { "type": "integer" }, "example": 10 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "rating": { "type": "integer" }, "title": { "type": "string" }, "comment": { "type": "string" }, "author": { "type": "string" }, "verified_purchase": { "type": "boolean" }, "images": { "type": "array", "items": {} }, "helpful_count": { "type": "integer" }, "reply": { "type": [ "string", "null" ] }, "replied_at": { "type": [ "string", "null" ] }, "created_at": { "type": "string" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer" }, "last_page": { "type": "integer" }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "page": { "type": [ "string", "null" ] }, "active": { "type": "boolean" } } } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer" }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "average": { "type": "number" }, "total": { "type": "integer" }, "counts": { "type": "object", "properties": { "5": { "type": "integer" }, "4": { "type": "integer" }, "3": { "type": "integer" }, "2": { "type": "integer" }, "1": { "type": "integer" } } }, "percents": { "type": "object", "properties": { "5": { "type": "integer" }, "4": { "type": "integer" }, "3": { "type": "integer" }, "2": { "type": "integer" }, "1": { "type": "integer" } } } } } } } } }, "example": { "data": [ { "id": 9, "rating": 5, "title": "Beautiful quality", "comment": "Honestly the best coat I've bought this year. It goes with almost everything in my wardrobe. Stitching and finishing are neat all the way through. Five stars...", "author": "Skye M.", "verified_purchase": true, "images": [], "helpful_count": 26, "reply": null, "replied_at": null, "created_at": "2026-09-05T05:34:53+00:00" }, { "id": 13, "rating": 5, "title": "Perfect fit", "comment": "The coat arrived two days early and was wrapped beautifully. The drape is gorgeous, and it feels comfortable all day. Packaging was minimal and recycled, whi...", "author": "Ben B.", "verified_purchase": false, "images": [], "helpful_count": 10, "reply": null, "replied_at": null, "created_at": "2026-08-22T09:32:53+00:00" } ], "links": { "first": "http://localhost/api/v1/products/belted-cotton-trench-coat/reviews?page=1", "last": "http://localhost/api/v1/products/belted-cotton-trench-coat/reviews?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "pagination.previous", "page": null, "active": false }, { "url": "http://localhost/api/v1/products/belted-cotton-trench-coat/reviews?page=1", "label": "1", "page": 1, "active": true } ], "path": "http://localhost/api/v1/products/belted-cotton-trench-coat/reviews", "per_page": 10, "to": 6, "total": 6, "summary": { "average": 4.7, "total": 6, "counts": { "5": 5, "4": 0, "3": 1, "2": 0, "1": 0 }, "percents": { "5": 83, "4": 0, "3": 17, "2": 0, "1": 0 } } } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "post": { "tags": [ "Reviews" ], "summary": "Write a review", "operationId": "postProducts/slug/reviews", "description": "One review per customer and product. Reviews are held for moderation unless the store auto-approves them (`pending` tells which).", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Product slug", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "rating", "comment" ], "properties": { "rating": { "type": "integer", "description": "1-5" }, "title": { "type": "string", "description": "Headline" }, "comment": { "type": "string", "description": "10-3000 characters" } } }, "example": { "rating": 5, "title": "Love it", "comment": "Great quality and fast delivery." } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "pending": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "id": 444, "pending": true }, "message": "Thanks for your review! It will appear once our team has checked it." } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart": { "get": { "tags": [ "Cart" ], "summary": "Get the cart", "operationId": "getCart", "description": "Signed-in customers always get their account cart. Guests identify their cart with the `X-Cart-Token` header: the first write (add to cart) returns a new token in the `X-Cart-Token` response header; store it and send it on every cart / checkout request.", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "sku": { "type": "string" }, "variant": { "type": [ "string", "null" ] }, "options": { "type": "string" }, "options_list": { "type": "array", "items": {} }, "qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": "integer" }, "unit_price": { "type": "integer" }, "unit_price_formatted": { "type": "string" }, "regular_price_formatted": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "line_total": { "type": "integer" }, "line_total_formatted": { "type": "string" }, "problem": { "type": [ "string", "null" ] }, "downloadable": { "type": "boolean" } } } }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": "string" }, "shipping_method_id": { "type": "integer" }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "number" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "integer" }, "amount_formatted": { "type": "string" } } } }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "number" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": "object", "properties": { "threshold": { "type": "integer" }, "threshold_formatted": { "type": "string" }, "remaining": { "type": "integer" }, "remaining_formatted": { "type": "string" }, "percent": { "type": "integer" }, "reached": { "type": "boolean" } } }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } } } }, "example": { "data": { "count": 2, "items_count": 2, "lines": 1, "total": 290, "total_formatted": "$290", "currency": "USD", "items": [ { "id": 13, "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "url": "http://localhost/product/leather-messenger-bag-olive", "image": "http://localhost/assets/images/category/category-fashion-02.png", "sku": "LM-BAG-0145", "variant": null, "options": "", "options_list": [], "qty": 2, "min_qty": 1, "max_qty": 60, "unit_price": 145, "unit_price_formatted": "$145", "regular_price_formatted": null, "discount_percent": 0, "line_total": 290, "line_total_formatted": "$290", "problem": null, "downloadable": false } ], "coupon": null, "totals": { "subtotal": 290, "subtotal_formatted": "$290", "discount": 0, "discount_formatted": "$0", "net_formatted": "$290", "shipping": 0, "shipping_formatted": "Free", "shipping_name": "Free shipping", "shipping_method_id": 2, "shipping_required": true, "shipping_estimated": true, "shipping_available": true, "tax": 20.3, "tax_formatted": "$20.30", "tax_inclusive": false, "tax_breakdown": [ { "name": "US Sales Tax", "rate": 7, "amount_formatted": "$20.30" } ], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 310.3, "total_formatted": "$310.30" }, "free_shipping": { "threshold": 75, "threshold_formatted": "$75", "remaining": 0, "remaining_formatted": "$0", "percent": 100, "reached": true }, "problems": [], "notices": [], "empty": false } } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "delete": { "tags": [ "Cart" ], "summary": "Empty the cart", "operationId": "deleteCart", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": {} }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": [ "string", "null" ] }, "shipping_method_id": { "type": [ "string", "null" ] }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "integer" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": {} }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": [ "string", "null" ] }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "count": 0, "items_count": 0, "lines": 0, "total": 0, "total_formatted": "$0", "currency": "USD", "items": [], "coupon": null, "totals": { "subtotal": 0, "subtotal_formatted": "$0", "discount": 0, "discount_formatted": "$0", "net_formatted": "$0", "shipping": 0, "shipping_formatted": "Not required", "shipping_name": null, "shipping_method_id": null, "shipping_required": false, "shipping_estimated": false, "shipping_available": true, "tax": 0, "tax_formatted": "$0", "tax_inclusive": false, "tax_breakdown": [], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 0, "total_formatted": "$0" }, "free_shipping": null, "problems": [], "notices": [], "empty": true }, "message": "Your cart is now empty." } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart/items": { "post": { "tags": [ "Cart" ], "summary": "Add a product", "operationId": "postCart/items", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "product_id" ], "properties": { "product_id": { "type": "integer", "description": "Product id" }, "variant_id": { "type": "integer", "description": "Required for variable products" }, "qty": { "type": "integer", "description": "Quantity (default 1)" }, "options": { "type": "object", "description": "Custom option values keyed by option id" } } }, "example": { "product_id": 1, "qty": 2 } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "sku": { "type": "string" }, "variant": { "type": [ "string", "null" ] }, "options": { "type": "string" }, "options_list": { "type": "array", "items": {} }, "qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": "integer" }, "unit_price": { "type": "integer" }, "unit_price_formatted": { "type": "string" }, "regular_price_formatted": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "line_total": { "type": "integer" }, "line_total_formatted": { "type": "string" }, "problem": { "type": [ "string", "null" ] }, "downloadable": { "type": "boolean" } } } }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": "string" }, "shipping_method_id": { "type": "integer" }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "number" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "integer" }, "amount_formatted": { "type": "string" } } } }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "number" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": "object", "properties": { "threshold": { "type": "integer" }, "threshold_formatted": { "type": "string" }, "remaining": { "type": "integer" }, "remaining_formatted": { "type": "string" }, "percent": { "type": "integer" }, "reached": { "type": "boolean" } } }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" }, "meta": { "type": "object", "properties": { "item_id": { "type": "integer" } } } } }, "example": { "data": { "count": 2, "items_count": 2, "lines": 1, "total": 290, "total_formatted": "$290", "currency": "USD", "items": [ { "id": 13, "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "url": "http://localhost/product/leather-messenger-bag-olive", "image": "http://localhost/assets/images/category/category-fashion-02.png", "sku": "LM-BAG-0145", "variant": null, "options": "", "options_list": [], "qty": 2, "min_qty": 1, "max_qty": 60, "unit_price": 145, "unit_price_formatted": "$145", "regular_price_formatted": null, "discount_percent": 0, "line_total": 290, "line_total_formatted": "$290", "problem": null, "downloadable": false } ], "coupon": null, "totals": { "subtotal": 290, "subtotal_formatted": "$290", "discount": 0, "discount_formatted": "$0", "net_formatted": "$290", "shipping": 0, "shipping_formatted": "Free", "shipping_name": "Free shipping", "shipping_method_id": 2, "shipping_required": true, "shipping_estimated": true, "shipping_available": true, "tax": 20.3, "tax_formatted": "$20.30", "tax_inclusive": false, "tax_breakdown": [ { "name": "US Sales Tax", "rate": 7, "amount_formatted": "$20.30" } ], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 310.3, "total_formatted": "$310.30" }, "free_shipping": { "threshold": 75, "threshold_formatted": "$75", "remaining": 0, "remaining_formatted": "$0", "percent": 100, "reached": true }, "problems": [], "notices": [], "empty": false }, "message": "Leather Messenger Bag, Olive was added to your cart.", "meta": { "item_id": 13 } } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart/items/{item}": { "patch": { "tags": [ "Cart" ], "summary": "Change a line quantity", "operationId": "patchCart/items/item", "parameters": [ { "name": "item", "in": "path", "required": true, "description": "Cart line id", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/CartToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "qty" ], "properties": { "qty": { "type": "integer", "description": "New quantity; 0 removes the line" } } }, "example": { "qty": 3 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "sku": { "type": "string" }, "variant": { "type": [ "string", "null" ] }, "options": { "type": "string" }, "options_list": { "type": "array", "items": {} }, "qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": "integer" }, "unit_price": { "type": "integer" }, "unit_price_formatted": { "type": "string" }, "regular_price_formatted": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "line_total": { "type": "integer" }, "line_total_formatted": { "type": "string" }, "problem": { "type": [ "string", "null" ] }, "downloadable": { "type": "boolean" } } } }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": "string" }, "shipping_method_id": { "type": "integer" }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "number" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "integer" }, "amount_formatted": { "type": "string" } } } }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "number" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": "object", "properties": { "threshold": { "type": "integer" }, "threshold_formatted": { "type": "string" }, "remaining": { "type": "integer" }, "remaining_formatted": { "type": "string" }, "percent": { "type": "integer" }, "reached": { "type": "boolean" } } }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "count": 3, "items_count": 3, "lines": 1, "total": 435, "total_formatted": "$435", "currency": "USD", "items": [ { "id": 13, "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "url": "http://localhost/product/leather-messenger-bag-olive", "image": "http://localhost/assets/images/category/category-fashion-02.png", "sku": "LM-BAG-0145", "variant": null, "options": "", "options_list": [], "qty": 3, "min_qty": 1, "max_qty": 60, "unit_price": 145, "unit_price_formatted": "$145", "regular_price_formatted": null, "discount_percent": 0, "line_total": 435, "line_total_formatted": "$435", "problem": null, "downloadable": false } ], "coupon": null, "totals": { "subtotal": 435, "subtotal_formatted": "$435", "discount": 0, "discount_formatted": "$0", "net_formatted": "$435", "shipping": 0, "shipping_formatted": "Free", "shipping_name": "Free shipping", "shipping_method_id": 2, "shipping_required": true, "shipping_estimated": true, "shipping_available": true, "tax": 30.45, "tax_formatted": "$30.45", "tax_inclusive": false, "tax_breakdown": [ { "name": "US Sales Tax", "rate": 7, "amount_formatted": "$30.45" } ], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 465.45, "total_formatted": "$465.45" }, "free_shipping": { "threshold": 75, "threshold_formatted": "$75", "remaining": 0, "remaining_formatted": "$0", "percent": 100, "reached": true }, "problems": [], "notices": [], "empty": false }, "message": "Cart updated." } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "delete": { "tags": [ "Cart" ], "summary": "Remove a line", "operationId": "deleteCart/items/item", "parameters": [ { "name": "item", "in": "path", "required": true, "description": "Cart line id", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/CartToken" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": {} }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": [ "string", "null" ] }, "shipping_method_id": { "type": [ "string", "null" ] }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "integer" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": {} }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": [ "string", "null" ] }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "count": 0, "items_count": 0, "lines": 0, "total": 0, "total_formatted": "$0", "currency": "USD", "items": [], "coupon": null, "totals": { "subtotal": 0, "subtotal_formatted": "$0", "discount": 0, "discount_formatted": "$0", "net_formatted": "$0", "shipping": 0, "shipping_formatted": "Not required", "shipping_name": null, "shipping_method_id": null, "shipping_required": false, "shipping_estimated": false, "shipping_available": true, "tax": 0, "tax_formatted": "$0", "tax_inclusive": false, "tax_breakdown": [], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 0, "total_formatted": "$0" }, "free_shipping": null, "problems": [], "notices": [], "empty": true }, "message": "Item removed from your cart." } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart/coupon": { "post": { "tags": [ "Cart" ], "summary": "Apply a coupon", "operationId": "postCart/coupon", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "Coupon code" } } }, "example": { "code": "WELCOME10" } } } }, "responses": { "422": { "description": "Validation or business-rule error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "properties": { "code": { "type": "array", "items": { "type": "string" } } } } } }, "example": { "message": "The coupon code \"NOT-A-CODE\" does not exist.", "errors": { "code": [ "The coupon code \"NOT-A-CODE\" does not exist." ] } } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "delete": { "tags": [ "Cart" ], "summary": "Remove the coupon", "operationId": "deleteCart/coupon", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": {} }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": [ "string", "null" ] }, "shipping_method_id": { "type": [ "string", "null" ] }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "integer" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": {} }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": [ "string", "null" ] }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "count": 0, "items_count": 0, "lines": 0, "total": 0, "total_formatted": "$0", "currency": "USD", "items": [], "coupon": null, "totals": { "subtotal": 0, "subtotal_formatted": "$0", "discount": 0, "discount_formatted": "$0", "net_formatted": "$0", "shipping": 0, "shipping_formatted": "Not required", "shipping_name": null, "shipping_method_id": null, "shipping_required": false, "shipping_estimated": false, "shipping_available": true, "tax": 0, "tax_formatted": "$0", "tax_inclusive": false, "tax_breakdown": [], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 0, "total_formatted": "$0" }, "free_shipping": null, "problems": [], "notices": [], "empty": true }, "message": "Coupon removed." } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart/shipping-methods": { "post": { "tags": [ "Cart" ], "summary": "Delivery methods and totals for an address", "operationId": "postCart/shippingMethods", "description": "Stores the address on the cart and returns the available delivery methods, payment methods and the updated totals. Pass `shipping_method` to select one.", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "country" ], "properties": { "country": { "type": "string", "description": "ISO 3166-1 alpha-2" }, "state": { "type": "string", "description": "State / province" }, "city": { "type": "string", "description": "City" }, "zip": { "type": "string", "description": "Postal code" }, "address_id": { "type": "integer", "description": "A saved address of the customer instead of the fields above" }, "shipping_method": { "type": "integer", "description": "Selected method id" }, "points": { "type": "integer", "description": "Reward points to redeem (customers)" }, "email": { "type": "string", "description": "Guest e-mail (for per-customer coupon limits)" } } }, "example": { "country": "US", "state": "CA", "city": "Los Angeles", "zip": "90001" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "shipping_required": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "selected_method": { "type": "integer" }, "methods": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "eta": { "type": "string" }, "cost": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "is_free": { "type": "boolean" }, "pickup_address": { "type": [ "string", "null" ] }, "selected": { "type": "boolean" } } } }, "payment_methods": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "offline": { "type": "boolean" } } } }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "sku": { "type": "string" }, "variant": { "type": [ "string", "null" ] }, "options": { "type": "string" }, "options_list": { "type": "array", "items": {} }, "qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": "integer" }, "unit_price": { "type": "integer" }, "unit_price_formatted": { "type": "string" }, "regular_price_formatted": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "line_total": { "type": "integer" }, "line_total_formatted": { "type": "string" }, "problem": { "type": [ "string", "null" ] }, "downloadable": { "type": "boolean" } } } }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": "string" }, "shipping_method_id": { "type": "integer" }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "number" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "integer" }, "amount_formatted": { "type": "string" } } } }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "number" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": "object", "properties": { "threshold": { "type": "integer" }, "threshold_formatted": { "type": "string" }, "remaining": { "type": "integer" }, "remaining_formatted": { "type": "string" }, "percent": { "type": "integer" }, "reached": { "type": "boolean" } } }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } } } } } }, "example": { "data": { "shipping_required": true, "shipping_available": true, "selected_method": 2, "methods": [ { "id": 1, "type": "flat_rate", "name": "Standard shipping", "description": "Tracked delivery in 3–5 business days.", "eta": "3–5 business days", "cost": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "is_free": false, "pickup_address": null, "selected": false }, { "id": 2, "type": "free_shipping", "name": "Free shipping", "description": "Free standard delivery on orders over $75.", "eta": "3–5 business days", "cost": { "amount": 0, "formatted": "$0", "currency": "USD" }, "is_free": true, "pickup_address": null, "selected": true } ], "payment_methods": [ { "key": "cod", "title": "Cash on Delivery", "description": "Pay with cash when your order is delivered.", "instructions": "Please have the exact amount ready when the courier arrives.", "offline": true }, { "key": "bank_transfer", "title": "Bank Transfer", "description": "Transfer the order total to our bank account. Your order ships once the payment is received.", "instructions": "Bank: Example Bank\nAccount name: Sellora Store\nIBAN: XX00 0000 0000 0000 0000\nUse your order number as the payment reference.", "offline": true } ], "cart": { "count": 3, "items_count": 3, "lines": 1, "total": 435, "total_formatted": "$435", "currency": "USD", "items": [ { "id": 13, "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "url": "http://localhost/product/leather-messenger-bag-olive", "image": "http://localhost/assets/images/category/category-fashion-02.png", "sku": "LM-BAG-0145", "variant": null, "options": "", "options_list": [], "qty": 3, "min_qty": 1, "max_qty": 60, "unit_price": 145, "unit_price_formatted": "$145", "regular_price_formatted": null, "discount_percent": 0, "line_total": 435, "line_total_formatted": "$435", "problem": null, "downloadable": false } ], "coupon": null, "totals": { "subtotal": 435, "subtotal_formatted": "$435", "discount": 0, "discount_formatted": "$0", "net_formatted": "$435", "shipping": 0, "shipping_formatted": "Free", "shipping_name": "Free shipping", "shipping_method_id": 2, "shipping_required": true, "shipping_estimated": false, "shipping_available": true, "tax": 30.45, "tax_formatted": "$30.45", "tax_inclusive": false, "tax_breakdown": [ { "name": "US Sales Tax", "rate": 7, "amount_formatted": "$30.45" } ], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 465.45, "total_formatted": "$465.45" }, "free_shipping": { "threshold": 75, "threshold_formatted": "$75", "remaining": 0, "remaining_formatted": "$0", "percent": 100, "reached": true }, "problems": [], "notices": [], "empty": false } } } } }, "headers": { "X-Cart-Token": { "description": "Guest cart token (store it and send it back)", "schema": { "type": "string" } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/cart/merge": { "post": { "tags": [ "Cart" ], "summary": "Merge the guest cart after sign-in", "operationId": "postCart/merge", "description": "Send both the Bearer token and the guest `X-Cart-Token`. (Signing in with `X-Cart-Token` already merges; use this endpoint when the token was obtained earlier.)", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "count": { "type": "integer" }, "items_count": { "type": "integer" }, "lines": { "type": "integer" }, "total": { "type": "integer" }, "total_formatted": { "type": "string" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "string" }, "sku": { "type": "string" }, "variant": { "type": [ "string", "null" ] }, "options": { "type": "string" }, "options_list": { "type": "array", "items": {} }, "qty": { "type": "integer" }, "min_qty": { "type": "integer" }, "max_qty": { "type": "integer" }, "unit_price": { "type": "integer" }, "unit_price_formatted": { "type": "string" }, "regular_price_formatted": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "line_total": { "type": "integer" }, "line_total_formatted": { "type": "string" }, "problem": { "type": [ "string", "null" ] }, "downloadable": { "type": "boolean" } } } }, "coupon": { "type": [ "string", "null" ] }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer" }, "subtotal_formatted": { "type": "string" }, "discount": { "type": "integer" }, "discount_formatted": { "type": "string" }, "net_formatted": { "type": "string" }, "shipping": { "type": "integer" }, "shipping_formatted": { "type": "string" }, "shipping_name": { "type": "string" }, "shipping_method_id": { "type": "integer" }, "shipping_required": { "type": "boolean" }, "shipping_estimated": { "type": "boolean" }, "shipping_available": { "type": "boolean" }, "tax": { "type": "number" }, "tax_formatted": { "type": "string" }, "tax_inclusive": { "type": "boolean" }, "tax_breakdown": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rate": { "type": "integer" }, "amount_formatted": { "type": "string" } } } }, "points": { "type": "integer" }, "points_discount": { "type": "integer" }, "points_discount_formatted": { "type": "string" }, "total": { "type": "number" }, "total_formatted": { "type": "string" } } }, "free_shipping": { "type": "object", "properties": { "threshold": { "type": "integer" }, "threshold_formatted": { "type": "string" }, "remaining": { "type": "integer" }, "remaining_formatted": { "type": "string" }, "percent": { "type": "integer" }, "reached": { "type": "boolean" } } }, "problems": { "type": "array", "items": {} }, "notices": { "type": "array", "items": {} }, "empty": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "count": 1, "items_count": 1, "lines": 1, "total": 145, "total_formatted": "$145", "currency": "USD", "items": [ { "id": 14, "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "url": "http://localhost/product/leather-messenger-bag-olive", "image": "http://localhost/assets/images/category/category-fashion-02.png", "sku": "LM-BAG-0145", "variant": null, "options": "", "options_list": [], "qty": 1, "min_qty": 1, "max_qty": 60, "unit_price": 145, "unit_price_formatted": "$145", "regular_price_formatted": null, "discount_percent": 0, "line_total": 145, "line_total_formatted": "$145", "problem": null, "downloadable": false } ], "coupon": null, "totals": { "subtotal": 145, "subtotal_formatted": "$145", "discount": 0, "discount_formatted": "$0", "net_formatted": "$145", "shipping": 0, "shipping_formatted": "Free", "shipping_name": "Free shipping", "shipping_method_id": 2, "shipping_required": true, "shipping_estimated": false, "shipping_available": true, "tax": 10.15, "tax_formatted": "$10.15", "tax_inclusive": false, "tax_breakdown": [ { "name": "US Sales Tax", "rate": 7, "amount_formatted": "$10.15" } ], "points": 0, "points_discount": 0, "points_discount_formatted": "−$0", "total": 155.15, "total_formatted": "$155.15" }, "free_shipping": { "threshold": 75, "threshold_formatted": "$75", "remaining": 0, "remaining_formatted": "$0", "percent": 100, "reached": true }, "problems": [], "notices": [], "empty": false }, "message": "Your guest cart has been merged into your account cart." } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/checkout": { "post": { "tags": [ "Checkout" ], "summary": "Place an order", "operationId": "postCheckout", "description": "Same payload as the web checkout. `payment.type` tells what to do next: `completed` (cash on delivery, bank transfer, free order ... nothing more to do), `redirect` (open `payment.redirect_url` in a browser / web view), `client` (initialise the gateway SDK with `payment.client`) or `failed` (retry with POST /orders/{number}/pay).", "parameters": [ { "$ref": "#/components/parameters/CartToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "first_name", "last_name", "billing", "payment_method" ], "properties": { "email": { "type": "string", "description": "Customer e-mail (ignored for signed-in customers)" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string", "description": "Required when the store requires it" }, "billing": { "type": "object", "description": "address_1, address_2, city, state, zip, country (ISO-2), company" }, "address_id": { "type": "integer", "description": "Saved address to bill instead of billing{}" }, "ship_to_different": { "type": "boolean", "description": "Use shipping{} / shipping_address_id" }, "shipping": { "type": "object", "description": "Shipping address (first_name, last_name, address_1, city, country ...)" }, "shipping_address_id": { "type": "integer", "description": "Saved shipping address" }, "shipping_method": { "type": "integer", "description": "Id from /cart/shipping-methods (required for physical goods)" }, "payment_method": { "type": "string", "description": "Key from bootstrap.payment_methods" }, "note": { "type": "string", "description": "Order note" }, "points": { "type": "integer", "description": "Reward points to redeem" }, "create_account": { "type": "boolean", "description": "Guests only: create an account (needs password)" }, "password": { "type": "string", "description": "Password for the new account" }, "terms": { "type": "boolean", "description": "Required when the store has a terms page" }, "expected_total": { "type": "number", "description": "Reject the order when the total changed" } } }, "example": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100", "billing": { "address_1": "1 Market St", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US" }, "ship_to_different": false, "shipping_method": 1, "payment_method": "cod", "note": "Leave at the door", "create_account": false, "terms": true } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "order": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": "integer" }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": [ "string", "null" ] }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } } }, "billing_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "shipping_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "note": { "type": "string" }, "tracking": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "sku": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "options": { "type": [ "string", "null" ] }, "qty": { "type": "integer" }, "unit_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "line_total": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "at": { "type": "string" } } } } } }, "payment": { "type": "object", "properties": { "type": { "type": "string" }, "paid": { "type": "boolean" }, "success_url": { "type": "string" } } } } } } }, "example": { "data": { "order": { "number": "SL-261002-0001", "status": { "value": "pending", "label": "Pending" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": 1, "can_cancel": true, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": null, "customer": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100" }, "billing_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "note": "Leave at the door", "tracking": null, "items": [ { "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "options": null, "qty": 1, "unit_price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "line_total": { "amount": 145, "formatted": "$145", "currency": "USD" } } ], "history": [ { "status": "pending", "comment": "Order placed.", "at": "2026-10-02T13:01:40+00:00" } ] }, "payment": { "type": "completed", "paid": false, "success_url": "http://localhost/checkout/success/SL-261002-0001?signature=a2419e98e70790e719b98ef1d8df5ed19c3f173c4444a771ada09e9c80d17256" } } } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/orders": { "get": { "tags": [ "Orders" ], "summary": "My orders", "operationId": "getOrders", "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Filter by status", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "description": "1-100", "schema": { "type": "integer" }, "example": 10 } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": [ "string", "null" ] }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": [ "string", "null" ] } } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } } } }, "example": { "data": [ { "number": "SL-261002-0001", "status": { "value": "pending", "label": "Pending" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": null, "can_cancel": true, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": null } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 10, "total": 1 }, "links": { "next": null, "prev": null } } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/orders/track": { "get": { "tags": [ "Orders" ], "summary": "Track an order (guests)", "operationId": "getOrders/track", "description": "Public, rate limited. Answers 404 unless number and e-mail match.\n\nRate limit: 10/min per IP.", "parameters": [ { "name": "number", "in": "query", "required": true, "description": "Order number", "schema": { "type": "string" }, "example": "SL-261002-0001" }, { "name": "email", "in": "query", "required": true, "description": "E-mail used for the order", "schema": { "type": "string" }, "example": "jane.doe@example.com" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": "integer" }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": [ "string", "null" ] }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } } }, "billing_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "shipping_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "note": { "type": "string" }, "tracking": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "sku": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "options": { "type": [ "string", "null" ] }, "qty": { "type": "integer" }, "unit_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "line_total": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "at": { "type": "string" } } } } } } } }, "example": { "data": { "number": "SL-261002-0001", "status": { "value": "pending", "label": "Pending" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": 1, "can_cancel": true, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": null, "customer": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100" }, "billing_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "note": "Leave at the door", "tracking": null, "items": [ { "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "options": null, "qty": 1, "unit_price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "line_total": { "amount": 145, "formatted": "$145", "currency": "USD" } } ], "history": [ { "status": "pending", "comment": "Order placed.", "at": "2026-10-02T13:01:40+00:00" } ] } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/orders/{number}": { "get": { "tags": [ "Orders" ], "summary": "Order detail", "operationId": "getOrders/number", "description": "Only the order's owner may read it: another customer's order answers 403, an unknown number 404.", "parameters": [ { "name": "number", "in": "path", "required": true, "description": "Order number", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": "integer" }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": [ "string", "null" ] }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } } }, "billing_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "shipping_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "note": { "type": "string" }, "tracking": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "sku": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "options": { "type": [ "string", "null" ] }, "qty": { "type": "integer" }, "unit_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "line_total": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "at": { "type": "string" } } } } } } } }, "example": { "data": { "number": "SL-261002-0001", "status": { "value": "pending", "label": "Pending" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": 1, "can_cancel": true, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": null, "customer": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100" }, "billing_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "note": "Leave at the door", "tracking": null, "items": [ { "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "options": null, "qty": 1, "unit_price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "line_total": { "amount": 145, "formatted": "$145", "currency": "USD" } } ], "history": [ { "status": "pending", "comment": "Order placed.", "at": "2026-10-02T13:01:40+00:00" } ] } } } } }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/orders/{number}/cancel": { "post": { "tags": [ "Orders" ], "summary": "Cancel an unpaid order", "operationId": "postOrders/number/cancel", "parameters": [ { "name": "number", "in": "path", "required": true, "description": "Order number", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "description": "Free text (max 500)" } } }, "example": { "reason": "Ordered by mistake" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": "integer" }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } } }, "billing_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "shipping_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "note": { "type": "string" }, "tracking": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "sku": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "options": { "type": [ "string", "null" ] }, "qty": { "type": "integer" }, "unit_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "line_total": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "at": { "type": "string" } } } } } }, "message": { "type": "string" } } }, "example": { "data": { "number": "SL-261002-0001", "status": { "value": "cancelled", "label": "Cancelled" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": 1, "can_cancel": false, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": "2026-10-02T13:01:40+00:00", "customer": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100" }, "billing_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "note": "Leave at the door", "tracking": null, "items": [ { "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "options": null, "qty": 1, "unit_price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "line_total": { "amount": 145, "formatted": "$145", "currency": "USD" } } ], "history": [ { "status": "pending", "comment": "Order placed.", "at": "2026-10-02T13:01:40+00:00" }, { "status": "cancelled", "comment": "Ordered by mistake", "at": "2026-10-02T13:01:40+00:00" } ] }, "message": "Order SL-261002-0001 has been cancelled." } } } }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/orders/{number}/pay": { "post": { "tags": [ "Orders" ], "summary": "Retry the payment", "operationId": "postOrders/number/pay", "description": "Same response shape as POST /checkout.", "parameters": [ { "name": "number", "in": "path", "required": true, "description": "Order number", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "payment_method": { "type": "string", "description": "Switch to another gateway" } } }, "example": [] } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "order": { "type": "object", "properties": { "number": { "type": "string" }, "status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_status": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } } }, "payment_method": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "shipping_method": { "type": "string" }, "currency": { "type": "string" }, "subtotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "shipping": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "tax": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "points_discount": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "total": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "coupon_code": { "type": [ "string", "null" ] }, "items_count": { "type": "integer" }, "can_cancel": { "type": "boolean" }, "placed_at": { "type": "string" }, "paid_at": { "type": [ "string", "null" ] }, "shipped_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] }, "cancelled_at": { "type": [ "string", "null" ] }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } } }, "billing_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "shipping_address": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "phone": { "type": "string" } } }, "note": { "type": "string" }, "tracking": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "sku": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "options": { "type": [ "string", "null" ] }, "qty": { "type": "integer" }, "unit_price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "line_total": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "at": { "type": "string" } } } } } }, "payment": { "type": "object", "properties": { "type": { "type": "string" }, "paid": { "type": "boolean" }, "success_url": { "type": "string" } } } } } } }, "example": { "data": { "order": { "number": "SL-261002-0001", "status": { "value": "pending", "label": "Pending" }, "payment_status": { "value": "pending", "label": "Pending" }, "payment_method": { "key": "cod", "name": "Cash on Delivery" }, "shipping_method": "Standard shipping", "currency": "USD", "subtotal": { "amount": 145, "formatted": "$145", "currency": "USD" }, "discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "shipping": { "amount": 5.99, "formatted": "$5.99", "currency": "USD" }, "tax": { "amount": 10.15, "formatted": "$10.15", "currency": "USD" }, "points_discount": { "amount": 0, "formatted": "$0", "currency": "USD" }, "total": { "amount": 161.14, "formatted": "$161.14", "currency": "USD" }, "coupon_code": null, "items_count": 1, "can_cancel": true, "placed_at": "2026-10-02T13:01:40+00:00", "paid_at": null, "shipped_at": null, "completed_at": null, "cancelled_at": null, "customer": { "email": "jane.doe@example.com", "first_name": "Jane", "last_name": "Doe", "phone": "+1 555 0100" }, "billing_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100" }, "note": "Leave at the door", "tracking": null, "items": [ { "product_id": 46, "variant_id": null, "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "options": null, "qty": 1, "unit_price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "line_total": { "amount": 145, "formatted": "$145", "currency": "USD" } } ], "history": [ { "status": "pending", "comment": "Order placed.", "at": "2026-10-02T13:01:40+00:00" } ] }, "payment": { "type": "completed", "paid": false, "success_url": "http://localhost/checkout/success/SL-261002-0001?signature=a2419e98e70790e719b98ef1d8df5ed19c3f173c4444a771ada09e9c80d17256" } } } } } }, "403": { "$ref": "#/components/responses/Forbidden" }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/addresses": { "get": { "tags": [ "Account" ], "summary": "Address book", "operationId": "getAddresses", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "country_name": { "type": "string" }, "phone": { "type": "string" }, "is_default_shipping": { "type": "boolean" }, "is_default_billing": { "type": "boolean" }, "formatted": { "type": "string" } } } } } }, "example": { "data": [ { "id": 4, "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "country_name": "United States", "phone": "+1 555 0100", "is_default_shipping": true, "is_default_billing": true, "formatted": "Jane Doe\n1 Market St\nSan Francisco, California 94105\nUnited States\n+1 555 0100" } ] } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "post": { "tags": [ "Account" ], "summary": "Add an address", "operationId": "postAddresses", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "first_name", "address_1", "city", "country" ], "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": "string" }, "address_1": { "type": "string" }, "address_2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string", "description": "ISO-2" }, "phone": { "type": "string" }, "is_default_shipping": { "type": "boolean" }, "is_default_billing": { "type": "boolean" } } }, "example": { "first_name": "Jane", "last_name": "Doe", "address_1": "1 Market St", "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "phone": "+1 555 0100", "is_default_shipping": false, "is_default_billing": false } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "country_name": { "type": "string" }, "phone": { "type": "string" }, "is_default_shipping": { "type": "boolean" }, "is_default_billing": { "type": "boolean" }, "formatted": { "type": "string" } } }, "message": { "type": "string" } } }, "example": { "data": { "id": 4, "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "country_name": "United States", "phone": "+1 555 0100", "is_default_shipping": true, "is_default_billing": true, "formatted": "Jane Doe\n1 Market St\nSan Francisco, California 94105\nUnited States\n+1 555 0100" }, "message": "The address was saved." } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/addresses/{address}": { "get": { "tags": [ "Account" ], "summary": "One address", "operationId": "getAddresses/address", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Address id", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "country_name": { "type": "string" }, "phone": { "type": "string" }, "is_default_shipping": { "type": "boolean" }, "is_default_billing": { "type": "boolean" }, "formatted": { "type": "string" } } } } }, "example": { "data": { "id": 4, "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "San Francisco", "state": "CA", "zip": "94105", "country": "US", "country_name": "United States", "phone": "+1 555 0100", "is_default_shipping": true, "is_default_billing": true, "formatted": "Jane Doe\n1 Market St\nSan Francisco, California 94105\nUnited States\n+1 555 0100" } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "put": { "tags": [ "Account" ], "summary": "Update an address", "operationId": "putAddresses/address", "description": "Full replacement, same fields as POST /addresses.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Address id", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "country_name": { "type": "string" }, "phone": { "type": "string" }, "is_default_shipping": { "type": "boolean" }, "is_default_billing": { "type": "boolean" }, "formatted": { "type": "string" } } }, "message": { "type": "string" } } }, "example": { "data": { "id": 4, "first_name": "Jane", "last_name": "Doe", "company": null, "address_1": "1 Market St", "address_2": null, "city": "Oakland", "state": "CA", "zip": "94105", "country": "US", "country_name": "United States", "phone": "+1 555 0100", "is_default_shipping": true, "is_default_billing": true, "formatted": "Jane Doe\n1 Market St\nOakland, California 94105\nUnited States\n+1 555 0100" }, "message": "The address was updated." } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/ValidationError" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } }, "delete": { "tags": [ "Account" ], "summary": "Delete an address", "operationId": "deleteAddresses/address", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Address id", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "The address was deleted." } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/wishlist": { "get": { "tags": [ "Account" ], "summary": "Wishlist products", "operationId": "getWishlist", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "hover_image": { "type": "string" }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "old_price": { "type": [ "string", "null" ] }, "price_range": { "type": [ "string", "null" ] }, "discount_percent": { "type": "integer" }, "rating": { "type": "object", "properties": { "average": { "type": "number" }, "count": { "type": "integer" } } }, "in_stock": { "type": "boolean" }, "stock_status": { "type": "string" }, "has_variants": { "type": "boolean" }, "badges": { "type": "array", "items": {} }, "is_new": { "type": "boolean" }, "is_featured": { "type": "boolean" }, "brand": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "integer" } } } } } }, "example": { "data": [ { "id": 46, "slug": "leather-messenger-bag-olive", "type": "simple", "name": "Leather Messenger Bag, Olive", "sku": "LM-BAG-0145", "url": "http://localhost/product/leather-messenger-bag-olive", "image": { "url": "http://localhost/assets/images/category/category-fashion-02.png", "alt": "Leather Messenger Bag, Olive", "sizes": { "thumb": "http://localhost/assets/images/category/category-fashion-02.png", "small": "http://localhost/assets/images/category/category-fashion-02.png", "medium": "http://localhost/assets/images/category/category-fashion-02.png", "large": "http://localhost/assets/images/category/category-fashion-02.png" } }, "hover_image": "http://localhost/assets/images/category/category-fashion-03.png", "price": { "amount": 145, "formatted": "$145", "currency": "USD" }, "old_price": null, "price_range": null, "discount_percent": 0, "rating": { "average": 4.7, "count": 158 }, "in_stock": true, "stock_status": "in_stock", "has_variants": false, "badges": [], "is_new": false, "is_featured": false, "brand": { "id": 8, "name": "Hollis", "slug": "hollis" }, "categories": [ { "id": 15, "name": "Bags", "slug": "bags" } ] } ], "meta": { "count": 1, "ids": [ 46 ] } } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/wishlist/toggle": { "post": { "tags": [ "Account" ], "summary": "Add / remove a product", "operationId": "postWishlist/toggle", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "product_id" ], "properties": { "product_id": { "type": "integer" }, "variant_id": { "type": "integer" } } }, "example": { "product_id": 1 } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "added": { "type": "boolean" }, "product_id": { "type": "integer" }, "count": { "type": "integer" } } }, "message": { "type": "string" } } }, "example": { "data": { "added": true, "product_id": 46, "count": 1 }, "message": "Added to your wishlist." } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/notifications": { "get": { "tags": [ "Account" ], "summary": "Notifications", "operationId": "getNotifications", "parameters": [ { "name": "filter", "in": "query", "required": false, "description": "`unread` for unread only", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "url": { "type": "string" }, "read": { "type": "boolean" }, "created_at": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "unread": { "type": "integer" } } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } } } }, "example": { "data": [ { "id": "c6ce8097-bcf6-42d8-bce1-687dc1d29c2b", "type": "order_status", "title": "Order SL-261002-0001 updated", "message": "Your order SL-261002-0001 is now Cancelled.", "url": "http://localhost/account/orders/SL-261002-0001", "read": false, "created_at": "2026-10-02T13:01:40+00:00" } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 1, "unread": 1 }, "links": { "next": null, "prev": null } } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/notifications/read-all": { "post": { "tags": [ "Account" ], "summary": "Mark all as read", "operationId": "postNotifications/readAll", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "All notifications are marked as read." } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/notifications/{id}/read": { "post": { "tags": [ "Account" ], "summary": "Mark one as read", "operationId": "postNotifications/id/read", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Notification id (UUID)", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Done." } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/notifications/{id}": { "delete": { "tags": [ "Account" ], "summary": "Delete a notification", "operationId": "deleteNotifications/id", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Notification id (UUID)", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } }, "example": { "message": "Done." } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/points": { "get": { "tags": [ "Account" ], "summary": "Reward points", "operationId": "getPoints", "description": "`meta.summary` holds the balance and redemption rules; `data` is the paginated ledger.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "balance": { "type": "integer" }, "value": { "type": "object", "properties": { "amount": { "type": "integer" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "earn_rate": { "type": "integer" }, "redeem_rate": { "type": "integer" }, "min_redeem": { "type": "integer" }, "can_redeem": { "type": "boolean" } } } } }, "links": { "type": "object", "properties": { "next": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] } } } } }, "example": { "data": [], "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 0, "summary": { "enabled": true, "balance": 0, "value": { "amount": 0, "formatted": "$0", "currency": "USD" }, "earn_rate": 1, "redeem_rate": 100, "min_redeem": 100, "can_redeem": false } }, "links": { "next": null, "prev": null } } } } }, "401": { "$ref": "#/components/responses/Unauthenticated" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/pages/{slug}": { "get": { "tags": [ "Content" ], "summary": "CMS page", "operationId": "getPages/slug", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Page slug, e.g. about-us", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "body": { "type": "string" }, "image": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "seo": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } }, "updated_at": { "type": "string" } } } } }, "example": { "data": { "id": 1, "slug": "about-us", "title": "About us", "excerpt": "Loom started as a rail of 40 pieces in a Lisbon warehouse. Today we stock 300 independent and heritage labels - every one chosen for how it's made and how lo...", "body": "Loom started as a rail of 40 pieces in a Lisbon warehouse. Today we stock 300 independent and heritage labels - every one chosen for how it's made and how lo...", "image": null, "url": "http://localhost/page/about-us", "seo": { "title": "About us", "description": "Loom started as a rail of 40 pieces in a Lisbon warehouse. Today we stock 300 independent and heritage labels - every one chosen for how it's made and how lo..." }, "updated_at": "2026-10-02T12:56:53+00:00" } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/blog": { "get": { "tags": [ "Content" ], "summary": "Blog posts", "operationId": "getBlog", "parameters": [ { "name": "category", "in": "query", "required": false, "description": "Blog category slug", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Search title / excerpt", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "description": "1-100", "schema": { "type": "integer" }, "example": 2 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "url": { "type": "string" }, "category": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "author": { "type": "string" }, "reading_time": { "type": "integer" }, "published_at": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" } } }, "links": { "type": "object", "properties": { "next": { "type": "string" }, "prev": { "type": [ "string", "null" ] } } } } }, "example": { "data": [ { "id": 1, "slug": "the-12-piece-winter-capsule-wardrobe", "title": "The 12-piece winter capsule wardrobe", "excerpt": "Twelve pieces, forty outfits: how our stylists build a winter wardrobe that works harder than it looks.", "image": { "url": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "alt": "The 12-piece winter capsule wardrobe", "sizes": { "thumb": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "small": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "medium": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "large": "http://localhost/assets/images/other/image-fashion-eight-01.jpg" } }, "url": "http://localhost/blog/the-12-piece-winter-capsule-wardrobe", "category": { "id": 4, "slug": "style-guide", "name": "Style guide" }, "author": "Sellora Admin", "reading_time": 2, "published_at": "2026-09-24T09:30:00+00:00" }, { "id": 2, "slug": "how-to-care-for-wool-so-it-lasts-a-decade", "title": "How to care for wool so it lasts a decade", "excerpt": "Washing, drying, de-pilling and storing - the knitwear routine our repair team swears by.", "image": { "url": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "alt": "How to care for wool so it lasts a decade", "sizes": { "thumb": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "small": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "medium": "http://localhost/assets/images/other/image-fashion-eight-03.jpg", "large": "http://localhost/assets/images/other/image-fashion-eight-03.jpg" } }, "url": "http://localhost/blog/how-to-care-for-wool-so-it-lasts-a-decade", "category": { "id": 1, "slug": "care", "name": "Care" }, "author": "Sellora Admin", "reading_time": 2, "published_at": "2026-09-18T09:30:00+00:00" } ], "meta": { "current_page": 1, "last_page": 5, "per_page": 2, "total": 9 }, "links": { "next": "http://localhost/api/v1/blog?per_page=2&page=2", "prev": null } } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/blog/categories": { "get": { "tags": [ "Content" ], "summary": "Blog categories", "operationId": "getBlog/categories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "posts_count": { "type": "integer" } } } } } }, "example": { "data": [ { "id": 1, "slug": "care", "name": "Care", "description": "Washing, mending and storing your clothes so they last.", "posts_count": 2 }, { "id": 2, "slug": "makers", "name": "Makers", "description": "Stories from the workshops and studios behind the labels we stock.", "posts_count": 1 } ] } } } }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/blog/{slug}": { "get": { "tags": [ "Content" ], "summary": "Blog post", "operationId": "getBlog/slug", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Post slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "image": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" }, "sizes": { "type": "object", "properties": { "thumb": { "type": "string" }, "small": { "type": "string" }, "medium": { "type": "string" }, "large": { "type": "string" } } } } }, "url": { "type": "string" }, "category": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, "author": { "type": "string" }, "reading_time": { "type": "integer" }, "published_at": { "type": "string" }, "body": { "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } }, "seo": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } } } } } }, "example": { "data": { "id": 1, "slug": "the-12-piece-winter-capsule-wardrobe", "title": "The 12-piece winter capsule wardrobe", "excerpt": "Twelve pieces, forty outfits: how our stylists build a winter wardrobe that works harder than it looks.", "image": { "url": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "alt": "The 12-piece winter capsule wardrobe", "sizes": { "thumb": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "small": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "medium": "http://localhost/assets/images/other/image-fashion-eight-01.jpg", "large": "http://localhost/assets/images/other/image-fashion-eight-01.jpg" } }, "url": "http://localhost/blog/the-12-piece-winter-capsule-wardrobe", "category": { "id": 4, "slug": "style-guide", "name": "Style guide" }, "author": "Sellora Admin", "reading_time": 2, "published_at": "2026-09-24T09:30:00+00:00", "body": "A capsule wardrobe isn't about owning less for the sake of it - it's about owning pieces that all work together. Our stylists built this one with twelve piec...", "tags": [ { "id": 4, "name": "Capsule", "slug": "capsule" }, { "id": 12, "name": "Knitwear", "slug": "knitwear" } ], "seo": { "title": "The 12-piece winter capsule wardrobe", "description": "Twelve pieces, forty outfits: how our stylists build a winter wardrobe that works harder than it looks." } } } } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/contact": { "post": { "tags": [ "Content" ], "summary": "Send a contact message", "operationId": "postContact", "description": "Rate limit: 10/min per IP.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "message", "consent" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "subject": { "type": "string" }, "order": { "type": "string", "description": "Related order number" }, "message": { "type": "string", "description": "20-2000 characters" }, "consent": { "type": "boolean", "description": "Must be true" } } }, "example": { "name": "Jane Doe", "email": "jane.doe@example.com", "subject": "Delivery question", "message": "Hello, where can I see the delivery time for my order?", "consent": true } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reference": { "type": "string" } } }, "message": { "type": "string" } } }, "example": { "data": { "reference": "#000003" }, "message": "Thanks, your message has been received." } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } }, "/newsletter/subscribe": { "post": { "tags": [ "Content" ], "summary": "Subscribe to the newsletter", "operationId": "postNewsletter/subscribe", "description": "Rate limit: 10/min per IP.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "example": { "email": "jane.doe@example.com" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "email": { "type": "string" }, "already": { "type": "boolean" } } }, "message": { "type": "string" } } }, "example": { "data": { "email": "news-83bo@example.com", "already": false }, "message": "Thanks for subscribing!" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "429": { "$ref": "#/components/responses/TooManyRequests" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Token from POST /auth/login or /auth/register" } }, "parameters": { "CartToken": { "name": "X-Cart-Token", "in": "header", "required": false, "description": "Guest cart token returned by the first cart write. Ignored for authenticated requests.", "schema": { "type": "string" } } }, "schemas": { "Money": { "type": "object", "properties": { "amount": { "type": "number" }, "formatted": { "type": "string" }, "currency": { "type": "string" } } }, "Error": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "responses": { "ValidationError": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "The E-mail field is required. (and 3 more errors)", "errors": { "email": [ "The E-mail field is required." ], "phone": [ "The Phone field is required." ], "password": [ "The Password field is required." ], "terms": [ "Please accept the terms to create your account." ] } } } } }, "Unauthenticated": { "description": "Missing or invalid Bearer token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Unauthenticated." } } } }, "Forbidden": { "description": "Not allowed (e.g. another customer's order)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "No query results for model [App\\Models\\Order]." } } } }, "NotFound": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "No query results for model [App\\Models\\Product]." } } } }, "TooManyRequests": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "message": "Too Many Attempts." } } } } } } }