Inventory > Transfers > transfersPage
Commerce APIInventoryTransferstransfersPage
transfersPage
GET:transfers/page.json

Description

Get all existing transfers.

See also: Pagination.

Permission bit: "transfers.read"

Topic: Transfers

Arguments

last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: TransfersPageSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


type: TransferCategory

Filter transfers output by a transfer type


Result

TransferPage

Preview (typescript)

Loading module