Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This page documents the checkout customer journey and associated API actions.

Contents

What is checkout?

Checkout is the final step in the shopping process, where the customer reviews their cart, see total price, enters payment information, and confirms the order.

In our platform checkout consists currently of two steps: cart and payment page.

How do you interact with the API?

Our ordering API uses endpoint and webhooks, which follow this principle:

  • We broadcast all changes that impact orders via our webhooks.

  • We make available all information on orders via our endpoints.

API Actions

Price webhook & endpoint

When a guest goes to checkout, the contents of their cart are priced against the POS.

We will trigger a Price Order webhook with the order contents for the selected store id and service mode. The POS is to return the price and availability for each item in the order, the total price and any errors using the Price Webhook Callback endpoint.

Commit webhook & endpoint

[ ]

Fire webhook & endpoint

[ ]

Order event webhook & endpoint

[ ]

  • No labels