GET
/
api
/
warehouse-transfers
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "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.

Response

200 - application/json

The warehouse transfer transactions have been retrieved successfully.

The response is of type object.