Merchant Setup

Create a new merchant

Create a merchant programmatically. The API key that creates the merchant owns it and pays for it: each discount code or NFC tap at the store that carries a discount uses one regular credit from that key (a 0% result is free), and so does every in-store scan. The store has no credit balance of its own. A key can create a limited number of merchants (429 past it).

post/v1/merchants

Request

  • Base URL: https://api.insumermodel.com
  • URL: https://api.insumermodel.com/v1/merchants
  • Auth: API key in header X-API-Key

Request body

companyNamestring required

Display name

companyIdstring required

Unique ID (alphanumeric, dash, underscore)

locationstring

City or region

externalIdstring

Optional partner handle for this merchant (e.g. a token collection address). Makes the call an idempotent upsert and requires domain verification before the merchant can publish to the directory.

allowDuplicateNameboolean

Set true to allow creating a merchant whose companyName matches an existing merchant. Without it, a duplicate name is rejected with 409.

Response

Merchant already exists and is managed by this same API key — returned as an idempotent upsert (the existing merchant) instead of a 409.

oktrue

Example response

{
  "meta": {
    "version": "1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.