GET
List stock transfers
Company space For: Stock keeper, Manager · Permission: transfers.list Conditions
  • A transfer is visible to the company that owns it and, once it is no longer a draft, to a company that holds a location of one of its step groups.
  • per_page 1 to 100; sort_by is one of id, status, type, motif, created_at, updated_at; sort_order is asc or desc.
Part of Plan and run stock transfers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer

Page size from 1 to 100, 15 by default.

Required range: 1 <= x <= 100
cursor
string

Cursor of the page to read, from the previous page's meta.

sort_by
enum<string>

One of id (default), status, type, motif, created_at, updated_at.

Available options:
id,
status,
type,
motif,
created_at,
updated_at
sort_order
enum<string>

asc (default) or desc.

Available options:
asc,
desc
status
string

Exact status to keep: draft, running, finished or cancelled. Other values are accepted and match nothing.

type
string

Exact type to keep. New transfers are all created as complex; simple exists only on old data.

motif
string

Case-insensitive 'contains' filter on the reason (motif) of the transfer.

Response

Paginated set of TransferResource

data
TransferResource · object[]
required

Transfers of the page.

meta
object
required

Cursor pagination information.