Start
Quickstart
You need a test key for your shop and curl in a terminal. Test mode is free, and nothing you do with a test key reaches a shopper.
Laufkontor Brandt is a sample shop. The examples show sample data.
1. Get a test key
On your dashboard, open Shop setup, then Connection, and make a secret key in test mode. You need to be an owner of the shop. The key starts with uc_test_. Copy it now, because Uncart shows it only once.
If your Connection page says making keys comes later, ask Uncart for your test key.
Put the key in an environment variable in your terminal. The examples in these pages all read it from there.
# Paste your test key between the quotes.
export UNCART_KEY='uc_test_your_key_here'
2. Check the key
Ask for the shop the key belongs to.
curl https://api.uncart.ai/v1/shop \
-H "Authorization: Bearer $UNCART_KEY"
Uncart answers with your shop, the mode the key works in and the scopes it carries. This is the answer for the example shop.
{
"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"
]
}
}
A 401 means the key is wrong, revoked or missing from the Authorization header. Authentication and keys explains why the answer is the same for all three.
3. Check your domains
Uncart only links to pages on domains you have verified.
Add yours on the same Connection page and publish its DNS record or file, as Verified domains shows. Then list them.
curl https://api.uncart.ai/v1/domains \
-H "Authorization: Bearer $UNCART_KEY"
{
"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
}
A domain marked verified is ready. pending means Uncart hasn't found the record or the file yet, and it looks again every 15 minutes for three days. failed means the record and the file are both gone, and Uncart doesn't link there until one is back.
What to read next
- Errors lists every error code and which ones to retry.
- Rate limits says how fast you may call.
- The API reference has every route, each with an example that Uncart's tests run.