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_pctnumberdefault: 0.25: Donor must hold this much above its own reorder point.
limitintegerdefault: 50

Responses

200Successful Response

Schema: SuccessEnvelope_TransferSuggestionsResponse_

successboolean
messagestring
codestring
dataTransferSuggestionsResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

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

bash

curl -X GET 'https://api.ondayzero.com/api/v1/inventory/transfer-suggestions/suggestions' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'