GET
View a transfer line
Company space For: Stock keeper · Permission: transfer_lines.retrieve Conditions
  • The transfer must be visible to the current company; the line must belong to the segment in the URL.
Part of Load goods and handle losses in transit.

Authorizations

Authorization
string
header
required

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

Path Parameters

transfer
string
required

Identifier of the transfer.

segment
string
required

Identifier of the transfer segment (27-character KSUID).

line
string
required

Identifier of the transfer line (27-character KSUID).

Response

200 - application/json

TransferLineResource

id
string
required

Identifier of the line (27-character KSUID).

transfer_id
string
required

Identifier of the transfer.

transfer_segment_id
string
required

Identifier of the segment carrying the line.

stockable_id
string
required

Identifier of the item transferred.

stockable_unit_id
string | null
required

Unit of the quantities; null when they are in the base unit.

base_quantity
integer
required

Quantity planned for the line, in the line's unit.

remaining_quantity
integer
required

Quantity not yet received at the destination, in the line's unit; it decreases with receptions and loss declarations.

in_transit_quantity
integer
required

Quantity already withdrawn from stock and still on its way: equal to remaining_quantity once withdrawals are executed, otherwise 0.

created_by_company_id
string
required

Company that created the line; a rerouted line keeps the company of the original line.

creator_user_id
string | null
required

Member who created the line; null when unknown.

created_at
string<date-time>
required

Date and time the record was created (ISO 8601, UTC).

updated_at
string<date-time>
required

Date and time the record was last changed (ISO 8601, UTC).

resolutions
TransferLineResolutionResource · object[]

Loss declarations of the line; present only when loaded.

dispatches
TransferStepDispatchResource · object[]

Planned or recorded sources the goods leave from, with asset, group and quantity.

stockable
object

Summary of the item.

stockable_unit
object | null

Summary of the unit; null when the line uses the base unit.