Guides¶
Task-oriented guides for building against the ecomtaxfree platform. Each one starts from what you want to do and shows requests you can run.
| Guide | Use it to |
|---|---|
| Authentication | Sign up from an invitation, sign in, and understand which credentials exist |
| Tenants and members | Pick the tenant a request acts in, invite people, and know what each role may do |
| GraphQL API | Make your first query, page through lists, handle errors, read your own writes |
| Checkout API | Ask whether an order or cart qualifies for a VAT refund |
| Shopify | Connect a Shopify shop to a retailer and see what happens afterwards |
Before you start¶
- The platform has two HTTP surfaces for callers: the tenant GraphQL endpoint (
POST /api/graphql) and the checkout GraphQL endpoint (POST /api/checkout/graphql). They take different credentials and expose different schemas. - There is no API key or other machine credential yet. Programmatic access to the tenant API uses a user session; see Authentication for what that means in practice.
- Every path in these guides is relative to the API's base URL. The examples write it as
https://<your ecomtaxfree host>.