GET
View a route leg
Company space For: Stock keeper, Manager · Permission: transfer_route_legs.retrieve Conditions
  • The transfer must be visible to the current company (owned by it, or not a draft and with a step at a location the company can use).
  • The leg must belong to the transfer. Costs and cost_total_minor are included only when the current company owns the transfer.
Part of Transport legs, vehicles and costs.

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.

route_leg
string
required

Identifier of the route leg, which must belong to the transfer.

Response

200 - application/json

TransferRouteLegResource

id
string
required

Identifier of the route leg.

transfer_id
string
required

Identifier of the transfer.

from_step_id
string
required

Step the leg starts from.

to_step_id
string
required

Step the leg arrives at; always the next step in order.

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

cost_total_minor
integer

Total of the leg's costs in minor units (divide by 10 to the power currency_exponent). Present only when costs are loaded.

costs
TransferRouteLegCostResource · object[]

Cost lines of the leg (label and amount); shown to the owner company only.

from_step
TransferStepResource · object

Starting step, when included.

to_step
TransferStepResource · object

Arrival step, when included.