POST
Declare transferred goods lost
Company space Cannot be undone For: Stock keeper · Permission: transfers.resolve-loss Conditions
  • Requires the transfers.resolve-loss permission.
  • The company must own the transfer or be able to operate the destination step of the segment; the transfer must be visible to it.
  • The transfer must be running.
  • The line must have executed withdrawals and no destination reception may be recorded.
  • quantity must be between 1 and the line’s remaining quantity and cannot exceed the withdrawn quantity left.
  • type must be loss, the only supported type.
  • When sources are sent they must match the original dispatch intent.
What else happens
  • Reduces the line’s remaining quantity and withdrawn stock by the lost quantity.
  • Removes from the segment the share of route costs that belonged to the lost goods and records it on the resolution (route cost in minor units).
  • Creates the resolution, which is attached to the destination step and cannot be removed through the API.
  • The goods are not returned to stock and no stock entry is created by this call.
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).

Body

application/json
type
enum<string>
required

Kind of resolution. Only loss is supported: part of the goods withdrawn for the line will not arrive. Required.

Available options:
loss
quantity
integer
required

Quantity declared lost, in the line's unit, between 1 and the line's remaining quantity. Required.

Required range: x >= 1
reason
string | null

Optional free text explaining the loss.

sources
object[] | null

Optional choice of the dispatched sources the lost quantity is taken from. Entries must match the original dispatch plan; when omitted the server picks the withdrawn stock itself.

Minimum array length: 1

Response

TransferLineResolutionResource

id
string
required

Identifier of the resolution (27-character KSUID).

transfer_id
string
required

Identifier of the transfer.

transfer_line_id
string
required

Identifier of the line the loss is declared on.

transfer_step_id
string
required

Destination step of the line's segment, where the goods were expected.

type
string
required

Kind of resolution; only loss exists.

quantity
integer
required

Quantity declared lost, in the line's unit.

reason
string | null
required

Free text given with the declaration; null when none.

company_id
string
required

Identifier of the company the record belongs to.

creator_user_id
string | null
required

Member who recorded the declaration; 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).