Allomancy

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, customers, categories, coupons, gift cards, store details, and loyalty tiers. 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/v1

The API is HTTPS only, and every path sits under /v1. For example, store details live at https://integrations.allomancy.net/v1/store.

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.

Where to go next

On this page