Retrieve warehouse transfer transactions with pagination.

{
  "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"
    }
  ]
}

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 ' where 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.

pagination

object

required

Pagination metadata

Show child attributes

pagination.total

number

required

Total number of items across all pages

Example:

100

pagination.page

number

required

Current page number (1-based)

Required range: x >= 1

Example:

1

pagination.pageSize

number

required

Number of items per page

Required range: x >= 1

Example:

10

data

object[]

Show child attributes

data.id

number

required

The ID of the warehouse transfer

Example:

1

data.date

string<date-time>

required

The date of the warehouse transfer

Example:

"2024-03-20"

data.formattedDate

string

required

The formatted date of the warehouse transfer

Example:

"Mar 20, 2024"

data.transactionNumber

string

required

The transaction number of the warehouse transfer

Example:

"WT-2024-001"

data.fromWarehouseId

number

required

The ID of the source warehouse

Example:

1

data.toWarehouseId

number

required

The ID of the destination warehouse

Example:

2

data.transferInitiatedAt

string<date-time>

required

The date when the transfer was initiated

Example:

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

data.transferDeliveredAt

string<date-time>

required

The date when the transfer was delivered

Example:

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

data.isInitiated

boolean

required

Whether the transfer has been initiated

Example:

true

data.isTransferred

boolean

required

Whether the transfer has been completed

Example:

true

data.fromWarehouse

object

required

The source warehouse details

data.toWarehouse

object

required

The destination warehouse details

data.entries

object[]

required

The entries of the warehouse transfer

Show child attributes

data.entries.id

number

required

The ID of the warehouse transfer entry

Example:

1

data.entries.itemId

number

required

The ID of the item being transferred

Example:

1

data.entries.quantity

number

required

The quantity of items being transferred

Example:

100

data.entries.cost

number

required

The cost per unit of the item

Example:

10.5

data.entries.total

number

required

The total cost of the transfer entry

Example:

1050

data.entries.formattedQuantity

string

required

The formatted quantity of items being transferred

Example:

"100.00"

data.entries.formattedCost

string

required

The formatted cost per unit of the item

Example:

"$10.50"

data.entries.formattedTotal

string

required

The formatted total cost of the transfer entry

Example:

"$1,050.00"

data.entries.item

object

required

The item details

data.createdAt

string<date-time>

required

The creation date of the warehouse transfer

Example:

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

data.updatedAt

string<date-time>

required

The last update date of the warehouse transfer

Example:

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

Publish the given expense transaction.Create a new warehouse transfer transaction.

⌘I

Get Started

API Reference

Retrieve warehouse transfer transactions with pagination.

Headers

Response