Store
Requires scope merchant-business_profile-read.
Retrieves the store’s business profile: name, contact, branding and storefront status, plus the store currency (with its currency_meta.precision) and its plan with every plan-gated feature as a boolean, so an app can format amounts and check a feature before calling a gated route. storefront.listable and blocked_by say whether the store may be listed on the open web (not a dev, test or template store, no storefront password, trading), and prices_include_tax whether its prices include tax; store/update announces a change to prices, currency, name or address, listability or availability.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "store", "data": { "store": { "id": 1095, "uid": "019a0b3a-af57-72d0-9c13-7036c3805892", "name": "Northwind Goods", "slug": "northwind-goods", "currency": "USD", "currency_meta": { "code": "USD", "symbol": "$", "precision": 2 }, "timezone": "America/New_York", "inventory_tracking": "track", "plan": { "code": "free", "features": { "has_pos": false, "barcode_generator": false, "marketing_automations": false, "rider_app": false, "instore_qr": false, "vendor_inboxes": false, "roles_permissions": false, "purchase_orders": false, "supplier_management": false, "products_export": false, "orders_export": false, "customers_export": false, "team_export": false, "website_themes": true, "website_ai_builder": true, "website_custom_domain": false, "custom_payment_gateway": false, "custom_mail_sender": false, "website_blog": false, "website_hide_powered_by": false } }, "contact": { "email": "[email protected]", "phone": "+1 202 555 0147" }, "address": { "address": "14 Mercer Street, New York, NY 10013", "landmark": "Opposite the public library", "region": "New York", "latitude": 40.7243, "longitude": -73.9997 }, "logo": "https://media.usequeek.com/uploads/stores/1095/logo.png", "banner": "https://media.usequeek.com/uploads/stores/1095/banner.png", "rating": { "value": 4.8, "count": 231 }, "status": "active", "operating_hours": { "weekdays": { "open_time": "08:00", "close_time": "22:00", "status": "closed" }, "saturday": { "open_time": "09:00", "close_time": "18:00" }, "sunday": { "open_time": null, "close_time": null }, "preparation_time": { "minimum": 30, "maximum": 120 }, "temporary_unavailable": true, "available_on_weekend": true }, "capabilities": { "queek_logistics_enabled": true, "delivery_enabled": true, "offers_free_delivery": false, "free_delivery_over": null, "pickup_enabled": true, "instore_order": false }, "prices_include_tax": false, "storefront": { "domains": [ "https://northwindgoods.example", "https://northwind-goods.queek.app" ], "platform_address": "https://northwind-goods.queek.app", "listable": true, "blocked_by": [] }, "created_at": "2026-06-02T08:00:00+01:00", "updated_at": "2026-09-24T18:30:00+01:00" } }}Requires scope merchant-exports-create.
Queues a whole-store archive (a zip of CSV files plus manifest.json) and answers 202 with the export row. It is always built in the background; read exports/{export} until status is ready and the download_url appears. The archive carries only what this key can read: products.csv needs merchant-items-read, orders.csv needs merchant-orders-read and customers.csv needs merchant-customers-read; a key holding none of them answers 422. Requesting an archive needs a paid plan: a Free store answers 403 subscription_feature_locked (reading an export already requested stays open). Without merchant-customers-contact-read the customer and buyer name, email and phone cells are blank. manifest.json lists exactly what the archive carries. The archive is customer personal data and download_url is a bearer link: anyone holding it can download the archive until expires_at, so keep it out of logs and share it with nobody. One export runs per store at a time (409 export_in_progress while one is active, including one the merchant started in the dashboard), and an installation may request three per rolling 24 hours (429 with Retry-After). A key reads only the exports it requested, and only an installed app’s own key may call these routes: a merchant’s own key answers 403 insufficient_scope. The archive is a snapshot at build time and has no deletion feed: records removed since a previous export are simply absent, so reconcile by comparing archives.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Retry-safe write key. The same key with the same body replays the stored response for 24h with Idempotent-Replayed: true; with a different body it is 409 idempotency_key_reuse; while the first call is still running it is 409 idempotency_key_in_progress.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/exports" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Export queued. Read it by id until its status is ready; the download link appears then.", "data": { "id": 1042, "status": "queued", "requested_at": "2026-09-30T10:05:00+01:00", "completed_at": null, "expires_at": "2026-10-07T10:05:00+01:00", "download_url": null }}Requires scope merchant-exports-read.
Reads an export this key requested: status is queued, building, ready, failed or expired. The download_url appears only while the status is ready, and works until expires_at (seven days after the request); it is a bearer link to the archive, so treat it as a secret. A failed export carries no reason: request another. {export} is the export id; another store’s, another installation’s, or an unknown id answers 404.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Path Parameters
Identifier of the export, as returned by the Merchant API.
Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted by a Server connection under Dashboard → Channels → Headless API (keys are also listed in Settings → Connections). The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/exports/1042" \ -H "X-Client-Key: {{merchantKey}}"{ "status": "success", "message": "Export retrieved", "data": { "id": 1042, "status": "ready", "requested_at": "2026-09-30T10:05:00+01:00", "completed_at": "2026-09-30T10:06:40+01:00", "expires_at": "2026-10-07T10:05:00+01:00", "download_url": "https://api.usequeek.com/api/v1/biz/store-export/1095/i0199a2d1-5a6b-7c7d-8e9f-0a1b2c3d4e50-Qm9ycm93ZWRGcm9tU2VjcmV0VG9rZW5FeGFtcGxlT25seQ?expires=1791021900&signature=0f1e2d3c4b5a69788796a5b4c3d2e1f00f1e2d3c4b5a69788796a5b4c3d2e1f0" }}