Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Listing → Create

AI-generated

Summary

Create a new listing

Inputs

  • simplify — Whether to return a simplified version of the response
  • fieldsToReturn — Choose from the list, or specify IDs using an expression.
  • authorFields — Choose from the list, or specify IDs using an expression.
  • title (required) — Title of the listing
  • authorId (required) — ID of the user to whom the listing belongs
  • state (required) — State of the listing
  • listingFields — Optional fields to include in the created listing (sub-collection).
  • description — Description of the listing
  • geolocation — Origin in format: "latitude,longitude"
  • images — Comma-separated list of image IDs
  • metadata — Metadata (merged on the top level).
  • privateData — Private data (merged on the top level).
  • publicData — Public data (merged on the top level).
  • price — Price amount and currency details (minor units).

Output shape

a single created Listing object

All fields of the created listing are returned; the simplify flag may omit some fields; errors return a standard error envelope.

Examples

Example 1: Create a new listing with a title and assign it to a user.

Set title to 'Cozy Studio', authorId to '550e8400-e29b-41d4-a716-446655440000', state to 'pendingApproval', simplify to true.

Example 2: Create a listing with optional fields and price details.

Set fieldsToReturn to ['title','price'], price amount to 25000, currency to 'USD', include description 'Bright apartment', geolocation '40.7128,-74.0060'.

Example 3: Create a listing and request a simplified response.

Set simplify to false, fieldsToReturn to ['title','price'], privateData with a custom field.

Links

Discussion