GET
View a vendor return
Company space For: Buyer, Stock keeper · Permission: vendor_returns.retrieve Part of Return goods to suppliers.

Authorizations

Authorization
string
header
required

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

Path Parameters

vendor_return
string
required

Identifier of the vendor return (27-character KSUID string).

Response

200 - application/json

VendorReturnResource

id
string
required

Identifier of the supplier return (27-character KSUID string).

vendor_id
string
required

Identifier of the supplier the goods go back to.

reference
string | null
required

Free reference of the return, unique among the company's supplier returns.

status
string
required

Lifecycle status: draft while it can still be edited or deleted, confirmed once the goods have left stock.

replacement_expected
boolean
required

Whether a replacement was expected. Always false today: replacement tracking is not supported.

returned_at
string<date-time> | null
required

Date and time the return was confirmed (ISO 8601); null while it is a draft.

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

items
VendorReturnItemResource · object[]

Lines of the return, when loaded (they are on the show, create, update and confirm answers and on each item of the list).