{ "openapi": "3.1.0", "info": { "title": "SMOKESTACK Partner Ecom API", "version": "2026-07-28", "description": "Revision-filtered public contract. Documentation is not runtime activation or partner authorization." }, "servers": [ { "url": "https://partner-api.invalid", "description": "Deliberately non-routable placeholder for generated clients and interactive documentation. Configure only the exact base URL supplied during credential-bound partner onboarding. Publishing a contract does not select a production or sandbox endpoint and does not assert that the revision is deployed, enabled for a partner, or production-ready." } ], "paths": { "/partner/ecom/v1/capabilities": { "get": { "operationId": "getPartnerCapabilities", "summary": "Get partner capability activation state", "description": "Reports configured capability state. Publishing this contract does not enable SMOKESTACK as an active storefront provider.", "tags": [ "Partner Ecom v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-07-28" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful partner response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerCapabilitiesResponse" } } } }, "400": { "description": "Invalid request, cursor, or missing idempotency key.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "401": { "description": "Partner authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "403": { "description": "Partner authority does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "404": { "description": "Partner-safe resource not found.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "406": { "description": "Requested API revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "409": { "description": "Idempotency, expiry, or stale-resource conflict.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "422": { "description": "The request is valid JSON but cannot be accepted as commerce authority.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "429": { "description": "Partner rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "500": { "description": "An unexpected error occurred without exposing internal details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "501": { "description": "The contract operation is published but is not enabled for this partner. Contract publication is not provider activation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry when known.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-supported-api-versions": [ "2026-07-28" ], "x-smokestack-required-operation": "getPartnerCapabilities", "x-smokestack-idempotency": { "required": false } } }, "/partner/ecom/v1/catalog/items": { "get": { "operationId": "listPartnerCatalogItems", "summary": "List provider-neutral sellable catalog items", "description": "Returns partner-facing product and variant facts without POS inventory rows, reservation counts, company IDs, or provider-specific identifiers.", "tags": [ "Partner Ecom v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "enum": [ "REC", "MED" ] }, "required": true, "name": "audience", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "search", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "category", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{1,2048}$" }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "const": "2026-07-28" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful partner response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerCatalogResponse" } } } }, "400": { "description": "Invalid request, cursor, or missing idempotency key.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "401": { "description": "Partner authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "403": { "description": "Partner authority does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "404": { "description": "Partner-safe resource not found.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "406": { "description": "Requested API revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "409": { "description": "Idempotency, expiry, or stale-resource conflict.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "422": { "description": "The request is valid JSON but cannot be accepted as commerce authority.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "429": { "description": "Partner rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "500": { "description": "An unexpected error occurred without exposing internal details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "501": { "description": "The contract operation is published but is not enabled for this partner. Contract publication is not provider activation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry when known.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-supported-api-versions": [ "2026-07-28" ], "x-smokestack-required-operation": "listPartnerCatalogItems", "x-smokestack-idempotency": { "required": false } } }, "/partner/ecom/v1/availability": { "get": { "operationId": "getPartnerAvailability", "summary": "Read sellable availability for variants", "description": "Returns storefront-safe availability and freshness, not POS on-hand or reservation internals.", "tags": [ "Partner Ecom v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "enum": [ "REC", "MED" ], "default": "REC" }, "required": false, "name": "audience", "in": "query" }, { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "required": true, "name": "variantId", "in": "query" }, { "schema": { "type": "string", "const": "2026-07-28" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful partner response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerAvailabilityResponse" } } } }, "400": { "description": "Invalid request, cursor, or missing idempotency key.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "401": { "description": "Partner authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "403": { "description": "Partner authority does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "404": { "description": "Partner-safe resource not found.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "406": { "description": "Requested API revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "409": { "description": "Idempotency, expiry, or stale-resource conflict.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "422": { "description": "The request is valid JSON but cannot be accepted as commerce authority.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "429": { "description": "Partner rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "500": { "description": "An unexpected error occurred without exposing internal details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "501": { "description": "The contract operation is published but is not enabled for this partner. Contract publication is not provider activation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-07-28" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date (`@` followed by Unix seconds) when an operation or revision is deprecated.", "schema": { "type": "string", "pattern": "^@[0-9]+$", "example": "@1814400000" } }, "Sunset": { "description": "RFC 8594 HTTP-date when a deprecated operation has a scheduled retirement; servers emit IMF-fixdate in GMT.", "schema": { "type": "string", "example": "Fri, 28 Jan 2028 00:00:00 GMT" } }, "Link": { "description": "Deprecation or successor documentation link; deprecation notices include rel=\"deprecation\".", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds until the caller may retry when known.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EcomPartnerError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-supported-api-versions": [ "2026-07-28" ], "x-smokestack-required-operation": "getPartnerAvailability", "x-smokestack-idempotency": { "required": false } } } }, "components": { "schemas": { "EcomPartnerCapabilitiesResponse": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "catalog", "availability", "quote", "checkout", "orders" ] }, "status": { "type": "string", "enum": [ "PLANNED", "DISABLED", "SHADOW", "ENABLED" ] } }, "required": [ "key", "status" ], "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "apiVersion": { "type": "string", "enum": [ "2026-07-28", "2026-08-09" ] }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt" ], "additionalProperties": {} } }, "required": [ "capabilities", "meta" ], "additionalProperties": {} }, "EcomPartnerError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "authentication_required", "permission_denied", "resource_not_found", "api_version_not_supported", "invalid_cursor", "idempotency_key_required", "idempotency_conflict", "quote_rejected", "quote_expired", "resource_stale", "unsupported_currency", "rate_limited", "capability_unavailable", "upstream_unavailable", "internal_error" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 }, "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "details": { "type": "object", "additionalProperties": {} }, "retryable": { "type": "boolean" } }, "required": [ "code", "message", "requestId", "correlationId", "retryable" ], "additionalProperties": {} }, "EcomPartnerCatalogResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "sku": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "variantName": { "type": "string", "minLength": 1, "maxLength": 300 }, "description": { "type": "string", "maxLength": 10000 }, "category": { "type": "string", "minLength": 1, "maxLength": 200 }, "brand": { "type": "string", "minLength": 1, "maxLength": 200 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "audiences": { "type": "array", "items": { "type": "string", "enum": [ "REC", "MED" ] }, "minItems": 1 }, "media": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "altText": { "type": "string", "maxLength": 500 }, "sortOrder": { "type": "integer", "minimum": 0 } }, "required": [ "url", "sortOrder" ], "additionalProperties": {} } }, "packagePotency": { "type": "object", "properties": { "thcMg": { "type": "number", "minimum": 0 }, "cbdMg": { "type": "number", "minimum": 0 }, "cbnMg": { "type": "number", "minimum": 0 }, "cbgMg": { "type": "number", "minimum": 0 }, "thcvMg": { "type": "number", "minimum": 0 }, "cbcMg": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "price": { "type": "object", "properties": { "unitPrice": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0 }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ], "additionalProperties": {} }, "effectiveUnitPrice": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0 }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ], "additionalProperties": {} }, "compareAtPrice": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0 }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ], "additionalProperties": {} }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1, "maxLength": 128 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "amount": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0 }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ], "additionalProperties": {} } }, "required": [ "code", "label", "amount" ], "additionalProperties": {} } }, "freshness": { "type": "object", "properties": { "observedAt": { "type": "string", "format": "date-time" }, "staleAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "observedAt", "staleAt", "expiresAt" ], "additionalProperties": {} } }, "required": [ "unitPrice", "effectiveUnitPrice", "discounts", "freshness" ], "additionalProperties": {} }, "availability": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "IN_STOCK", "LOW_STOCK", "OUT_OF_STOCK", "UNAVAILABLE" ] }, "quantityAvailable": { "type": "integer", "minimum": 0 }, "fulfillmentMethods": { "type": "array", "items": { "type": "string", "enum": [ "PICKUP", "CURBSIDE", "DELIVERY" ] } }, "freshness": { "type": "object", "properties": { "observedAt": { "type": "string", "format": "date-time" }, "staleAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "observedAt", "staleAt", "expiresAt" ], "additionalProperties": {} } }, "required": [ "state", "fulfillmentMethods", "freshness" ], "additionalProperties": {} }, "sourceTimestamps": { "type": "object", "properties": { "catalogAt": { "type": "string", "format": "date-time" }, "pricingAt": { "type": "string", "format": "date-time" }, "availabilityAt": { "type": "string", "format": "date-time" } }, "required": [ "catalogAt", "pricingAt", "availabilityAt" ], "additionalProperties": {} } }, "required": [ "productId", "variantId", "sku", "name", "variantName", "tags", "audiences", "media", "price", "availability", "sourceTimestamps" ], "additionalProperties": {} } }, "page": { "type": "object", "properties": { "nextCursor": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{1,2048}$" }, "cursorExpiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": {} }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "apiVersion": { "type": "string", "enum": [ "2026-07-28", "2026-08-09" ] }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt" ], "additionalProperties": {} } }, "required": [ "data", "page", "meta" ], "additionalProperties": {} }, "EcomPartnerAvailabilityResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "availability": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "IN_STOCK", "LOW_STOCK", "OUT_OF_STOCK", "UNAVAILABLE" ] }, "quantityAvailable": { "type": "integer", "minimum": 0 }, "fulfillmentMethods": { "type": "array", "items": { "type": "string", "enum": [ "PICKUP", "CURBSIDE", "DELIVERY" ] } }, "freshness": { "type": "object", "properties": { "observedAt": { "type": "string", "format": "date-time" }, "staleAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "observedAt", "staleAt", "expiresAt" ], "additionalProperties": {} } }, "required": [ "state", "fulfillmentMethods", "freshness" ], "additionalProperties": {} } }, "required": [ "productId", "variantId", "availability" ], "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,128}$" }, "apiVersion": { "type": "string", "enum": [ "2026-07-28", "2026-08-09" ] }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt" ], "additionalProperties": {} } }, "required": [ "data", "meta" ], "additionalProperties": {} } }, "securitySchemes": { "partnerServiceBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Single-use, short-lived server credential with kid, issuer, token-use, audience, purpose, exact operation, assignment, partner, tenant, store, and channel claims. Browser code must never receive it." } } } }