GET
View a delivery item
Company space For: Buyer, Stock keeper · Permission: purchase_reception_items.retrieve Part of Receive purchased goods.

Authorizations

Authorization
string
header
required

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

Path Parameters

purchase_delivery
string
required

Identifier of the purchase delivery (27-character KSUID).

item
string
required

Identifier of the reception line (not the purchase line) of the delivery or pickup named in the path (27-character KSUID). It must belong to that reception.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, asset_id, purchase_id, item_id, reception_id, quantity, accepted_quantity, damaged_quantity, damage_stockable_unit_id, damage_reason, damage_cost_treatment, damage_cost_total, base_cost_total, allocated_purchase_leftover, allocated_landed_cost_total, cost_total, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: item, item.stockable, item.stockableUnit, damageStockableUnit, damageStockableUnit.uomUnit, damageStockableUnit.prices, damageStockableUnit.stockable.

Response

200 - application/json

Resource.

id

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

asset_id

Identifier of the location asset (warehouse or shop) where the accepted goods will be added to stock at confirmation.

purchase_id

Identifier of the purchase of the reception.

item_id

Identifier of the purchase line being received.

reception_id

Identifier of the delivery or pickup this line belongs to.

purchase_item
object | null

The purchase line, present only when requested with include=item; null otherwise.

quantity
integer

Quantity received on this line, in the purchase line's unit, damaged goods included.

accepted_quantity
integer

Quantity accepted into stock: received quantity minus damaged_quantity, expressed in the damage unit when damage_stockable_unit_id is set, otherwise in the purchase unit. Computed by the server.

damaged_quantity
integer

Quantity found damaged, in the damage unit (the purchase unit when none is set). 0 when nothing is damaged.

damage_stockable_unit_id

Identifier of the unit in which damaged_quantity is counted, or null for the purchase unit.

damage_stockable_unit
object | null

The damage unit, present only when requested with include=damageStockableUnit; null otherwise.

damage_reason

Why the goods are damaged: ordinary or exceptional. Null when nothing is damaged.

damage_cost_treatment

How the cost of the damaged goods is treated: absorbed_by_remaining_stock (kept in the cost of the accepted stock) or expensed (removed from the stock cost). Null when nothing is damaged.

damage_cost_total
number

Cost attributed to the damaged goods, in major units. 0 until the reception is confirmed.

base_cost_total
number

Commercial cost of the received quantity taken from the purchase line (tax included), in major units, before extra costs.

allocated_purchase_leftover
number

Share of the purchase's rounding leftover given to this line, in major units. 0 until the reception is confirmed.

allocated_landed_cost_total
number

Share of the reception's extra costs (and delivery fee) given to this line, in major units. 0 until the reception is confirmed.

cost_total
number

Total cost of the line, in major units: base cost plus the spread amounts, minus the damage cost when it is expensed. Equals base_cost_total until the reception is confirmed.

created_at

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

updated_at

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