Getting started

Start the flow

Access your customer dashboad

Subscribe to webhooks

Retrieve available merchants

Create a session

Install the SDK

Initialize the SDK

Login

Handle authenticated event

Add a product to a cart

Call Sync Cart to add a product to a cart using the product.external_id. To be notified when a product is successfully added to a cart and to receive cart information, listen to the SYNC_CART_SUCCEEDED webhook.

Update delivery address (optional)

If a user would like to update their delivery address after initially provided in Sync Cart, simply make the same request again with a new delivery_location, like you are patching the cart. You will receive fresh information regarding the cart, including the price.total.

A delivery address must be present in the user’s merchant account prior to checkout if the fulfillment is via any delivery option. Therefore, if a delivery_location is not provided in Sync Cart and/or a delivery_location is not provided back in SYNC_CART_SUCCEEDED, then you cannot proceed with Checkout.

Update fulfillment preference (optional)

If a user would like to update the fulfillment preference for a given product after the initial Sync Cart request, simply make the same request again with a value for products.fulfillment.id that you received in the SYNC_CART_SUCCEEDED webhook. You will receive fresh information regarding the cart, including the price.total.

Checkout

Call Checkout to checkout a cart. To be notified when a checkout process is successful, listen to the CHECKOUT_SUCCEEDED webhook, which will include an array of transactions by Id created by the checkout.

Get order confirmation details

When you receive the CHECKOUT_SUCCEEDED webhook, call Get Transaction By Id for each transaction you receive (using the transaction.id) to retrieve transaction information and subsequently enrich an order confirmation.

Handle disconnected merchant accounts

If for example a user changes their password to a merchant account, the connection.status in Get Merchant Accounts will be returned as disconnected and you will not be able to make any successful requests to Sync Cart or Checkout until the user’s merchant account is reconnected. In this case, you’ll want to display a UX in your app to allow users to reconnect their account. For example, you may choose to display a button that says “Reconnect” or similarly allow the user to invoke the SDK to reconnect their account.