{"openapi":"3.1.0","info":{"title":"GET /api/v1/inventory/costing/consumptions","version":"1.0.0","description":"List cost-lot consumptions"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/inventory/costing/consumptions":{"get":{"tags":["inventory:costing"],"summary":"List cost-lot consumptions","description":"The consumption ledger: which lot each unit left or came back to, at what cost, for which order, invoice, adjustment or count.","operationId":"list_cost_consumptions","parameters":[{"name":"variant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only this variant","title":"Variant Id"},"description":"Only this variant"},{"name":"source_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. shopify_fulfillment, invoice_line, adjustment","title":"Source Type"},"description":"e.g. shopify_fulfillment, invoice_line, adjustment"},{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Order, invoice, ... id","title":"Source Id"},"description":"Order, invoice, ... id"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":200,"title":"Limit"}},{"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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CostConsumptionListResponse_"}}}},"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":"list_cost_consumptions_api_v1_inventory_costing_consumptions_get"}}},"components":{"schemas":{"CostConsumptionListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CostConsumptionRow"},"type":"array","title":"Items"}},"type":"object","title":"CostConsumptionListResponse"},"CostConsumptionRow":{"properties":{"id":{"type":"string","title":"Id"},"variant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Id"},"lot_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lot Id"},"related_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Related Id","description":"Draw a restore puts back / pending row a true-up covers"},"kind":{"type":"string","title":"Kind","description":"consume | restore | pending | true_up | recost | unlayered"},"method":{"type":"string","title":"Method","description":"fifo | fefo | weighted_average | standard"},"quantity":{"type":"string","title":"Quantity"},"unit_cost_cents":{"type":"string","title":"Unit Cost Cents","description":"Cost booked per unit (cents)"},"lot_unit_cost_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lot Unit Cost Cents"},"cost_cents":{"type":"integer","title":"Cost Cents"},"pending_quantity":{"type":"string","title":"Pending Quantity","description":"Units still without a lot","default":"0"},"adjustment_cents":{"type":"integer","title":"Adjustment Cents","description":"COGS correction to post","default":0},"source_type":{"type":"string","title":"Source Type"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"source_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Line Id"},"consumed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consumed At"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"}},"type":"object","required":["id","kind","method","quantity","unit_cost_cents","cost_cents","source_type"],"title":"CostConsumptionRow","description":"One movement in the cost-lot consumption ledger."},"SuccessEnvelope_CostConsumptionListResponse_":{"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/CostConsumptionListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CostConsumptionListResponse]"},"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":[]}]}