This repository contains example transaction processes and the email templates for Sharetribe. These processes can be used as starting points for customizing your marketplace using Sharetribe CLI.
To understand the transaction engine in Sharetribe, see the Transaction process article in Sharetribe Developer Docs.
To get up and running with Sharetribe CLI, see the Getting started with Sharetribe CLI guide in Sharetribe Developer Docs.
Clone this repository:
git clone git@github.com:sharetribe/sharetribe-example-processes.git
Change to the cloned directory:
cd sharetribe-example-processes
Let's use my-marketplace-id as an example Marketplace ID and
instant-booking as the process that is taken into use.
Using the example processes, create a new process to your marketplace:
flex-cli process create -m my-marketplace-id --process instant-booking --path instant-booking
Create an alias to the process:
flex-cli process create-alias -m my-marketplace-id --process instant-booking --version 1 --alias release-1
Check that everything is good:
flex-cli process list -m my-marketplace-id --process instant-booking
Then set up your Sharetribe Web Template customization to use that process alias and continue customizing your process and UI. You can find process-specific suggestions in the README.md file of each process.
For customizing the transaction process, see the transaction process format guide.
For editing the transactional email templates, see the Email templates reference in Sharetribe Developer Docs.
The example processes are meant to showcase some of the capabilities
of the transaction engine. See the differences in the process.edn
files in each process directory to see how they differ only slightly.
All the payment processes support Strong Customer Authentication (SCA).
The example processes differ mostly in availability management and pricing. To understand these concepts, see the Listing availability management and Custom pricing articles in Sharetribe Developer Docs.
This is the default process that is created in our backend for new test marketplaces and used for bookings.
When used in Sharetribe Web Template (web-template) customizing pricing can be done within the template by utilizing privileged transitions.
This is the default process that is created in our backend for new test marketplaces and used for purchases. It is a transaction process designed for product selling with shipping or pickup, and it uses the Sharetribe stock management features.
When used in Sharetribe Web Template (web-template) customizing pricing can be done within the template by utilizing privileged transitions.
This is the default process that is created in our backend for new test marketplaces and used for free messaging. Its only function is to start a transaction so participants can send messages within the context of that transaction. The process does not use any payment, booking, or stock features.
This is an example of instant booking supporting both card and push payment methods.
See payment methods overview for more info.
The README.md file in the process folder describes how to take the process into use in the Sharetribe Web Template.
This process differs clearly from the other processes as seen in the visualization below. It uses price negotiation where the customer and provider can negotiate a new total price for the transaction.
The transitions for the negotiation showcase an example how to handle the negotiation in an offering phase before moving onto the payment.
The README.md file in the process folder describes how to take the process into use in the Sharetribe Web Template.
Note that price negotiation is just one way to customize the pricing. Our powerful Custom pricing enables several use cases for transaction pricing.
In addition to price negotiation, you can also add a functionality to negotiate the booking days within the process. For this use case, you would need to add the update-booking action to the negotiation transitions, and pass the new suggested booking times as transition parameters. To do this, you would need to make sure in your client app that the listing has availability for the suggested new booking time.
This process makes it possible to create bookings for more than 90 days in the future and still use the default Stripe integration. The automatic off-session payment process creates the booking when the transaction is initiated, but handles the payment closer to the actual booking time. See the automatic off-session payments article for more information.
The README.md file in the process folder describes how to take the process into use in the Sharetribe Web Template.
