{ "openapi": "3.1.0", "info": { "title": "SMOKESTACK Partner Data API", "version": "2026-08-07", "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/data/v1/capabilities": { "get": { "operationId": "getPartnerDataCapabilities", "summary": "Get enabled data sets", "description": "Reports the exact read-only data sets enabled for this location credential.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataCapabilitiesResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "getPartnerDataCapabilities", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } }, "/partner/data/v1/locations": { "get": { "operationId": "listPartnerDataLocations", "summary": "Get the credential-bound location", "description": "Returns only the canonical location bound to the supplied client credential.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataLocationsResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "listPartnerDataLocations", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } }, "/partner/data/v1/sales": { "get": { "operationId": "listPartnerDataSales", "summary": "List immutable sale and refund facts", "description": "Returns sale-time price, tax, tender, catalog descriptor, product-measurement, and compliance snapshots. Current catalog or policy data is never substituted for historical facts; pre-snapshot rows are explicitly marked LEGACY_UNVERIFIABLE.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedAfter", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedBefore", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataSalesResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "listPartnerDataSales", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } }, "/partner/data/v1/products": { "get": { "operationId": "listPartnerDataProducts", "summary": "List product and variant records", "description": "Returns location-relevant product and variant facts with snapshot-bound pagination.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedAfter", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedBefore", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataProductsResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "listPartnerDataProducts", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } }, "/partner/data/v1/inventory": { "get": { "operationId": "listPartnerDataInventory", "summary": "List canonical inventory balances", "description": "Returns canonical Holding atomic quantities with Quantity Basis, Location and Package identity, and an optional external identity association without internal cost data.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedAfter", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedBefore", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataInventoryResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "listPartnerDataInventory", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } }, "/partner/data/v1/customer-compliance": { "get": { "operationId": "listPartnerDataCustomerCompliance", "summary": "List privacy-reduced customer compliance evidence", "description": "Returns pseudonymous customer references and append-only verification outcomes. Names, contact details, birth dates, ID numbers, medical-card numbers, images, and notes are excluded.", "tags": [ "Partner Data v1" ], "security": [ { "clientId": [], "apiKey": [] } ], "parameters": [ { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedAfter", "in": "query" }, { "schema": { "type": "string", "format": "date-time" }, "required": false, "name": "changedBefore", "in": "query" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "const": "2026-08-07" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-client-id", "in": "header" }, { "schema": { "type": "string" }, "required": true, "name": "x-smokestack-api-key", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string" }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful location-scoped response.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataCustomerComplianceResponse" } } } }, "400": { "description": "Invalid request or cursor.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "401": { "description": "Client authentication required.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "403": { "description": "The location credential does not permit this data set.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "406": { "description": "Unsupported contract revision.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "429": { "description": "Rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "500": { "description": "Unexpected internal error.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } }, "503": { "description": "Authoritative dependency unavailable.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-07" } }, "X-Request-ID": { "description": "Request identifier.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "End-to-end correlation identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerDataError" } } } } }, "x-smokestack-operation-status": "enabled", "x-smokestack-required-operation": "listPartnerDataCustomerCompliance", "x-smokestack-supported-api-versions": [ "2026-08-07" ] } } }, "components": { "schemas": { "PartnerDataCapabilitiesResponse": { "type": "object", "properties": { "capabilities": { "type": "array", "items": { "type": "object", "properties": { "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "dataset", "status" ] } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "operation": { "type": "string", "enum": [ "capabilities" ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "operation" ] } }, "required": [ "capabilities", "meta" ] }, "PartnerDataError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "authentication_required", "permission_denied", "api_version_not_supported", "invalid_cursor", "rate_limited", "upstream_unavailable", "internal_error" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 }, "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "retryable": { "type": "boolean" }, "details": { "type": "object", "additionalProperties": {} } }, "required": [ "code", "message", "requestId", "correlationId", "retryable" ] }, "PartnerDataLocationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "locationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "stateCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "licenseNumber": { "type": "string", "minLength": 1, "maxLength": 256 }, "createdAt": { "type": "string", "format": "date-time" }, "changedAt": { "type": "string", "format": "date-time" } }, "required": [ "locationId", "name", "stateCode", "licenseNumber", "createdAt", "changedAt" ] } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "syncOverlapSeconds": { "type": "number", "enum": [ 300 ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "dataset", "syncOverlapSeconds" ] } }, "required": [ "data", "meta" ] }, "PartnerDataSalesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "saleId": { "type": "string", "format": "uuid" }, "locationId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "SALE", "REFUND", "EXCHANGE" ] }, "status": { "type": "string", "enum": [ "COMPLETED", "VOIDED" ] }, "originalSaleId": { "type": "string", "format": "uuid" }, "customerRef": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "occurredAt": { "type": "string", "format": "date-time" }, "changedAt": { "type": "string", "format": "date-time" }, "amounts": { "type": "object", "properties": { "subtotal": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "exciseTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "salesTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "total": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] } }, "required": [ "subtotal", "exciseTax", "salesTax", "total" ] }, "compliance": { "oneOf": [ { "type": "object", "properties": { "evidenceStatus": { "type": "string", "enum": [ "VERIFIED" ] }, "gramsEquivalent": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "unitsEquivalent": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 256 }, "rulesetDigest": { "type": "string", "pattern": "^canon2:sha256:[0-9a-f]{64}$" } }, "required": [ "evidenceStatus", "gramsEquivalent", "decisionId", "rulesetDigest" ] }, { "type": "object", "properties": { "evidenceStatus": { "type": "string", "enum": [ "LEGACY_UNVERIFIABLE" ] }, "gramsEquivalent": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "unitsEquivalent": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 256 }, "rulesetDigest": { "type": "string", "pattern": "^canon2:sha256:[0-9a-f]{64}$" } }, "required": [ "evidenceStatus" ] } ] }, "lines": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "lineId": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "packageId": { "type": "string", "format": "uuid" }, "regulatoryIdentifier": { "type": "string", "minLength": 1, "maxLength": 256 }, "productType": { "type": "string", "minLength": 1, "maxLength": 200 }, "quantity": { "type": "integer" }, "unitPrice": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "discount": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "loyaltyApplied": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "exciseTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "salesTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "lineTotal": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "netWeight": { "type": "object", "properties": { "value": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "unit": { "type": "string", "enum": [ "g", "mg", "oz", "lb", "ml", "each" ] }, "basis": { "type": "string", "enum": [ "product_mass", "thc_mass" ] } }, "required": [ "value", "unit", "basis" ] }, "catalogEvidenceStatus": { "type": "string", "enum": [ "VERIFIED" ] }, "sku": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "category": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "lineId", "productId", "quantity", "unitPrice", "discount", "loyaltyApplied", "exciseTax", "salesTax", "lineTotal", "catalogEvidenceStatus", "sku", "name", "category" ] }, { "type": "object", "properties": { "lineId": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "packageId": { "type": "string", "format": "uuid" }, "regulatoryIdentifier": { "type": "string", "minLength": 1, "maxLength": 256 }, "productType": { "type": "string", "minLength": 1, "maxLength": 200 }, "quantity": { "type": "integer" }, "unitPrice": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "discount": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "loyaltyApplied": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "exciseTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "salesTax": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "lineTotal": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "netWeight": { "type": "object", "properties": { "value": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "unit": { "type": "string", "enum": [ "g", "mg", "oz", "lb", "ml", "each" ] }, "basis": { "type": "string", "enum": [ "product_mass", "thc_mass" ] } }, "required": [ "value", "unit", "basis" ] }, "catalogEvidenceStatus": { "type": "string", "enum": [ "LEGACY_UNVERIFIABLE" ] }, "sku": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "category": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "lineId", "productId", "quantity", "unitPrice", "discount", "loyaltyApplied", "exciseTax", "salesTax", "lineTotal", "catalogEvidenceStatus" ] } ] } }, "tenders": { "type": "array", "items": { "type": "object", "properties": { "tenderId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "CASH", "CARD", "GIFT_CARD", "STORE_CREDIT", "OTHER" ] }, "amount": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] } }, "required": [ "tenderId", "type", "amount" ] } } }, "required": [ "saleId", "locationId", "kind", "status", "customerRef", "occurredAt", "changedAt", "amounts", "compliance", "lines", "tenders" ] }, { "oneOf": [ { "type": "object", "properties": { "audienceEvidenceStatus": { "type": "string", "enum": [ "VERIFIED" ] }, "audience": { "type": "string", "enum": [ "REC", "MED" ] } }, "required": [ "audienceEvidenceStatus", "audience" ] }, { "type": "object", "properties": { "audienceEvidenceStatus": { "type": "string", "enum": [ "LEGACY_UNVERIFIABLE" ] }, "audience": { "type": "string", "enum": [ "REC", "MED" ] } }, "required": [ "audienceEvidenceStatus" ] } ] } ] } }, "page": { "type": "object", "properties": { "nextCursor": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "cursorExpiresAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "syncOverlapSeconds": { "type": "number", "enum": [ 300 ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "dataset", "syncOverlapSeconds" ] } }, "required": [ "data", "page", "meta" ] }, "PartnerDataProductsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "productSku": { "type": "string", "minLength": 1, "maxLength": 256 }, "variantSku": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "variantName": { "type": "string", "minLength": 1, "maxLength": 300 }, "category": { "type": "string", "minLength": 1, "maxLength": 200 }, "productType": { "type": "string", "minLength": 1, "maxLength": 200 }, "active": { "type": "boolean" }, "price": { "type": "object", "properties": { "amountMinor": { "type": "integer" }, "currency": { "type": "string", "enum": [ "USD" ] } }, "required": [ "amountMinor", "currency" ] }, "netWeight": { "type": "object", "properties": { "value": { "type": "string", "pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]{1,3})?$" }, "unit": { "type": "string", "enum": [ "g", "mg", "oz", "lb", "ml", "each" ] }, "basis": { "type": "string", "enum": [ "product_mass", "thc_mass" ] } }, "required": [ "value", "unit", "basis" ] }, "createdAt": { "type": "string", "format": "date-time" }, "changedAt": { "type": "string", "format": "date-time" } }, "required": [ "productId", "variantId", "productSku", "variantSku", "name", "category", "active", "price", "createdAt", "changedAt" ] } }, "page": { "type": "object", "properties": { "nextCursor": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "cursorExpiresAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "syncOverlapSeconds": { "type": "number", "enum": [ 300 ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "dataset", "syncOverlapSeconds" ] } }, "required": [ "data", "page", "meta" ] }, "PartnerDataInventoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "inventoryId": { "type": "string", "format": "uuid" }, "locationId": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "sku": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "quantityBasis": { "type": "object", "properties": { "uom": { "type": "string", "enum": [ "each", "mg", "g", "kg", "ml", "l", "oz", "lb" ] }, "scale": { "type": "integer", "minimum": 0, "maximum": 9 } }, "required": [ "uom", "scale" ] }, "quantities": { "type": "object", "properties": { "onHand": { "type": "integer", "minimum": 0 }, "reserved": { "type": "integer", "minimum": 0 }, "quarantined": { "type": "integer", "minimum": 0 }, "returned": { "type": "integer", "minimum": 0 }, "wasted": { "type": "integer", "minimum": 0 }, "available": { "type": "integer", "minimum": 0 } }, "required": [ "onHand", "reserved", "quarantined", "returned", "wasted", "available" ] }, "aggregateVersion": { "type": "integer", "minimum": 0 }, "deleted": { "type": "boolean" }, "package": { "type": "object", "properties": { "packageId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": "string", "enum": [ "active", "held", "depleted", "archived" ] }, "lotCode": { "type": "string", "minLength": 1, "maxLength": 256 }, "expiresAt": { "type": "string", "format": "date-time" }, "externalIdentity": { "type": "object", "properties": { "namespace": { "type": "string", "minLength": 1, "maxLength": 256 }, "externalId": { "type": "string", "minLength": 1, "maxLength": 256 }, "observedAt": { "type": "string", "format": "date-time" } }, "required": [ "namespace", "externalId", "observedAt" ] } }, "required": [ "packageId", "lifecycleStatus" ] }, "changedAt": { "type": "string", "format": "date-time" } }, "required": [ "inventoryId", "locationId", "productId", "variantId", "sku", "name", "quantityBasis", "quantities", "aggregateVersion", "deleted", "changedAt" ] } }, "page": { "type": "object", "properties": { "nextCursor": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "cursorExpiresAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "syncOverlapSeconds": { "type": "number", "enum": [ 300 ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "dataset", "syncOverlapSeconds" ] } }, "required": [ "data", "page", "meta" ] }, "PartnerDataCustomerComplianceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "evidenceId": { "type": "string", "format": "uuid" }, "customerRef": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "saleId": { "type": "string", "format": "uuid" }, "audience": { "type": "string", "enum": [ "REC", "MED" ] }, "verificationMethod": { "type": "string", "minLength": 1, "maxLength": 256 }, "documentType": { "type": "string", "minLength": 1, "maxLength": 256 }, "documentIssuer": { "type": "string", "minLength": 1, "maxLength": 256 }, "documentExpiration": { "type": "string", "format": "date" }, "decision": { "type": "string", "minLength": 1, "maxLength": 256 }, "minimumAgeMet": { "type": "boolean" }, "verifiedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "changedAt": { "type": "string", "format": "date-time" } }, "required": [ "evidenceId", "customerRef", "audience", "verificationMethod", "decision", "minimumAgeMet", "verifiedAt", "expiresAt", "changedAt" ] } }, "page": { "type": "object", "properties": { "nextCursor": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{32,4096}$" }, "cursorExpiresAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "correlationId": { "type": "string", "pattern": "^[A-Za-z0-9._:~-]{1,256}$" }, "apiVersion": { "type": "string", "enum": [ "2026-08-07" ] }, "generatedAt": { "type": "string", "format": "date-time" }, "syncCheckpoint": { "type": "string", "format": "date-time" }, "customerReferenceVersion": { "type": "string", "enum": [ "hmac-sha256-v1" ] }, "dataset": { "type": "string", "enum": [ "locations", "sales", "products", "inventory", "customer_compliance" ] }, "syncOverlapSeconds": { "type": "number", "enum": [ 300 ] } }, "required": [ "requestId", "correlationId", "apiVersion", "generatedAt", "syncCheckpoint", "customerReferenceVersion", "dataset", "syncOverlapSeconds" ] } }, "required": [ "data", "page", "meta" ] } }, "securitySchemes": { "clientId": { "type": "apiKey", "in": "header", "name": "X-SMOKESTACK-Client-ID", "description": "Public, high-entropy location client identifier issued by SMOKESTACK." }, "apiKey": { "type": "apiKey", "in": "header", "name": "X-SMOKESTACK-API-Key", "description": "Secret location API key shown only at issuance or rotation." } } } }