Get Transfer Order

GET /inventory/warehouse-transfer-orders/{id}

Group: Inventory › Warehouse Transfer Orders · Operation ID: getTransferOrder

Returns the transfer order with the given identifier, with its lines. To look one up by documentNumber, use POST inventory/warehouse-transfer-orders/search.

The id is the order's own, the value POST inventory/warehouse-transfer-orders returned and the collection publishes. A document number is not accepted here: look one up by documentNumber on the collection or on POST inventory/warehouse-transfer-orders/search.

Read this before converting. A line whose status is 'NEEDS_SOURCE', or whose locationId is absent, has no warehouse to draw from, and POST inventory/warehouse-transfer-orders/:id/commit refuses the whole order while any such line remains. openLineCount says how much of the order is still outstanding.

The response is the same item schema as the collection, plus the lines a collection field cannot carry.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the transfer order to return.

Response

200 Success

Under data (getTransferOrderOutput):

Field Type Required Description
id string yes The unique identifier for the transfer order.
documentNumber string no The transfer order's number, for example 'WTO-1043'.
documentStatus string yes The status of the transfer order, computed from the lines and set by no endpoint directly. Possible values: 'DRAFT', 'IN_TRANSFER', 'PARTIALLY_PROCESSED', 'PROCESSED'. 'DRAFT' while the order is being written, 'IN_TRANSFER' while a transfer created from it has yet to commit, 'PARTIALLY_PROCESSED' once a transfer has moved part of what was asked for and a remainder is still open, and 'PROCESSED' once nothing is open.
documentDate string (date) no The date the transfer order is dated. Format YYYY-MM-DD.
referenceNumber string no Your own reference on the transfer order.
entityId string no The legal entity the transfer order belongs to. See id on GET base/entities.
entityName string no The name of that legal entity.
locationId string no The warehouse the goods leave, where the order names one for the whole document. A line may name its own. See id on GET inventory/warehouses/:id.
locationCode string no The code of that warehouse.
locationName string no The name of that warehouse.
targetLocationId string no The warehouse the goods go to. See id on GET inventory/warehouses/:id.
targetLocationCode string no The code of that warehouse.
targetLocationName string no The name of that warehouse.
notes string no Free text on the document.
lineCount number no The number of lines on the transfer order.
openLineCount number no How many lines still have quantity left to transfer. Zero means everything has been taken.
createdDate string (date-time) no The date and time the transfer order was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the transfer order record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object yes The lines of the transfer order. Absent from the collection GET inventory/warehouse-transfer-orders, which returns lineCount instead.
lines[].id string yes The unique identifier for the line. updateLines and deleteLines address a line by it.
lines[].itemId string no The item to move. See id on GET inventory/items/:id.
lines[].itemCode string no The code of that item.
lines[].itemName string no The name of that item.
lines[].locationId string no The warehouse this line draws from. See id on GET inventory/warehouses/:id. Absent while no source warehouse has been resolved, and such a line blocks the conversion.
lines[].locationCode string no The code of that warehouse.
lines[].locationName string no The name of that warehouse.
lines[].targetLocationId string no The warehouse this line delivers to. See id on GET inventory/warehouses/:id.
lines[].targetLocationCode string no The code of that warehouse.
lines[].targetLocationName string no The name of that warehouse.
lines[].unitId string no The unit the quantity is in. There is no endpoint for it.
lines[].unitCode string no The code of that unit.
lines[].quantity string (decimal) no How much to move, in the line's unit. Always greater than zero.
lines[].inventoryQuantity string (decimal) no The same amount in the item's stocking unit, which is what the warehouse counts.
lines[].openQuantity string (decimal) no How much of the line is still to be transferred.
lines[].processedQuantity string (decimal) no How much of the line a transfer has already taken.
lines[].status string no The state of the line. 'NEEDS_SOURCE' means no source warehouse has been resolved, and the transfer order cannot be converted until it is.
lines[].notes string no Free text on the line.

Errors

Code Status
NOT_FOUND 400

Statuses