GET
/
api
/
warehouse-transfers
/
{id}
{
  "id": 1,
  "date": "2024-03-20",
  "formattedDate": "Mar 20, 2024",
  "transactionNumber": "WT-2024-001",
  "fromWarehouseId": 1,
  "toWarehouseId": 2,
  "transferInitiatedAt": "2024-03-20T10:00:00Z",
  "transferDeliveredAt": "2024-03-21T15:00:00Z",
  "isInitiated": true,
  "isTransferred": true,
  "fromWarehouse": {},
  "toWarehouse": {},
  "entries": [
    {
      "id": 1,
      "itemId": 1,
      "quantity": 100,
      "cost": 10.5,
      "total": 1050,
      "formattedQuantity": "100.00",
      "formattedCost": "$10.50",
      "formattedTotal": "$1,050.00",
      "item": {}
    }
  ],
  "createdAt": "2024-03-20T09:00:00Z",
  "updatedAt": "2024-03-21T15:00:00Z"
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Response

200 - application/json

The warehouse transfer transaction details have been retrieved successfully.

​
id
number
required

The ID of the warehouse transfer

Example:

1

​
date
string<date-time>
required

The date of the warehouse transfer

Example:

"2024-03-20"

​
formattedDate
string
required

The formatted date of the warehouse transfer

Example:

"Mar 20, 2024"

​
transactionNumber
string
required

The transaction number of the warehouse transfer

Example:

"WT-2024-001"

​
fromWarehouseId
number
required

The ID of the source warehouse

Example:

1

​
toWarehouseId
number
required

The ID of the destination warehouse

Example:

2

​
transferInitiatedAt
string<date-time>
required

The date when the transfer was initiated

Example:

"2024-03-20T10:00:00Z"

​
transferDeliveredAt
string<date-time>
required

The date when the transfer was delivered

Example:

"2024-03-21T15:00:00Z"

​
isInitiated
boolean
required

Whether the transfer has been initiated

Example:

true

​
isTransferred
boolean
required

Whether the transfer has been completed

Example:

true

​
fromWarehouse
object
required

The source warehouse details

​
toWarehouse
object
required

The destination warehouse details

​
entries
object[]
required

The entries of the warehouse transfer

​
createdAt
string<date-time>
required

The creation date of the warehouse transfer

Example:

"2024-03-20T09:00:00Z"

​
updatedAt
string<date-time>
required

The last update date of the warehouse transfer

Example:

"2024-03-21T15:00:00Z"