Developer API
A per-store REST API for building integrations on top of your Allomancy store.
The Allomancy Third-Party API lets an external service read and manage a single store programmatically: products, vendors, customers, customer tokens, categories, coupons, gift cards, sales, store details, and loyalty tiers. It can also send your service signed webhooks about sales, payments, and redeliveries. It is a public REST API authenticated by a per-store API key.
One key, one store
Every API key belongs to exactly one store and acts on that store's data. The store owner creates the key in Allomancy Stores, grants it a set of scopes, and shares it with the integration. Send the key on every request in the X-API-Key header. See Authentication for the full key model.
Base URL and versioning
All requests go to:
https://integrations.allomancy.net/v1The API is HTTPS only, and every path sits under /v1. For example, store details live at https://integrations.allomancy.net/v1/store.
Two surfaces
The API has two halves:
- REST endpoints: you call Allomancy to read and change store data.
- Outbound webhooks: Allomancy calls a URL you register when something happens in the store, such as a completed sale. See Webhooks.
Reading the responses
REST responses use JSON with camelCase field names. Enumerated fields serialize as integers, not strings: a discount type, for example, comes back as 0, 1, or 2 rather than a name. The Object reference page carries a value table for every such field, and its conventions list the few REST fields that carry string values instead. Webhook payloads differ: they name enum values as strings, such as "Purchase".