Sharetribe API changes

2024-10-08

Added

• Add read permission to currentUser permissionSet in the Marketplace API.
• Add read permission to user permissionSet in the Integration API.
• New Integration API endpoint /users/update_permissions

2024-10-02

Added

• Add initiateTransactions permission to currentUser permissionSet in the Marketplace API.
• Add initiateTransactions permission to user permissionSet in the Integration API.

2024-08-27

Added

• Add attribute state to the currentUser resource in the Marketplace API.
• Add attribute state to the user resource in the Marketplace API.
• Add attribute state to the user resource in the Integration API.

Deprecated

• The banned flag in the currentUser and user resources in the Marketplace API, and in the user resource in the Integration API, is now deprecated. Use state instead.

2024-08-16

Added

• Add support for new query parameters ids keywords origin bounds price publicData metadata start end seats availability minDuration stockMode minStock sort states in the Marketplace API /own_listings/query endpoint.

2024-08-14

Added

• Add attribute permissions and relationship effectivePermissionSet for the currentUser resource in the Marketplace API.
• Add attribute permissions and relationship effectivePermissionSet for the user resource in the Integration API.

2024-05-20

Added

• Add support for passing collection options (collectionOptions parameter) when creating Stripe Account Links with the /stripe_account_links/create Marketplace API endpoint.

Deprecated

• The collect parameters in the /stripe_account_links/create Marketplace API endpoint is now deprecated. Use collectionOptions instead.

2024-04-25

Changed

• User display name can now be reset to default value. Affected endpoints:
  • /current_user/update_profile in Marketplace API
  • /users/update_profile in Integration API

2023-10-16

Added

• Add /sitemap_data/query_listings and /sitemap_data/query_assets API endpoints to Marketplace API.

2023-08-30

Added

• Add support for an additional query parameter stockMode in the Marketplace API /listings/query and the Integration API /listings/query API endpoints.

2023-05-09

Added

• Add support for querying multiple assets

2023-03-06

Added

• Add support for additional query parameters userId, listingId, createdAtStart, createdAtEnd and processNames in the Marketplace API /transactions/query API endpoint.

2023-02-14

Added

• Add documentation for asset references in Asset Delivery API.

2023-01-17

Fixed

• Fix an issue that prevented the listing search from working with negative numbers as search parameters

2022-12-21

Changed

• Document API rate limits that come into effect. See:
  • API rate limits introduction
  • Rate limits in the Marketplace API
  • Rate limits in the Integration API

2022-05-16

• Add reference for the new Asset Delivery API.

2022-05-03

Added

• Add support for creating a listing in the Integration API via the /listings/create endpoint.

Fixed

• Fix issue causing several Marketplace and Integration API endpoints to ignore the limit.* and fields.* query parameters.

2022-04-05

Fixed

• Integration API's /users/show now treats the email query parameter as case insensitive, as the rest of the APIs.

2022-03-23

Added

• Add support for deleting a user in the Marketplace API /current_user/delete endpoint using trusted token.

Changed

• The /transactions/transition and /transactions/transition_speculative command endpoints in the Marketplace API now return appropriate error code if either party of the transaction is a banned or deleted user.
• The /transactions/transition and /transactions/transition_speculative command endpoints in the Integration API now return appropriate error code if either party of the transaction is a banned or deleted user.

2021-12-16

Added

• Add support for filtering users by extended data in the Integration API /users/query endpoint.
• Add support for sorting of users by numeric extended data in the Integration API /users/query endpoint.
• Add paginationLimit to API response meta where applicable. Update documentation on pagination limits in some API requests. See pagination section.

2021-10-08

Changed

• Change /listings/query to return no listings if ids parameter is empty. Earlier, the API ignored ids filter if the value was empty.

2021-09-22

Added

Add support for ids query parameter in the /listings/query endpoints in both the Marketplace API and the Integration API.

2021-09-20

Added

Add support for listing stock management:

• Add new resource type stockAdjustment in the Marketplace API and the Integration API and new API endpoints:
  • /stock_adjustments/create in the Marketplace API and the Integration API
  • /stock_adjustments/query in the Marketplace API and the Integration API
• Add new resource type stockReservation in the Marketplace API and the Integration API and new API endpoints:
  • /stock_reservations/show endpoint in the Integration API
• Add new resource type stock in the Marketplace API and the Integration API and new API endpoints:
  • /stock/compare_and_set in the Marketplace API and the Integration API
• Add new relationships:
  • currentStock relationship of ownListing resource in the Marketplace API
  • currentStock relationship of listing resource in the Marketplace API
  • currentStock relationship of listing resource in the Integration API
  • stockReservation relationship of transaction resource in the Marketplace API
  • stockReservation relationship of transaction resource in the Integration API
• Add support for new nested relationships:
  • listing.currentStock of transaction resources in the Marketplace API and Integration API
  • stockReservation.stockAdjustments of transaction resource in the Integration API
• Add support for filtering listings by minimum available stock in the /listings/query endpoints in the Marketplace API and the Integration API

2021-06-10

Changed

• Allow creating Stripe Customer without PaymentMethodId. See
  • /api/stripe_customer/creater

2021-05-11

Changed

• Allow combining sort and keywords parameters in listings query in Marketplace API and Integration API. See
  • /api/listings/query
  • /integration_api/listings/query

2021-04-29

Changed

• Updated Flex API timezone data to use the 2021a version of the IANA timezone database. This fixes an issue where time-based availability plans were incorrectly handled for some time zones that had their DST rules changed recently.

2021-03-25

• Add support for ISO 8601 timestamp string format without milliseconds, e.g. "2021-03-25T18:01:42Z"

2021-02-04

Added

• Add a listing relationship to booking resource in Integration API. See booking relationships
• Add support for querying events with relatedResourceId. See querying events.

2021-01-27

Added

• Add a relationship from reviews to transaction in Integration API. See review relationships

2021-01-26

Deprecated

• description attribute of the marketplace resource in Marketplace API is now deprecated.
• description attribute of the marketplace resource in Integration API is now deprecated.

2020-12-16

Added

• Add OpenID Connect to supported identity providers, see Identity providers.

2020-12-15

Added

• Add support for querying events in the Integration API
  • See Events
  • New Integration API endpoint /events/query
• Add support for listing relationship for availabilityException resource type in the Integration API
• Add support for ownListing relationship for availabilityException resource type in the Marketplace API

Changed

• Update the Integration API URL to https://flex-integ-api.sharetribe.com/v1/integration_api/. Use of the old https://flex-api.sharetribe.com/v1/integration_api/ for the Integration API is now DEPRECATED. The latest Flex Integration API SDK v1.4.0 uses the correct URL by default.

2020-11-16

Added

• Add Google to supported identity providers, see Identity providers.

2020-10-15

Added

• Add support for authenticating using an identity provider
  • New endpoint in Marketplace API /current_user/create_with_idp
  • New endpoint in Authentication API /auth/auth_with_idp
  • currentUser resource in Marketplace API has a new attribute: identityProviders.
  • user resource in Integration API has a new attribute: identityProviders.

2020-09-28

• New possible state proposed for booking resources in the Marketplace API and the Integration API

2020-08-12

Added

• Add support for custom image variants in Marketplace and Integration APIs
  • See Image variants in the Marketplace API
  • See Image variants in the Integration API

2020-07-08

Added

• Add support for transitioning transactions as operator via the Integration API:
  • New API endpoint /transactions/transition
  • New API endpoint /transactions/transition_speculative
• Add support for transaction metadata:
  • Add metadata to the transaction resource format in the Marketplace API
  • Add metadata to the transaction resource format in the Integration API
  • New API endpoint /transactions/update_metadata

2020-06-25

Added

• Add support to Authentication API for token_exchange for requesting trusted:user tokens that are used for secure API calls
• Enable client secrets for Marketplace API applications
• Enable privileged transitions that require trusted:user token for transitioning

2020-06-15

Changed

• Expand supported query time range for availability exceptions in both the Marketplace API and the Integration API
• Expand the supported query time range for bookings in the Marketplace API
• Expand the supported query time range for timeslots in the Marketplace API

2020-04-30

Changed

• Update documentation to clarify that transactions can not have more than 100 transitions.

2020-03-25

Added

• Add support for filtering listings by time-based availability in /listings/query endpoints in both the Marketplace API and the Integration API:
  • New types of availability filtering time-full and time-partial
  • Support for partial availability with given minimum duration (minDuration query parameter)
  • NOTE: Pagination is not supported with time-full and time-partial availability search queries
• Add support for minimum duration queries when filtering by day-based availability:
  • New minDuration query parameter is now supported
  • NOTE: Pagination is not supported with queries using minDuration
• Add support for new sort query parameter in /listings/query. It allows controlling sort order and sorting listings by one or more of:
  • price amount
  • listing creation time
  • numeric publicData and metadata attributes that have a corresponding extended data schema defined

For details, see:

• Marketplace API /listings/query
• Integration API /listings/query

Changed

• Deprecating full and partial values for availability query parameter in /listings/query in both the Marketplace API and the Integration API. Use day-full and day-partial instead.

2020-02-19

Fixed

• Integration API endpoint /users/show always returned false for stripeConnected.

2020-02-12

Chanegd

• Auth API /token POST endpoint now returns scopes associated with the issued token.

2020-01-21

Added

• Add support for updating, approving, closing and opening listings in the Integration API:
  • New endpoint /listings/update
  • New endpoint /listings/approve
  • New endpoint /listings/close
  • New endpoint /listings/open
• Add support for updating user profile data in the Integration API:
  • New endpoint /users/update_profile
• Add public metadata support for users (new attribute profile.metadata):
  • Read-only support in the Marketplace API user and currentUser resources
  • Read-write support in the Integration API user
• Add support for creating, querying and deleting availability exceptions in the Integration API:
  • New endpoint /availability_exceptions/query
  • New endpoint /availability_exceptions/create
  • New endpoint /availability_exceptions/delete
• Add support for uploading images in the Integration API:
  • New endpoint /images/upload
• Add support for querying transactions by user or listing in the Integration API's /transactions/query API endpoint.
• Add support for deleting user profile image in the Marketplace API /current_user/update_profile endpoint.

2019-12-20

Changed

• Stripe Account resource in Marketplace API updated to contain Account object returned from Stripe, see stripeAccount.

Added

• New API endpoint /stripe_account/fetch.

2019-12-19

Changed

• Marketplace API endpoints that invoke the Stripe API now return a 409 response with error code stripe-invalid-request for all unknown 4xx responses from Stripe. See:
  • /stripe_account
  • /stripe_account_links
  • /stripe_persons
  • /stripe_customer

2019-12-11

Fixed

• Change listings keyword search to be accent insensitive.

Changed

• Listing's query now supports passing in the minimum number of seats that the listing should have available on the given period to match. Works with both the Integration API and the Marketplace API.

2019-12-04

Added

• A new Flex API is now available - Integration API.

2019-12-02

Added

• Add support for client_credentials grant using client secret in the Authentication API. Used for obtaining access tokens for the Integration API.

2019-11-27

Changed

• Listing's query now allows choosing between AND (has all) and OR (has any) matching mode for public extended data and metadata when querying against a multi enum field. The default is still AND so this is a non-breaking change. See /listings/query.

2019-09-16

Added

• Expose listing's availability plan type and timezone in listing resources.

2019-08-22

Added

• Add support for storing payment cards using Stripe's Customers and Payment Methods
  • New API endpoint /stripe_setup_intents/create
  • New API endpoint /stripe_customer/create
  • New API endpoint /stripe_customer/add_payment_method
  • New API endpoint /stripe_customer/delete_payment_method
  • New API resource stripeSetupIntent
  • New API resource stripePaymentMethod
  • Updated relationships on API resource currentUser

2019-07-16

Added

• Keyword search added to the listings query endpoint. See /listings/query.

2019-06-12

Changed

• Expand the bookings query up to 365 days in the future for listings with a day-based availability plan. See /bookings/query.

2019-05-15

Changed

• Allow querying listings by availability up to 365 days in the future. See /listings/query.
• Expand the timeslots query range to 365 days for listings with a day-based availability plan. See /timeslots/query.

2019-04-15

Changed

• Increase page size to 500 for the time slots query endpoint: See /timeslots/query
• Time-based availability management and booking display times officially relased. See:
  • Listing availability management
  • Own listing availability plan
  • Bookings
  • Time slots

2019-03-25

Added

• Add support for creating Stripe Business accounts and Stripe Persons:
  • New API endpoint /stripe_account/create replacing deprecated /current_user/create_stripe_account
  • New API endpoint /stripe_account/update replacing deprecated /current_user/update_stripe_account
  • New API endpoint /stripe_persons/create

Changed

• Deprecate chargesEnabled and payoutsEnabled flags for currentUser resource
• Deprecate /current_user/create_stripe_account API endpoint
• Deprecate /current_user/update_stripe_account API endpoint

2019-03-21

Added

• Arbitrary line item codes in the transaction resource format. For more information about arbitrary line items, see Custom pricing.
• New parameter types money and ["lineItems"] in the processTransition resource format.

2019-02-20

Added

• Beta: Support for time-based availability plans and timeslots. See:
  • Listing availability management
  • /own_listings/create
  • /own_listings/update
  • /timeslots/query
• Beta: Support for booking display times in booking resource type.

2019-01-30

Changed

• Allow requesting password reset with unverified email address via /password_reset/request API endpoint.

Fixed

• privateData was missing from currentUser resource type when profileImage was included in the /current_user/show API endpoint.

2019-01-28

Added

• Support for querying listings by day-based availability in /listings/query API endpoint.

2019-01-10

Added

• Add deleted flag for user and own_user resources.

2018-11-26

Added

• Support for day-based availability management. See:
  • Listing availability management
  • /own_listings/create
  • /own_listings/update
  • /availability_exceptions/*
  • /timeslots/query
• Support for querying bookings for a given time range. See /bookings/query.

2018-11-15

Added

• Support for draft listing state. See /own_listings/create_draft, /own_listings/publish_draft and /own_listings/discard_draft API endpoints.

2018-10-25

Added

• Support for removing listing's price or location data in /own_listings/update API endpoint

Fixed

• Fix setting location if listing did not previously have location data in /own_listings/update API endpoint

2018-08-14

Added

• New query parameter price for /listings/query API endpoint, which allows filtering listings by price

2018-08-08

Added

• New attribute protectedData for transaction resource
• New possible value object for processTransition parameter types

2018-07-05

Added

• New API endpoint: /timeslots/query