Skip to main content

Get Warehouse Transfer

GET 
/api/v2/warehouse-transfers/:warehouseTransfer

Returns the full detail view of a warehouse transfer.

Required scope: warehouses:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Eager-loads: from_warehouse, to_warehouse, tags, adjustments, shipments (with lines and receipts), financial_lines, and COGS data. Also preloads current stock levels for both warehouses.

For transfers with an Amazon FBA destination, the response includes back-links to the Amazon records the transfer materializes: amazon_inbound_shipment (the FBA inbound shipment) and amazon_inbound_plan (the FBA inbound plan it was built from). Each carries an integration_instance_id, which identifies the Amazon account the record belongs to. Both are omitted when the transfer has no Amazon destination.

amazon_inbound_shipment.is_legacy tells you which shipment detail endpoint to call for it: true means the record is a legacy FBA inbound shipment, retrievable at GET /api/amazon/{integrationInstance}/inbound/shipments/{shipment}; false means it is a current-format shipment, retrievable at GET /api/amazon/{integrationInstance}/new-inbound/shipments/{shipment}. The two record sets use independent id sequences, so the same id can exist in both — always branch on this flag rather than assuming a format.

Landed-cost invoices attached to the transfer are returned under bills. A transfer is always denominated in the tenant's base currency, so each bill carries both the supplier's own figures and the same figures restated in that base currency: total_amount and allocations[].allocation_amount are in the bill's currency (currency_code, converted at currency_rate), while total_amount_in_tenant_currency and allocations[].allocation_amount_in_tenant_currency are in the base currency. Only the tenant-currency figures may be summed into transfer totals — adding the native amounts mixes currencies. is_foreign_currency is true when the invoice was raised in something other than the base currency.

The same applies to each line's cogs block: cogs.landed_costs_total and cogs.landed_costs[].amount are reported in the base currency, matching what the FIFO layer and the accounting COGS book.

Request​

Responses​

OK

Response Headers
    Content-Type