Actions28
- Asset Actions
- Availability Exception Actions
- Event Actions
- Image Actions
- Listing Actions
- Marketplace Actions
- Stock Actions
- Transaction Actions
- User Actions
Transaction → Transition
AI-generatedSummary
Transition a Sharetribe transaction.
Inputs
- transactionId (required) — ID of the transaction to transition, e.g. 550e8400-e29b-41d4-a716-446655440000.
- transition (required) — The transition to perform on the transaction; possible values depend on the transaction state and marketplace process definitions.
- speculative — Whether to perform a dry‑run transition that returns a preview of the result without changing the transaction.
- simplify — Whether to return a simplified version of the response.
- transactionFields — Fields to include in the response; can be selected from the predefined list or specified via expression.
- listingFields — Fields to include from the associated listing; can be selected or specified via expression.
- userFields — Fields to include from the customer or provider; can be selected or specified via expression.
- params — Optional parameters required to perform the transition; provided as a fixed collection.
Output shape
A transaction object; simplified if simplify=true, otherwise full transaction data.
The returned object includes only the fields selected via transactionFields; omitted fields are omitted entirely. If simplify is false, the full transaction payload is returned.
Examples
Example 1: Transition a transaction to the next state
Set transactionId to '550e8400-e29b-41d4-a716-446655440000', transition to 'nextState', leave speculative false, simplify true, and select transactionFields ['state','lastTransition'].
Example 2: Dry‑run a transition to preview price changes
Set speculative true, provide transactionId and transition, optionally set simplify true, and optionally add params to adjust pricing.
Example 3: Retrieve full transaction details after transition
Set simplify false, choose transactionFields including 'booking','customer','lineItems','state', and provide the required transition name.