Receive transfer

POST/api/v1/inventory/transfers/{transfer_id}/receive

Mark transfer as received. Adds inventory to destination location.

Operation ID: receive_transfer_api_v1_inventory_transfers__transfer_id__receive_post·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

Path

transfer_idstringrequired

Request body

Schema: TransferReceiveRequest

received_datestring · date

Date of receipt (defaults to today)

itemsarray · TransferItemReceiverequiredTransferItemReceive

Items received with quantities

4 fields

transfer_item_idstringrequired: ID of the transfer item
received_quantityintegerrequired: Actual quantity received
has_damageboolean
damage_notesstring

notesstring

Responses

201Successful Response

Schema: SuccessEnvelope_TransferResponse_

successboolean
messagestring
codestring
dataTransferResponse

400Bad Request - Invalid input

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

POST/api/v1/inventory/transfers/{transfer_id}/receive

bash

curl -X POST 'https://api.ondayzero.com/api/v1/inventory/transfers/{transfer_id}/receive' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "items": []
}'