GET
List purchase return items
Company space For: Buyer, Stock keeper · Permission: purchase_return_items.list Conditions
  • Only items of that return are listed.
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

purchase_return
string
required

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

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, return_id, purchase_item_id, stockable_unit_id, stock_sources, quantity, cost_total, stock_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: purchaseItem, purchaseItem.stockable, purchaseItem.stockableUnit, stockableUnit, stockableUnit.uomUnit, stockableUnit.prices, stockableUnit.stockable.

Response

200 - application/json

Resource.

data
PurchaseReturnItemResource · object[]
required

Items of this page.

meta
object
required

Pagination details.