Overview & Prerequisites
The Expressoft Delivery API is built on GraphQL. It lets you connect a delivery application to Expressoft in three ways:
- Queries read reference data: customers, addresses, locations, product categories, and prices.
- Mutations write data back to Expressoft: new customers, addresses, companies, and orders.
- Webhooks notify your system when something changes in Expressoft: order status, location availability, preparation time, stock.
All calls go to one GraphQL endpoint over HTTPS. You authenticate with a Bearer token.
Prerequisites
Before you start, make sure you have:
- API credentials: a username and a password issued by Expressoft. See Getting AccessGetting Access.
- Sandbox access: build and test against https://sandbox.expressoft.eu before you ask for production.
- A GraphQL client: Postman, curl, or the Expressoft GraphQL Playground. Any of them works.
- A public HTTPS endpoint (only if you want webhooks): Expressoft calls this URL when an event happens.
Postman collection
Expressoft published a Postman collection for the Delivery API. It contains the requests described on these pages: Expressoft Delivery API collection.
To use it, create a Postman environment with your username, your password, and the sandbox endpoint. Run Get Token first. The other requests use the token it returns.
How the pages fit together
Follow the sidebar from top to bottom. Each page uses keys (publicKey values) returned by the previous one.
- Authentication: get a Bearer token.
- GraphQL Playground: explore the schema interactively.
- Setup Queries: read the reference data you need to build an order (locations, price lists, products, streets).
- Place Order: create the customer, the address, and the order.
- Webhooks: get notified when the order or the location changes.
A mutation can return HTTP 200 and still fail a business rule. Always check errorCode and errorMessage in the mutation result, not only the HTTP status.
Webhooks work differently per environment. In sandbox you set them yourself with a mutation. In production, Expressoft representatives configure them for you. Contact [email protected] to set them up.
The customer and loyalty data (points, vouchers, receipts, gift cards) are covered in the CRM & Loyalty API pages. They use the same endpoint and the same token. See Schema ReferenceSchema Reference for the other areas of the schema: delivery areas and streets, driver users and payment methods.