Introduction

Integration Overview

Get Your Retailer Access Token

You will fill out a short questionnaire explaining your store's ecosystem and in response, we will provide you with credentials. When you have your Croissant clientId and clientSecret, proceed to 'Authentication'.

Sync your product catalogue.

This generates Croissant pricing for your products in our backend.
We can subscribe to your store's product feed endpoint or you can interact with the API manually.
When to Call: You'll make PUTs to our products API on your initial product sync.

Update your store pages with Croissant On-Site Messaging.

Croissant On-Site Messaging is built with smart components that integrate with Croissant APIs to fetch and display the current price on your store.

Sync your orders.

Call the /carts API to create new carts, fulfill them, and cancel them.
When to Call: You will make a POST to our /carts when your customer completes checkout. These POST requests will include your customer's isOptedIn value, either "true" or "false".

Update your catalogue

When to call: Each time any changes occur in your store's catalogue.
When changes are made to your catalogue such as when products are added or when prices change, call the /products/{id} endpoint to update Croissant.

👍

A Few Tips

🔐 You will need Croissant Credentials to generate your access token and make authenticated requests.

👉📖 Read the Recipes. Recipes provide examples of API usage written in Javascript.

✨😌 When a request requires you POST or PUT an ID, send the ID your store already uses. Croissant will ensure your unique IDs are associated to your store. The same logic applies to your GET /{id} requests!

💦🧠 Drink plenty of water. Studies suggest that mild dehydration can reduce cognitive function and increase silly mistakes. Research conducted by a team at the Georgia Institute of Technology found that small levels of dehydration (around 1-2% loss of body mass due to fluid loss) can lead to reductions in brain volume. [source]