Skip to main content
GET
cURL
Returns a paginated list of inventory items within the organization. valueCents is the latest valuation of the item’s product, in cents. Items appear here once they are in_vault. createdAt is when that happened. internalIdentifier is Beach’s human-readable id, distinct from id. openOutboundShipmentId is the open outbound shipment id. It is omitted when that shipment is rejected or cancelled. An in_vault item can still be on an open transfer. Create Transfer then returns Item {label} is already on another transfer request.

Authorizations

string
required
Send Bearer <token> in this header. The key needs inventory:read.

Query Parameters

number
default:"1"
number
default:"25"
string
One of in_vault, pending_transfer, pending_outbound, shipped_out.
string
cURL