Sharetribe API Reference

https://www.sharetribe.com/api-reference
Admin
The Sharetribe API Reference provides comprehensive documentation for developers to integrate with...
Tokens:237,247
Snippets:1,206
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create Stripe Setup Intent Response (SDK)

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example response object from the SDK after creating a Stripe SetupIntent.

```javascript
// res.data
{
    data: {
        id: UUID {uuid: "5d2db7ba-f902-426b-a0a2-a94b3886a825"},
        type: "stripeSetupIntent",
        attributes: {
            stripeSetupIntentId: "seti_1Ewp1XXXXXXGQQ9xoFZb4Ypn",
            clientSecret: "seti_1Ewp1SLSea1GQQ9xoFZb4Ypn_secret_foo"
        }
    }
}
```

--------------------------------

### Create Stripe Setup Intent Request (SDK)

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example usage of the SDK to create a Stripe SetupIntent. The `expand: true` option retrieves the full resource in the response.

```javascript
sdk.stripeSetupIntents.create({}, {
  expand: true
}).then(res => {
  // res.data
});
```

--------------------------------

### Create Stripe Setup Intent Request (cURL)

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example cURL command to create a Stripe SetupIntent. Ensure you replace ACCESS_TOKEN with a valid token.

```bash
$ curl -X POST 'https://flex-api.sharetribe.com/v1/api/stripe_setup_intents/create?expand=true' \
    -H 'Accept: application/json' \
    -H 'Content-type: application/json' \
    -H 'Authorization: bearer ACCESS_TOKEN'
```

--------------------------------

### Query Bookings with JavaScript SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This JavaScript SDK example demonstrates how to query bookings by providing the listing ID and the start and end times.

```javascript
sdk.bookings.query({
  listingId: new UUID("c6ff7190-bdf7-47a0-8a2b-e3136e74334f"),
  start: new Date("2025-11-27T00:00:00.000Z"),
  end: new Date("2025-12-30T00:00:00.000Z")
}).then(res => {
  // res.data contains the response data
});
```

--------------------------------

### Show User SDK Request Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example JavaScript SDK usage to retrieve a specific user's details.

```javascript
var userId = new UUID("3c073fae-6172-4e75-8b92-f560d58cd47c");
sdk.users.show({id: userId}).then(res => {
  // res.data contains the response data
});

```

--------------------------------

### Example User Creation Response

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the full user resource returned after a successful user creation request when the `expand` parameter is used.

```json
{
  "data": {
    "id": "3c073fae-6172-4e75-8b92-f560d58cd47c",
    "type": "currentUser",
    "attributes": {
      "banned": false,
      "deleted": false,
      "state": "active",
      "createdAt": "2025-03-28T09:12:58.866Z",
      "email": "joe.dunphy@example.com",
      "emailVerified": false,
      "pendingEmail": null,
      "stripeConnected": false,
      "stripePayoutsEnabled": false,
      "stripeChargesEnabled": false,
      "profile": {
        "firstName": "Joe",
        "lastName": "Dunphy",
        "displayName": "Dunphy Co.",
        "abbreviatedName": "JD",
        "bio": "Hello, I am Joe.",
        "publicData": {
          "age": 27
        },
        "protectedData": {
          "phoneNumber": "+1-202-555-5555"
        },
        "privateData": {
          "discoveredServiceVia": "Twitter"
        },
        "metadata": {}
      }
    }
  }
}

```

--------------------------------

### Marketplace Show Response Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the response received when requesting marketplace details.

```json
{
  "data": {
    "id": "16c6a4b8-88ee-429b-835a-6725206cd08c",
    "type": "marketplace",
    "attributes": {
      "name": "My Marketplace",
      "description": "My marketplace"
    }
  }
}
```

```javascript
// res.data
{
  data: {
    id: UUID {uuid: "16c6a4b8-88ee-429b-835a-6725206cd08c"},
    type: "marketplace",
    attributes: {
      name: "My Marketplace",
      description: "My marketplace"
    }
  }
}
```

--------------------------------

### Query Availability Exceptions with SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This JavaScript SDK example demonstrates how to query availability exceptions. It requires the listingId, start, and end times to be provided as arguments.

```javascript
sdk.availabilityExceptions.query({
  listingId: new UUID("c6ff7190-bdf7-47a0-8a2b-e3136e74334f"),
  start: new Date("2025-11-27T00:00:00.000Z"),
  end: new Date("2025-12-30T00:00:00.000Z")
}).then(res => {
  // res.data contains the response data
});
```

--------------------------------

### Create User Response Example (SDK)

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example of the response data structure when using the Sharetribe SDK to create a user with an identity provider.

```javascript
// res.data
{
  data: {
    id: UUID {uuid: "3c073fae-6172-4e75-8b92-f560d58cd47c"},
    type: "currentUser",
    attributes: {
      banned: false,
      deleted: false,
      state: "active",
      createdAt: new Date("2025-03-28T09:12:58.866Z"),
      email: "joe.dunphy@example.com",
      emailVerified: false,
      pendingEmail: null,
      stripeConnected: false,
      stripePayoutsEnabled: false,
      stripeChargesEnabled: false,
      identityProviders: {
        facebook: {
          userId: "11223344"
        }
      },
      profile: {
        firstName: "Joe",
        lastName: "Dunphy",
        displayName: "Dunphy Co.",
        abbreviatedName: "JD",
        bio: "Hello, I am Joe.",
        publicData: {
          age: 27
        },
        protectedData: {
          phoneNumber: "+1-202-555-5555"
        },
        privateData: {
          discoveredServiceVia: "Twitter"
        },
        metadata: {}
      }
    }
  }
}

```

--------------------------------

### Example Transaction Transition Response

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of a successful response when transitioning a transaction. It includes details about the transaction's state, pricing, and transition history.

```json
{
  "data": {
    "id": "ef98e897-5b81-49a5-aca6-01d9759df075",
    "type": "transaction",
    "attributes": {
      "createdAt": "2025-03-27T12:30:02.000Z",
      "processName": "default-booking",
      "processVersion": 3,
      "lastTransition": "transition/accept",
      "lastTransitionedAt": "2025-03-27T13:35:03.100Z",
      "state": "state/accepted",
      "payinTotal": {
        "amount": 6360,
        "currency": "USD"
      },
      "payoutTotal": {
        "amount": 5724,
        "currency": "USD"
      },
      "lineItems": [
        {
          "code": "line-item/day",
          "quantity": 4,
          "units": 2,
          "seats": 2,
          "reversal": false,
          "unitPrice": {
            "amount": 1590,
            "currency": "USD"
          },
          "lineTotal": {
            "amount": 6360,
            "currency": "USD"
          },
          "includeFor": [
            "customer",
            "provider"
          ]
        },
        {
          "code": "line-item/provider-commission",
          "percentage": -10.0,
          "reversal": false,
          "unitPrice": {
            "amount": 6360,
            "currency": "USD"
          },
          "lineTotal": {
            "amount": -636,
            "currency": "USD"
          },
          "includeFor": [
            "provider"
          ]
        }
      ],
      "protectedData": {},
      "transitions": [
        {
          "transition": "transition/request",
          "createdAt": "2025-03-27T12:30:03.100Z",
          "by": "customer"
        },
        {
          "transition": "transition/accept",
          "createdAt": "2025-03-27T13:35:03.100Z",
          "by": "provider"
        }
      ]
    }
  }
}

```

--------------------------------

### Example Response for Time Slot Query

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the JSON response structure when querying for available time slots. It includes details about each time slot, such as its ID, type, seats, start, and end times.

```json
{
  "data": [
    {
      "id": "d479cd2d-5890-405a-b895-20a9a1ffdde7",
      "type": "timeSlot",
      "attributes": {
        "type": "time-slot/day",
        "seats": 3,
        "start": "2025-04-19T00:00:00.000Z",
        "end": "2025-04-20T00:00:00.000Z"
      }
    },
    {
      "id": "2698b352-b7b5-4fd8-9303-31aa96957556",
      "type": "timeSlot",
      "attributes": {
        "type": "time-slot/day",
        "seats": 1,
        "start": "2025-04-22T00:00:00.000Z",
        "end": "2025-04-23T00:00:00.000Z"
      }
    },
    {
      "id": "4f0ae8dc-f08e-46da-935d-f33aab6459b0",
      "type": "timeSlot",
      "attributes": {
        "type": "time-slot/day",
        "seats": 10,
        "start": "2025-04-23T00:00:00.000Z",
        "end": "2025-04-24T00:00:00.000Z"
      }
    }
  ],
  "meta": {
    "totalItems": 3,
    "totalPages": 1,
    "page": 1,
    "perPage": 100
  }
}

```

--------------------------------

### Example User Creation Response (SDK)

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the full user resource returned after a successful user creation request when using the Sharetribe SDK with `expand: true`.

```javascript
// res.data
{
  data: {
    id: UUID {uuid: "3c073fae-6172-4e75-8b92-f560d58cd47c"},
    type: "currentUser",
    attributes: {
      banned: false,
      deleted: false,
      state: "active",
      createdAt: new Date("2025-03-28T09:12:58.866Z"),
      email: "joe.dunphy@example.com",
      emailVerified: false,
      pendingEmail: null,
      stripeConnected: false,
      stripePayoutsEnabled: false,
      stripeChargesEnabled: false,
      profile: {
        firstName: "Joe",
        lastName: "Dunphy",
        displayName: "Dunphy Co.",
        abbreviatedName: "JD",
        bio: "Hello, I am Joe.",
        publicData: {
          age: 27
        },
        protectedData: {
          phoneNumber: "+1-202-555-5555"
        },
        privateData: {
          discoveredServiceVia: "Twitter"
        },
        metadata: {}
      }
    }
  }
}

```

--------------------------------

### Initialize Sharetribe SDK

Source: https://www.sharetribe.com/api-reference/asset-delivery-api.html

Shows how to create an instance of the Sharetribe SDK for JavaScript, providing your marketplace's Client ID for authentication.

```javascript
const sharetribeSdk = require('sharetribe-flex-sdk');

const sdk = sharetribeSdk.createInstance({
  clientId: '<Your Client ID here>'
});

```

--------------------------------

### Query Stock Adjustments with SDK

Source: https://www.sharetribe.com/api-reference/integration.html

This JavaScript SDK example demonstrates how to query stock adjustments. It requires the listingId, start, and end dates to be provided as arguments to the query function.

```javascript
integrationSdk.stockAdjustments.query({
  listingId: new UUID("c6ff7190-bdf7-47a0-8a2b-e3136e74334f"),
  start: new Date("2021-09-07T00:00:00.000Z"),
  end: new Date("2021-09-10T00:00:00.000Z")
}).then(res => {
  // res.data contains the response data
});
```

--------------------------------

### Example Response for Create Listing (JSON)

Source: https://www.sharetribe.com/api-reference/integration.html

This is an example of the JSON response received after successfully creating a listing. It includes the listing's attributes and related data like images.

```json
{
  "data": {
    "id": "c6ff7190-bdf7-47a0-8a2b-e3136e74334f",
    "type": "listing",
    "attributes": {
      "description": "Brand new track bike.",
      "deleted": false,
      "geolocation": {
        "lat": 40.64542,
        "lng": -74.08508
      },
      "createdAt": "2025-03-23T08:40:24.443Z",
      "state": "published",
      "title": "Peugeot eT101",
      "availabilityPlan": null,
      "privateData": {
        "externalServiceId": "new-service-id-4324"
      },
      "publicData": {
        "address": {
          "country": "USA"
        },
        "category": "track",
        "gears": 22
      },
      "metadata": {
        "promoted": false,
        "verified": true,
        "rating": 4
      },
      "price": {
        "amount": 1590,
        "currency": "USD"
      }
    },
    "relationships": {
      "images": {
        "data": [
          {"id": "f8afadaa-dd4f-4536-b9a7-b405834dc25d", "type": "image"}
        ]
      }
    }
  },
  "included": [
    {
      "id": "f8afadaa-dd4f-4536-b9a7-b405834dc25d",
      "type": "image",
      "attributes": {
        "variants": {
          "default": {
            "width": 720,
            "height": 540,
            "url": "https://www.example.com/image/f8afadaa-dd4f-4536-b9a7-b405834dc25d"
          }
        }
      }
    }
  ]
}

```

--------------------------------

### Query Time Slots with JavaScript SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This JavaScript SDK example demonstrates how to query available time slots. It requires the listing ID, start date, and end date as parameters.

```javascript
// Query available timeslots between 19th and 24th
// assuming there is a booking from 20th to 22nd.
sdk.timeslots.query({
  listingId: new UUID("c6ff7190-bdf7-47a0-8a2b-e3136e74334f"),
  start: new Date("2025-04-19T00:00:00.000Z"),
  end: new Date("2025-04-24T00:00:00.000Z")
}).then(res => {
  // res.data comains the response data
});

```

--------------------------------

### Query Users with Integration SDK

Source: https://www.sharetribe.com/api-reference/integration.html

This example shows how to query users using the integration SDK. The response data is available in the `res.data` property.

```javascript
var userId = new UUID("3c073fae-6172-4e75-8b92-f560d58cd47c");
integrationSdk.users.query().then(res => {
  // res.data contains the response data
});

```

--------------------------------

### Example Booking Resource (JSON)

Source: https://www.sharetribe.com/api-reference/integration.html

This snippet shows the structure of a booking resource as returned by the API in JSON format. It includes details like seats, start and end times, and the booking state.

```json
{
  "data": {
    "id": "5a3e765a-06ea-4ca6-ba7f-f394ad2888a1",
    "type": "booking",
    "attributes": {
      "seats": 3,
      "start": "2025-04-20T00:00:00.000Z",
      "end": "2025-04-22T00:00:00.000Z",
      "displayStart": "2025-04-20T18:00:00.000Z",
      "displayEnd": "2025-04-22T10:00:00.000Z",
      "state": "accepted"
    }
  }
}
```

--------------------------------

### Create Stripe Setup Intents

Source: https://www.sharetribe.com/api-reference/marketplace.html

Creates a Stripe SetupIntent object to set up a customer's payment methods.

```APIDOC
## POST /stripeSetupIntents

### Description
Creates a Stripe SetupIntent object to set up a customer's payment methods.

### Method
POST

### Endpoint
/stripeSetupIntents
```

--------------------------------

### Query Stock Adjustments with cURL

Source: https://www.sharetribe.com/api-reference/integration.html

Use this cURL command to make a GET request to the stock adjustments query endpoint. Ensure you replace ACCESS_TOKEN with your valid token and provide the correct listingId, start, and end timestamps.

```bash
$ curl 'https://flex-integ-api.sharetribe.com/v1/integration_api/stock_adjustments/query?listingId=c6ff7190-bdf7-47a0-8a2b-e3136e74334f&start=2021-09-07T00:00:00.000Z&end=2021-09-10T00:00:00.000Z' \
    -H 'Accept: application/json' \
    -H 'Authorization: bearer ACCESS_TOKEN'
```

--------------------------------

### Create User with Sharetribe SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This JavaScript example demonstrates how to create a user using the Sharetribe SDK. The `expand: true` option returns the full user resource.

```javascript
sdk.currentUser.create({
  email: "joe.dunphy@example.com",
  password: "secret-pass",
  firstName: "Joe",
  lastName: "Dunphy",
  displayName: "Dunphy Co.",
  bio: "Hello, I am Joe.",
  publicData: {
    age: 27
  },
  protectedData: {
    phoneNumber: "+1-202-555-5555"
  },
  privateData: {
    discoveredServiceVia: "Twitter"
  }
}, {
  expand: true
}).then(res => {
  // res.data
});

```

--------------------------------

### Password Reset Response Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example response after resetting a password.

```json
{
  "data": {
    "id": "852e1b31-dc67-438b-8ef4-c1b75845c0b6",
    "type": "passwordReset"
  }
}

```

```javascript
{
  data: {
    id: UUID {uuid: "852e1b31-dc67-438b-8ef4-c1b75845c0b6"},
    type: "passwordReset"
  }
}

```

--------------------------------

### Transition Transaction with JavaScript SDK

Source: https://www.sharetribe.com/api-reference/integration.html

Use the integration SDK to transition a transaction. This example shows how to accept a transaction. The `expand: true` option can be used to include expanded data in the response.

```javascript
// Example transition assuming a process where the operator accepts transactions
integrationSdk.transactions.transition({
  id: new UUID("ef98e897-5b81-49a5-aca6-01d9759df075"),
  transition: "transition/accept",
  params: {}
}, {
  expand: true
}).then(res => {
  // res.data contains the response data
});

```

```javascript
// res.data
{
  data: {
    id: UUID {uuid: "ef98e897-5b81-49a5-aca6-01d9759df075"},
    type: "transaction",
    attributes: {
      createdAt: new Date("2025-03-27T12:30:02.000Z"),
      processName: "default-booking",
      processVersion: 3,
      lastTransition: "transition/accept",
      lastTransitionedAt: new Date("2025-03-27T13:35:03.100Z"),
      state: "state/accepted",
      payinTotal: {
        amount: 6360,
        currency: "USD"
      },
      payoutTotal: {
        amount: 5724,
        currency: "USD"
      },
      lineItems: [
        {
          code: "line-item/day",
          quantity: 4,
          units: 2,
          seats: 2,
          reversal: false,
          unitPrice: {
            amount: 1590,
            currency: "USD"
          },
          lineTotal: {
            amount: 6360,
            currency: "USD"
          },
          includeFor: [
            "customer",
            "provider"
          ]
        },
        {
          code: "line-item/provider-commission",
          percentage: -10.0,
          reversal: false,
          unitPrice: {
            amount: 6360,
            currency: "USD"
          },
          lineTotal: {
            amount: -636,
            currency: "USD"
          },
          includeFor: [
            "provider"
          ]
        }
      ],
      protectedData: {},
      transitions: [
        {
          transition: "transition/request",
          createdAt: new Date("2025-03-27T12:30:03.100Z"),
          by: "customer"
        },
        {
          transition: "transition/accept",
          createdAt: new Date("2025-03-27T13:35:03.100Z"),
          by: "operator"
        }
      ]
    }
  }
}

```

--------------------------------

### Marketplace Resource JSON Example

Source: https://www.sharetribe.com/api-reference/integration.html

This is an example of the marketplace resource in JSON format.

```json
{
  "data": {
    "id": "16c6a4b8-88ee-429b-835a-6725206cd08c",
    "type": "marketplace",
    "attributes": {
      "name": "My Marketplace",
      "description": "My marketplace"
    }
  }
}
```

```javascript
{
  data: {
    id: UUID {uuid: "16c6a4b8-88ee-429b-835a-6725206cd08c"},
    type: "marketplace",
    attributes: {
      name: "My Marketplace",
      description: "My marketplace"
    }
  }
}
```

--------------------------------

### Create Listing with SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

Use the Sharetribe SDK to programmatically create a new listing. This example demonstrates how to structure the data for the `create` method.

```javascript
sdk.ownListings.create({
  title: "Peugeot eT101",
  description: "7-speed Hybrid",
  geolocation: new LatLng(40.64542, -74.08508),
  availabilityPlan: {
    type: "availability-plan/day",
    entries: [
      {
        dayOfWeek: "mon",
        seats: 3
      },
      {
        dayOfWeek: "fri",
        seats: 1
      }
    ]
  },
  privateData: {
    externalServiceId: "abcd-service-id-1234"
  },
  publicData: {
    address: {
      city: "New York",
      country: "USA",
      state: "NY",
      street": "230 Hamilton Ave"
    },
    category: "road",
    gears: 22,
    rules: "This is a nice, bike! Please, be careful with it."
  },
  price: new Money(1590, "USD"),
  images: [
    new UUID("6a177221-247e-42a9-9cca-403238b86d7c"),
    new UUID("f8afadaa-dd4f-4536-b9a7-b405834dc25d")
  ],
  protectedFileAttachments: [
    {fileId: new UUID("b5dcf48f-c74b-4b5b-ae76-98d9e5a84d85")}
  ]
}, {
  expand: true,
  include: ["images"]
}).then(res => {
  // res.data
});

```

--------------------------------

### Password Reset Request Response Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example response after requesting a password reset.

```json
{
  "data": {
    "id": "04dea6b2-f7af-4896-b6df-aaabf012a80e",
    "type": "passwordReset"
  }
}

```

```javascript
{
  data: {
    id: UUID {uuid: "04dea6b2-f7af-4896-b6df-aaabf012a80e"},
    type: "passwordReset"
  }
}

```

--------------------------------

### Password Reset API Resource Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example of the passwordReset API resource type.

```json
{
  "data": {
    "id": "04dea6b2-f7af-4896-b6df-aaabf012a80e",
    "type": "passwordReset",
    "attributes": {}
  }
}

```

```javascript
{
  data: {
    id: UUID {uuid: "04dea6b2-f7af-4896-b6df-aaabf012a80e"},
    type: "passwordReset",
    attributes: {}
  }
}

```

--------------------------------

### Create Stripe Customer via Sharetribe SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This example demonstrates how to create a Stripe customer using the Sharetribe SDK. It shows how to pass the payment method ID and optional query parameters.

```javascript
sdk.stripeCustomer.create({
  stripePaymentMethodId: "pm_1EmfL3LSea1GQQ9xudUuun1q"
}, {
  expand: true,
  include: "defaultPaymentMethod"
}).then(res => {
  // res.data
});

```

--------------------------------

### User Resource JavaScript Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the JavaScript object structure for a user resource.

```javascript
{
  data: {
    id: UUID {uuid: "3c073fae-6172-4e75-8b92-f560d58cd47c"},
    type: "user",
    attributes: {
      banned: false,
      deleted: false,
      state: "active",
      createdAt: new Date("2025-03-28T09:12:58.866Z"),
      profile: {
        displayName: "Joe D",
        abbreviatedName: "JD",
        bio: "Hello, I'm Joe.",
        publicData: {
          age: 27
        },
        metadata: {
          verified: true
        }
      }
    }
  }
}

```

--------------------------------

### Initiate Transaction with Sharetribe SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

Initiate a transaction using the Sharetribe SDK. This example demonstrates how to pass transaction parameters and handle the response. Assumes a process with daily booking and preauthorization.

```javascript
// Example initiation assuming a process with daily booking
// and preauthorization.
sdk.transactions.initiate({
  processAlias: "default-booking/release-1",
  transition: "transition/request",
  params: {
    listingId: "c6ff7190-bdf7-47a0-8a2b-e3136e74334f",
    bookingStart: new Date("2025-04-20T00:00:00.000Z"),
    bookingEnd: new Date("2025-04-22T00:00:00.000Z"),
    seats: 2,
    cardToken: "tok_mastercard"
  }
}, {
  expand: true
}).then(res => {
  // res.data contains the response data
});

```

--------------------------------

### Example response for sending verification email

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of a successful response when sending a verification email.

```json
{
  "data": {
    "id": "3c073fae-6172-4e75-8b92-f560d58cd47c",
    "type": "currentUser"
  }
}

```

--------------------------------

### Example Response for Single Asset

Source: https://www.sharetribe.com/api-reference/asset-delivery-api.html

This is an example of the JSON response structure when retrieving a single asset.

```json
{
  "data": {
    "exampleString": "example asset data",
    "exampleArray": ["item1", "item2"]
  },
  "meta": {
    "version": "abcd"
  }
}

```

--------------------------------

### Query Listings with SDK

Source: https://www.sharetribe.com/api-reference/marketplace.html

This JavaScript SDK example demonstrates how to search for listings using parameters like origin, price, and public data attributes. The results are returned in a Promise, with the data available in the `res.data` property.

```javascript
// Search all listings, ordered by distance from given location,
// matching only listings with `publicData.gears` less than 23
// and price amount between 14.00 and 16.00.
var origin = new LatLng(40.0, -74.0);
sdk.listings.query({
  origin: origin,
  price: "1400,1600",
  pub_gears: ",23"
}).then(res => {
  // res.data contains the response data
});
```

--------------------------------

### Example Booking Query Response

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the JSON response structure when querying bookings, showing booking details and metadata.

```json
{
  "data": [
    {
      "id": "5a3e765a-06ea-4ca6-ba7f-f394ad2888a1",
      "type": "booking",
      "attributes": {
        "seats": 3,
        "start": "2025-04-20T00:00:00.000Z",
        "end": "2025-04-22T00:00:00.000Z",
        "displayStart": "2025-04-20T18:00:00.000Z",
        "displayEnd": "2025-04-22T10:00:00.000Z",
        "state": "accepted"
      }
    },
    {"...": "..."},
    {"...": "..."}
  ],
  "meta": {
    "totalItems": 5,
    "totalPages": 1,
    "page": 1,
    "perPage": 100
  }
}
```

--------------------------------

### Show Marketplace API Example

Source: https://www.sharetribe.com/api-reference/marketplace.html

Example of how to call the 'show' endpoint of the Marketplace API using curl. Ensure a valid access token is included in the Authorization header.

```bash
$ curl -X GET 'https://flex-api.sharetribe.com/v1/api/marketplace/show' \
    -H 'Authorization: bearer ACCESS_TOKEN'

```

--------------------------------

### Example Image Upload Response

Source: https://www.sharetribe.com/api-reference/integration.html

This is an example of a successful response when uploading an image. It includes the image ID and variant details.

```json
{
  "data": {
    "id": "5a8f34f6-202c-4916-af7a-53d56004e872",
    "type": "image",
    "attributes": {
      "variants": {
        "default": {
          "width": 720,
          "height": 540,
          "url": "https://www.example.com/images/5a8f34f6-202c-4916-af7a-53d56004e872"
        }
      }
    }
  }
}

```

--------------------------------

### Example HTTP Response for Open Listing

Source: https://www.sharetribe.com/api-reference/integration.html

This is a sample JSON response when successfully opening a listing with the `expand=true` parameter. It includes all attributes of the listing.

```json
{
  "data": {
    "id": "c6ff7190-bdf7-47a0-8a2b-e3136e74334f",
    "type": "listing",
    "attributes": {
      "description": "7-speed Hybrid",
      "deleted": false,
      "geolocation": {
        "lat": 40.64542,
        "lng": -74.08508
      },
      "createdAt": "2025-03-23T08:40:24.443Z",
      "state": "published",
      "title": "Peugeot eT101",
      "availabilityPlan": null,
      "privateData": {
        "externalServiceId": "abcd-service-id-1234"
      },
      "publicData": {
        "address": {
          "city": "New York",
          "country": "USA",
          "state": "NY",
          "street": "230 Hamilton Ave"
        },
        "category": "road",
        "gears": 22,
        "rules": "This is a nice, bike! Please, be careful with it."
      },
      "metadata": {
        "promoted": true
      },
      "price": {
        "amount": 1590,
        "currency": "USD"
      }
    }
  }
}

```

--------------------------------

### Fetch Listing with Image Variants

Source: https://www.sharetribe.com/api-reference/marketplace.html

This example demonstrates how to fetch a listing and include specific image variants, including a custom-defined one. It shows the cURL command and the equivalent SDK call.

```APIDOC
## GET /v1/api/listings/show

### Description
Fetches a listing and allows specifying image variants to be included in the response. This includes predefined variants and custom variants defined in the request.

### Method
GET

### Endpoint
/v1/api/listings/show

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the listing to show.
- **include** (string) - Optional - Specifies related resources to include, e.g., `images`.
- **fields.image** (string) - Optional - Comma-separated list of image variants to include, e.g., `variants.square-small,variants.my-variant`.
- **imageVariant.[VARIANT NAME]** (string) - Optional - Defines a custom image variant. Format is semicolon-separated key-value pairs, e.g., `w:320;h:640;fit:scale`.
  - **w** (integer) - Optional - Image width (8-3072).
  - **h** (integer) - Optional - Image height (8-3072).
  - **fit** (string) - Optional - Fit mode (`scale` or `crop`).

### Request Example
```bash
curl 'https://flex-api.sharetribe.com/v1/api/listings/show?id=c6ff7190-bdf7-47a0-8a2b-e3136e74334f&include=images&fields.image=variants.square-small,variants.my-variant&imageVariant.my-variant=w:320;h:640;fit:scale' \
    -H 'Accept: application/json' \
    -H 'Authorization: bearer ACCESS_TOKEN'
```

### Response
#### Success Response (200)
- **data** (object) - The listing object.
  - **id** (string) - The listing ID.
  - **type** (string) - The resource type (`listing`).
  - **attributes** (object) - Listing attributes.
  - **relationships** (object) - Relationships to other resources.
    - **images** (object) - Image relationship data.
      - **data** (array) - Array of image objects.
        - **id** (string) - Image ID.
        - **type** (string) - Resource type (`image`).
- **included** (array) - Included related resources.
  - **id** (string) - Image ID.
  - **type** (string) - Resource type (`image`).
  - **attributes** (object) - Image attributes.
    - **variants** (object) - Available image variants.
      - **[VARIANT NAME]** (object) - Specific variant details.
        - **height** (integer) - Variant height.
        - **width** (integer) - Variant width.
        - **url** (string) - URL of the variant image.
        - **name** (string) - Name of the variant.

#### Response Example
```json
{
  "data": {
    "id": "c6ff7190-bdf7-47a0-8a2b-e3136e74334f",
    "type": "listing",
    "attributes": {...},
    "relationships": {
      "images": {
        "data": [
          {
            "id": "4617c584-edfd-49e9-be43-2f1d50fb6e35",
            "type": "image"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "4617c584-edfd-49e9-be43-2f1d50fb6e35",
      "type": "image",
      "attributes": {
        "variants": {
          "my-variant": {
            "height": 640,
            "width": 320,
            "url": "https://www.example.com/image/5f2a6d44-c826-4a20-aae8-4c24b80b8dc6",
            "name": "my-variant"
          },
          "square-small": {
            "height": 240,
            "width": 240,
            "url": "https://www.example.com/image/5f2a6d65-28fe-49c5-9218-8c6a3924349a",
            "name": "square-small"
          }
        }
      }
    }
  ]
}
```
```

--------------------------------

### Example API Response for Messages

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example of the JSON response structure when querying messages. It includes message data and pagination metadata.

```json
{
  "data": [
    {
      "id": "1ce7eeb5-f60b-4119-bf37-d5a6f04e1dd3",
      "type": "message",
      "attributes": {
        "content": "Sure! I haven't changed them yet.",
        "createdAt": "2025-03-28T10:04:01.324Z",
        "deleted": false
      }
    },
    {
      "id": "efe37293-5e58-4f8d-8507-64616e34d22e",
      "type": "message",
      "attributes": {
        "content": "Hello,\n\nDoes the bike have winter tyres? Snow is back.",
        "createdAt": "2025-03-28T09:12:58.866Z",
        "deleted": false
      }
    }
  ],
  "meta": {
    "totalItems": 2,
    "totalPages": 1,
    "page": 1,
    "perPage": 100
  }
}
```

--------------------------------

### Image Resource Example (SDK)

Source: https://www.sharetribe.com/api-reference/integration.html

This is the SDK representation of an image resource, detailing its ID and various image variants.

```javascript
{
  data: {
    id: UUID {uuid: "5a8f34f6-202c-4916-af7a-53d56004e872"},
    type: "image",
    attributes: {
      variants: {
        default: {
          name: "default",
          width: 720,
          height: 540,
          url: "https://www.example.com/images/5a8f34f6-202c-4916-af7a-53d56004e872"
        },
        "landscape-crop": {
          name: "landscape-crop",
          width: 800,
          height: 600,
          url: "https://www.example.com/images/5a8f34f6-202c-4916-af7a-53d56004e872?v=landscape-crop"
        },
        "landscape-crop2x": {
          name: "landscape-crop2x",
          width: 1600,
          height: 1200,
          url: "https://www.example.com/images/5a8f34f6-202c-4916-af7a-53d56004e872?v=landscape-crop2x"
        }
      }
    }
  }
}
```

--------------------------------

### Example Transaction Query Response (JSON)

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example JSON response for a transaction query, showing the structure of transaction data and metadata.

```json
{
  "data": [
    {
      "id": "ef98e897-5b81-49a5-aca6-01d9759df075",
      "type": "transaction",
      "attributes": {
        "createdAt": "2025-03-27T12:30:02.000Z",
        "processName": "default-booking",
        "processVersion": 3,
        "lastTransition": "transition/request",
        "lastTransitionedAt": "2025-03-27T12:30:03.100Z",
        "state": "state/pending",
        "payinTotal": {
          "amount": 6360,
          "currency": "USD"
        },
        "payoutTotal": {
          "amount": 5724,
          "currency": "USD"
        },
        "lineItems": [
          {
            "code": "line-item/day",
            "quantity": 4,
            "units": 2,
            "seats": 2,
            "reversal": false,
            "unitPrice": {
              "amount": 1590,
              "currency": "USD"
            },
            "lineTotal": {
              "amount": 6360,
              "currency": "USD"
            },
            "includeFor": [
              "customer",
              "provider"
            ]
          },
          {
            "code": "line-item/provider-commission",
            "percentage": -10.0,
            "reversal": false,
            "unitPrice": {
              "amount": 6360,
              "currency": "USD"
            },
            "lineTotal": {
              "amount": -636,
              "currency": "USD"
            },
            "includeFor": [
              "provider"
            ]
          }
        ],
        "protectedData": {},
        "transitions": [
          {
            "transition": "transition/request",
            "createdAt": "2025-03-27T12:30:03.100Z",
            "by": "customer"
          }
        ]
      }
    },
    {...},
    {...}
  ],
  "meta": {
    "totalItems": 3,
    "totalPages": 1,
    "page": 1,
    "perPage": 100
  }
}
```

--------------------------------

### Example Transaction Initiation Response (JSON)

Source: https://www.sharetribe.com/api-reference/marketplace.html

This is an example JSON response for a successfully initiated transaction. It includes transaction details, state, pricing, and line items.

```json
{
  "data": {
    "id": "ef98e897-5b81-49a5-aca6-01d9759df075",
    "type": "transaction",
    "attributes": {
      "createdAt": "2025-03-27T12:30:02.000Z",
      "processName": "default-booking",
      "processVersion": 3,
      "lastTransition": "transition/request",
      "lastTransitionedAt": "2025-03-27T12:30:03.100Z",
      "state": "state/pending",
      "payinTotal": {
        "amount": 6360,
        "currency": "USD"
      },
      "payoutTotal": {
        "amount": 5724,
        "currency": "USD"
      },
      "lineItems": [
        {
          "code": "line-item/day",
          "quantity": 4,
          "units": 2,
          "seats": 2,
          "reversal": false,
          "unitPrice": {
            "amount": 1590,
            "currency": "USD"
          },
          "lineTotal": {
            "amount": 6360,
            "currency": "USD"
          },
          "includeFor": [
            "customer",
            "provider"
          ]
        },
        {
          "code": "line-item/provider-commission",
          "percentage": -10.0,
          "reversal": false,
          "unitPrice": {
            "amount": 6360,
            "currency": "USD"
          },
          "lineTotal": {
            "amount": -636,
            "currency": "USD"
          },
          "includeFor": [
            "provider"
          ]
        }
      ],
      "protectedData": {},
      "transitions": [
        {
          "transition": "transition/request",
          "createdAt": "2025-03-27T12:30:03.100Z",
          "by": "customer"
        }
      ]
    }
  }
}

```
Tokens:
Raw