Actions28
- Asset Actions
- Availability Exception Actions
- Event Actions
- Image Actions
- Listing Actions
- Marketplace Actions
- Stock Actions
- Transaction Actions
- User Actions
Stock → Get Reservation
AI-generatedSummary
Retrieve a stock reservation by ID with optional simplification and selectable fields.
Inputs
- stockReservationId (required) — The ID of the stock reservation to show
- simplify — Whether to return a simplified version of the response
- stockFields — Choose which stock-related fields to return, or specify IDs using an expression
- listingFields — Choose which listing author fields to return, or specify IDs using an expression
- transactionFields — Choose which transaction fields to return, or specify IDs using an expression
- userFields — Choose which author/customer/provider fields to return, or specify IDs using an expression
Output shape
a single stock reservation record with fields defined by the selected options
Only the fields explicitly selected via the multiOptions parameters are included; when simplify is true a reduced set is returned; the response is not paginated.
Examples
Example 1: Fetch a reservation with a known ID, returning only quantity and state in simplified mode
stockReservationId = "550e8400-e29b-41d4-a716-446655440000", simplify = true, stockFields = ["quantity","state"]
Example 2: Fetch a reservation without simplification, requesting listing and transaction details
stockReservationId = "550e8400-e29b-41d4-a716-446655440000", simplify = false, stockFields = ["listing"], listingFields = ["title","state"], transactionFields = ["state","lastTransition"]
Example 3: Fetch a reservation and include author fields in the response
stockReservationId = "550e8400-e29b-41d4-a716-446655440000", simplify = false, stockFields = ["listing"], userFields = ["firstName","lastName","email"]