Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Transaction → Get

AI-generated

Summary

Retrieves a single Sharetribe transaction.

Inputs

  • transactionId (required) — Unique identifier of the transaction to retrieve.
  • simplify — If true, returns a simplified response with fewer fields.
  • transactionFields — List of transaction attributes to include; can be specified via expression.
  • listingFields — Attributes of the associated listing to include when simplify is false.
  • userFields — Attributes of the customer or provider user to include when simplify is false.

Output shape

a single transaction object

When simplify is true the response is reduced; otherwise full transaction data is returned. The result may contain only the fields specified by transactionFields, listingFields, and userFields.

Examples

Example 1: Fetch a transaction by its ID and return simplified fields.

transactionId = '550e8400-e29b-41d4-a716-446655440000', simplify = true

Example 2: Get a transaction with specific listing and user fields.

transactionId = '...', transactionFields = ['booking','createdAt'], listingFields = ['title'], userFields = ['email']

Example 3: Retrieve a transaction with default settings.

transactionId = '...'; simplify = true (default)

Links

Discussion