Overview & Prerequisites
The CRM & Loyalty API gives your system access to the customer and loyalty data of Expressoft: customers, the points balance, the wallet balance, vouchers, promotions, the points of each receipt, and gift cards. It is built on GraphQL.
It uses the same endpoint, the same schema and the same token as the Delivery API. This section covers the customer and loyalty part of that schema.
Expressoft is the source of truth for this data.
- Your system starts every request. Expressoft answers.
- This API doesn't send notifications. Query the data when you need it.
- All communication goes through one GraphQL endpoint over HTTPS.
Prerequisites
You need | Where to get it |
|---|---|
A user name and a password | Expressoft issues them per integration. See Getting Access. |
A Bearer token | Generate it with the token request. See Authentication. |
The GraphQL endpoint | https://sandbox.expressoft.eu/connect/api/interopgql in sandbox. See Environments. |
What you can do
Goal | Page |
|---|---|
Find a customer by phone, name or code | Customer Identification |
Read the profile, the points balance and the wallet balance | Customer Details |
Create a customer | Creating a Customer |
Update or delete a customer, manage addresses, companies and marketing consent | Editing a Customer |
Read the points earned and used on each receipt | Points Balance & Transactions |
Read the vouchers of a customer | Vouchers |
Read the loyalty promotions | Promotions |
Create a gift card | Gift Cards |
Show a customer code in a QR code | QR and Time-Limited Codes |