{ "openapi": "3.0.3", "info": { "title": "ItsPawned API", "version": "v1", "description": "A framework-free JSON API for catalog browsing, category navigation, cart flows, and token-based admin operations." }, "servers": [ { "url": "https://api.ItsPawned.com", "description": "Primary API base URL" } ], "tags": [ { "name": "General", "description": "Service health and platform-wide utility endpoints." }, { "name": "Products", "description": "Product listing, featured merchandising, and individual product lookups." }, { "name": "Categories", "description": "Category summaries and product collections grouped by category." }, { "name": "Cart", "description": "Token-aware cart retrieval and cart mutation endpoints." }, { "name": "Chat", "description": "Storefront customer support chat session, live stream, and message endpoints." }, { "name": "Checkout", "description": "Order creation, secure confirmation links, and customer-safe order status lookups." }, { "name": "Auth", "description": "Token-based admin authentication and auth-status endpoints." }, { "name": "Admin", "description": "Protected back-office product, category, user, and profile endpoints." } ], "paths": { "/": { "get": { "tags": [ "General" ], "operationId": "health", "summary": "Health check", "description": "Confirms the API is available and returns service metadata.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" }, "api_version": { "type": "string" } }, "required": [ "status", "service", "api_version" ] }, "example": { "status": "ok", "service": "ItsPawned", "api_version": "v1" } } } } }, "x-group-id": "general", "x-endpoint-id": "health", "x-example-values": [] } }, "/health": { "get": { "tags": [ "General" ], "operationId": "health_alt", "summary": "Health check alias", "description": "Alias of the root health check endpoint for uptime monitors and infrastructure probes.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" }, "api_version": { "type": "string" } }, "required": [ "status", "service", "api_version" ] }, "example": { "status": "ok", "service": "ItsPawned", "api_version": "v1" } } } } }, "x-group-id": "general", "x-endpoint-id": "health-alt", "x-example-values": [] } }, "/docs": { "get": { "tags": [ "General" ], "operationId": "docs_html", "summary": "Interactive API explorer", "description": "Returns the HTML API explorer UI generated from this documentation spec.", "responses": { "200": { "description": "Successful response", "content": { "text/html": { "schema": { "type": "string" }, "example": "API ExplorerInteractive API explorer" } } } }, "x-group-id": "general", "x-endpoint-id": "docs-html", "x-example-values": [] } }, "/openapi.json": { "get": { "tags": [ "General" ], "operationId": "docs_openapi_json", "summary": "OpenAPI document", "description": "Returns the generated OpenAPI 3.0.3 document for this API.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "openapi": { "type": "string" }, "info": { "type": "object", "properties": { "title": { "type": "string" }, "version": { "type": "string" } }, "required": [ "title", "version" ] } }, "required": [ "openapi", "info" ] }, "example": { "openapi": "3.0.3", "info": { "title": "ItsPawned API", "version": "v1" } } } } } }, "x-group-id": "general", "x-endpoint-id": "docs-openapi-json", "x-example-values": [] } }, "/spec": { "get": { "tags": [ "General" ], "operationId": "docs_openapi_spec_alias", "summary": "OpenAPI document alias", "description": "Alias of the generated OpenAPI document endpoint.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "openapi": { "type": "string" }, "info": { "type": "object", "properties": { "title": { "type": "string" }, "version": { "type": "string" } }, "required": [ "title", "version" ] } }, "required": [ "openapi", "info" ] }, "example": { "openapi": "3.0.3", "info": { "title": "ItsPawned API", "version": "v1" } } } } } }, "x-group-id": "general", "x-endpoint-id": "docs-openapi-spec-alias", "x-example-values": [] } }, "/docs/postman-collection": { "get": { "tags": [ "General" ], "operationId": "docs_postman_collection", "summary": "Generated Postman collection", "description": "Downloads the generated Postman collection derived from the same endpoint specification used by the explorer and OpenAPI output.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "info": { "type": "object", "properties": { "name": { "type": "string" }, "schema": { "type": "string" } }, "required": [ "name", "schema" ] }, "item": { "type": "array", "items": [] } }, "required": [ "info", "item" ] }, "example": { "info": { "name": "ItsPawned API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [] } } } } }, "x-group-id": "general", "x-endpoint-id": "docs-postman-collection", "x-example-values": [] } }, "/products": { "get": { "tags": [ "Products" ], "operationId": "products_list", "summary": "List products", "description": "Returns all products, optionally filtered by category slug and free-text search.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Searches name, category, summary, and description.", "schema": { "type": "string" }, "example": "Field Pack Utility Kit" }, { "name": "category", "in": "query", "required": false, "description": "Category slug filter such as travel-gear or workspace.", "schema": { "type": "string" }, "example": "apparel" }, { "name": "sort", "in": "query", "required": false, "description": "Sort order: featured, price-asc, price-desc, name-asc, or name-desc.", "schema": { "type": "string" }, "example": "featured" }, { "name": "page", "in": "query", "required": false, "description": "One-based page number for paginated results.", "schema": { "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "required": false, "description": "Page size, capped by the catalog repository.", "schema": { "type": "integer" }, "example": 2 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Count": { "type": "string" }, "Insert size": { "type": "string" }, "Material": { "type": "string" } }, "required": [ "Count", "Insert size", "Material" ] }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "base_price": { "type": "number", "format": "float" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "discount_percent", "discount_label", "tags", "media", "base_price", "has_discount", "savings_amount", "primary_image" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "sort": { "type": "string" }, "sort_options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ] } }, "search": { "type": "string" }, "category": { "type": "string" }, "from": { "type": "integer" }, "to": { "type": "integer" }, "has_previous": { "type": "boolean" }, "has_next": { "type": "boolean" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } } }, "required": [ "count", "page", "per_page", "total_pages", "sort", "sort_options", "search", "category", "from", "to", "has_previous", "has_next", "categories" ] } }, "required": [ "data", "meta" ] }, "example": { "data": [ { "sku": "NS-1050", "slug": "acrylic-price-blocks", "name": "Acrylic Price Blocks", "category": "Retail Display", "category_slug": "retail-display", "category_summary": "Display-support tools for cleaner demos, organized counters, and better small-format merchandising.", "summary": "Reusable acrylic blocks for pricing cards and short promotional copy.", "description": "The Acrylic Price Blocks keep pricing and short messaging clean, readable, and consistent across counters and display tables.", "price": 22.95, "inventory": 81, "featured": true, "features": [ "Clear slot for paper or card inserts", "Low profile suited to smaller products", "Easy-wipe acrylic with rounded edges" ], "specs": { "Count": "6 blocks", "Insert size": "2 in x 3.5 in", "Material": "Clear acrylic" }, "discount_percent": 15, "discount_label": "", "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%234338ca%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23c4b5fd%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ERetail%20Display%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EAcrylic%20Price%20Blocks%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1050%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Acrylic Price Blocks image 1" } ], "base_price": 27, "has_discount": true, "savings_amount": 4.05, "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%234338ca%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23c4b5fd%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ERetail%20Display%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EAcrylic%20Price%20Blocks%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1050%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Acrylic Price Blocks image 1" } }, { "sku": "NS-1046", "slug": "field-crew-vest", "name": "Field Crew Vest", "category": "Apparel", "category_slug": "apparel", "category_summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "summary": "Light quilted vest with utility pockets and internal device sleeve.", "description": "The Field Crew Vest adds pocket capacity and light warmth without restricting movement during setup, visits, and inventory tasks.", "price": 92, "inventory": 24, "featured": true, "features": [ "Light insulation for shoulder seasons", "Internal chest sleeve for phones or small scanners", "Two-way front zip for easier seated wear" ], "specs": { "Shell": "Recycled nylon", "Insulation": "60 gsm synthetic fill", "Fit": "Regular layering fit" }, "base_price": 92, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } } ], "meta": { "count": 53, "page": 1, "per_page": 2, "total_pages": 27, "sort": "featured", "sort_options": [ { "value": "featured", "label": "Featured first" }, { "value": "price-asc", "label": "Price: low to high" }, { "value": "price-desc", "label": "Price: high to low" }, { "value": "name-asc", "label": "Name: A to Z" }, { "value": "name-desc", "label": "Name: Z to A" } ], "search": "", "category": "", "from": 1, "to": 2, "has_previous": false, "has_next": true, "categories": [ { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 }, { "slug": "hydration", "name": "Hydration", "summary": "Everyday hydration gear for long routes, site visits, and all-day travel between meetings.", "product_count": 9 }, { "slug": "retail-display", "name": "Retail Display", "summary": "Display-support tools for cleaner demos, organized counters, and better small-format merchandising.", "product_count": 8 }, { "slug": "stationery", "name": "Stationery", "summary": "Paper goods made for field notes, planning, and structured follow-up after customer conversations.", "product_count": 9 }, { "slug": "travel-gear", "name": "Travel Gear", "summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "product_count": 9 }, { "slug": "workspace", "name": "Workspace", "summary": "Desk-bound tools designed to make counters, checkout stations, and shared work surfaces feel more deliberate.", "product_count": 9 } ] } } } } } }, "x-group-id": "products", "x-endpoint-id": "products-list", "x-example-values": { "q": "Field Pack Utility Kit", "category": "apparel", "sort": "featured", "page": 1, "per_page": 2 } } }, "/products/featured": { "get": { "tags": [ "Products" ], "operationId": "products_featured", "summary": "Featured products", "description": "Returns the current featured product set for storefront merchandising.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Count": { "type": "string" }, "Insert size": { "type": "string" }, "Material": { "type": "string" } }, "required": [ "Count", "Insert size", "Material" ] }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "base_price": { "type": "number", "format": "float" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "discount_percent", "discount_label", "tags", "media", "base_price", "has_discount", "savings_amount", "primary_image" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "filter": { "type": "string" } }, "required": [ "count", "filter" ] } }, "required": [ "data", "meta" ] }, "example": { "data": [ { "sku": "NS-1050", "slug": "acrylic-price-blocks", "name": "Acrylic Price Blocks", "category": "Retail Display", "category_slug": "retail-display", "category_summary": "Display-support tools for cleaner demos, organized counters, and better small-format merchandising.", "summary": "Reusable acrylic blocks for pricing cards and short promotional copy.", "description": "The Acrylic Price Blocks keep pricing and short messaging clean, readable, and consistent across counters and display tables.", "price": 22.95, "inventory": 81, "featured": true, "features": [ "Clear slot for paper or card inserts", "Low profile suited to smaller products", "Easy-wipe acrylic with rounded edges" ], "specs": { "Count": "6 blocks", "Insert size": "2 in x 3.5 in", "Material": "Clear acrylic" }, "discount_percent": 15, "discount_label": "", "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%234338ca%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23c4b5fd%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ERetail%20Display%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EAcrylic%20Price%20Blocks%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1050%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Acrylic Price Blocks image 1" } ], "base_price": 27, "has_discount": true, "savings_amount": 4.05, "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%234338ca%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23c4b5fd%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ERetail%20Display%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EAcrylic%20Price%20Blocks%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1050%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Acrylic Price Blocks image 1" } }, { "sku": "NS-1046", "slug": "field-crew-vest", "name": "Field Crew Vest", "category": "Apparel", "category_slug": "apparel", "category_summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "summary": "Light quilted vest with utility pockets and internal device sleeve.", "description": "The Field Crew Vest adds pocket capacity and light warmth without restricting movement during setup, visits, and inventory tasks.", "price": 92, "inventory": 24, "featured": true, "features": [ "Light insulation for shoulder seasons", "Internal chest sleeve for phones or small scanners", "Two-way front zip for easier seated wear" ], "specs": { "Shell": "Recycled nylon", "Insulation": "60 gsm synthetic fill", "Fit": "Regular layering fit" }, "base_price": 92, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } }, { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } } ], "meta": { "count": 11, "filter": "featured" } } } } } }, "x-group-id": "products", "x-endpoint-id": "products-featured", "x-example-values": [] } }, "/products/{slug}": { "get": { "tags": [ "Products" ], "operationId": "product_detail", "summary": "Product detail", "description": "Returns one product, including normalized media fields, plus a related-product collection.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "The product slug defined in the catalog repository.", "schema": { "type": "string" }, "example": "field-pack-utility-kit" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Capacity": { "type": "string" }, "Weight": { "type": "string" } }, "required": [ "Material", "Capacity", "Weight" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] }, "meta": { "type": "object", "properties": { "related": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Closure": { "type": "string" }, "Length": { "type": "string" } }, "required": [ "Material", "Closure", "Length" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } } }, "required": [ "related" ] } }, "required": [ "data", "meta" ] }, "example": { "data": { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } }, "meta": { "related": [ { "sku": "NS-1007", "slug": "trail-brief-organizer", "name": "Trail Brief Organizer", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "Slim zip organizer for proposals, receipts, and charging gear.", "description": "The Trail Brief Organizer keeps daily travel documents separated from cables and accessories, making quick stops and handoffs easier to manage.", "price": 48, "inventory": 39, "featured": false, "features": [ "Three-panel internal layout for paper and accessories", "Water-shedding exterior with soft inner lining", "Flat profile sized for briefcases and field packs" ], "specs": { "Material": "Coated canvas", "Closure": "YKK zip", "Length": "13 in" }, "base_price": 48, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ETrail%20Brief%20Organizer%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1007%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Trail Brief Organizer placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ETrail%20Brief%20Organizer%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1007%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Trail Brief Organizer placeholder artwork" } }, { "sku": "NS-1008", "slug": "route-case-sling", "name": "Route Case Sling", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "Cross-body sling for tablets, forms, and quick-access personal carry.", "description": "The Route Case Sling is built for short site visits and high-mobility days, balancing document storage with a compact tablet sleeve.", "price": 72, "inventory": 27, "featured": true, "features": [ "Padded tablet sleeve with top zip access", "Wide stabilizing strap for active movement", "Front admin pocket with pen and badge slots" ], "specs": { "Capacity": "9 liters", "Weight": "1.4 lb", "Fit": "Left or right shoulder carry" }, "base_price": 72, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ERoute%20Case%20Sling%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1008%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Route Case Sling placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ERoute%20Case%20Sling%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1008%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Route Case Sling placeholder artwork" } }, { "sku": "NS-1009", "slug": "survey-clip-folio", "name": "Survey Clip Folio", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "Hardback folio with internal clipboard and tablet pocket.", "description": "The Survey Clip Folio is designed for inspections, signatures, and field notes where teams need paper support without giving up device storage.", "price": 58, "inventory": 33, "featured": false, "features": [ "Integrated metal clip under a weather flap", "Document pockets sized for letter forms", "Elastic pen loop and stylus keeper" ], "specs": { "Height": "12.5 in", "Width": "9.75 in", "Shell": "Compressed felt board" }, "base_price": 58, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ESurvey%20Clip%20Folio%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1009%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Survey Clip Folio placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ESurvey%20Clip%20Folio%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1009%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Survey Clip Folio placeholder artwork" } } ] } } } } } }, "x-group-id": "products", "x-endpoint-id": "product-detail", "x-example-values": { "slug": "field-pack-utility-kit" } } }, "/categories": { "get": { "tags": [ "Categories" ], "operationId": "categories_list", "summary": "List categories", "description": "Returns category summaries with product counts for catalog navigation.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" } }, "required": [ "count" ] } }, "required": [ "data", "meta" ] }, "example": { "data": [ { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 }, { "slug": "hydration", "name": "Hydration", "summary": "Everyday hydration gear for long routes, site visits, and all-day travel between meetings.", "product_count": 9 }, { "slug": "retail-display", "name": "Retail Display", "summary": "Display-support tools for cleaner demos, organized counters, and better small-format merchandising.", "product_count": 8 }, { "slug": "stationery", "name": "Stationery", "summary": "Paper goods made for field notes, planning, and structured follow-up after customer conversations.", "product_count": 9 }, { "slug": "travel-gear", "name": "Travel Gear", "summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "product_count": 9 }, { "slug": "workspace", "name": "Workspace", "summary": "Desk-bound tools designed to make counters, checkout stations, and shared work surfaces feel more deliberate.", "product_count": 9 } ], "meta": { "count": 6 } } } } } }, "x-group-id": "categories", "x-endpoint-id": "categories-list", "x-example-values": [] } }, "/categories/{slug}": { "get": { "tags": [ "Categories" ], "operationId": "category_detail", "summary": "Category detail", "description": "Returns one category and a paginated, sortable list of the products assigned to it.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "The category slug defined in the catalog repository.", "schema": { "type": "string" }, "example": "apparel" }, { "name": "sort", "in": "query", "required": false, "description": "Sort order: featured, price-asc, price-desc, name-asc, or name-desc.", "schema": { "type": "string" }, "example": "featured" }, { "name": "page", "in": "query", "required": false, "description": "One-based page number for the category listing.", "schema": { "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "required": false, "description": "Page size for the category listing.", "schema": { "type": "integer" }, "example": 2 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "sort": { "type": "string" }, "sort_options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ] } }, "search": { "type": "string" }, "category": { "type": "string" }, "from": { "type": "integer" }, "to": { "type": "integer" }, "has_previous": { "type": "boolean" }, "has_next": { "type": "boolean" }, "products": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Shell": { "type": "string" }, "Insulation": { "type": "string" }, "Fit": { "type": "string" } }, "required": [ "Shell", "Insulation", "Fit" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } } }, "required": [ "count", "page", "per_page", "total_pages", "sort", "sort_options", "search", "category", "from", "to", "has_previous", "has_next", "products" ] } }, "required": [ "data", "meta" ] }, "example": { "data": { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 }, "meta": { "count": 9, "page": 1, "per_page": 2, "total_pages": 5, "sort": "featured", "sort_options": [ { "value": "featured", "label": "Featured first" }, { "value": "price-asc", "label": "Price: low to high" }, { "value": "price-desc", "label": "Price: high to low" }, { "value": "name-asc", "label": "Name: A to Z" }, { "value": "name-desc", "label": "Name: Z to A" } ], "search": "", "category": "apparel", "from": 1, "to": 2, "has_previous": false, "has_next": true, "products": [ { "sku": "NS-1046", "slug": "field-crew-vest", "name": "Field Crew Vest", "category": "Apparel", "category_slug": "apparel", "category_summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "summary": "Light quilted vest with utility pockets and internal device sleeve.", "description": "The Field Crew Vest adds pocket capacity and light warmth without restricting movement during setup, visits, and inventory tasks.", "price": 92, "inventory": 24, "featured": true, "features": [ "Light insulation for shoulder seasons", "Internal chest sleeve for phones or small scanners", "Two-way front zip for easier seated wear" ], "specs": { "Shell": "Recycled nylon", "Insulation": "60 gsm synthetic fill", "Fit": "Regular layering fit" }, "base_price": 92, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Crew%20Vest%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1046%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Crew Vest placeholder artwork" } }, { "sku": "NS-1005", "slug": "canvas-merchant-apron", "name": "Canvas Merchant Apron", "category": "Apparel", "category_slug": "apparel", "category_summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "summary": "Waxed canvas apron with hidden phone pocket and removable cross-back straps.", "description": "The Canvas Merchant Apron is built for busy counters, demos, and merchandising tables, with balanced pocket placement and straps that stay comfortable through long shifts.", "price": 76, "inventory": 17, "featured": false, "features": [ "Waxed cotton canvas with brass hardware", "Cross-back strap option for lower shoulder strain", "Split front pockets with hidden phone sleeve" ], "specs": { "Material": "12 oz waxed canvas", "Fit": "Adjustable unisex", "Care": "Spot clean and rewax as needed" }, "base_price": 76, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ECanvas%20Merchant%20Apron%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1005%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Canvas Merchant Apron placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%237f1d1d%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23fca5a5%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EApparel%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ECanvas%20Merchant%20Apron%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1005%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Canvas Merchant Apron placeholder artwork" } } ] } } } } } }, "x-group-id": "categories", "x-endpoint-id": "category-detail", "x-example-values": { "slug": "apparel", "sort": "featured", "page": 1, "per_page": 2 } } }, "/cart": { "get": { "tags": [ "Cart" ], "operationId": "cart_view", "summary": "Current cart", "description": "Returns the current cart, including items, count, and subtotal. When a cart token is supplied, the request resumes that cart.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "subtotal": { "type": "number", "format": "float" }, "is_empty": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } } }, "required": [ "count", "subtotal", "is_empty", "items" ] } }, "required": [ "status", "cart" ] }, "example": { "status": "ok", "cart": { "count": 1, "subtotal": 89, "is_empty": false, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ] } } } } } }, "x-group-id": "cart", "x-endpoint-id": "cart-view", "x-example-values": [] } }, "/cart/items": { "post": { "tags": [ "Cart" ], "operationId": "cart_add", "summary": "Add item to cart", "description": "Adds a SKU to the current cart and returns the updated cart state. If no cart token is supplied, the API creates one.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "subtotal": { "type": "number", "format": "float" } }, "required": [ "count", "subtotal" ] } }, "required": [ "status", "message", "cart" ] }, "example": { "status": "ok", "message": "Added to cart.", "cart": { "count": 1, "subtotal": 89 } } } } } }, "x-group-id": "cart", "x-endpoint-id": "cart-add", "x-example-values": { "sku": "NS-1001", "quantity": 1 }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sku": { "type": "string", "description": "The product SKU to add." }, "quantity": { "type": "integer", "description": "Quantity to add. Defaults to 1." } }, "required": [ "sku" ] }, "example": { "sku": "NS-1001", "quantity": 1 } } } } } }, "/cart/update": { "post": { "tags": [ "Cart" ], "operationId": "cart_update", "summary": "Update cart quantity", "description": "Updates the quantity for a cart item and returns the revised cart payload.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "subtotal": { "type": "number", "format": "float" } }, "required": [ "count", "subtotal" ] } }, "required": [ "status", "message", "cart" ] }, "example": { "status": "ok", "message": "Cart quantity updated.", "cart": { "count": 2, "subtotal": 178 } } } } } }, "x-group-id": "cart", "x-endpoint-id": "cart-update", "x-example-values": { "sku": "NS-1001", "quantity": 2 }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sku": { "type": "string", "description": "The product SKU already present in the cart." }, "quantity": { "type": "integer", "description": "The desired cart quantity. Use 0 to remove." } }, "required": [ "sku", "quantity" ] }, "example": { "sku": "NS-1001", "quantity": 2 } } } } } }, "/cart/remove": { "post": { "tags": [ "Cart" ], "operationId": "cart_remove", "summary": "Remove cart item", "description": "Removes one SKU from the cart and returns the updated empty or reduced cart.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "subtotal": { "type": "integer" }, "is_empty": { "type": "boolean" }, "items": { "type": "array", "items": [] } }, "required": [ "count", "subtotal", "is_empty", "items" ] } }, "required": [ "status", "message", "cart" ] }, "example": { "status": "ok", "message": "Item removed from cart.", "cart": { "count": 0, "subtotal": 0, "is_empty": true, "items": [] } } } } } }, "x-group-id": "cart", "x-endpoint-id": "cart-remove", "x-example-values": { "sku": "NS-1001" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sku": { "type": "string", "description": "The product SKU to remove from the cart." } }, "required": [ "sku" ] }, "example": { "sku": "NS-1001" } } } } } }, "/cart/clear": { "post": { "tags": [ "Cart" ], "operationId": "cart_clear", "summary": "Clear cart", "description": "Clears the full cart for the current session.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "cart": { "type": "object", "properties": { "count": { "type": "integer" }, "subtotal": { "type": "integer" }, "is_empty": { "type": "boolean" }, "items": { "type": "array", "items": [] } }, "required": [ "count", "subtotal", "is_empty", "items" ] } }, "required": [ "status", "message", "cart" ] }, "example": { "status": "ok", "message": "Cart cleared.", "cart": { "count": 0, "subtotal": 0, "is_empty": true, "items": [] } } } } } }, "x-group-id": "cart", "x-endpoint-id": "cart-clear", "x-example-values": [] } }, "/chat": { "get": { "tags": [ "Chat" ], "operationId": "chat_session", "summary": "Current storefront chat session", "description": "Returns whether customer chat is enabled and, when a chat token is present, the current conversation. Send the chat token in the X-Newsite-Chat-Token header to resume an existing thread.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "conversation": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "string" }, "sender_name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "sender", "sender_name", "body", "created_at" ] } } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender", "messages" ] } }, "required": [ "enabled", "conversation" ] }, "meta": { "type": "object", "properties": { "chat_token": { "type": "string" }, "clear_chat_token": { "type": "boolean" } }, "required": [ "chat_token", "clear_chat_token" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": { "enabled": true, "conversation": { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "open", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:32:56+00:00", "last_message_at": "2026-04-17T11:32:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin", "messages": [ { "id": "msg-1001", "sender": "customer", "sender_name": "Alex Customer", "body": "Hi, do you have this item in stock and ready to ship?", "created_at": "2026-04-17T11:28:56+00:00" }, { "id": "msg-1002", "sender": "admin", "sender_name": "Support", "body": "Absolutely. I can help with shipping and availability questions.", "created_at": "2026-04-17T11:32:56+00:00" } ] } }, "meta": { "chat_token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "clear_chat_token": false } } } } } }, "x-group-id": "chat", "x-endpoint-id": "chat-session", "x-example-values": [] } }, "/chat/stream": { "get": { "tags": [ "Chat" ], "operationId": "chat_stream", "summary": "Stream storefront chat updates", "description": "Streams live chat session updates as server-sent events. The client may send an existing chat token in the optional chat_token query string when opening the stream, or establish the conversation first through GET /chat.", "parameters": [ { "name": "chat_token", "in": "query", "required": false, "description": "Optional chat token used to resume an existing conversation when the EventSource request cannot attach custom headers.", "schema": { "type": "string" }, "example": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1" } ], "responses": { "200": { "description": "Successful response", "content": { "text/event-stream": { "schema": { "type": "string" }, "example": "event: conversation\ndata: {\"status\":\"ok\",\"data\":{\"enabled\":true,\"conversation\":{\"id\":\"chat-1001\",\"token\":\"c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1\",\"status\":\"open\",\"customer\":{\"name\":\"Alex Customer\",\"email\":\"customer@example.test\"},\"created_at\":\"2026-04-17T11:18:56+00:00\",\"updated_at\":\"2026-04-17T11:32:56+00:00\",\"last_message_at\":\"2026-04-17T11:32:56+00:00\",\"unread_admin_count\":0,\"unread_customer_count\":0,\"message_count\":2,\"last_message_preview\":\"Absolutely. I can help with shipping and availability questions.\",\"last_message_sender\":\"admin\",\"messages\":[{\"id\":\"msg-1001\",\"sender\":\"customer\",\"sender_name\":\"Alex Customer\",\"body\":\"Hi, do you have this item in stock and ready to ship?\",\"created_at\":\"2026-04-17T11:28:56+00:00\"},{\"id\":\"msg-1002\",\"sender\":\"admin\",\"sender_name\":\"Support\",\"body\":\"Absolutely. I can help with shipping and availability questions.\",\"created_at\":\"2026-04-17T11:32:56+00:00\"}]}},\"meta\":{\"chat_token\":\"c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1\",\"clear_chat_token\":false}}\n\n" } } } }, "x-group-id": "chat", "x-endpoint-id": "chat-stream", "x-example-values": { "chat_token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1" } } }, "/chat/messages": { "post": { "tags": [ "Chat" ], "operationId": "chat_message_create", "summary": "Send storefront chat message", "description": "Creates a new chat conversation or appends a customer reply to an existing one. When successful, the response includes the chat token in metadata for future polling or streaming requests.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "conversation": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "string" }, "sender_name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "sender", "sender_name", "body", "created_at" ] } } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender", "messages" ] } }, "required": [ "enabled", "conversation" ] }, "meta": { "type": "object", "properties": { "chat_token": { "type": "string" }, "clear_chat_token": { "type": "boolean" } }, "required": [ "chat_token", "clear_chat_token" ] } }, "required": [ "status", "message", "data", "meta" ] }, "example": { "status": "ok", "message": "Message sent. We will reply here as soon as possible.", "data": { "enabled": true, "conversation": { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "open", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:32:56+00:00", "last_message_at": "2026-04-17T11:32:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin", "messages": [ { "id": "msg-1001", "sender": "customer", "sender_name": "Alex Customer", "body": "Hi, do you have this item in stock and ready to ship?", "created_at": "2026-04-17T11:28:56+00:00" }, { "id": "msg-1002", "sender": "admin", "sender_name": "Support", "body": "Absolutely. I can help with shipping and availability questions.", "created_at": "2026-04-17T11:32:56+00:00" } ] } }, "meta": { "chat_token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "clear_chat_token": false } } } } } }, "x-group-id": "chat", "x-endpoint-id": "chat-message-create", "x-example-values": { "name": "Alex Customer", "email": "customer@example.test", "message": "Hi, do you have this item in stock and ready to ship?" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Customer display name shown to support staff." }, "email": { "type": "string", "description": "Customer email address for follow-up." }, "message": { "type": "string", "description": "Customer message body." } }, "required": [ "message" ] }, "example": { "name": "Alex Customer", "email": "customer@example.test", "message": "Hi, do you have this item in stock and ready to ship?" } } } } } }, "/checkout/address-metadata": { "get": { "tags": [ "Checkout" ], "operationId": "checkout_address_metadata", "summary": "Checkout address metadata", "description": "Returns the supported checkout countries, controlled state lists, and whether USPS ZIP lookup is configured for this environment.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "default_country": { "type": "string" }, "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "postal_code_label": { "type": "string" }, "postal_code_pattern": { "type": "string" } }, "required": [ "code", "name", "postal_code_label", "postal_code_pattern" ] } }, "states_by_country": { "type": "object", "properties": { "US": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": [ "code", "name" ] } } }, "required": [ "US" ] }, "lookup": { "type": "object", "properties": { "provider": { "type": "string" }, "enabled": { "type": "boolean" }, "requires_oauth": { "type": "boolean" } }, "required": [ "provider", "enabled", "requires_oauth" ] } }, "required": [ "default_country", "countries", "states_by_country", "lookup" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "default_country": "US", "countries": [ { "code": "US", "name": "United States", "postal_code_label": "ZIP code", "postal_code_pattern": "^\\d{5}$" } ], "states_by_country": { "US": [ { "code": "CA", "name": "California" }, { "code": "NY", "name": "New York" } ] }, "lookup": { "provider": "usps", "enabled": false, "requires_oauth": true } } } } } } }, "x-group-id": "checkout", "x-endpoint-id": "checkout-address-metadata", "x-example-values": [] } }, "/checkout/address-lookup": { "get": { "tags": [ "Checkout" ], "operationId": "checkout_address_lookup", "summary": "ZIP to city/state lookup", "description": "Uses the local API as a USPS-backed proxy to resolve a 5-digit ZIP code into a city and two-letter state code for checkout autofill.", "parameters": [ { "name": "postal_code", "in": "query", "required": true, "description": "5-digit United States ZIP code.", "schema": { "type": "string" }, "example": "50314" }, { "name": "country", "in": "query", "required": false, "description": "Supported checkout country code. Defaults to US.", "schema": { "type": "string" }, "example": "US" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "postal_code": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "state_name": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "source": { "type": "string" }, "message": { "type": "string" } }, "required": [ "postal_code", "city", "state", "state_name", "country", "country_code", "source", "message" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "postal_code": "50314", "city": "Des Moines", "state": "IA", "state_name": "Iowa", "country": "United States", "country_code": "US", "source": "usps", "message": "City and state loaded from USPS." } } } } } }, "x-group-id": "checkout", "x-endpoint-id": "checkout-address-lookup", "x-example-values": { "postal_code": "50314", "country": "US" } } }, "/checkout/orders": { "post": { "tags": [ "Checkout" ], "operationId": "checkout_create_order", "summary": "Create order from cart", "description": "Creates an order from the current cart, stores shipping and billing details, clears the cart, and sends a confirmation email with a secure status link. Billing details are not returned in the response.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "reference": { "type": "string" }, "email": { "type": "string" } }, "required": [ "reference", "email" ] }, "meta": { "type": "object", "properties": { "email_sent": { "type": "boolean" } }, "required": [ "email_sent" ] } }, "required": [ "status", "message", "data", "meta" ] }, "example": { "status": "ok", "message": "Order placed. Check your email for the confirmation link.", "data": { "reference": "NSO-20260417-A1B2C3", "email": "customer@example.test" }, "meta": { "email_sent": true } } } } } }, "x-group-id": "checkout", "x-endpoint-id": "checkout-create-order", "x-example-values": { "email": "customer@example.test", "phone": "555-0100", "shipping_full_name": "Alex Customer", "shipping_address1": "120 Market Street", "shipping_address2": "Suite 3", "shipping_city": "Tulsa", "shipping_state": "OK", "shipping_postal_code": "74103", "shipping_country": "US", "billing_same_as_shipping": "1" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email used for the confirmation link." }, "phone": { "type": "string", "description": "Customer phone number." }, "shipping_full_name": { "type": "string", "description": "Recipient name for shipping." }, "shipping_address1": { "type": "string", "description": "Shipping street address." }, "shipping_address2": { "type": "string", "description": "Shipping address line 2." }, "shipping_city": { "type": "string", "description": "Shipping city." }, "shipping_state": { "type": "string", "description": "Shipping two-letter state or territory code selected from checkout metadata." }, "shipping_postal_code": { "type": "string", "description": "Shipping 5-digit ZIP code." }, "shipping_country": { "type": "string", "description": "Shipping country code selected from checkout metadata." }, "billing_same_as_shipping": { "type": "boolean", "description": "Use 1, true, yes, or on to reuse the shipping address." }, "billing_full_name": { "type": "string", "description": "Billing name when different from shipping." }, "billing_address1": { "type": "string", "description": "Billing street address." }, "billing_address2": { "type": "string", "description": "Billing address line 2." }, "billing_city": { "type": "string", "description": "Billing city." }, "billing_state": { "type": "string", "description": "Billing two-letter state or territory code selected from checkout metadata." }, "billing_postal_code": { "type": "string", "description": "Billing 5-digit ZIP code." }, "billing_country": { "type": "string", "description": "Billing country code selected from checkout metadata." } }, "required": [ "email", "shipping_full_name", "shipping_address1", "shipping_city", "shipping_state", "shipping_postal_code", "shipping_country" ] }, "example": { "email": "customer@example.test", "phone": "555-0100", "shipping_full_name": "Alex Customer", "shipping_address1": "120 Market Street", "shipping_address2": "Suite 3", "shipping_city": "Tulsa", "shipping_state": "OK", "shipping_postal_code": "74103", "shipping_country": "US", "billing_same_as_shipping": "1", "billing_full_name": "", "billing_address1": "", "billing_address2": "", "billing_city": "", "billing_state": "", "billing_postal_code": "", "billing_country": "" } } } } } }, "/checkout/orders/{token}": { "get": { "tags": [ "Checkout" ], "operationId": "checkout_order_status", "summary": "Order status by secure token", "description": "Returns the customer-facing order confirmation payload for a valid confirmation token. Billing details are intentionally omitted, and the token is designed to be unguessable.", "parameters": [ { "name": "token", "in": "path", "required": true, "description": "The secure confirmation token delivered by email.", "schema": { "type": "string" }, "example": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string" }, "placed_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "phone" ] }, "shipping_address": { "type": "object", "properties": { "full_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "full_name", "address1", "address2", "city", "state", "postal_code", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } }, "pricing": { "type": "object", "properties": { "subtotal": { "type": "number", "format": "float" }, "currency": { "type": "string" } }, "required": [ "subtotal", "currency" ] }, "payment": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "email_delivery": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ] } }, "required": [ "reference", "status", "placed_at", "customer", "shipping_address", "items", "pricing", "payment", "email_delivery" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "reference": "NSO-20260417-A1B2C3", "status": "received", "placed_at": "2026-04-17T11:33:56+00:00", "customer": { "email": "customer@example.test", "phone": "555-0100" }, "shipping_address": { "full_name": "Alex Customer", "address1": "120 Market Street", "address2": "Suite 3", "city": "Tulsa", "state": "OK", "postal_code": "74103", "country": "United States" }, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ], "pricing": { "subtotal": 89, "currency": "USD" }, "payment": { "status": "awaiting_processor" }, "email_delivery": { "sent": true } } } } } } }, "x-group-id": "checkout", "x-endpoint-id": "checkout-order-status", "x-example-values": { "token": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1" } } }, "/admin/session/invalidate": { "get": { "tags": [ "Auth" ], "operationId": "admin_session_invalidate", "summary": "Invalidate current admin session", "description": "Explicitly clears the current admin session token. Intended for XMLHttpRequest-based security invalidation flows.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "authenticated": { "type": "boolean" }, "user": { "nullable": true } }, "required": [ "authenticated", "user" ] }, "meta": { "type": "object", "properties": { "clear_auth_token": { "type": "boolean" } }, "required": [ "clear_auth_token" ] } }, "required": [ "status", "message", "data", "meta" ] }, "example": { "status": "ok", "message": "Admin session invalidated.", "data": { "authenticated": false, "user": null }, "meta": { "clear_auth_token": true } } } } } }, "x-group-id": "auth", "x-endpoint-id": "admin-session-invalidate", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/session": { "get": { "tags": [ "Auth" ], "operationId": "admin_session", "summary": "Current admin session", "description": "Returns whether the current request has an authenticated admin token and, if so, the signed-in user record.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "authenticated": { "type": "boolean" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "authenticated", "user" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "authenticated": true, "user": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } } }, "x-group-id": "auth", "x-endpoint-id": "admin-session", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/login": { "post": { "tags": [ "Auth" ], "operationId": "admin_login", "summary": "Admin sign in", "description": "Starts an admin login and returns an auth token that can be sent in the X-Newsite-Admin-Token header for protected admin endpoints.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "authenticated": { "type": "boolean" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "authenticated", "user" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Welcome back.", "data": { "authenticated": true, "user": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } } }, "x-group-id": "auth", "x-endpoint-id": "admin-login", "x-example-values": { "email": "admin@northstar.local", "password": "Admin123!" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "Admin email address." }, "password": { "type": "string", "description": "Admin password." } }, "required": [ "email", "password" ] }, "example": { "email": "admin@northstar.local", "password": "Admin123!" } } } } } }, "/admin/logout": { "post": { "tags": [ "Auth" ], "operationId": "admin_logout", "summary": "Admin sign out", "description": "Clears the current admin session.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "authenticated": { "type": "boolean" }, "user": { "nullable": true } }, "required": [ "authenticated", "user" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "You have been signed out.", "data": { "authenticated": false, "user": null } } } } } }, "x-group-id": "auth", "x-endpoint-id": "admin-logout", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/summary": { "get": { "tags": [ "Admin" ], "operationId": "admin_summary", "summary": "Admin dashboard summary", "description": "Returns high-level counts for products, categories, users, and featured products. Requires an authenticated admin token.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "counts": { "type": "object", "properties": { "orders": { "type": "integer" }, "pending_shipments": { "type": "integer" }, "products": { "type": "integer" }, "categories": { "type": "integer" }, "users": { "type": "integer" }, "featured_products": { "type": "integer" }, "unread_chats": { "type": "integer" } }, "required": [ "orders", "pending_shipments", "products", "categories", "users", "featured_products", "unread_chats" ] }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "counts", "user" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "counts": { "orders": 1, "pending_shipments": 1, "products": 53, "categories": 6, "users": 2, "featured_products": 11, "unread_chats": 0 }, "user": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-summary", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/orders": { "get": { "tags": [ "Admin" ], "operationId": "admin_orders_list", "summary": "List orders", "description": "Returns the admin order queue, with optional search and shipping-status filters, plus valid order and shipping status options.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Order search query, typically by reference, customer email, or shipping fields.", "schema": { "type": "string" }, "example": "NSO-20260417-A1B2C3" }, { "name": "shipping_status", "in": "query", "required": false, "description": "Optional shipping status filter such as pending, processing, shipped, delivered, or cancelled.", "schema": { "type": "string" }, "example": "pending" }, { "name": "page", "in": "query", "required": false, "description": "One-based page number.", "schema": { "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "required": false, "description": "Requested page size.", "schema": { "type": "integer" }, "example": 20 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string" }, "placed_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "phone" ] }, "shipping_address": { "type": "object", "properties": { "full_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "full_name", "address1", "address2", "city", "state", "postal_code", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } }, "pricing": { "type": "object", "properties": { "subtotal": { "type": "number", "format": "float" }, "currency": { "type": "string" } }, "required": [ "subtotal", "currency" ] }, "payment": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "email_delivery": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ] } }, "required": [ "reference", "status", "placed_at", "customer", "shipping_address", "items", "pricing", "payment", "email_delivery" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "order_status_options": { "type": "array", "items": { "type": "string" } }, "shipping_status_options": { "type": "array", "items": { "type": "string" } } }, "required": [ "count", "page", "per_page", "total_pages", "order_status_options", "shipping_status_options" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": [ { "reference": "NSO-20260417-A1B2C3", "status": "received", "placed_at": "2026-04-17T11:33:56+00:00", "customer": { "email": "customer@example.test", "phone": "555-0100" }, "shipping_address": { "full_name": "Alex Customer", "address1": "120 Market Street", "address2": "Suite 3", "city": "Tulsa", "state": "OK", "postal_code": "74103", "country": "United States" }, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ], "pricing": { "subtotal": 89, "currency": "USD" }, "payment": { "status": "awaiting_processor" }, "email_delivery": { "sent": true } } ], "meta": { "count": 1, "page": 1, "per_page": 20, "total_pages": 1, "order_status_options": [ "received", "processing", "completed", "cancelled" ], "shipping_status_options": [ "pending", "processing", "shipped", "delivered", "cancelled" ] } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-orders-list", "x-example-values": { "q": "NSO-20260417-A1B2C3", "shipping_status": "pending", "page": 1, "per_page": 20 }, "security": [ { "AdminToken": [] } ] } }, "/admin/orders/{reference}": { "get": { "tags": [ "Admin" ], "operationId": "admin_order_detail", "summary": "Order detail", "description": "Returns one order by reference, including editable shipping and payment fields plus valid status option lists.", "parameters": [ { "name": "reference", "in": "path", "required": true, "description": "Order reference such as NSO-20260320-A1B2C3.", "schema": { "type": "string" }, "example": "NSO-20260417-A1B2C3" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string" }, "placed_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "phone" ] }, "shipping_address": { "type": "object", "properties": { "full_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "full_name", "address1", "address2", "city", "state", "postal_code", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } }, "pricing": { "type": "object", "properties": { "subtotal": { "type": "number", "format": "float" }, "currency": { "type": "string" } }, "required": [ "subtotal", "currency" ] }, "payment": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "email_delivery": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ] } }, "required": [ "reference", "status", "placed_at", "customer", "shipping_address", "items", "pricing", "payment", "email_delivery" ] }, "meta": { "type": "object", "properties": { "order_status_options": { "type": "array", "items": { "type": "string" } }, "shipping_status_options": { "type": "array", "items": { "type": "string" } } }, "required": [ "order_status_options", "shipping_status_options" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": { "reference": "NSO-20260417-A1B2C3", "status": "received", "placed_at": "2026-04-17T11:33:56+00:00", "customer": { "email": "customer@example.test", "phone": "555-0100" }, "shipping_address": { "full_name": "Alex Customer", "address1": "120 Market Street", "address2": "Suite 3", "city": "Tulsa", "state": "OK", "postal_code": "74103", "country": "United States" }, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ], "pricing": { "subtotal": 89, "currency": "USD" }, "payment": { "status": "awaiting_processor" }, "email_delivery": { "sent": true } }, "meta": { "order_status_options": [ "received", "processing", "completed", "cancelled" ], "shipping_status_options": [ "pending", "processing", "shipped", "delivered", "cancelled" ] } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-order-detail", "x-example-values": { "reference": "NSO-20260417-A1B2C3" }, "security": [ { "AdminToken": [] } ] } }, "/admin/orders/{reference}/update": { "post": { "tags": [ "Admin" ], "operationId": "admin_order_update", "summary": "Update order", "description": "Updates order, shipping, payment, and item details. Status changes can trigger archived or delivered customer notifications depending on environment mail support.", "parameters": [ { "name": "reference", "in": "path", "required": true, "description": "Existing order reference.", "schema": { "type": "string" }, "example": "NSO-20260417-A1B2C3" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string" }, "placed_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "phone" ] }, "shipping_address": { "type": "object", "properties": { "full_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "full_name", "address1", "address2", "city", "state", "postal_code", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } }, "pricing": { "type": "object", "properties": { "subtotal": { "type": "number", "format": "float" }, "currency": { "type": "string" } }, "required": [ "subtotal", "currency" ] }, "payment": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "email_delivery": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ] } }, "required": [ "reference", "status", "placed_at", "customer", "shipping_address", "items", "pricing", "payment", "email_delivery" ] }, "meta": { "type": "object", "properties": { "status_changes": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "label": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "field", "label", "from", "to" ] } }, "status_email_sent": { "type": "boolean" } }, "required": [ "status_changes", "status_email_sent" ] } }, "required": [ "status", "message", "data", "meta" ] }, "example": { "status": "ok", "message": "Order updated and customer notified.", "data": { "reference": "NSO-20260417-A1B2C3", "status": "received", "placed_at": "2026-04-17T11:33:56+00:00", "customer": { "email": "customer@example.test", "phone": "555-0100" }, "shipping_address": { "full_name": "Alex Customer", "address1": "120 Market Street", "address2": "Suite 3", "city": "Tulsa", "state": "OK", "postal_code": "74103", "country": "United States" }, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ], "pricing": { "subtotal": 89, "currency": "USD" }, "payment": { "status": "awaiting_processor" }, "email_delivery": { "sent": true } }, "meta": { "status_changes": [ { "field": "shipping_status", "label": "Shipping status", "from": "pending", "to": "shipped" } ], "status_email_sent": true } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-order-update", "x-example-values": { "reference": "NSO-20260417-A1B2C3", "status": "processing", "shipping_status": "shipped", "shipping_carrier": "UPS", "shipping_tracking_number": "1Z999AA10123456784", "shipping_tracking_url": "https://example.test/tracking/1Z999AA10123456784", "admin_notes": "Packed and handed to carrier." }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Order status: received, processing, completed, or cancelled." }, "shipping_status": { "type": "string", "description": "Shipping status: pending, processing, shipped, delivered, or cancelled." }, "shipping_carrier": { "type": "string", "description": "Shipping carrier label." }, "shipping_tracking_number": { "type": "string", "description": "Carrier tracking number." }, "shipping_tracking_url": { "type": "string", "description": "Tracking URL shown in customer messaging." }, "admin_notes": { "type": "string", "description": "Internal admin notes stored on the order." } } }, "example": { "status": "processing", "shipping_status": "shipped", "shipping_carrier": "UPS", "shipping_tracking_number": "1Z999AA10123456784", "shipping_tracking_url": "https://example.test/tracking/1Z999AA10123456784", "admin_notes": "Packed and handed to carrier." } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/orders/{reference}/email": { "post": { "tags": [ "Admin" ], "operationId": "admin_order_email", "summary": "Email order customer", "description": "Sends or archives a manual admin message to the order customer and stores delivery metadata with the order.", "parameters": [ { "name": "reference", "in": "path", "required": true, "description": "Existing order reference.", "schema": { "type": "string" }, "example": "NSO-20260417-A1B2C3" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "reference": { "type": "string" }, "status": { "type": "string" }, "placed_at": { "type": "string" }, "customer": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "phone" ] }, "shipping_address": { "type": "object", "properties": { "full_name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" } }, "required": [ "full_name", "address1", "address2", "city", "state", "postal_code", "country" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "summary": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "quantity": { "type": "integer" }, "line_total": { "type": "number", "format": "float" } }, "required": [ "sku", "slug", "name", "category", "category_slug", "summary", "price", "inventory", "quantity", "line_total" ] } }, "pricing": { "type": "object", "properties": { "subtotal": { "type": "number", "format": "float" }, "currency": { "type": "string" } }, "required": [ "subtotal", "currency" ] }, "payment": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "email_delivery": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ] } }, "required": [ "reference", "status", "placed_at", "customer", "shipping_address", "items", "pricing", "payment", "email_delivery" ] }, "meta": { "type": "object", "properties": { "email_sent": { "type": "boolean" } }, "required": [ "email_sent" ] } }, "required": [ "status", "message", "data", "meta" ] }, "example": { "status": "ok", "message": "Customer email sent.", "data": { "reference": "NSO-20260417-A1B2C3", "status": "received", "placed_at": "2026-04-17T11:33:56+00:00", "customer": { "email": "customer@example.test", "phone": "555-0100" }, "shipping_address": { "full_name": "Alex Customer", "address1": "120 Market Street", "address2": "Suite 3", "city": "Tulsa", "state": "OK", "postal_code": "74103", "country": "United States" }, "items": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "price": 89, "inventory": 24, "quantity": 1, "line_total": 89 } ], "pricing": { "subtotal": 89, "currency": "USD" }, "payment": { "status": "awaiting_processor" }, "email_delivery": { "sent": true } }, "meta": { "email_sent": true } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-order-email", "x-example-values": { "reference": "NSO-20260417-A1B2C3", "message": "Your order has been packed and will leave the warehouse this afternoon." }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Optional manual note included with the order update email." } } }, "example": { "message": "Your order has been packed and will leave the warehouse this afternoon." } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/products": { "get": { "tags": [ "Admin" ], "operationId": "admin_products_list", "summary": "List admin products", "description": "Returns a paginated product list for back-office management. Requires an authenticated admin token.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Optional product search query.", "schema": { "type": "string" }, "example": "Field Pack Utility Kit" }, { "name": "sort", "in": "query", "required": false, "description": "Sort order such as name-asc, name-desc, price-asc, price-desc, or featured.", "schema": { "type": "string" }, "example": "name-asc" }, { "name": "page", "in": "query", "required": false, "description": "One-based page number.", "schema": { "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "required": false, "description": "Requested page size, capped by the repository.", "schema": { "type": "integer" }, "example": 2 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Capacity": { "type": "string" }, "Weight": { "type": "string" } }, "required": [ "Material", "Capacity", "Weight" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total_pages": { "type": "integer" }, "sort": { "type": "string" } }, "required": [ "count", "page", "per_page", "total_pages", "sort" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": [ { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } }, { "sku": "NS-1002", "slug": "ledger-desk-stand", "name": "Ledger Desk Stand", "category": "Workspace", "category_slug": "workspace", "category_summary": "Desk-bound tools designed to make counters, checkout stations, and shared work surfaces feel more deliberate.", "summary": "Angled oak stand for tablets, notebooks, and point-of-sale devices in small retail counters.", "description": "The Ledger Desk Stand lifts tablets and notebooks into a cleaner working angle, helping compact counters feel more intentional while reducing clutter around the register or intake desk.", "price": 54.5, "inventory": 41, "featured": true, "features": [ "Solid oak face with cork-lined device rest", "Stable base sized for point-of-sale tablets and notebooks", "Cable pass-through channel under the rear edge" ], "specs": { "Footprint": "9.5 in x 7 in", "Angle": "18 degrees", "Finish": "Natural oil-sealed oak" }, "base_price": 54.5, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23164e63%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%2338bdf8%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EWorkspace%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ELedger%20Desk%20Stand%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1002%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Ledger Desk Stand placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23164e63%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%231f2937%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%2338bdf8%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3EWorkspace%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3ELedger%20Desk%20Stand%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1002%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Ledger Desk Stand placeholder artwork" } } ], "meta": { "count": 53, "page": 1, "per_page": 2, "total_pages": 27, "sort": "name-asc" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-products-list", "x-example-values": { "q": "Field Pack Utility Kit", "sort": "name-asc", "page": 1, "per_page": 2 }, "security": [ { "AdminToken": [] } ] }, "post": { "tags": [ "Admin" ], "operationId": "admin_product_create", "summary": "Create product", "description": "Creates a new product record. Tags accept comma-separated values. Features, specs, and media accept pipe-separated values in the docs UI.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Capacity": { "type": "string" }, "Weight": { "type": "string" } }, "required": [ "Material", "Capacity", "Weight" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Product created.", "data": { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-product-create", "x-example-values": { "sku": "NS-9000", "slug": "ops-travel-bundle", "name": "Ops Travel Bundle", "category_slug": "apparel", "summary": "A bundled kit for field teams.", "description": "A bundled kit for field teams that need a fast start.", "price": "129.00", "discount_percent": "10", "discount_label": "Spring sale", "inventory": "24", "featured": "1", "tags": "bundle, field, travel", "features": "Padded case|Organizer insert", "specs": "Weight: 2 lb|Material: Ripstop nylon", "media": "https://placehold.co/1200x900?text=Ops+Travel+Bundle" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "sku": { "type": "string", "description": "Unique product SKU." }, "slug": { "type": "string", "description": "Optional product slug." }, "name": { "type": "string", "description": "Product name." }, "category_slug": { "type": "string", "description": "Managed category slug from the admin category list." }, "summary": { "type": "string", "description": "Short product summary." }, "description": { "type": "string", "description": "Longer product description." }, "price": { "type": "number", "format": "float", "description": "Base product price before discount." }, "discount_percent": { "type": "number", "format": "float", "description": "Discount percentage from 0 to 100." }, "discount_label": { "type": "string", "description": "Optional sale label." }, "inventory": { "type": "integer", "description": "Inventory count." }, "featured": { "type": "boolean", "description": "Use 1, true, yes, or on to feature the product." }, "tags": { "type": "string", "description": "Comma-separated tags." }, "features": { "type": "string", "description": "Pipe-separated feature list." }, "specs": { "type": "string", "description": "Pipe-separated key:value specs." }, "media": { "type": "string", "description": "Pipe-separated media URLs." } }, "required": [ "sku", "name", "category_slug", "price" ] }, "example": { "sku": "NS-9000", "slug": "ops-travel-bundle", "name": "Ops Travel Bundle", "category_slug": "apparel", "summary": "A bundled kit for field teams.", "description": "A bundled kit for field teams that need a fast start.", "price": "129.00", "discount_percent": "10", "discount_label": "Spring sale", "inventory": "24", "featured": "1", "tags": "bundle, field, travel", "features": "Padded case|Organizer insert", "specs": "Weight: 2 lb|Material: Ripstop nylon", "media": "https://placehold.co/1200x900?text=Ops+Travel+Bundle" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/products/{sku}": { "get": { "tags": [ "Admin" ], "operationId": "admin_product_detail", "summary": "Admin product detail", "description": "Returns one product by SKU for editing and inventory management.", "parameters": [ { "name": "sku", "in": "path", "required": true, "description": "The unique product SKU.", "schema": { "type": "string" }, "example": "NS-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Capacity": { "type": "string" }, "Weight": { "type": "string" } }, "required": [ "Material", "Capacity", "Weight" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-product-detail", "x-example-values": { "sku": "NS-1001" }, "security": [ { "AdminToken": [] } ] } }, "/admin/products/{sku}/update": { "post": { "tags": [ "Admin" ], "operationId": "admin_product_update", "summary": "Update product", "description": "Updates an existing product by SKU.", "parameters": [ { "name": "sku", "in": "path", "required": true, "description": "Existing product SKU.", "schema": { "type": "string" }, "example": "NS-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "sku": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "category_slug": { "type": "string" }, "category_summary": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "float" }, "inventory": { "type": "integer" }, "featured": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "specs": { "type": "object", "properties": { "Material": { "type": "string" }, "Capacity": { "type": "string" }, "Weight": { "type": "string" } }, "required": [ "Material", "Capacity", "Weight" ] }, "base_price": { "type": "number", "format": "float" }, "discount_percent": { "type": "number", "format": "float" }, "discount_label": { "type": "string" }, "has_discount": { "type": "boolean" }, "savings_amount": { "type": "number", "format": "float" }, "tags": { "type": "array", "items": [] }, "media": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "primary_image": { "type": "object", "properties": { "type": { "type": "string" }, "src": { "type": "string" }, "alt": { "type": "string" } }, "required": [ "type", "src", "alt" ] } }, "required": [ "sku", "slug", "name", "category", "category_slug", "category_summary", "summary", "description", "price", "inventory", "featured", "features", "specs", "base_price", "discount_percent", "discount_label", "has_discount", "savings_amount", "tags", "media", "primary_image" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Product updated.", "data": { "sku": "NS-1001", "slug": "field-pack-utility-kit", "name": "Field Pack Utility Kit", "category": "Travel Gear", "category_slug": "travel-gear", "category_summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "summary": "A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.", "description": "The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.", "price": 89, "inventory": 24, "featured": true, "features": [ "Weather-resistant shell with reinforced base panel", "Interior divider system sized for forms, cables, and accessories", "Quick-access side pocket for phone and badge carry" ], "specs": { "Material": "Waxed ripstop and ballistic nylon trim", "Capacity": "18 liters", "Weight": "2.1 lb" }, "base_price": 89, "discount_percent": 0, "discount_label": "", "has_discount": false, "savings_amount": 0, "tags": [], "media": [ { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } ], "primary_image": { "type": "image", "src": "data:image/svg+xml;charset=UTF-8,%3Csvg%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%20viewBox%3D%270%200%201200%20900%27%3E%3Cdefs%3E%3ClinearGradient%20id%3D%27bg%27%20x1%3D%270%25%27%20y1%3D%270%25%27%20x2%3D%27100%25%27%20y2%3D%27100%25%27%3E%3Cstop%20offset%3D%270%25%27%20stop-color%3D%27%23115e59%27%2F%3E%3Cstop%20offset%3D%27100%25%27%20stop-color%3D%27%230f172a%27%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%271200%27%20height%3D%27900%27%20fill%3D%27url%28%23bg%29%27%2F%3E%3Ccircle%20cx%3D%27980%27%20cy%3D%27140%27%20r%3D%27180%27%20fill%3D%27%23f59e0b%27%20fill-opacity%3D%270.22%27%2F%3E%3Ccircle%20cx%3D%27220%27%20cy%3D%27760%27%20r%3D%27220%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.08%27%2F%3E%3Crect%20x%3D%2764%27%20y%3D%2764%27%20width%3D%271072%27%20height%3D%27772%27%20rx%3D%2736%27%20fill%3D%27%23ffffff%27%20fill-opacity%3D%270.10%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.22%27%2F%3E%3Ctext%20x%3D%27104%27%20y%3D%27152%27%20fill%3D%27%23f8fafc%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2734%27%20letter-spacing%3D%278%27%3ETravel%20Gear%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27430%27%20fill%3D%27%23ffffff%27%20font-family%3D%27Georgia%2C%20Times%20New%20Roman%2C%20serif%27%20font-size%3D%2774%27%20font-weight%3D%27700%27%3EField%20Pack%20Utility%20Kit%3C%2Ftext%3E%3Ctext%20x%3D%27104%27%20y%3D%27506%27%20fill%3D%27%23e2e8f0%27%20font-family%3D%27Arial%2C%20Helvetica%2C%20sans-serif%27%20font-size%3D%2728%27%3ENS-1001%3C%2Ftext%3E%3Cpath%20d%3D%27M104%20592%20C244%20548%20364%20548%20500%20592%20C642%20638%20764%20638%20912%20592%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.35%27%20stroke-width%3D%2710%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3Cpath%20d%3D%27M104%20664%20C212%20622%20332%20622%20446%20664%20C570%20710%20708%20710%20850%20664%27%20stroke%3D%27%23ffffff%27%20stroke-opacity%3D%270.18%27%20stroke-width%3D%276%27%20fill%3D%27none%27%20stroke-linecap%3D%27round%27%2F%3E%3C%2Fsvg%3E", "alt": "Field Pack Utility Kit placeholder artwork" } } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-product-update", "x-example-values": { "sku": "NS-1001", "name": "Field Pack Utility Kit", "price": "89.00", "discount_percent": "0", "inventory": "24", "featured": "1" }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Updated product name." }, "price": { "type": "number", "format": "float", "description": "Updated base price." }, "discount_percent": { "type": "number", "format": "float", "description": "Updated discount percentage." }, "inventory": { "type": "integer", "description": "Updated inventory count." }, "featured": { "type": "boolean", "description": "Use 1, true, yes, or on to feature the product." } } }, "example": { "name": "Field Pack Utility Kit", "price": "89.00", "discount_percent": "0", "inventory": "24", "featured": "1" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/products/{sku}/delete": { "post": { "tags": [ "Admin" ], "operationId": "admin_product_delete", "summary": "Delete product", "description": "Removes a product by SKU.", "parameters": [ { "name": "sku", "in": "path", "required": true, "description": "Existing product SKU.", "schema": { "type": "string" }, "example": "NS-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "required": [ "status", "message" ] }, "example": { "status": "ok", "message": "Product removed." } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-product-delete", "x-example-values": { "sku": "NS-1001" }, "security": [ { "AdminToken": [] } ] } }, "/admin/products/export/csv": { "get": { "tags": [ "Admin" ], "operationId": "admin_products_export_csv", "summary": "Export product catalog CSV", "description": "Exports the full product catalog as CSV using the same headers accepted by the import endpoint. Requires an authenticated admin token.", "responses": { "200": { "description": "Successful response", "content": { "text/csv": { "schema": { "type": "string" }, "example": "sku,slug,name,category_slug,category,summary,description,price,discount_percent,discount_label,inventory,featured,tags,features,specs,media\nNS-1001,field-pack-utility-kit,\"Field Pack Utility Kit\",travel-gear,\"Travel Gear\",\"A modular carry kit with cable sleeves, document pockets, and weather-resistant outer fabric.\",\"The Field Pack Utility Kit is a modular carry system built for fast-moving teams. It keeps chargers, documents, samples, and personal gear organized without becoming bulky during travel days.\",89,0,,24,1,,\"Weather-resistant shell with reinforced base panel|Interior divider system sized for forms, cables, and accessories|Quick-access side pocket for phone and badge carry\",,\n" } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-products-export-csv", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/products/import/csv": { "post": { "tags": [ "Admin" ], "operationId": "admin_products_import_csv", "summary": "Import product catalog CSV", "description": "Validates and replaces the product catalog from an uploaded CSV file. Existing order references are preserved and invalid references are rejected. Requires an authenticated admin token.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "imported": { "type": "integer" }, "csv_headers": { "type": "array", "items": { "type": "string" } } }, "required": [ "imported", "csv_headers" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Products imported.", "data": { "imported": 53, "csv_headers": [ "sku", "slug", "name", "category_slug", "category", "summary", "description", "price", "discount_percent", "discount_label", "inventory", "featured", "tags", "features", "specs", "media" ] } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-products-import-csv", "x-example-values": { "products_csv": "products.csv" }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "products_csv": { "type": "string", "format": "binary", "description": "CSV file containing the product catalog export format." } }, "required": [ "products_csv" ] }, "example": { "products_csv": "products.csv" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/categories": { "get": { "tags": [ "Admin" ], "operationId": "admin_categories_list", "summary": "List admin categories", "description": "Returns the managed category list used by catalog navigation and product forms.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" } }, "required": [ "count" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": [ { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 }, { "slug": "hydration", "name": "Hydration", "summary": "Everyday hydration gear for long routes, site visits, and all-day travel between meetings.", "product_count": 9 }, { "slug": "retail-display", "name": "Retail Display", "summary": "Display-support tools for cleaner demos, organized counters, and better small-format merchandising.", "product_count": 8 }, { "slug": "stationery", "name": "Stationery", "summary": "Paper goods made for field notes, planning, and structured follow-up after customer conversations.", "product_count": 9 }, { "slug": "travel-gear", "name": "Travel Gear", "summary": "Durable carrying systems and travel-ready goods for teams that work between desks, vehicles, and customer sites.", "product_count": 9 }, { "slug": "workspace", "name": "Workspace", "summary": "Desk-bound tools designed to make counters, checkout stations, and shared work surfaces feel more deliberate.", "product_count": 9 } ], "meta": { "count": 6 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-categories-list", "x-example-values": [], "security": [ { "AdminToken": [] } ] }, "post": { "tags": [ "Admin" ], "operationId": "admin_category_create", "summary": "Create category", "description": "Creates a managed category for storefront navigation and product assignment.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Category created.", "data": { "slug": "seasonal-kits", "name": "Seasonal Kits", "summary": "Short-run bundles and seasonal promotional packages.", "product_count": 0 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-category-create", "x-example-values": { "name": "Seasonal Kits", "slug": "seasonal-kits", "summary": "Short-run bundles and seasonal promotional packages." }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Category display name." }, "slug": { "type": "string", "description": "Optional category slug." }, "summary": { "type": "string", "description": "Category summary copy." } }, "required": [ "name" ] }, "example": { "name": "Seasonal Kits", "slug": "seasonal-kits", "summary": "Short-run bundles and seasonal promotional packages." } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/categories/{slug}": { "get": { "tags": [ "Admin" ], "operationId": "admin_category_detail", "summary": "Admin category detail", "description": "Returns one managed category including its current product count.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Existing category slug.", "schema": { "type": "string" }, "example": "apparel" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-category-detail", "x-example-values": { "slug": "apparel" }, "security": [ { "AdminToken": [] } ] } }, "/admin/categories/{slug}/update": { "post": { "tags": [ "Admin" ], "operationId": "admin_category_update", "summary": "Update category", "description": "Updates a managed category and syncs assigned products to the latest name, slug, and summary.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Existing category slug.", "schema": { "type": "string" }, "example": "apparel" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "product_count": { "type": "integer" } }, "required": [ "slug", "name", "summary", "product_count" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Category updated.", "data": { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos.", "product_count": 9 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-category-update", "x-example-values": { "slug": "apparel", "name": "Apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos." }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Updated category name." }, "slug": { "type": "string", "description": "Updated category slug." }, "summary": { "type": "string", "description": "Updated category summary." } } }, "example": { "name": "Apparel", "slug": "apparel", "summary": "Hard-wearing soft goods for retail floors, pop-up activations, and customer-facing demos." } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/categories/{slug}/delete": { "post": { "tags": [ "Admin" ], "operationId": "admin_category_delete", "summary": "Delete category", "description": "Deletes an unused managed category. Categories with assigned products are rejected until those products are reassigned.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Existing category slug.", "schema": { "type": "string" }, "example": "seasonal-kits" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "required": [ "status", "message" ] }, "example": { "status": "ok", "message": "Category removed." } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-category-delete", "x-example-values": { "slug": "seasonal-kits" }, "security": [ { "AdminToken": [] } ] } }, "/admin/users": { "get": { "tags": [ "Admin" ], "operationId": "admin_users_list", "summary": "List admin users", "description": "Returns the user records available to the admin area.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "meta": { "type": "object", "properties": { "count": { "type": "integer" } }, "required": [ "count" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": [ { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" }, { "id": "usr-69b176eb8d59a", "name": "Jake", "email": "jake.pogorelec@ntalife.com", "role": "admin", "created_at": "2026-03-11T14:06:35+00:00", "updated_at": "2026-03-11T14:06:35+00:00" } ], "meta": { "count": 2 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-users-list", "x-example-values": [], "security": [ { "AdminToken": [] } ] }, "post": { "tags": [ "Admin" ], "operationId": "admin_user_create", "summary": "Create admin user", "description": "Creates a new admin-area user.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "User created.", "data": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-user-create", "x-example-values": { "name": "Operations Admin", "email": "ops-admin@northstar.local", "role": "admin", "password": "Admin123!" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name." }, "email": { "type": "string", "description": "Email address." }, "role": { "type": "string", "description": "Role label, defaults to admin." }, "password": { "type": "string", "description": "Password with at least 8 characters." } }, "required": [ "name", "email", "password" ] }, "example": { "name": "Operations Admin", "email": "ops-admin@northstar.local", "role": "admin", "password": "Admin123!" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/users/{id}": { "get": { "tags": [ "Admin" ], "operationId": "admin_user_detail", "summary": "Admin user detail", "description": "Returns one admin user record by id.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "User id.", "schema": { "type": "string" }, "example": "usr-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-user-detail", "x-example-values": { "id": "usr-1001" }, "security": [ { "AdminToken": [] } ] } }, "/admin/users/{id}/update": { "post": { "tags": [ "Admin" ], "operationId": "admin_user_update", "summary": "Update admin user", "description": "Updates an existing user and optionally resets the password if a new password is provided.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Existing user id.", "schema": { "type": "string" }, "example": "usr-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "User updated.", "data": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-user-update", "x-example-values": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "password": "" }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Updated display name." }, "email": { "type": "string", "description": "Updated email address." }, "role": { "type": "string", "description": "Updated role label." }, "password": { "type": "string", "description": "Optional password reset." } } }, "example": { "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "password": "" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/users/{id}/delete": { "post": { "tags": [ "Admin" ], "operationId": "admin_user_delete", "summary": "Delete admin user", "description": "Deletes an admin-area user. The currently signed-in account cannot delete itself.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Existing user id.", "schema": { "type": "string" }, "example": "usr-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "required": [ "status", "message" ] }, "example": { "status": "ok", "message": "User removed." } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-user-delete", "x-example-values": { "id": "usr-1001" }, "security": [ { "AdminToken": [] } ] } }, "/admin/profile": { "get": { "tags": [ "Admin" ], "operationId": "admin_profile", "summary": "Current admin profile", "description": "Returns the currently authenticated admin user record.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "status", "data" ] }, "example": { "status": "ok", "data": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-profile", "x-example-values": [], "security": [ { "AdminToken": [] } ] }, "post": { "tags": [ "Admin" ], "operationId": "admin_profile_update", "summary": "Update current admin profile", "description": "Updates the current signed-in admin profile without changing role.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "email", "role", "created_at", "updated_at" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Profile updated.", "data": { "id": "usr-1001", "name": "Administrator", "email": "admin@northstar.local", "role": "admin", "created_at": "2026-03-11T14:00:05+00:00", "updated_at": "2026-03-11T22:17:57+00:00" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-profile-update", "x-example-values": { "name": "Administrator", "email": "admin@northstar.local" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Updated display name." }, "email": { "type": "string", "description": "Updated email address." } }, "required": [ "name", "email" ] }, "example": { "name": "Administrator", "email": "admin@northstar.local" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/profile/chat": { "post": { "tags": [ "Admin" ], "operationId": "admin_profile_chat_update", "summary": "Update chat availability", "description": "Enables or disables storefront chat by updating app configuration.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "chat_enabled": { "type": "boolean" } }, "required": [ "chat_enabled" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Chat enabled.", "data": { "chat_enabled": true } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-profile-chat-update", "x-example-values": { "chat_enabled": "1" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "chat_enabled": { "type": "boolean", "description": "Use 1, true, yes, or on to enable storefront chat." } }, "required": [ "chat_enabled" ] }, "example": { "chat_enabled": "1" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/profile/logo": { "post": { "tags": [ "Admin" ], "operationId": "admin_profile_logo_upload", "summary": "Upload company logo", "description": "Uploads a new company logo asset and updates the storefront branding configuration to point at the stored file.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "company_logo_url": { "type": "string" } }, "required": [ "company_logo_url" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Logo uploaded.", "data": { "company_logo_url": "https://ItsPawned.com/assets/images/company-logo.png" } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-profile-logo-upload", "x-example-values": { "logo_file": "company-logo.png" }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "logo_file": { "type": "string", "format": "binary", "description": "Image file to use as the storefront company logo." } }, "required": [ "logo_file" ] }, "example": { "logo_file": "company-logo.png" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/profile/password": { "post": { "tags": [ "Admin" ], "operationId": "admin_password_update", "summary": "Change current admin password", "description": "Updates the current signed-in admin password after validating the existing password.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "required": [ "status", "message" ] }, "example": { "status": "ok", "message": "Password updated." } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-password-update", "x-example-values": { "current_password": "Admin123!", "new_password": "Admin1234!", "confirm_password": "Admin1234!" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "current_password": { "type": "string", "description": "Existing password." }, "new_password": { "type": "string", "description": "New password with at least 8 characters." }, "confirm_password": { "type": "string", "description": "Repeat the new password." } }, "required": [ "current_password", "new_password", "confirm_password" ] }, "example": { "current_password": "Admin123!", "new_password": "Admin1234!", "confirm_password": "Admin1234!" } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/chats": { "get": { "tags": [ "Admin" ], "operationId": "admin_chat_list", "summary": "List chat conversations", "description": "Returns all customer chat conversations for the admin inbox, including unread counts and whether storefront chat is enabled.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender" ] } }, "meta": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "unread_admin_count": { "type": "integer" } }, "required": [ "enabled", "unread_admin_count" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": [ { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "open", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:32:56+00:00", "last_message_at": "2026-04-17T11:32:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin" }, { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "closed", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:33:56+00:00", "last_message_at": "2026-04-17T11:33:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin" } ], "meta": { "enabled": true, "unread_admin_count": 0 } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-chat-list", "x-example-values": [], "security": [ { "AdminToken": [] } ] } }, "/admin/chats/{id}": { "get": { "tags": [ "Admin" ], "operationId": "admin_chat_detail", "summary": "Chat conversation detail", "description": "Returns one admin chat thread and marks unread admin messages as read.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat conversation id.", "schema": { "type": "string" }, "example": "chat-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "string" }, "sender_name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "sender", "sender_name", "body", "created_at" ] } } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender", "messages" ] }, "meta": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } }, "required": [ "status", "data", "meta" ] }, "example": { "status": "ok", "data": { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "open", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:32:56+00:00", "last_message_at": "2026-04-17T11:32:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin", "messages": [ { "id": "msg-1001", "sender": "customer", "sender_name": "Alex Customer", "body": "Hi, do you have this item in stock and ready to ship?", "created_at": "2026-04-17T11:28:56+00:00" }, { "id": "msg-1002", "sender": "admin", "sender_name": "Support", "body": "Absolutely. I can help with shipping and availability questions.", "created_at": "2026-04-17T11:32:56+00:00" } ] }, "meta": { "enabled": true } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-chat-detail", "x-example-values": { "id": "chat-1001" }, "security": [ { "AdminToken": [] } ] } }, "/admin/chats/{id}/messages": { "post": { "tags": [ "Admin" ], "operationId": "admin_chat_message_create", "summary": "Reply to chat conversation", "description": "Sends an admin reply into an existing customer chat thread.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat conversation id.", "schema": { "type": "string" }, "example": "chat-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "string" }, "sender_name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "sender", "sender_name", "body", "created_at" ] } } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender", "messages" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Reply sent.", "data": { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "open", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:32:56+00:00", "last_message_at": "2026-04-17T11:32:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin", "messages": [ { "id": "msg-1001", "sender": "customer", "sender_name": "Alex Customer", "body": "Hi, do you have this item in stock and ready to ship?", "created_at": "2026-04-17T11:28:56+00:00" }, { "id": "msg-1002", "sender": "admin", "sender_name": "Support", "body": "Absolutely. I can help with shipping and availability questions.", "created_at": "2026-04-17T11:32:56+00:00" } ] } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-chat-message-create", "x-example-values": { "id": "chat-1001", "message": "Thanks for reaching out. This item is in stock and can ship today." }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Admin reply body." } }, "required": [ "message" ] }, "example": { "message": "Thanks for reaching out. This item is in stock and can ship today." } } } }, "security": [ { "AdminToken": [] } ] } }, "/admin/chats/{id}/status": { "post": { "tags": [ "Admin" ], "operationId": "admin_chat_status_update", "summary": "Update chat conversation status", "description": "Closes or reopens an existing customer chat conversation.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat conversation id.", "schema": { "type": "string" }, "example": "chat-1001" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "status": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_message_at": { "type": "string" }, "unread_admin_count": { "type": "integer" }, "unread_customer_count": { "type": "integer" }, "message_count": { "type": "integer" }, "last_message_preview": { "type": "string" }, "last_message_sender": { "type": "string" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "string" }, "sender_name": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "sender", "sender_name", "body", "created_at" ] } } }, "required": [ "id", "token", "status", "customer", "created_at", "updated_at", "last_message_at", "unread_admin_count", "unread_customer_count", "message_count", "last_message_preview", "last_message_sender", "messages" ] } }, "required": [ "status", "message", "data" ] }, "example": { "status": "ok", "message": "Chat closed.", "data": { "id": "chat-1001", "token": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1", "status": "closed", "customer": { "name": "Alex Customer", "email": "customer@example.test" }, "created_at": "2026-04-17T11:18:56+00:00", "updated_at": "2026-04-17T11:33:56+00:00", "last_message_at": "2026-04-17T11:33:56+00:00", "unread_admin_count": 0, "unread_customer_count": 0, "message_count": 2, "last_message_preview": "Absolutely. I can help with shipping and availability questions.", "last_message_sender": "admin", "messages": [ { "id": "msg-1001", "sender": "customer", "sender_name": "Alex Customer", "body": "Hi, do you have this item in stock and ready to ship?", "created_at": "2026-04-17T11:28:56+00:00" }, { "id": "msg-1002", "sender": "admin", "sender_name": "Support", "body": "Absolutely. I can help with shipping and availability questions.", "created_at": "2026-04-17T11:32:56+00:00" } ] } } } } } }, "x-group-id": "admin", "x-endpoint-id": "admin-chat-status-update", "x-example-values": { "id": "chat-1001", "status": "closed" }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Conversation status. Use open or closed." } }, "required": [ "status" ] }, "example": { "status": "closed" } } } }, "security": [ { "AdminToken": [] } ] } } }, "components": { "securitySchemes": { "AdminToken": { "type": "apiKey", "in": "header", "name": "X-Newsite-Admin-Token", "description": "Opaque admin auth token returned from POST /admin/login." }, "CartToken": { "type": "apiKey", "in": "header", "name": "X-Newsite-Cart-Token", "description": "Opaque cart token returned in cart and checkout response metadata." }, "ChatToken": { "type": "apiKey", "in": "header", "name": "X-Newsite-Chat-Token", "description": "Opaque chat token returned in chat response metadata and used to resume customer chat threads." } } } }