Suggest site-to-site transfers

GET /api/v1/inventory/transfer-suggestions/suggestions

Return (donor, receiver, quantity) suggestions for variants with surplus at one location and deficit at another.

Operation ID: list_transfer_suggestions_api_v1_inventory_transfer_suggestions_suggestions_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

surplus_pct number default: 0.25

Donor must hold this much above its own reorder point.

limit integer default: 50

Responses

200 Successful Response

Schema: TransferSuggestionsResponse

suggestions array · TransferSuggestion TransferSuggestion
12 fields
variant_id string required
variant_name string
sku string
from_location_id string required
to_location_id string required
from_location_name string
to_location_name string
donor_available number required
donor_reorder_point number required
receiver_on_hand number required
receiver_reorder_point number required
suggested_quantity integer required
total integer

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object