{"openapi":"3.1.0","info":{"title":"POST /api/v1/inventory/cogs/standard/preview","version":"1.0.0","description":"Preview the standard-cost COGS re-rate"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/inventory/cogs/standard/preview":{"post":{"tags":["inventory:standard_costs"],"summary":"Preview the standard-cost COGS re-rate","description":"Per source (shopify, invoice) and variant: units sold in the window, the cost in force, standard COGS, the COGS the source recorded, and the delta. Writes nothing; plan_hash goes to /apply.","operationId":"standard_cogs_preview","parameters":[{"name":"from_date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"First sale day (YYYY-MM-DD)","title":"From Date"},"description":"First sale day (YYYY-MM-DD)"},{"name":"to_date","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Last sale day (YYYY-MM-DD)","title":"To Date"},"description":"Last sale day (YYYY-MM-DD)"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_StandardCogsPreviewResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"standard_cogs_preview_api_v1_inventory_cogs_standard_preview_post"}}},"components":{"schemas":{"CostInForce":{"properties":{"unit_cost_cents":{"type":"integer","title":"Unit Cost Cents"},"units":{"type":"integer","title":"Units"}},"type":"object","required":["unit_cost_cents","units"],"title":"CostInForce"},"StandardCogsPreviewResponse":{"properties":{"from_date":{"type":"string","format":"date","title":"From Date"},"to_date":{"type":"string","format":"date","title":"To Date"},"cogs_basis":{"type":"string","enum":["fifo","standard"],"title":"Cogs Basis"},"rows":{"items":{"$ref":"#/components/schemas/StandardCogsRow"},"type":"array","title":"Rows"},"sources":{"additionalProperties":{"additionalProperties":{"type":"integer"},"type":"object"},"type":"object","title":"Sources"},"delta_cents":{"type":"integer","title":"Delta Cents"},"plan_hash":{"type":"string","title":"Plan Hash","description":"Pass to /apply to draft exactly this"}},"type":"object","required":["from_date","to_date","cogs_basis","delta_cents","plan_hash"],"title":"StandardCogsPreviewResponse"},"StandardCogsRow":{"properties":{"source":{"type":"string","enum":["shopify","invoice"],"title":"Source"},"variant_id":{"type":"string","title":"Variant Id"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"variant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Name"},"units":{"type":"integer","title":"Units"},"costs_in_force":{"items":{"$ref":"#/components/schemas/CostInForce"},"type":"array","title":"Costs In Force"},"standard_cogs_cents":{"type":"integer","title":"Standard Cogs Cents","description":"Units x cost in force"},"posted_cogs_cents":{"type":"integer","title":"Posted Cogs Cents","description":"Cost the source captured (Shopify line cost / invoice line cost)"},"delta_cents":{"type":"integer","title":"Delta Cents","description":"standard - posted"},"uncosted_units":{"type":"integer","title":"Uncosted Units","description":"Units with no standard or unit cost (kept at posted)","default":0}},"type":"object","required":["source","variant_id","units","standard_cogs_cents","posted_cogs_cents","delta_cents"],"title":"StandardCogsRow"},"SuccessEnvelope_StandardCogsPreviewResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/StandardCogsPreviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[StandardCogsPreviewResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}