Reference

Shop

The shop a key belongs to, and the domains Uncart may link to.

Laufkontor Brandt is a sample shop. The examples show sample data.

The shop of this key

GET /v1/shop

Any secret key, whatever its scopes (carts:write, catalogue:write, discounts:write, orders:write, webhooks:manage).

The shop the key belongs to, the mode it works in, and what the key may do. Use it to check that a key works.

Answers

StatusWhen
200The shop.
401No valid API key. Every refusal of a key (missing, malformed, unknown, revoked, expired, the wrong mode or a missing scope) gets this same answer, so it tells nobody why. More
403The key is valid, but its shop does not connect through the Uncart API. More
422The body or the query does not match the schema. details names each field and the rule it broke, at most 10, never its value; never a name you chose either (an unknown property is named by its parent, an unknown query parameter as query, and a step of a field's path that is no name of the spec is *). More
429Too many requests. Try again after Retry-After seconds. Each key may make requests_per_second (bursts of burst), and each shop, all its keys together, shop_requests_per_second (bursts of shop_burst); the RateLimit headers say what is left of the nearer limit. These are counted in each of Uncart's API tasks (one, and two for a few minutes while Uncart deploys; a deploy starts every count afresh). In front of them, all of the Uncart API's clients together may make gateway_requests_per_second (bursts of gateway_burst): past that, Uncart's gateway itself answers 429 with {"message":"Too Many Requests"}, without the RateLimit headers. Treat that 429 the same way. More
500Something went wrong on Uncart's side. Nothing the request did is kept, nor its answer: send the same request again, with the same Idempotency-Key, and it runs once. More
503Uncart cannot check API keys at this moment. Nothing was done; try again after Retry-After seconds. More

Example

ShellRequest
curl 'https://api.uncart.ai/v1/shop' \
  -H "Authorization: Bearer $UNCART_KEY"
JSONAnswer 200
{
  "id": "5f0c7a1e-2b9d-4c3e-8a71-0d6e4b2a9c01",
  "name": "Laufkontor Brandt",
  "mode": "test",
  "key": {
    "id": "ExampleKeyId0001",
    "kind": "secret",
    "scopes": [
      "carts:write",
      "catalogue:write",
      "discounts:write",
      "orders:write",
      "webhooks:manage"
    ]
  }
}

The shop's domains

GET /v1/domains

Any secret key, whatever its scopes (carts:write, catalogue:write, discounts:write, orders:write, webhooks:manage).

The domains the shop added on the dashboard, and whether each is verified. Uncart links only to addresses on a verified domain (exactly that host, not its subdomains), and checks each again every day.

Answers

StatusWhen
200The shop's domains, oldest first.
401No valid API key. Every refusal of a key (missing, malformed, unknown, revoked, expired, the wrong mode or a missing scope) gets this same answer, so it tells nobody why. More
403The key is valid, but its shop does not connect through the Uncart API. More
422The body or the query does not match the schema. details names each field and the rule it broke, at most 10, never its value; never a name you chose either (an unknown property is named by its parent, an unknown query parameter as query, and a step of a field's path that is no name of the spec is *). More
429Too many requests. Try again after Retry-After seconds. Each key may make requests_per_second (bursts of burst), and each shop, all its keys together, shop_requests_per_second (bursts of shop_burst); the RateLimit headers say what is left of the nearer limit. These are counted in each of Uncart's API tasks (one, and two for a few minutes while Uncart deploys; a deploy starts every count afresh). In front of them, all of the Uncart API's clients together may make gateway_requests_per_second (bursts of gateway_burst): past that, Uncart's gateway itself answers 429 with {"message":"Too Many Requests"}, without the RateLimit headers. Treat that 429 the same way. More
500Something went wrong on Uncart's side. Nothing the request did is kept, nor its answer: send the same request again, with the same Idempotency-Key, and it runs once. More
503Uncart cannot check API keys at this moment. Nothing was done; try again after Retry-After seconds. More

Example

ShellRequest
curl 'https://api.uncart.ai/v1/domains' \
  -H "Authorization: Bearer $UNCART_KEY"
JSONAnswer 200
{
  "data": [
    {
      "domain": "shop.example.com",
      "status": "verified",
      "verified_at": "2026-10-20T08:00:00.000Z"
    },
    {
      "domain": "www.example.com",
      "status": "pending",
      "verified_at": null
    }
  ],
  "next_cursor": null
}