{"openapi":"3.1.0","info":{"title":"GET /api/v1/inventory/transfer-suggestions/suggestions","version":"1.0.0","description":"Suggest site-to-site transfers"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/inventory/transfer-suggestions/suggestions":{"get":{"tags":["inventory:transfer_suggestions"],"summary":"Suggest site-to-site transfers","description":"Return (donor, receiver, quantity) suggestions for variants with surplus at one location and deficit at another.","operationId":"list_transfer_suggestions_api_v1_inventory_transfer_suggestions_suggestions_get","parameters":[{"name":"surplus_pct","in":"query","required":false,"schema":{"type":"number","maximum":2.0,"minimum":0.0,"description":"Donor must hold this much above its own reorder point.","default":0.25,"title":"Surplus Pct"},"description":"Donor must hold this much above its own reorder point."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"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/TransferSuggestionsResponse"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"TransferSuggestion":{"properties":{"variant_id":{"type":"string","title":"Variant Id"},"variant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Name"},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"},"from_location_id":{"type":"string","title":"From Location Id"},"to_location_id":{"type":"string","title":"To Location Id"},"from_location_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Location Name"},"to_location_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Location Name"},"donor_available":{"type":"number","title":"Donor Available"},"donor_reorder_point":{"type":"number","title":"Donor Reorder Point"},"receiver_on_hand":{"type":"number","title":"Receiver On Hand"},"receiver_reorder_point":{"type":"number","title":"Receiver Reorder Point"},"suggested_quantity":{"type":"integer","title":"Suggested Quantity"}},"type":"object","required":["variant_id","from_location_id","to_location_id","donor_available","donor_reorder_point","receiver_on_hand","receiver_reorder_point","suggested_quantity"],"title":"TransferSuggestion"},"TransferSuggestionsResponse":{"properties":{"suggestions":{"items":{"$ref":"#/components/schemas/TransferSuggestion"},"type":"array","title":"Suggestions"},"total":{"type":"integer","title":"Total","default":0}},"type":"object","title":"TransferSuggestionsResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}