GET
View a transfer segment
Company space For: Stock keeper · Permission: transfer_segments.retrieve Conditions
  • The transfer must be visible to the current company (owned, or non-draft with a step on a location the company can use).
  • Segment costs are only shown to the company that owns the transfer.
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).

Response

200 - application/json

TransferSegmentResource

id
string
required

Identifier of the segment.

transfer_id
string
required

Identifier of the transfer.

from_step_id
string
required

Step the goods leave.

to_step_id
string
required

Step the goods go to; later in the route than the source.

started_at
string<date-time> | null
required

When goods were first withdrawn for this segment, ISO 8601; null before.

ended_at
string<date-time> | null
required

When goods were first received at the destination, ISO 8601; null before.

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).

route_leg_ids
array

Identifiers of the route legs the segment travels over.

cost_total_minor
integer

Total of the segment's costs in minor units. Present only for the owner company.

from_step
TransferStepResource · object

Source step, when included.

to_step
TransferStepResource · object

Destination step, when included.

costs
TransferSegmentCostResource · object[]

Costs allocated to the segment; shown to the owner company only.

lines
TransferLineResource · object[]

Lines of goods carried by the segment.