Glossary of Terms
Term | Meaning |
|---|---|
Bearer token | The token you get from the token endpoint and send as Authorization: Bearer <token>. One token works for both APIs. |
Callback URL (urlPath) | The URL on your side that receives webhook messages from Expressoft. |
Connection | A GraphQL list that supports cursor pagination and returns totalCount, pageInfo and items. |
Cursor | A marker that points to a position in a list. Send pageInfo.endCursor as after to read the next page. |
Customer | A person who buys from you. A customer has a category, addresses, optional companies, marketing consents and loyalty data. |
Customer category | A group of customers. You need a category key to create a customer. |
Delivery area | A zone served by one or more locations. |
errorCode / errorMessage / errorData | The error fields of a mutation result. errorCode is a number, errorMessage is the name of the error in words, errorData holds details. |
Gift card | A prepaid card with a value, a currency, a VAT category and a validity period. It is created through the API and used at the POS. |
GraphQL Playground | The Expressoft-hosted tool to explore the schema and test requests. |
Guid | The type of most identifiers: a 36-character unique value such as 00000000-0000-0000-0000-000000000001. |
languageCode | A field of the token request. en returns English texts, ro returns Romanian texts. |
Location | A place that prepares orders (for example a restaurant), with an availability flag and a preparation time. |
Marketing action | A consent a customer can give or refuse, for example a newsletter. true is opt-in, false is opt-out. |
Mutation | A GraphQL operation that creates, changes or deletes data. |
Payment method | A way a customer pays. Each payment method has a paymentMethodType: CASH, CARD, MEAL_TICKET, VIRAMENT, MOBILE, PMS, CONTACT_DEBT, ACCOUNT_DEBT, ELECTRONIC_MEAL_TICKET. The list of methods depends on the environment. |
Points (loyalty points) | Loyalty points. The balance is in loyalty.points.balance. Points and amounts are decimal numbers. |
Price list (sale price category) | A set of sale prices. You pass one when you read prices and when you create an order. |
Profile | A sales mode of Expressoft. Promotions and orders are linked to profiles. The ProfileType values are DELIVERY (Delivery), RESTAURANT (Restaurant), RETAIL_FOOD (Retail Food), BEAUTY (Beauty), QUICK_SERVICE (QuickService), RETAIL_NON_FOOD (Retail NonFood), SELF_SERVICE_KIOSK (Self Service Kiosk), CASHLESS (Cashless). |
Promotion | A discount rule that Expressoft applies automatically. |
publicKey | The identifier of a record in the API. |
Query | A GraphQL operation that reads data. |
Sandbox / Production | The test environment and the live environment. They have separate URLs and credentials. |
Segmentation category | The customer segment assigned in Expressoft. It can be null. |
Source of truth | Data that Expressoft owns and calculates, such as the points balance. Query it, don't recalculate it. |
Time-limited code | The code of a customer or voucher, requested with windowMinutes. It is an HMAC token that is safe to show in a QR code. |
totalCount | The number of items in a list, ignoring paging. |
Voucher | A discount given to a customer at checkout. It has a validity period and a maximum number of uses. |
Wallet | A money balance of a customer. loyalty.wallet.balance is the debit amount, with VAT. |
Webhook | A message that Expressoft sends to your URL when an event happens. Delivery API only. |