{"info":{"description":"The NeroCart API (https://nerocart.com/docs). Set baseUrl to your store's address (https://yourstore.com) and apiKey to a key made in Settings › API keys. Guide: https://nerocart.com/developers","name":"NeroCart API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"item":[{"name":"Who sells this variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Cheapest first, paused offers included — an operator’s screen needs to see those too.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","offers"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/offers","variable":[{"key":"id","value":""}]}}},{"name":"List sellers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every seller, whatever their status. The storefront listing at /api/vendors shows approved ones only.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors"],"raw":"{{baseUrl}}/api/v1/admin/vendors"}}},{"name":"Add a seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"They arrive pending unless the body says otherwise.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors"],"raw":"{{baseUrl}}/api/v1/admin/vendors"}}},{"name":"Read a seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id","variable":[{"key":"id","value":""}]}}},{"name":"Edit a seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Approving one is a status change here, and it leaves an audit row carrying both sides.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Withdraws everything they were offering, by cascade. Suspending is the way to stop somebody selling while keeping the record.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id","variable":[{"key":"id","value":""}]}}},{"name":"What one seller is offering","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id","offers"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id/offers","variable":[{"key":"id","value":""}]}}},{"name":"Set a seller’s price for a variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates the offer or replaces the one that is there. One row per seller per variant.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id","offers"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id/offers","variable":[{"key":"id","value":""}]}}},{"name":"Withdraw one offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id","offers",":variantId"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id/offers/:variantId","variable":[{"key":"id","value":""},{"key":"variantId","value":""}]}}},{"name":"Open a login for a seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates an operator account with the `vendor` role attached to this seller. Gated on `team.write`, not `vendors.write`: editing a seller’s commission and handing somebody access to the store are different powers.\n\nThe account and the attachment are inseparable — a database CHECK (M48) refuses the vendor role without a vendor and any other role with one, because an account with the role and no vendor is the row every scoping rule fails open on. Deleting the seller deletes their logins.\n\nThe role carries no rights by default. What a vendor may do is granted by this store on the Roles screen; what a vendor may *see* is scoped to their own rows regardless.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","vendors",":id","users"],"raw":"{{baseUrl}}/api/v1/admin/vendors/:id/users","variable":[{"key":"id","value":""}]}}},{"name":"Who is selling this, for a shopper","request":{"auth":{"type":"noauth"},"description":"Active offers from approved sellers, cheapest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","variants",":id","offers"],"raw":"{{baseUrl}}/api/v1/store/variants/:id/offers","variable":[{"key":"id","value":""}]}}},{"name":"Approved sellers","request":{"auth":{"type":"noauth"},"description":"Approved only, and not from a query parameter: a storefront cannot ask for the pending ones by adding ?status=pending.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","vendors"],"raw":"{{baseUrl}}/api/v1/store/vendors"}}},{"name":"One seller’s shop","request":{"auth":{"type":"noauth"},"description":"A pending or suspended seller answers 404 rather than 403: that a slug is taken is itself something a shopper has no business learning.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","vendors",":slug"],"raw":"{{baseUrl}}/api/v1/store/vendors/:slug","variable":[{"key":"slug","value":""}]}}}],"name":"Vendors"},{"item":[{"name":"The account's saved addresses (Adreslerim)","request":{"auth":{"type":"noauth"},"description":"Defaults first. Empty for an unverified account.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","addresses"],"raw":"{{baseUrl}}/api/v1/store/customer/addresses"}}},{"name":"Save an address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 20 per account. Making it a default moves the default from the address that had it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","addresses"],"raw":"{{baseUrl}}/api/v1/store/customer/addresses"}}},{"name":"Change a saved address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","addresses",":id"],"raw":"{{baseUrl}}/api/v1/store/customer/addresses/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a saved address","request":{"auth":{"type":"noauth"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","addresses",":id"],"raw":"{{baseUrl}}/api/v1/store/customer/addresses/:id","variable":[{"key":"id","value":""}]}}},{"name":"The signed-in shopper's saved cards","request":{"auth":{"type":"noauth"},"description":"Saved cards (CH7): what the payment provider's card storage holds for this account — brand, bank, last four digits and expiry, never a number. `provider` narrows the list to one payment method. Empty until the owner switches saved cards on for a provider and the shopper saves a card at checkout. The card token and user key are sealed in the database and never returned.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","cards"],"raw":"{{baseUrl}}/api/v1/store/customer/cards"}}},{"name":"Delete a saved card","request":{"auth":{"type":"noauth"},"description":"Removes the card from the payment provider's storage (when the provider is set up) and from the account.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","cards",":id"],"raw":"{{baseUrl}}/api/v1/store/customer/cards/:id","variable":[{"key":"id","value":""}]}}},{"name":"Mesajlarım: the customer's chats","request":{"auth":{"type":"noauth"},"description":"Every chat started with the account's proved e-mail, newest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats"],"raw":"{{baseUrl}}/api/v1/store/customer/chats"}}},{"name":"Start a chat from the account","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Under the account's name and e-mail, about one of their orders when order_number is given; the store's assistant answers first when it is on.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats"],"raw":"{{baseUrl}}/api/v1/store/customer/chats"}}},{"name":"One of the customer's chats","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats",":id"],"raw":"{{baseUrl}}/api/v1/store/customer/chats/:id","variable":[{"key":"id","value":""}]}}},{"name":"Send a file in one of the customer's chats","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats",":id","attachments"],"raw":"{{baseUrl}}/api/v1/store/customer/chats/:id/attachments","variable":[{"key":"id","value":""}]}}},{"name":"A file of one of the customer's chats","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats",":id","attachments",":file"],"raw":"{{baseUrl}}/api/v1/store/customer/chats/:id/attachments/:file","variable":[{"key":"id","value":""},{"key":"file","value":""}]}}},{"name":"Close one of the customer's chats","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Both sides get the conversation by e-mail; writing again opens it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats",":id","close"],"raw":"{{baseUrl}}/api/v1/store/customer/chats/:id/close","variable":[{"key":"id","value":""}]}}},{"name":"Write in one of the customer's chats","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","chats",":id","messages"],"raw":"{{baseUrl}}/api/v1/store/customer/chats/:id/messages","variable":[{"key":"id","value":""}]}}},{"name":"The signed-in buyer's company","request":{"auth":{"type":"noauth"},"description":"Its name, the buyer's role, and for its admin the orders its buyers placed (the last 100). 404 when the buyer has no company.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","company"],"raw":"{{baseUrl}}/api/v1/store/customer/company"}}},{"name":"The signed-in customer's store credit","request":{"auth":{"type":"noauth"},"description":"Usable store credit, one amount per currency; empty until the address is verified.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","credit"],"raw":"{{baseUrl}}/api/v1/store/customer/credit"}}},{"name":"Apply the signed-in customer's store credit to a cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Puts their usable credit in the cart's currency on the cart (as many cards as a basket takes). A verified address only.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","credit","apply"],"raw":"{{baseUrl}}/api/v1/store/customer/credit/apply"}}},{"name":"The account's dealer status","request":{"auth":{"type":"noauth"},"description":"Whether the store takes applications, whether the account is a dealer now, and its latest application (ADR-0091 §3). no-store.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","dealer"],"raw":"{{baseUrl}}/api/v1/store/customer/dealer"}}},{"name":"Apply to buy as a dealer","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A verified account's application (company, VKN/TCKN with check digits, tax office with a VKN, phone, the KVKK notice). One open application per account (409 dealer_application_exists); 404 dealer_applications_closed when the store takes none; 403 verify_first for an unverified address; 429 past 3 a day per account or 30 an hour per store. A honeypot or a form sent too fast is answered the same and dropped. The store is told by email and its staff channels. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","dealer"],"raw":"{{baseUrl}}/api/v1/store/customer/dealer"}}},{"name":"Change the email address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs the password. Emails a confirmation link (24 hours) to the new address; the account keeps its address until the link is opened (POST /customer/email/confirm).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","email"],"raw":"{{baseUrl}}/api/v1/store/customer/email"}}},{"name":"Confirm a new email address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Spends an email-change link: the account's address becomes the new one, verified, and the guest orders placed with it are attached.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","email","confirm"],"raw":"{{baseUrl}}/api/v1/store/customer/email/confirm"}}},{"name":"Sign in with email and password","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Works before the address is verified. A verified account's guest orders placed with its address are attached on the way in. A wrong password and an address with no account are the same error and take the same time. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","login"],"raw":"{{baseUrl}}/api/v1/store/customer/login"}}},{"name":"End this session","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","logout"],"raw":"{{baseUrl}}/api/v1/store/customer/logout"}}},{"name":"End every session of the account (this one too)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","logout-all"],"raw":"{{baseUrl}}/api/v1/store/customer/logout-all"}}},{"name":"The signed-in customer's points","request":{"auth":{"type":"noauth"},"description":"With their invitation code when the store gives referral points; empty until the address is verified.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","loyalty"],"raw":"{{baseUrl}}/api/v1/store/customer/loyalty"}}},{"name":"Turn points into store credit","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At least the programme's minimum; becomes store credit (0183) in the base currency. A verified address only.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","loyalty","redeem"],"raw":"{{baseUrl}}/api/v1/store/customer/loyalty/redeem"}}},{"name":"The signed-in account","request":{"auth":{"type":"noauth"},"description":"Also slides the session's expiry.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","me"],"raw":"{{baseUrl}}/api/v1/store/customer/me"}}},{"name":"Change name and phone","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","me"],"raw":"{{baseUrl}}/api/v1/store/customer/me"}}},{"name":"Close the account","request":{"auth":{"type":"noauth"},"description":"KVKK/GDPR erasure of the address in this store (the same as the panel's): the customer record, its sessions, links and addresses are deleted; orders stay, as the law requires, with the person's name, phone and street address removed. Refused while an order, return or refund is in progress.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","me"],"raw":"{{baseUrl}}/api/v1/store/customer/me"}}},{"name":"Complete signing in with Google or Apple","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes what the provider sent back (`state`, `code`, Apple's first-time `user`) with the `binding` the storefront kept. The state is used once. The code is exchanged, the ID token is verified (signature against the provider's JWKS, issuer, audience, expiry, nonce) and the shopper is found by their provider identity or, the first time, by the e-mail address the provider verified: linked to an existing account, or a verified account is opened. An unverified address places nobody (422 `oauth_email_unverified`); a password-only account that was never verified loses its password when linked. 401 `oauth_failed` / `oauth_expired`; 429 after repeated failures. Answers like a sign-in, with the session for the storefront's server only, plus `return_to` and `new`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","oauth","callback"],"raw":"{{baseUrl}}/api/v1/store/customer/oauth/callback"}}},{"name":"The sign-ins the store offers (Google, Apple)","request":{"auth":{"type":"noauth"},"description":"Which of `google` and `apple` the store has set up (its own client id and secret entered in the panel), in the order the buttons show. Empty when the store offers none: the storefront then shows no button. Not cacheable.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","oauth","providers"],"raw":"{{baseUrl}}/api/v1/store/customer/oauth/providers"}}},{"name":"Begin signing in with Google or Apple","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes the state, nonce and PKCE pair, stores the hashes and the public challenge, and returns the provider's authorisation URL to send the browser to, with `binding` (the PKCE verifier) for the storefront's server to keep in an HttpOnly cookie until the callback. `redirect_uri` must be https on one of the store's own addresses at /api/account/oauth/callback; `return_to` is a path on the store (anything else is dropped). 409 `oauth_not_configured` when the store does not offer the provider.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","oauth","start"],"raw":"{{baseUrl}}/api/v1/store/customer/oauth/start"}}},{"name":"The account's orders (Siparişlerim)","request":{"auth":{"type":"noauth"},"description":"Newest first. Empty for an account whose address is not verified.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","orders"],"raw":"{{baseUrl}}/api/v1/store/customer/orders"}}},{"name":"Change the password","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs the current password. Every other session ends; this one stays. The shopper is emailed that the password changed.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","password"],"raw":"{{baseUrl}}/api/v1/store/customer/password"}}},{"name":"Forgot password: email a reset link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Emails a reset link (1 hour, single use) when the address has an account in this store. Identical answer for every address. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","password-reset"],"raw":"{{baseUrl}}/api/v1/store/customer/password-reset"}}},{"name":"Set a new password from a reset link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sets the password, marks the address verified (the link proves the mailbox), ends every session, drops the account's other links, attaches its guest orders and signs the shopper in. A name and marketing tick typed at sign-up but never verified are discarded.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","password-reset","confirm"],"raw":"{{baseUrl}}/api/v1/store/customer/password-reset/confirm"}}},{"name":"The stores a NeroCart customer runs","request":{"auth":{"type":"noauth"},"description":"On the platform's own store only (404 elsewhere): the stores the account's proved e-mail belongs to as staff.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","platform"],"raw":"{{baseUrl}}/api/v1/store/customer/platform"}}},{"name":"Open a customer account (sign up)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates an account on the store's customer record for the address and emails a verification link (24 hours, single use). When the address already has an account nothing is created and its owner is emailed the way back in instead. The answer is identical either way, and the email is sent after the answer, so neither the body, the status nor the timing says whether an address has an account. Throttled per address and client. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","register"],"raw":"{{baseUrl}}/api/v1/store/customer/register"}}},{"name":"The signed-in customer's repeat orders","request":{"auth":{"type":"noauth"},"description":"Empty until the address is verified.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","subscriptions"],"raw":"{{baseUrl}}/api/v1/store/customer/subscriptions"}}},{"name":"Repeat one of the customer's orders","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every 7 to 365 days; when due, a payment link of its lines is e-mailed — nothing is charged without the customer. A verified address only.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","subscriptions"],"raw":"{{baseUrl}}/api/v1/store/customer/subscriptions"}}},{"name":"Change the customer's repeat order","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Pause, resume, cancel, skip the next or change the interval.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","subscriptions",":id"],"raw":"{{baseUrl}}/api/v1/store/customer/subscriptions/:id","variable":[{"key":"id","value":""}]}}},{"name":"Verify the account's email address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Spends a verification link together with the account's password (the link alone would let somebody who signed up with another person's address claim that person's orders by getting them to click). Marks the address verified, attaches the store's guest orders placed with it, grants a marketing consent ticked at sign-up (double opt-in) and signs the shopper in.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","verify"],"raw":"{{baseUrl}}/api/v1/store/customer/verify"}}},{"name":"Send a new verification link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","verify","resend"],"raw":"{{baseUrl}}/api/v1/store/customer/verify/resend"}}},{"name":"The account's favourites (Favorilerim)","request":{"auth":{"type":"noauth"},"description":"Product ids, newest first. A guest keeps favourites in the browser; they are merged in with POST after sign-in.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","wishlist"],"raw":"{{baseUrl}}/api/v1/store/customer/wishlist"}}},{"name":"Add products to the favourites (merge)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds the active products named in `product_ids` (at most 200); an unknown or archived product is skipped and one already there keeps its date. The list holds at most 200 products: 409 when it is full.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","wishlist"],"raw":"{{baseUrl}}/api/v1/store/customer/wishlist"}}},{"name":"Remove a product from the favourites","request":{"auth":{"type":"noauth"},"description":"A product not on the list is no error.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","customer","wishlist",":product_id"],"raw":"{{baseUrl}}/api/v1/store/customer/wishlist/:product_id","variable":[{"key":"product_id","value":""}]}}}],"name":"account"},{"item":[{"name":"Test the BizimHesap connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Reads BizimHesap's warehouse list (GET /api/b2b/warehouses) with the saved firm id and API token, whether or not the integration is switched on yet: the cheapest authenticated call. `ok` is true when BizimHesap answered; `warehouses` is how many it listed. Nothing is written at BizimHesap or stored; the answer never carries the token. 409 when the firm id or the token is missing. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","accounting-bizimhesap","test"],"raw":"{{baseUrl}}/api/v1/admin/x/accounting-bizimhesap/test"}}}],"name":"accounting-bizimhesap"},{"item":[{"name":"The store’s activity","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every recorded operator action, newest first. Two things a reader has to know: a key present in changes.after and absent from changes.before means the previous value was not recorded rather than that it was empty; and created_at is the transaction's start time, so an audit row and the outbox event from the same transaction carry an identical instant. An unknown actor_kind, action or entity_type answers with an empty page rather than a 400, because a feed that refuses a stale filter is a screen an operator cannot get out of. It sits behind store.operate: filtering the whole store by person is a different question from the history of one record, which follows that record's own read right.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","audit"],"raw":"{{baseUrl}}/api/v1/admin/audit"}}},{"name":"Who appears in the trail","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Most recently active first, capped at 200. No meta block: it is a short bounded list, and it is built from the trail rather than from the team table.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","audit","actors"],"raw":"{{baseUrl}}/api/v1/admin/audit/actors"}}},{"name":"A campaign’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Budget figures are integers on both sides of a change. A record with no rows answers 200 with an empty array rather than 404.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/campaigns/:id/history","variable":[{"key":"id","value":""}]}}},{"name":"A category’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Creation, edits and deletion, with parent_id on both sides of a move. A record with no rows answers 200 with an empty array rather than 404: the log knowing nothing about a record is not the record being absent, and everything that existed before this table did has an honestly empty history.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/history","variable":[{"key":"id","value":""}]}}},{"name":"A discount’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"value_bp and value_minor are integers on both sides of a change, never a percentage and never a formatted amount. A record with no rows answers 200 with an empty array rather than 404: the log knowing nothing about a record is not the record being absent, and everything that existed before this table did has an honestly empty history.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/history","variable":[{"key":"id","value":""}]}}},{"name":"A location’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Includes location.set_default, which silently redirects every future reservation in the store. A record with no rows answers 200 with an empty array rather than 404: the log knowing nothing about a record is not the record being absent, and everything that existed before this table did has an honestly empty history.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id/history","variable":[{"key":"id","value":""}]}}},{"name":"A product’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Product edits, options, media and collection membership, plus every variant edit under it — including the price, because a variant edit is filed against the product an operator is looking at. A record with no rows answers 200 with an empty array rather than 404: the log knowing nothing about a record is not the record being absent, and everything that existed before this table did has an honestly empty history.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/history","variable":[{"key":"id","value":""}]}}},{"name":"A tax rate’s history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"rate_bp in basis points on both sides — what makes \"who raised VAT, and when\" answerable. A record with no rows answers 200 with an empty array rather than 404: the log knowing nothing about a record is not the record being absent, and everything that existed before this table did has an honestly empty history.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates",":id","history"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates/:id/history","variable":[{"key":"id","value":""}]}}}],"name":"admin:audit"},{"item":[{"name":"Complete signing in to the panel with Google Workspace","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes `state`, `code` and the `binding` from the start. The state is used once. The ID token is verified (JWKS signature, issuer, audience, expiry, nonce) and must carry a verified address whose `hd` claim is one of the store's allowed Workspace domains and matches the address's domain; the address must belong to an EXISTING active team member (nobody is created). The first Google account a member uses is remembered; a different one is refused. A member with a second factor enrolled gets 403 `google_signin_use_password`. Answers like the password sign-in: a session token and the record. 401 `google_signin_failed` / `google_signin_expired`; 403 `google_signin_not_allowed`; 429 after repeated failures.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-google","callback"],"raw":"{{baseUrl}}/api/v1/admin/auth-google/callback"}}},{"name":"Begin signing in to the panel with Google Workspace","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Public, like the password sign-in. Makes the state, nonce and PKCE pair and returns Google's authorisation URL with `binding` (the PKCE verifier), which the panel keeps in sessionStorage until its callback page loads. `redirect_uri` must be https://\u003cthis panel's host\u003e/admin/sign-in/google/. `tenant_id` names the tenant as the password sign-in does. 409 `google_signin_not_configured` when the store set no client or no allowed domains.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-google","start"],"raw":"{{baseUrl}}/api/v1/admin/auth-google/start"}}},{"name":"End this session","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-logout"],"raw":"{{baseUrl}}/api/v1/admin/auth-logout"}}},{"name":"Exchange a session for a fresh one","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The panel calls this on boot to turn a stored token back into an identity, and to learn that a token has expired without waiting for a real request to fail. The old token is revoked. A static admin token is not a session and gets a 400.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-refresh"],"raw":"{{baseUrl}}/api/v1/admin/auth-refresh"}}},{"name":"Whether this installation has an operator yet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Public, because it has to answer before anyone can hold a credential. The panel calls it first so a fresh database offers to create the first superuser instead of presenting a login form nobody could satisfy.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-state"],"raw":"{{baseUrl}}/api/v1/admin/auth-state"}}},{"name":"Sign in with an email and a password","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns a session token to send as `Authorization: Bearer \u003ctoken\u003e`. The session belongs to one tenant — the one the host names, or `tenant_id` — and a person who belongs to several signs in to each. Wrong password, unknown operator and unknown tenant give the identical 400, so the endpoint cannot be used to discover who has an account. Failures are throttled per email and address, per address and per email, in PostgreSQL, so every instance counts the same ones. A user with a second factor must also send `otp` or `recovery_code`. Cloudflare Turnstile (ADR-0096): on a NeroCart host with the platform's keys set, the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). A store's own keys never guard the sign-in.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","auth-with-password"],"raw":"{{baseUrl}}/api/v1/admin/auth-with-password"}}},{"name":"Create the first superuser","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Public only while no superuser exists; afterwards it is 409 for everyone. This is the one-time window that lets a fresh install become usable without shell access.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","install"],"raw":"{{baseUrl}}/api/v1/admin/install"}}},{"name":"List invitations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Outstanding first, then accepted ones most recent first. Accepted invitations are kept so the team screen can answer who let somebody in.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invitations"],"raw":"{{baseUrl}}/api/v1/admin/invitations"}}},{"name":"Invite somebody to the team","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns the invitation with its `token` and `accept_url` — the only response that ever carries them. Send the link; the invitee chooses their own password and nobody else ever sees it.\n\nRe-inviting an address replaces the outstanding invitation, so the previous link stops working. An address that already belongs to an operator is refused: changing somebody's role has its own endpoint, and it cannot be used to hand out a fresh password.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invitations"],"raw":"{{baseUrl}}/api/v1/admin/invitations"}}},{"name":"See what an invitation is for","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Unauthenticated, necessarily: the invitee has no account yet. Holding the token is the credential, and the response says only what somebody with the link is about to be told anyway. An expired, used or unknown token resolves to nothing.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invitations","accept",":token"],"raw":"{{baseUrl}}/api/v1/admin/invitations/accept/:token","variable":[{"key":"token","value":""}]}}},{"name":"Accept an invitation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates the operator with the password they choose and signs them in, returning the same token/record shape as signing in does. An invitee who has just chosen a password should not then be shown a login form.\n\nThe invitation is claimed with a conditional update inside the same transaction, so two people opening one link cannot both become operators.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invitations","accept",":token"],"raw":"{{baseUrl}}/api/v1/admin/invitations/accept/:token","variable":[{"key":"token","value":""}]}}},{"name":"Revoke an invitation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Closes an outstanding link. An accepted invitation is history and cannot be revoked — remove the operator instead.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invitations",":id"],"raw":"{{baseUrl}}/api/v1/admin/invitations/:id","variable":[{"key":"id","value":""}]}}},{"name":"Who am I, and where am I signed in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Any signed-in operator, whatever their role. The static admin token has no person behind it and gets a 403.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me"],"raw":"{{baseUrl}}/api/v1/admin/me"}}},{"name":"Change your own email or password","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Deliberately not behind `team.write` — that is also the right to change everybody's role, and gating this behind it means a staff member must ask an owner to choose a password for them.\n\n`current_password` is required for either change: a session left open on an unlocked laptop should not be enough to take the account over. Changing the password ends every other session and keeps this one.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me"],"raw":"{{baseUrl}}/api/v1/admin/me"}}},{"name":"Remove the second factor","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs the password and a code. Refused (403) when the membership or the role requires a second factor: that is the store's policy to change.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","mfa"],"raw":"{{baseUrl}}/api/v1/admin/me/mfa"}}},{"name":"Turn the second factor on","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The first correct code from the authenticator confirms the enrollment and returns the recovery codes. Wrong codes are throttled.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","mfa","confirm"],"raw":"{{baseUrl}}/api/v1/admin/me/mfa/confirm"}}},{"name":"Start setting up a second factor","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns a TOTP secret (RFC 6238: HMAC-SHA1, 30 s, 6 digits) and its otpauth:// URI, once. Nothing is on until the first code is confirmed. Refused (409) when a second factor is already set up.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","mfa","enroll"],"raw":"{{baseUrl}}/api/v1/admin/me/mfa/enroll"}}},{"name":"Replace the recovery codes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Proven by a current code or an unused recovery code; every earlier recovery code stops working.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","mfa","recovery-codes"],"raw":"{{baseUrl}}/api/v1/admin/me/mfa/recovery-codes"}}},{"name":"Sign yourself out everywhere","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Ends every session including this one. \"Everywhere\" that quietly excepted the device you are on would not be what it says. Since M8 this ends the user's sessions in every tenant they belong to.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","revoke-sessions"],"raw":"{{baseUrl}}/api/v1/admin/me/revoke-sessions"}}},{"name":"The tenants the signed-in user belongs to","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"For a tenant switcher: sign in to another with `tenant_id` on /api/admin/auth-with-password. Read through the platform role, which may see who belongs where and nothing else.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","tenants"],"raw":"{{baseUrl}}/api/v1/admin/me/tenants"}}},{"name":"Ask for a password reset link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Public, because a reset cannot require the credential it replaces. The answer is 202 whatever address goes in — identical in body and in status for an address that belongs to an operator and one that does not — so the route cannot be used to discover who has an account. `delivery` is `none` when the store has no email backend beyond the built-in logger; nothing will arrive, and no token is written at all. Repeated requests are throttled, on a budget separate from the login one. Cloudflare Turnstile (ADR-0096): on a NeroCart host with the platform's keys set, the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). A store's own keys never guard the sign-in.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","password-reset"],"raw":"{{baseUrl}}/api/v1/admin/password-reset"}}},{"name":"Spend a reset link and sign in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Public. The token travels in the body rather than the path, so the one request that spends it is not repeated in an access log. It is claimed and spent in a single transaction, so two people opening one link cannot both win; every session that operator held ends with it, as does every other outstanding link of theirs, and the session in the response is new. The password is validated before the token is touched, so a typo does not burn the link.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","password-reset","confirm"],"raw":"{{baseUrl}}/api/v1/admin/password-reset/confirm"}}},{"name":"Whether a reset link is still alive","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Public: holding the token is the credential. It returns only when the link expires, so the reset screen can show a dead link before anybody types a password twice. It deliberately does not name the account — an endpoint that turned a token into an address would be the one place in this flow that confirms an operator exists.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","password-reset",":token"],"raw":"{{baseUrl}}/api/v1/admin/password-reset/:token","variable":[{"key":"token","value":""}]}}},{"name":"List operators","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers"],"raw":"{{baseUrl}}/api/v1/admin/superusers"}}},{"name":"Add an operator","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers"],"raw":"{{baseUrl}}/api/v1/admin/superusers"}}},{"name":"Change an operator's email or password","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Send either field, or both. Changing the password signs that operator out everywhere, because a password change is how someone responds to a compromise. The email and the password are the user's (M8): for a person who also belongs to another organisation this is refused with 403, and they change their own through PATCH /api/admin/me.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove an operator","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The last superuser cannot be removed: an admin panel nobody can sign in to is not a state an operator can click their way out of.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id","variable":[{"key":"id","value":""}]}}},{"name":"Mail an operator a reset link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires `team.write`, the right that can already set that operator's password outright — so this grants nothing new, and replaces the practice of choosing somebody's password for them.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id","password-reset"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id/password-reset","variable":[{"key":"id","value":""}]}}},{"name":"Sign somebody else out everywhere","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"What to reach for when a laptop goes missing, or before removing an account. A role change already takes effect on the next request — the role is read from the row each time — but a session has to be ended to stop it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id","revoke-sessions"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id/revoke-sessions","variable":[{"key":"id","value":""}]}}}],"name":"admin:auth"},{"item":[{"name":"Suggest an item's HS code from the tariff list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Finds the item's six-digit Harmonised System subheading in the tariff list (the open HS 2022 dataset joined with Türkiye's 2026 tariff): the list is searched with the item's name, type and category words; when the store has an AI it only chooses among those lines (it may ask for one more search with words of its own) and a code outside them is never taken; without an AI the list's closest lines are the answer (candidates). Writes nothing. An AI that is not set up or fails is a 200 with error set (not_configured, rate_limited, provider_error, timeout, network, refused, invalid_answer, no_match) and the candidates still filled. Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","ai","hs-code"],"raw":"{{baseUrl}}/api/v1/admin/ai/hs-code"}}},{"name":"The AI providers the panel offers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every provider the AI assistant can use, in the panel's order, with its default model and the page where its API keys are made (the panel opens it in a new tab). Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","ai","providers"],"raw":"{{baseUrl}}/api/v1/admin/ai/providers"}}},{"name":"Test the store's AI","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One tiny call through the store's AI (its own key, else NeroCart's); spends one call of the store's budget. ok, or the kind of failure: not_configured, provider_error (http_status 401: the key was refused), rate_limited, timeout, network, refused, invalid_answer. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","ai","test"],"raw":"{{baseUrl}}/api/v1/admin/ai/test"}}},{"name":"List brands","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The vendors of the store's products and the brands saved without products now. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","brands"],"raw":"{{baseUrl}}/api/v1/admin/brands"}}},{"name":"Save a brand's page address, logo and words","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"By name (a product's vendor). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","brands"],"raw":"{{baseUrl}}/api/v1/admin/brands"}}},{"name":"Translate a brand's words","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Machine-translates the brand's words (rich description, search title and description) into every other language of the store through its translation service. The brand's name and the glossary's protected terms stay as they are; a translation written by hand is kept. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","brands","translate"],"raw":"{{baseUrl}}/api/v1/admin/brands/translate"}}},{"name":"List campaigns","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's campaigns, newest first. Needs discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns"],"raw":"{{baseUrl}}/api/v1/admin/campaigns"}}},{"name":"Create a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs discounts.write. Audited as campaign.create.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns"],"raw":"{{baseUrl}}/api/v1/admin/campaigns"}}},{"name":"Get a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only the keys present are written, under the row lock checkout registers usage under. The budget's `used` cannot be written.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its promotions stay, without a campaign. Orders keep their snapshots.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"List, search or browse the tree","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Three shapes from one route. `?q=` searches the whole tree and answers with a bounded flat set of paths, which is the normal way to work once a full taxonomy is imported. `?parent=root` or `?parent={id}` returns one level, the shape a browsable picker asks for, bounded by construction. Neither, and the whole tree comes back, but only while it is small enough to send honestly: past that the response is a bounded slice whose `meta.total` reports the real size, so a client that compares the two can see it holds only a part and switch to searching.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories"],"raw":"{{baseUrl}}/api/v1/admin/categories"}}},{"name":"Create a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories"],"raw":"{{baseUrl}}/api/v1/admin/categories"}}},{"name":"Get a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Refused while anything still points at it, whether a subcategory or a product filed under it. Deleting a branch is not a way to lose what was in it, so the references have to be moved first.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id","variable":[{"key":"id","value":""}]}}},{"name":"The branch a category sits on, root first","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The chain from the root down to this category, the category itself last. A client that holds one category and needs what the whole branch says about it cannot get there from the listing — a store carrying a full taxonomy has thousands of categories and the listing sends a page — so the chain is asked for by id. Each node carries its metadata, which is where a category declares the fields it asks of a product. An unknown id comes back as an empty list rather than a 404: it is a category deleted while somebody had the product open.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","ancestors"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/ancestors","variable":[{"key":"id","value":""}]}}},{"name":"List a category's translations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","translations"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/translations","variable":[{"key":"id","value":""}]}}},{"name":"Set a category's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the language's translation; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Remove a category's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Move a category's translation through review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs categories.write. draft → reviewed → approved → published, one step at a time, or back to draft from any state (reject / withdraw). The same status again is a no-op. Only a published translation is served by store reads. Audited (`category.translation_status`, with the note).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories",":id","translations",":lang","status"],"raw":"{{baseUrl}}/api/v1/admin/categories/:id/translations/:lang/status","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"A collection's rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Absent rules: a hand-picked collection. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","rules"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/rules","variable":[{"key":"id","value":""}]}}},{"name":"Make a collection automatic, or hand-picked again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"With rules the members become the products that match them (all or any): tag eq, vendor eq, product_type eq, title contains, category_id eq, price gt/lt (minor units). Worked out now and again after products change. Null rules keep the members, now hand-picked. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","rules"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/rules","variable":[{"key":"id","value":""}]}}},{"name":"Move a collection's translation through review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs collections.write. draft → reviewed → approved → published, one step at a time, or back to draft from any state (reject / withdraw). The same status again is a no-op. Only a published translation is served by store reads. Audited (`collection.translation_status`, with the note).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","translations",":lang","status"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/translations/:lang/status","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"The store's currencies and exchange rates","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. The base currency and every extra currency the store's markets sell in, each priced by hand (manual) or from the European Central Bank's daily reference rate (auto) with a markup and a rounding rule; the last rate, when the prices were last updated, and how many prices are automatic or set by hand.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","currencies"],"raw":"{{baseUrl}}/api/v1/admin/currencies"}}},{"name":"Update the rates and automatic prices now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. Queues the currency.rates job for the store (it also runs every six hours by itself): fetches the day's ECB rates and rewrites the automatic prices.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","currencies","refresh"],"raw":"{{baseUrl}}/api/v1/admin/currencies/refresh"}}},{"name":"Set how a currency's prices are made","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. manual: prices by hand (the product editor, the CSV). auto: every variant's price in the currency follows the base price × the rate × (1 + markup %), rounded by the rule — a price set by hand is never overwritten. Switching to auto queues a refresh. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","currencies",":code"],"raw":"{{baseUrl}}/api/v1/admin/currencies/:code","variable":[{"key":"code","value":""}]}}},{"name":"Hand the prices set by hand over to the rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. Every price set by hand in the currency becomes automatic, so the next refresh rewrites it from the rate (an imported price list the store now wants to follow the rate). Audited; queues a refresh when the currency is automatic.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","currencies",":code","release-hand-prices"],"raw":"{{baseUrl}}/api/v1/admin/currencies/:code/release-hand-prices","variable":[{"key":"code","value":""}]}}},{"name":"Look up the tariff list (HS / GTİP)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The tariff list by code or by words: a code or the start of one (0902, 0902.10, 0904.21.90) lists the lines one level under it in code order (a subheading lists Türkiye's 12-digit GTİP lines); words (green tea, yeşil çay) list the subheadings whose text matches best, Turkish and English folded. At most 10 lines; exact is q's own line when q is a code the list holds. The same for every store. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customs","hs"],"raw":"{{baseUrl}}/api/v1/admin/customs/hs"}}},{"name":"List discounts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts"],"raw":"{{baseUrl}}/api/v1/admin/discounts"}}},{"name":"Create a discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts"],"raw":"{{baseUrl}}/api/v1/admin/discounts"}}},{"name":"Get a discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`used_count` cannot be written: it is a fact about what happened, and letting an operator type over it would silently reopen a promotion that has been fully used. `target_ids` absent leaves the stored set alone; a list replaces it whole, because the caller holds the whole list; `[]` clears it, which is refused while the resulting scope is still products, collections or categories. Setting `scope` to `order` clears the targets in the same transaction without needing `target_ids`. Moving the scope to or between the other three requires `target_ids` in the same body — the targets it would otherwise inherit are of the wrong kind. A patch that changes only `target_ids` is a real edit and bumps `updated_at`. (This operation still references DiscountInput rather than a DiscountPatch schema, so the field documents both verbs by accident rather than by design.)","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Orders that used it keep their snapshot and read correctly.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id","variable":[{"key":"id","value":""}]}}},{"name":"Where a discount's coupon is shown","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The pages and popups whose working or live version holds a coupon widget for this discount, by language (\"3 sayfada kullanılıyor\" before it is deleted). Needs discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","coupon-uses"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/coupon-uses","variable":[{"key":"id","value":""}]}}},{"name":"Orders that used this discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What a promotion has actually been spent on, newest first. The rows are the snapshots taken at checkout, so a rule that has since been renamed still reads as what it was.\n\nCancelled orders are listed here, marked by their status, and excluded from the detail's `redeemed_total` — so `meta.total` counts more orders than `redeemed_orders` whenever any were cancelled.\n\nNeeds both `discounts.read` and `orders.read`: the row carries an order number, an email address and a total.\n\nA deleted rule's redemptions are unreachable here, because `order_discounts.discount_id` is `ON DELETE SET NULL` and the snapshots stay with their orders.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","orders"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/orders","variable":[{"key":"id","value":""}]}}},{"name":"Try a discount against a basket","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A dry run, so a new promotion's first test is not a real customer. Nothing is locked, nothing is written and no usage is claimed, so a preview can never exhaust a code.\n\nA rule that would not apply comes back as `applies: false` with the reason, not as an error — the question was whether it works, and \"no, it expired on Friday\" is a successful answer to it. Reasons include an expired or unstarted window, an inactive rule, a usage limit reached, a basket below the minimum, a code already used by that email address, a scope holding nothing in this basket, and a codeless automatic rule, which nothing evaluates at checkout yet.\n\nSend `subtotal_minor` for an order-wide rule, or `lines` for a scoped one — a scoped rule comes off the lines its targets reach, which a bare total cannot say. Sending both is a 400.\n\nThe request being wrong is still an error: an unknown id is 404 and a negative amount is 400.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","preview"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/preview","variable":[{"key":"id","value":""}]}}},{"name":"Products a discount reaches","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The products this promotion applies to, resolved the way checkout resolves them: the products a rule names, the members of its collections, or everything filed under its categories (descendants included); an order-wide rule reaches every product. Newest first, best match first under `q`. Assigning products is the discount's own PATCH (`target_ids`). Needs both `discounts.read` and `catalog.read`.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","products"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/products","variable":[{"key":"id","value":""}]}}},{"name":"Hidden stock by variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The tenant's shipped variants with their hidden count (ADR-0142), those holding some first, then by product. Needs inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","inventory","hidden-stock"],"raw":"{{baseUrl}}/api/v1/admin/inventory/hidden-stock"}}},{"name":"Variants at or below a stock threshold","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","inventory","low-stock"],"raw":"{{baseUrl}}/api/v1/admin/inventory/low-stock"}}},{"name":"Invoice items (what products are invoiced as)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's list: the name on the invoice, the customs description and the tariff number (GTİP), by name. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items"}}},{"name":"Create an invoice item","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Name 1–120 characters, unique in the store; customs at most 105; hs_code empty or 6–12 digits (dots are dropped). At most 100 per store. Audited (invoice_item.create). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items"}}},{"name":"The invoice item of each product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A product invoiced under its own name is absent. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items","assignments"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items/assignments"}}},{"name":"Invoice products as an item","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Puts 1–1000 products on an item, or (item_id null) back on their own names. Audited (invoice_item.assign). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items","assignments"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items/assignments"}}},{"name":"Replace an invoice item","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (invoice_item.update). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items",":id"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete an invoice item","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its products are invoiced under their own names again. Audited (invoice_item.delete). Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoice-items",":id"],"raw":"{{baseUrl}}/api/v1/admin/invoice-items/:id","variable":[{"key":"id","value":""}]}}},{"name":"The KDV list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The platform's list of product kinds with their Turkish KDV rate and legal basis (2007/13033 and its amendments to 2026-11-04), groups first, each group's entries after it. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","kdv","categories"],"raw":"{{baseUrl}}/api/v1/admin/kdv/categories"}}},{"name":"The store's KDV classes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's classes that carry a rate, by name. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","kdv","classes"],"raw":"{{baseUrl}}/api/v1/admin/kdv/classes"}}},{"name":"Add a KDV class","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns the store's class for a list entry (made the first time it is picked), or makes the merchant's own class with any rate. Audited (tax_class.create). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","kdv","classes"],"raw":"{{baseUrl}}/api/v1/admin/kdv/classes"}}},{"name":"Put a burned code back into its pool","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For a code the store knows was never used (a refund before it was redeemed, a code burned by mistake); its unit goes back on the shelf. A reason is required. Audited as licence_key.restore. Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","licence-keys",":id","restore"],"raw":"{{baseUrl}}/api/v1/admin/licence-keys/:id/restore","variable":[{"key":"id","value":""}]}}},{"name":"Read a code in the clear","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every call writes a licence_key.reveal audit row naming the operator, in the same transaction as the read; the code is not in the row. Answered no-store. Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","licence-keys",":id","reveal"],"raw":"{{baseUrl}}/api/v1/admin/licence-keys/:id/reveal","variable":[{"key":"id","value":""}]}}},{"name":"List locations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"In the order stock is drawn from them: lowest priority first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations"],"raw":"{{baseUrl}}/api/v1/admin/locations"}}},{"name":"Open a location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A new location holds nothing and is not made default — that would silently redirect every future reservation as a side effect of adding a shelf. Move stock into it with the variant transfer endpoint.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations"],"raw":"{{baseUrl}}/api/v1/admin/locations"}}},{"name":"Get a location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Deactivating one that still holds stock is refused, and the error names how many units are stranded: an inactive location would have its units counted in `stock_on_hand` while nothing could reserve them.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id","variable":[{"key":"id","value":""}]}}},{"name":"Close a location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Refused while it holds stock, and refused for the default one — something has to answer \"where does this land\". Orders already filled from here keep reading; their lines simply stop naming a place.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id","variable":[{"key":"id","value":""}]}}},{"name":"Make this the default location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The default is where stock lands when nothing names a place: new variants, CSV imports, and every client written before locations existed. Exactly one location is the default, so this moves it rather than adding one.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id","default"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id/default","variable":[{"key":"id","value":""}]}}},{"name":"Everything that moved at one location","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The same ledger from the other end: everything that has moved at one location, newest first. A location that has been deleted answers 404 — its rows stay readable on the variant route, where the location_code snapshot still names where the units were.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id","movements"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id/movements","variable":[{"key":"id","value":""}]}}},{"name":"What one location holds","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The inverse of `GET /api/admin/variants/{id}/stock`: what one place is holding, rather than where one variant is. Each row carries `at_location` beside the variant's store-wide figures, so \"the store has 40, this shelf has none\" is one row rather than two requests. Only variants this location already has a stock row for appear — one it has never carried is not a shelf it can restock.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","locations",":id","stock"],"raw":"{{baseUrl}}/api/v1/admin/locations/:id/stock","variable":[{"key":"id","value":""}]}}},{"name":"The store's variant option sets","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"By name. A set fills a product option in the panel; it is never read by the storefront. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","option-sets"],"raw":"{{baseUrl}}/api/v1/admin/option-sets"}}},{"name":"Create a variant option set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited. At most 200 sets per store. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","option-sets"],"raw":"{{baseUrl}}/api/v1/admin/option-sets"}}},{"name":"Replace a variant option set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited; products filled from it keep their options. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","option-sets",":id"],"raw":"{{baseUrl}}/api/v1/admin/option-sets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a variant option set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited; products filled from it keep their options. Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","option-sets",":id"],"raw":"{{baseUrl}}/api/v1/admin/option-sets/:id","variable":[{"key":"id","value":""}]}}},{"name":"The store's product fields","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Typed fields kept on every product (text, number, boolean, date, url), in order. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-fields"],"raw":"{{baseUrl}}/api/v1/admin/product-fields"}}},{"name":"Replace the store's product fields","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 50; their order is the list's. A field taken away keeps its values on products, unshown. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-fields"],"raw":"{{baseUrl}}/api/v1/admin/product-fields"}}},{"name":"Set a file's link life and opening count","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Days 1–3650, openings 1–1000; for links made from now on. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-files",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-files/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With every link to it. Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-files",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-files/:id","variable":[{"key":"id","value":""}]}}},{"name":"Product labels (Ürünler › Etiketler)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Best priority first. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-labels"],"raw":"{{baseUrl}}/api/v1/admin/product-labels"}}},{"name":"Create a product label","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Words per language, colours, and a rule: manual (put on products by hand), collection, tag, new (days), discount (percent), min_price. At most 50 per store. Audited (product_label.create). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-labels"],"raw":"{{baseUrl}}/api/v1/admin/product-labels"}}},{"name":"Replace a product label","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A label changed to a rule leaves the products it was on by hand. Audited (product_label.update). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-labels",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-labels/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a product label","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited (product_label.delete). Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-labels",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-labels/:id","variable":[{"key":"id","value":""}]}}},{"name":"List product questions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, at most 500; status narrows (pending, published, hidden). Right: reviews.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-questions"],"raw":"{{baseUrl}}/api/v1/admin/product-questions"}}},{"name":"Answer, publish or hide a question","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A first answer is e-mailed to the asker. Right: reviews.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-questions",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-questions/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a question","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: reviews.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-questions",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-questions/:id","variable":[{"key":"id","value":""}]}}},{"name":"List your saved product views","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. The signed-in operator's own views of the products list, by name.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-views"],"raw":"{{baseUrl}}/api/v1/admin/product-views"}}},{"name":"Save a product view","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.read. `query` is the list's query string as the panel writes it; `id`, `page` and token-like keys are dropped. The same name replaces the operator's view. At most 50 per list. Audited (`saved_view.create`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-views"],"raw":"{{baseUrl}}/api/v1/admin/product-views"}}},{"name":"Delete a saved product view","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. Only the operator's own view. Audited (`saved_view.delete`).","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-views",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-views/:id","variable":[{"key":"id","value":""}]}}},{"name":"List products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products"],"raw":"{{baseUrl}}/api/v1/admin/products"}}},{"name":"Create a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Options and variants may be created in the same call. For a product with no options, send `sku` and `price_minor` instead of `variants` and the single default variant is created for you.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products"],"raw":"{{baseUrl}}/api/v1/admin/products"}}},{"name":"Apply one action to many products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write (and collections.write for `add_to_collection`). Each product is its own transaction with its own audit row and event, so one failure never undoes the others; the answer lists what was done and what failed, with the reason. `publish` sets status active, `unpublish` draft. `delete` needs `confirm: true`. At most 500 products. Orders have no bulk writes: money and shipping actions stay one order at a time (bulk export is `ids=` on the order export).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products","bulk"],"raw":"{{baseUrl}}/api/v1/admin/products/bulk"}}},{"name":"Change many prices at once","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"percent: every price of the chosen products in every currency (the store's own and each currency price) moves by `value` %, rounded to the currency's smallest unit (-90…500). amount: `value` in `currency` (the store's own when empty) is added to every price in that currency. `compare_at` moves the struck-through price the same way. Nothing is written when a price would fall below zero (400). `product_ids` empty: every product. `dry_run`: counts and a few before/after samples, nothing written. Audited; a price.changed event per product.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products","bulk-price"],"raw":"{{baseUrl}}/api/v1/admin/products/bulk-price"}}},{"name":"Currencies the store has prices in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products","bulk-price","currencies"],"raw":"{{baseUrl}}/api/v1/admin/products/bulk-price/currencies"}}},{"name":"Get a product in any status","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id"],"raw":"{{baseUrl}}/api/v1/admin/products/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every field is optional; an omitted field is left alone, which is what distinguishes \"not mentioned\" from \"set to empty\".","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id"],"raw":"{{baseUrl}}/api/v1/admin/products/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Order lines survive: they hold their own snapshot and their product reference is simply nulled.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id"],"raw":"{{baseUrl}}/api/v1/admin/products/:id","variable":[{"key":"id","value":""}]}}},{"name":"A product's field values","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"By key. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","fields"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/fields","variable":[{"key":"id","value":""}]}}},{"name":"Write a product's field values","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Each checked against its field's type; an empty value removes it; a key the store does not define is refused. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","fields"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/fields","variable":[{"key":"id","value":""}]}}},{"name":"A product's downloadable files","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","files"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/files","variable":[{"key":"id","value":""}]}}},{"name":"Add a downloadable file to a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Multipart form, field \"file\", up to 50 MB. Kept outside the public media library; a paid order's buyer gets an expiring link. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","files"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/files","variable":[{"key":"id","value":""}]}}},{"name":"A product's labels put on by hand","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","labels"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/labels","variable":[{"key":"id","value":""}]}}},{"name":"Put manual labels on a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces them; only manual labels. Audited (product.labels_set). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","labels"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/labels","variable":[{"key":"id","value":""}]}}},{"name":"Add an option axis","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","options"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/options","variable":[{"key":"id","value":""}]}}},{"name":"Replace the option matrix","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sets the whole matrix and reconciles the variants with it in one transaction — which is what an editor needs, since renaming an axis or dropping a value is a single intent that would leave the product incoherent if split across calls.\n\nSend an option's `id` to keep it: matched by name alone, renaming \"Size\" to \"Größe\" is indistinguishable from deleting one axis and adding another, and every variant would lose its size. Omit `id` for a new axis. A value carries an id for the same reason — send `{\"id\": 7, \"value\": \"Crimson\"}` to rename the value that row 7 holds, and a bare `\"Crimson\"` to add a new one.\n\nA variant whose combination survives is left completely alone — price, SKU and stock included. A variant whose combination no longer exists is deleted; its order lines keep their own snapshot, so history stays readable. New combinations are created only when `generate_variants` is set.\n\nThe same value may not appear on two axes: variant options are resolved by value, so \"Small\" as both a Size and a Cup could not be told apart, and the request is refused rather than silently mis-resolved.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","options"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/options","variable":[{"key":"id","value":""}]}}},{"name":"The products picked to go with a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"related: on its page before the automatic suggestions; cross_sell: offered in the basket. In order. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","relations"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/relations","variable":[{"key":"id","value":""}]}}},{"name":"Replace the products picked to go with a product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 12 each; the product itself and repeats are dropped. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","relations"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/relations","variable":[{"key":"id","value":""}]}}},{"name":"A product's sale prices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each variant's regular price, its sale price and the sale's window, in the variants' order. A variant whose compare-at is above its price and that has no window reads as a sale without one. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","sales"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/sales","variable":[{"key":"id","value":""}]}}},{"name":"A product's selling","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The product's sale rows (one per currency: countries, VAT rate, shipping included, the price over its variants) and its export record (ticari tanım, customs description, GTİP, origin, Incoterm — the store's default proposed when unset —, duties), each row with its state (live, draft, or flagged: inherited and on sale as before) and exactly what it lacks (ADR-0146). A product with nothing stored yet answers inherited rows derived from today's markets, prices and tax rules (`derived: true`) and sells as before. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","selling"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/selling","variable":[{"key":"id","value":""}]}}},{"name":"Save a product's selling","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the product's sale rows and changes its export record (nil fields are left as they are). A row sent exactly as it was inherited stays inherited (sells as before); a new or edited row is held by the gate: incomplete, it is saved as a draft and never offered. A row's `price_minor` prices every variant in that currency; a currency the store has no market for gets one. The ticari tanım names the product's invoice item (found by name, else created); GTİP and the customs description are the item's; the origin is written to every variant. Audited (product.selling_update). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","selling"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/selling","variable":[{"key":"id","value":""}]}}},{"name":"Put a product in a tax class","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. The product's class wins over its category's and the store's rates (M2). `tax_class_id: null` takes the product out of any class. Audited (`product.tax_class_set`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","tax-class"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/tax-class","variable":[{"key":"id","value":""}]}}},{"name":"List a product's translations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","translations"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/translations","variable":[{"key":"id","value":""}]}}},{"name":"Set a product's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the language's translation; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Remove a product's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Move a product's translation through review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. draft → reviewed → approved → published, one step at a time, or back to draft from any state (reject / withdraw). The same status again is a no-op. Only a published translation is served by store reads. Audited (`product.translation_status`, with the note).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","translations",":lang","status"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/translations/:lang/status","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Add a variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`options` names the value chosen on each of the product's axes, in any order. Two variants may not select the same combination — that is enforced by a unique index, not by hope.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","variants"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/variants","variable":[{"key":"id","value":""}]}}},{"name":"Apply selling to products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies another product's rows and export record, a template, or rows written out to products, through the same validation as the product page: every resulting row is evaluated by the gate and an incomplete one is a draft (ADR-0146). Prices are never copied. `dry_run` answers what each product would be, writing nothing; `withdrawn` counts rows offered before and not after. Audited (product.selling_apply). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","apply"],"raw":"{{baseUrl}}/api/v1/admin/selling/apply"}}},{"name":"Move products under the selling rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Fills each product's rows from today's data (markets and their countries, the countries its baskets reach today, variant prices, tax rules) and stores them as inherited: they keep selling exactly as before, and what they lack is only flagged until the merchant edits the row (ADR-0146). No Incoterm or duties mode is set. No ids: every product of the store not moved yet; a product already moved is skipped. Audited (product.selling_migrate). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","migrate"],"raw":"{{baseUrl}}/api/v1/admin/selling/migrate"}}},{"name":"The store side of selling","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What every sale row of the store depends on (ADR-0146): base currency, home and origin country, the company details still missing, the currencies a connected payment system can charge, the market currencies, the default Incoterm and the store's KDV dahil / hariç rule. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","store"],"raw":"{{baseUrl}}/api/v1/admin/selling/store"}}},{"name":"Selling templates","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's named presets of sale rows and export fields (ADR-0146). Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","templates"],"raw":"{{baseUrl}}/api/v1/admin/selling/templates"}}},{"name":"Create a selling template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates a named preset of rows (countries, VAT, shipping included; never prices) and export fields. Audited (selling_template.save). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","templates"],"raw":"{{baseUrl}}/api/v1/admin/selling/templates"}}},{"name":"Replace a selling template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (selling_template.save). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","templates",":id"],"raw":"{{baseUrl}}/api/v1/admin/selling/templates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a selling template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited (selling_template.delete). Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","selling","templates",":id"],"raw":"{{baseUrl}}/api/v1/admin/selling/templates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Run the SEO autopilot over everything now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues the seo.autofill job over every product (and its pictures' alt texts, with media.write) and category (with categories.write), in the default language and every translation that has a title. Only empty fields are written — never one the merchant filled — each audited; the AI assistant writes them when set up and use_ai is not false, the rules otherwise. 202 with the new run; 200 with the run already queued or running. Needs catalog.write. Since ADR-0116 every record goes through the autopilot's pass: empty fields and the system's own texts are written (title, description, focus keyword, picture alt texts; pages and posts too, outside their reviewed versions), a text the merchant wrote is never changed — only proposed against — and every write is recorded for undo.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","autofill"],"raw":"{{baseUrl}}/api/v1/admin/seo/autofill"}}},{"name":"A background SEO fill's progress and result","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","autofill",":id"],"raw":"{{baseUrl}}/api/v1/admin/seo/autofill/:id","variable":[{"key":"id","value":""}]}}},{"name":"The SEO autopilot: health, the switch, what it did, what waits","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The SEO centre's one screen (ADR-0116): the store's SEO health (0–100 from the signals Google documents for stores: titles present and unique, descriptions, picture alt texts, brand and GTIN for product markup, products reached through a category, every language translated), whether the Otopilot is on, the store's AI, the latest 50 changes the system made (each with whether it can still be undone) and up to 100 open suggestions for texts the merchant wrote or the health-claim guard stopped. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","autopilot"],"raw":"{{baseUrl}}/api/v1/admin/seo/autopilot"}}},{"name":"Switch the SEO autopilot on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"On by default. Switched on (with an AI set up), every product, category, page and post is queued for a pass; off, the queue is emptied and nothing is written automatically. Audited (seo.autopilot_set). Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","autopilot"],"raw":"{{baseUrl}}/api/v1/admin/seo/autopilot"}}},{"name":"Undo one change the SEO autopilot made (Geri al)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Restores the text before the change when the field still holds what the change wrote (409 otherwise, and for a change already undone or changed again since), and records the undo; the autopilot then leaves that field alone. Needs catalog.read and the record's write right: catalog.write (product), categories.write (category), media.write (picture), content.write (page, post).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","changes",":id","undo"],"raw":"{{baseUrl}}/api/v1/admin/seo/changes/:id/undo","variable":[{"key":"id","value":""}]}}},{"name":"A record's focus keyword in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The focus keyword the SEO autopilot keeps for a product, category, page or post in a language (the default language when omitted); empty when none. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","keyword",":kind",":id"],"raw":"{{baseUrl}}/api/v1/admin/seo/keyword/:kind/:id","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"Keep the merchant's focus keyword for one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Saves the focus keyword the merchant typed for a product, category, page or post in a language (the default language when omitted); recorded as the merchant's, so the SEO autopilot leaves it alone. Spaces are collapsed; at most 100 characters; empty clears it. Needs catalog.read and the record's write right.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","keyword",":kind",":id"],"raw":"{{baseUrl}}/api/v1/admin/seo/keyword/:kind/:id","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"The SEO centre: what is missing, per record type and language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Counts of products, categories, pages, posts and product pictures missing an SEO title, a meta description or an alt text, per store language; up to 100 records with problems (lengths, duplicates); the AI assistant's state and the latest background fill. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","overview"],"raw":"{{baseUrl}}/api/v1/admin/seo/overview"}}},{"name":"Apply an SEO suggestion (Uygula)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Writes the suggested text when the field still holds what it held when the suggestion was made (409 and the suggestion marked stale otherwise); the text is then the merchant's. Needs catalog.read and the record's write right.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","proposals",":id","apply"],"raw":"{{baseUrl}}/api/v1/admin/seo/proposals/:id/apply","variable":[{"key":"id","value":""}]}}},{"name":"Dismiss an SEO suggestion (Yoksay)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The same suggestion against the same text is not made again. Audited (seo.proposal_dismissed). Needs catalog.read and the record's write right.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","proposals",":id","dismiss"],"raw":"{{baseUrl}}/api/v1/admin/seo/proposals/:id/dismiss","variable":[{"key":"id","value":""}]}}},{"name":"Write SEO texts for the record being edited (Otomatik doldur)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An SEO title, a meta description, a focus keyword and one alt text per picture in the editing language, from the record as the editor holds it. Through the AI assistant when the store has a key (its own in the ai-assistant plugin, else the platform's COS_AI_ANTHROPIC_KEY / COS_AI_OPENAI_KEY), else by rules; writes nothing. Needs catalog.read and catalog.write (product), categories.write (category) or content.write (page, post). The AI budget is 30 calls a minute per tenant.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","seo","suggest"],"raw":"{{baseUrl}}/api/v1/admin/seo/suggest"}}},{"name":"The store's size guides","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"By name. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","size-guides"],"raw":"{{baseUrl}}/api/v1/admin/size-guides"}}},{"name":"Create a size guide","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited; announces product.updated for the products it reaches. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","size-guides"],"raw":"{{baseUrl}}/api/v1/admin/size-guides"}}},{"name":"One size guide","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","size-guides",":id"],"raw":"{{baseUrl}}/api/v1/admin/size-guides/:id","variable":[{"key":"id","value":""}]}}},{"name":"Replace a size guide","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited; announces product.updated for the products it reached and now reaches. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","size-guides",":id"],"raw":"{{baseUrl}}/api/v1/admin/size-guides/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a size guide","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited. Right: catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","size-guides",":id"],"raw":"{{baseUrl}}/api/v1/admin/size-guides/:id","variable":[{"key":"id","value":""}]}}},{"name":"Stock alerts: settings and report (Ürünler › Stok bildirimleri)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The switch, SMS and the multiple, and the last 30 days: waiting now, sent, converted (an order of the item from the same address within 7 days). Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stock-alerts"],"raw":"{{baseUrl}}/api/v1/admin/stock-alerts"}}},{"name":"Save the stock alert settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (stock_alerts.update). Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stock-alerts"],"raw":"{{baseUrl}}/api/v1/admin/stock-alerts"}}},{"name":"What people are waiting for","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Per variant with waiting requests, most wanted first: how many wait to be told it is back, how many for a price drop, the free stock. A buying signal. Right: inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stock-alerts","demand"],"raw":"{{baseUrl}}/api/v1/admin/stock-alerts/demand"}}},{"name":"The requests, with their addresses","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first; `variant_id`, `status` waiting, sent or cancelled. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stock-alerts","requests"],"raw":"{{baseUrl}}/api/v1/admin/stock-alerts/requests"}}},{"name":"List tax rates, most specific first","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The order they come back in is the order they are applied in, so a reader can see which rule wins without reproducing the resolution.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates"}}},{"name":"Create a tax rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One rule per country, state and category. A second rule covering the same three is refused: that is a mistake to catch at entry, not a preference to resolve at checkout.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates"}}},{"name":"Get a tax rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates",":id"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a tax rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Changing a rate affects what is charged from now on and nothing already sold. What each order was charged is stored on its lines, so an invoice prints the same figures next year as it does today.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates",":id"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a tax rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Orders keep what they were charged.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-rates",":id"],"raw":"{{baseUrl}}/api/v1/admin/tax-rates/:id","variable":[{"key":"id","value":""}]}}},{"name":"List the attribute dictionary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store-wide field dictionary: a handle, what the field is called, and the values it offers wherever a category asks for it. Ordered by handle, because a dictionary's order is its spelling.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","taxonomy-attributes"],"raw":"{{baseUrl}}/api/v1/admin/taxonomy-attributes"}}},{"name":"Add a field to the dictionary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The handle is supplied rather than derived from the label: it is the key a category's metadata names, so deriving it would make renaming a label orphan every category using the field. It is folded to lower case and may carry neither whitespace nor a slash. Choices keep the order sent — \"XS, S, M, L, XL\" is the publisher's order and the only useful one — with blanks and exact repeats dropped.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","taxonomy-attributes"],"raw":"{{baseUrl}}/api/v1/admin/taxonomy-attributes"}}},{"name":"Read one dictionary entry","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","taxonomy-attributes",":handle"],"raw":"{{baseUrl}}/api/v1/admin/taxonomy-attributes/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Edit one dictionary entry","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Label and choices only. The handle is not patchable and sending it is a 400 rather than a silent no-op: it is the key every category's metadata holds, and renaming it here would detach them all without saying so. Moving a field to a new handle is a create, an edit of the categories that name it, and a delete. A sent `choices` array replaces the whole list.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","taxonomy-attributes",":handle"],"raw":"{{baseUrl}}/api/v1/admin/taxonomy-attributes/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Remove one dictionary entry","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Never refused. A category that still names the handle keeps the field and simply offers no fixed choices, which is a free-text field rather than a broken one.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","taxonomy-attributes",":handle"],"raw":"{{baseUrl}}/api/v1/admin/taxonomy-attributes/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"The store's translation glossary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. Protected terms, preferred translations and forbidden translations, reported to translators as warnings. Nothing calls a translation service.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translation-glossary"],"raw":"{{baseUrl}}/api/v1/admin/translation-glossary"}}},{"name":"Add a glossary rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. Audited (`translation_glossary.create`). The same rule twice is 409.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translation-glossary"],"raw":"{{baseUrl}}/api/v1/admin/translation-glossary"}}},{"name":"Check text against the glossary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.read. Which of the store's rules a translation into `language` breaks, field by field — the admin translation form asks while the operator types. Writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translation-glossary","check"],"raw":"{{baseUrl}}/api/v1/admin/translation-glossary/check"}}},{"name":"Replace a glossary rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write. Audited (`translation_glossary.update`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translation-glossary",":id"],"raw":"{{baseUrl}}/api/v1/admin/translation-glossary/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a glossary rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.write. Audited (`translation_glossary.delete`).","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translation-glossary",":id"],"raw":"{{baseUrl}}/api/v1/admin/translation-glossary/:id","variable":[{"key":"id","value":""}]}}},{"name":"Machine translation: providers and runs","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. The installed machine translation providers (DeepL; an AI provider when one is installed), the one a run uses now (empty when none is set up), and each language's latest run.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","auto"],"raw":"{{baseUrl}}/api/v1/admin/translations/auto"}}},{"name":"Translate what a language is missing","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs catalog.write (collections and categories also need their own write rights; without them a run leaves them out). Queues a background run that machine-translates the language's missing products (with options and rich descriptions), collections and categories through the configured provider, the glossary respected: records with nothing stored get a machine translation; machine translations get their empty fields; records a person started are skipped. The translations are drafts in the review queue unless publish is true, which moves each through review to published at once, audited. 409 when no provider is set up (details.reason translator_not_configured) or a run of the language is under way.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","auto"],"raw":"{{baseUrl}}/api/v1/admin/translations/auto"}}},{"name":"Export translations as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. Streams one row per record, language and field: entity, id, handle (the base slug), language, field (title, subtitle — products —, description, seo_title, seo_description, slug), source_text (the default language's text), translation, status, source. Archived products are left out. Upload the edited file as an import job with kind=translations. Option and variant labels are not in the file.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","export"],"raw":"{{baseUrl}}/api/v1/admin/translations/export"}}},{"name":"Records missing a translation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. The records of one kind lacking a complete translation in a language — products (not archived), collections, categories — or, for pages and blog posts, published in the default language and not in this one; by title. For translating by hand.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","missing"],"raw":"{{baseUrl}}/api/v1/admin/translations/missing"}}},{"name":"The translation review queue","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read. Stored translations of products, collections and categories, newest change first; by default every one not published yet.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","review"],"raw":"{{baseUrl}}/api/v1/admin/translations/review"}}},{"name":"Count records missing a translation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Per non-default store language: products (not archived), collections and categories lacking a complete translation.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","translations","summary"],"raw":"{{baseUrl}}/api/v1/admin/translations/summary"}}},{"name":"Update a variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stock is deliberately not patchable here. Inventory moves through its own endpoint so that every change is a transactional adjustment rather than a blind overwrite of a number another request may have just changed.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a variant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A product must keep at least one variant: a product with nothing sellable is not a product.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id","variable":[{"key":"id","value":""}]}}},{"name":"A variant's hidden stock","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The variant's hidden count (gizli stok, ADR-0142) and its latest 50 ledger lines, newest first. Hidden stock is the owner's own count beside the regular stock: panel only — no storefront route, feed or checkout reads it — and it never limits a sale. Needs inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","hidden-stock"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/hidden-stock","variable":[{"key":"id","value":""}]}}},{"name":"Move or count a variant's hidden stock","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Exactly one of `adjust` (a move, + or −) and `set` (a count of the shelf), with an optional reason; a ledger line records who, when, how much and why. The count never goes below zero (409 `hidden_stock_short`). The regular stock is not touched. Needs inventory.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","hidden-stock"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/hidden-stock","variable":[{"key":"id","value":""}]}}},{"name":"Move stock","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Send `adjust` to move the count by a delta (receiving stock), or `set` to replace it (a stock take). Neither may leave on-hand below the quantity already reserved at that location for orders in flight.\n\n`location_id` says which shelf; omit it for the default one, which is what a single-location store always means.\n\nRefused with 409 when the receiving location is closed: stock moves out of a closed location, never into it. Every decrease is still allowed, including at a closed one, because emptying a closed shelf is the only way it is ever cleared.\n\n`incoming` records stock on its way to the location; it is information only and never sellable.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","inventory"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/inventory","variable":[{"key":"id","value":""}]}}},{"name":"A variant's licence-key pool","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The pool's settings and its codes counted by state (ADR-0088 §2). 404 when the variant is not sold as codes. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-key-pool"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-key-pool","variable":[{"key":"id","value":""}]}}},{"name":"Start or change a variant's licence-key pool","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creating a pool makes the variant a code product: tracked, never sold past its codes, never a parcel (requires_shipping false); its stock becomes its unused codes — units on its shelves are written off (a stock take to zero, in the ledger). Refused (409) for a variant with units promised to open orders, on pre-order, or sold from a supplier's offer. On an existing pool, only the fields given change. Audited as licence_key.pool_update. Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-key-pool"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-key-pool","variable":[{"key":"id","value":""}]}}},{"name":"Stop selling a variant as codes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Only a pool that never held a code may go (409 otherwise: remove its unused codes instead). Needs catalog.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-key-pool"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-key-pool","variable":[{"key":"id","value":""}]}}},{"name":"A variant's codes, masked","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. Each code is masked (its last characters only); reading one in the clear is POST /api/admin/licence-keys/{id}/reveal, audited. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-keys"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-keys","variable":[{"key":"id","value":""}]}}},{"name":"Import codes into a variant's pool","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Pasted text (one code per line), a CSV with a `code` column (and optionally `expires_at`, `note`), or structured rows; at most 10 000 per import. Each code is sealed at rest with the secrets keyring (409 when the server has none), de-duplicated by its keyed fingerprint against every code the store ever held, and becomes one unit on the pool's shelf (stock ledger kind import). A row that cannot be read is listed in problems; the rest import. dry_run counts and writes nothing. The answer never repeats a code. Audited as licence_key.import (counts only). Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-keys","import"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-keys/import","variable":[{"key":"id","value":""}]}}},{"name":"Remove unused codes from a variant's pool","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Each named code must be unused (409 otherwise); its unit leaves the shelf, never below what is promised to orders awaiting payment (409). Audited as licence_key.remove. Needs catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","licence-keys","remove"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/licence-keys/remove","variable":[{"key":"id","value":""}]}}},{"name":"How a variant's stock got here","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The append-only stock ledger for one variant, newest first. One row per real change, carrying two signed deltas, the balances after, what kind of movement it was, which path caused it, the operator's reason and the order behind it. Ordered by id rather than by created_at: a transfer writes both of its rows in one transaction and they share the instant exactly. Behind inventory.read, because reading how a count got there is reading stock.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","movements"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/movements","variable":[{"key":"id","value":""}]}}},{"name":"A variant's prices in other currencies","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the store charges for the variant in each currency other than its base currency (the base-currency price is the variant's own `price`). A market in a currency with no price here does not offer the variant. Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","prices"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/prices","variable":[{"key":"id","value":""}]}}},{"name":"Set a variant's price in a currency","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates or replaces the price in `currency`. The base currency is refused (set the variant's own price). Needs catalog.write. Audited against the product.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","prices"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/prices","variable":[{"key":"id","value":""}]}}},{"name":"Stop selling a variant in a currency","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.write. Audited against the product.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","prices",":currency"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/prices/:currency","variable":[{"key":"id","value":""},{"key":"currency","value":""}]}}},{"name":"Set a variant's regular price, sale price and window","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A sale without a window is written at once (price = sale, compare-at = regular); with one it waits for its start and ends at its end, the variant then back at its regular price (the sale job, every minute). No sale price ends any sale. The sale price is below the regular one; the end is after the start and ahead of now. Right: catalog.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","sale"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/sale","variable":[{"key":"id","value":""}]}}},{"name":"Where a variant's stock is","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The variant's own `stock_on_hand` and `stock_reserved` are the sums of these rows. This is the breakdown a picker, a stock take or a delivery estimate actually needs.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","stock"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/stock","variable":[{"key":"id","value":""}]}}},{"name":"Move stock between locations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One statement out and one in, in a single transaction, so the store's total never changes even for an instant. Reserved units do not travel: they are promised to orders that will be picked from where they are, and moving them would send a picker to the wrong shelf.\n\nRefused with 409 when `to_location_id` is closed: stock moves out of a closed location, never into it. The **source** may be closed, and always could be — that is the recovery path for a store that already has units stranded at one.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","stock","transfer"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/stock/transfer","variable":[{"key":"id","value":""}]}}}],"name":"admin:catalog"},{"item":[{"name":"Reorder one parent's children","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Renumbers a whole sibling set in one transaction, giving the ids sent positions 0..n-1 in the order they arrive. One call rather than a PATCH per row because `position` is per-parent and dense — dropping a row above three siblings renumbers four of them, and separate writes can fail part-way and leave an order that is half old and half new (D54).\n\n`parent_id` is required and nullable: send `null` to reorder the roots. Omitting the key is refused rather than treated as null, so a body that forgets it cannot silently reorder the top level.\n\n`ids` must name exactly that parent's children — all of them, each once, and nothing else. A partial list is refused rather than interpreted, because every reading of one is a guess. Moving a category to a different parent is `parent_id` on PATCH /api/admin/categories/{id}, not this.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","categories","reorder"],"raw":"{{baseUrl}}/api/v1/admin/categories/reorder"}}}],"name":"admin:categories"},{"item":[{"name":"List collections","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every collection, including the empty ones the public listing hides.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections"],"raw":"{{baseUrl}}/api/v1/admin/collections"}}},{"name":"Create a collection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections"],"raw":"{{baseUrl}}/api/v1/admin/collections"}}},{"name":"Get a collection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a collection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every field is optional; an omitted field is left alone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a collection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The products in it survive. A collection groups products, it does not own them, so deleting \"Summer sale\" must not delete the summer stock — only the membership rows go.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id","variable":[{"key":"id","value":""}]}}},{"name":"List a collection's products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"In the order the collection was curated, drafts included — staging them is what an operator is doing here. 404 rather than an empty page for a collection that does not exist, which is what a curation screen needs to know before it offers to reorder anything. It takes the same filter vocabulary as the product listing, except `collection_id`: the path already names the collection, so sending one is a 400 rather than a filter nobody would notice being dropped.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","products"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/products","variable":[{"key":"id","value":""}]}}},{"name":"Replace a collection's products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replace, not merge, for the reason the product-side route gives: the caller holds the whole list — INCLUDING the memberships it never fetched, which are deleted. A screen must hold the entire membership before it saves. The order sent is the order stored, and it is the only way a collection's own order is ever chosen — it writes `member_position`, never the `position` that orders a collection inside one product's own list (D40). `product_ids` is required: omitting it is a 400, and an explicit empty array is how a collection is emptied without being deleted. An unknown product id rejects the whole request. The answer is 204: the useful response would be the whole membership, and a page of it is a list a client could re-save from and lose the tail — read it back with the GET above.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","products"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/products","variable":[{"key":"id","value":""}]}}},{"name":"List a collection's translations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","translations"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/translations","variable":[{"key":"id","value":""}]}}},{"name":"Set a collection's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the language's translation; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Remove a collection's translation in one language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","collections",":id","translations",":lang"],"raw":"{{baseUrl}}/api/v1/admin/collections/:id/translations/:lang","variable":[{"key":"id","value":""},{"key":"lang","value":""}]}}},{"name":"Replace a product's collections","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replace, not merge: the caller holds the whole list. An \"add\" endpoint quietly re-creates a membership the operator removed in another tab, with no way for them to see that it happened. The order sent is the order stored, an unknown id rejects the whole request, and an empty list clears membership. The `position` it writes is where each collection sits in THIS product's list, not where this product sits in each collection — that is `member_position`, which only PUT /api/admin/collections/{id}/products writes (D40).","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","collections"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/collections","variable":[{"key":"id","value":""}]}}}],"name":"admin:collections"},{"item":[{"name":"Write templates and styles into a file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A template or kit file (format nerocart.kit, version 1): the templates named by `refs` (starters in `lang`, the store's own) and, with `styles`, the theme draft's global styles. Library pictures travel by reference. Writes nothing. Needs content.read and vb_kits.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","export"],"raw":"{{baseUrl}}/api/v1/admin/builder/export"}}},{"name":"Bring a template or kit file in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A file is never trusted: decoded strictly (an unknown key is refused), at most 1 MB and 20 templates, every section checked exactly as a page save (as for saving a template), its global styles as the theme's. A library picture this store does not have is left out of its template and listed in `missing`; nothing is fetched. Names already used get \" (2)\", \" (3)\" …. With `styles` the file's global styles go into the theme draft (needs theme.write too). Logged (GET /builder/imports) and audited (content.template_import). Needs content.write and vb_kits.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","import"],"raw":"{{baseUrl}}/api/v1/admin/builder/import"}}},{"name":"The import log","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The files imported and kits applied, newest first (the last 50), with the pictures each left out. Needs content.read and vb_kits.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","imports"],"raw":"{{baseUrl}}/api/v1/admin/builder/imports"}}},{"name":"The starter kits","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Kits (ADR-0085, VB-7): each a set of starter templates — the page it makes, in order — and global styles. `available` is false while a template of its page waits for a feature (`needs`). Needs content.read and vb_kits.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","kits"],"raw":"{{baseUrl}}/api/v1/admin/builder/kits"}}},{"name":"Apply a kit to the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Writes the kit's global styles into the theme draft (unless `styles` is false; needs theme.write too) — previewed and published with the theme — and keeps the kit's page as a template of the store (kind page, origin kit:\u003cid\u003e). Logged and audited (content.kit_apply). Needs content.write and vb_kits.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","kits",":id","apply"],"raw":"{{baseUrl}}/api/v1/admin/builder/kits/:id/apply","variable":[{"key":"id","value":""}]}}},{"name":"The template library","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"\"Hazır şablonlar\" (ADR-0085, VB-7): the starter templates (hero, features, testimonials, pricing, questions, calls to action, a product showcase, about, contact; drawn only with the theme's tokens, with their own licensed pictures) in a language, then the store's own templates (free layout sections and pages, newest first). Each says whether the store can use it now (`available`; `needs` names the features its items wait for). Needs content.read and the store's vb_kits (else 403, reason feature_off).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","templates"],"raw":"{{baseUrl}}/api/v1/admin/builder/templates"}}},{"name":"Save a free layout section or a page as a template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Keeps one free layout section (kind layout) or a page's sections (kind page) under a name, checked exactly as a page save checks them (no item this release does not know; the store's flags; CSS and HTML need theme.publish; library pictures, discounts, popups and the commerce widgets' references must exist). Shares the saved sections' limit (100) and names (once, any case). Audited (content.template_save). Needs content.write and vb_kits.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","templates"],"raw":"{{baseUrl}}/api/v1/admin/builder/templates"}}},{"name":"Rename a template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Renames one of the store's templates (a starter cannot be). Needs content.write and vb_kits.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","templates",":id"],"raw":"{{baseUrl}}/api/v1/admin/builder/templates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes one of the store's templates; pages that took it keep their copy. Needs content.write and vb_kits.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","builder","templates",":id"],"raw":"{{baseUrl}}/api/v1/admin/builder/templates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Blog authors","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The authors by name, each with its article count. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","authors"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/authors"}}},{"name":"Add an author","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A name (≤ 120), a bio per language, a picture (https or a store path); the slug is made from the name when left out. Audited. Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","authors"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/authors"}}},{"name":"Change an author","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"As adding one. Audited. Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","authors",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/authors/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete an author","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Their articles keep the text byline of each version. Audited. Needs content.publish.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","authors",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/authors/:id","variable":[{"key":"id","value":""}]}}},{"name":"Blog categories","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The categories in their order, each with its article count. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","categories"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/categories"}}},{"name":"Add a blog category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A name in at least one language (plain text, ≤ 80), a description per language, an order; the slug is made from the Turkish name when left out (any language's letters, ADR-0066). Audited. Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","categories"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/categories"}}},{"name":"Change a blog category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"As adding one. Audited. Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","categories",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/categories/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a blog category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its articles stay, without a category. Audited. Needs content.publish.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","categories",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/categories/:id","variable":[{"key":"id","value":""}]}}},{"name":"Comment moderation queue","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Comments newest first, filtered by state and article; with the writer's email (personal data, kept for moderation). Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","comments"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/comments"}}},{"name":"Comment counts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"How many comments wait, are shown, rejected or spam. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","comments","counts"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/comments/counts"}}},{"name":"Moderate a comment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Approve, reject, mark as spam or put back to pending, and/or answer under it (≤ 3000 characters; empty removes the answer). Audited. Needs content.review.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","comments",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/comments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a comment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited. Needs content.review.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","comments",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/comments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Blog settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The comment mode (off, moderated, auto) and the blog's page size. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","settings"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/settings"}}},{"name":"Change the blog settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Comments off, moderated or approved automatically; 3–48 articles a page. Audited. Needs content.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","blog","settings"],"raw":"{{baseUrl}}/api/v1/admin/content/blog/settings"}}},{"name":"The store's global items","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Global items (pages of kind global, ADR-0085 VB-7b) by name, each with its languages and on how many pages and popups it is placed (their working or live versions). Create, edit, review and publish one through the content page routes (kind global; a new one needs vb_kits). Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","globals"],"raw":"{{baseUrl}}/api/v1/admin/content/globals"}}},{"name":"Where a global item is placed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The pages and popups whose working or live version places this global item, by language (\"3 sayfada kullanılıyor\"). Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","globals",":id","uses"],"raw":"{{baseUrl}}/api/v1/admin/content/globals/:id/uses","variable":[{"key":"id","value":""}]}}},{"name":"Convert a columns section into a free layout","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Serbest düzene dönüştür\" (ADR-0085 §2, VB-3): the columns section (ADR-0073 container) in, the free layout section out — a row container of N columns, every widget in its column as the node of the same kind — proven to hold the same texts and pictures in the same reading order and to pass the document check. Stores nothing: the editor applies it as one undoable change. A section with a widget the free layout does not have yet (form and newsletter: VB-5; countdown, products, categories, posts: VB-6) is refused with every such block named (details.reason not_convertible, details.refusals). Needs content.read and the store's vb_layout and vb_media_drop (details.reason feature_off).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","layout","convert"],"raw":"{{baseUrl}}/api/v1/admin/content/layout/convert"}}},{"name":"List pages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Home first, each with its live version and working copy per language. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages"],"raw":"{{baseUrl}}/api/v1/admin/content/pages"}}},{"name":"Create a page","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The home page (kind home, one per store) or a custom page with a slug. Needs content.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages"],"raw":"{{baseUrl}}/api/v1/admin/content/pages"}}},{"name":"A page","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/pages/:id","variable":[{"key":"id","value":""}]}}},{"name":"Rename a page or change its slug","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs content.write; audited. A patch that changes something emits content.page_changed (the storefront revalidates its page lists and pages); one that changes nothing writes no event and no audit row.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/pages/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a custom page","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every version goes with it; the home page cannot be deleted. Needs content.publish; audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/pages/:id","variable":[{"key":"id","value":""}]}}},{"name":"Save the draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the editor's work for one language, starting a draft (the next version) when there is none. The document is validated against the section schema set. A version in review or approved is frozen (409). Needs content.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages",":id","draft",":language"],"raw":"{{baseUrl}}/api/v1/admin/content/pages/:id/draft/:language","variable":[{"key":"id","value":""},{"key":"language","value":""}]}}},{"name":"Open a page in the page editor","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The page in one language as the customizer's page editor opens it (ADR-0069): the working copy's document (else the live version's) in the section model — a document stored in the older Puck form is converted on the fly without loss (`converted`) — the working copy's revision, the page section schemas with the box every section has, the custom CSS field and whether this operator may change it (theme.publish), the live theme's colour schemes and the areas the working copy changes against the live version. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","pages",":id","editor"],"raw":"{{baseUrl}}/api/v1/admin/content/pages/:id/editor","variable":[{"key":"id","value":""}]}}},{"name":"The store's popups","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Popups (pages of kind popup, ADR-0085 §9) by name, each with its languages, its rules (the live version's, else the working copy's, in the first language that has one) and the period's counts — views, closes, conversions and their rate, codes copied, sign-ups and the revenue the popup brought (ADR-0133; each popup of an A/B group is one variant, its rules name the group); with the default rules of a new popup, the page kinds a rule may name and the periods the counts may cover. Create, edit, review and publish a popup through the content page routes (kind popup), or put it live at once with go-live. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","popups"],"raw":"{{baseUrl}}/api/v1/admin/content/popups"}}},{"name":"Put a popup live at once","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The popup studio's \"Yayınla\" (ADR-0133): the working copy of every language that has one (draft, in review or approved) is published in one step and one transaction, without the review the content workflow asks of an editor without the publish right; each version's audit row records go_live. With nothing new to publish, the live versions as they are; with nothing at all, 409. Saving is the editor's ordinary draft save. Needs content.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","popups",":id","go-live"],"raw":"{{baseUrl}}/api/v1/admin/content/popups/:id/go-live","variable":[{"key":"id","value":""}]}}},{"name":"Pause a popup","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes a popup off the store in every language (ADR-0133): each live version is withdrawn — archived where a working copy exists, otherwise turned back into the working copy — so nothing of the work is lost and \"go-live\" brings it back. The storefront hears it as content.page_changed. A popup with nothing live answers the same. Needs content.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","popups",":id","pause"],"raw":"{{baseUrl}}/api/v1/admin/content/popups/:id/pause","variable":[{"key":"id","value":""}]}}},{"name":"Issue a preview token","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A one-hour token the storefront accepts as ?preview= to render the page's working copy and the theme draft. Needs content.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","preview-tokens"],"raw":"{{baseUrl}}/api/v1/admin/content/preview-tokens"}}},{"name":"Redirect rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every rule, with the allowed statuses and languages. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","redirects"],"raw":"{{baseUrl}}/api/v1/admin/content/redirects"}}},{"name":"Add a redirect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds a 301/302/308 rule; a rule that would close a loop or make a chain longer than five hops is refused (409). Needs content.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","redirects"],"raw":"{{baseUrl}}/api/v1/admin/content/redirects"}}},{"name":"Add and replace redirect rules from a CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Columns by name: `from` and `to` (required), `status` (301 default, 302, 308), `language` (empty: every language), `note`. A row whose language and from match an existing rule replaces it; any other row is added. Every row is checked like a rule saved by hand, plus duplicates in the file, the store's limit of 2000 rules, and loops and chains over the resulting set. All or nothing: one refused row writes nothing (`applied` false, `errors` by line). `dry_run=1` reports and writes nothing. Needs content.publish; every written rule is audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","redirects","import"],"raw":"{{baseUrl}}/api/v1/admin/content/redirects/import"}}},{"name":"Change a redirect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces a rule, with the same checks as adding one. Needs content.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","redirects",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/redirects/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a redirect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs content.publish; audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","redirects",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/redirects/:id","variable":[{"key":"id","value":""}]}}},{"name":"The section schema set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The registered section types and their fields; the editor builds its forms from it. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","sections"],"raw":"{{baseUrl}}/api/v1/admin/content/sections"}}},{"name":"Editorial settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","settings"],"raw":"{{baseUrl}}/api/v1/admin/content/settings"}}},{"name":"Replace the editorial settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Self-approval policy and the preview origin. Needs content.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","settings"],"raw":"{{baseUrl}}/api/v1/admin/content/settings"}}},{"name":"List versions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, without documents; status=in_review is the review queue. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions"],"raw":"{{baseUrl}}/api/v1/admin/content/versions"}}},{"name":"A version","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With its document. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id","variable":[{"key":"id","value":""}]}}},{"name":"Approve","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"in_review → approved. The submitter may approve only when the store allows self-approval (403 otherwise). Needs content.review; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/approve","variable":[{"key":"id","value":""}]}}},{"name":"List a working copy's save points","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Save points of a page version, newest first (at most 50 per version). Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","checkpoints"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/checkpoints","variable":[{"key":"id","value":""}]}}},{"name":"Save a save point of a page draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Kaydet\" under an area of the page editor (ADR-0069): a save point of the whole draft for an area ('' the whole page, meta, sections, sections/\u003csection id\u003e), at the revision the change was made on. The version must be a draft; a stale revision is refused with 409 (details.reason stale_revision, details.current_revision). Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","checkpoints"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/checkpoints","variable":[{"key":"id","value":""}]}}},{"name":"Compare a version with the live one","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Section-level diff (added, removed, changed with the changed fields, moved, unchanged) and page-level field changes between this version and the live version of the same page and language, or another version (?against=\u003cid\u003e). Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","diff"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/diff","variable":[{"key":"id","value":""}]}}},{"name":"Publish or schedule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"approved → published now (the previous live version is archived; emits content.published), or scheduled when `at` is more than a minute ahead (a job publishes it then). Needs content.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","publish"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/publish","variable":[{"key":"id","value":""}]}}},{"name":"Reject","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"in_review → draft with a required comment. Needs content.review; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","reject"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/reject","variable":[{"key":"id","value":""}]}}},{"name":"Put an area of a page draft back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bu bölümdeki değişiklikleri geri al\" (ADR-0069): the area goes back to the newest save point that holds it, else to the live version, else to an empty page; one section is replaced where it is, put back at its old place or taken out. The draft as it was is kept as an automatic save point first. Changing a section's own CSS this way needs theme.publish as any save does. Needs content.write; audited (content_version.revert).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","revert"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/revert","variable":[{"key":"id","value":""}]}}},{"name":"Restore an earlier version","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Publishes a copy of an earlier published version as a new version. Needs content.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","rollback"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/rollback","variable":[{"key":"id","value":""}]}}},{"name":"Cancel a schedule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The version stays approved. Needs content.publish; audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","schedule"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/schedule","variable":[{"key":"id","value":""}]}}},{"name":"Submit for review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"draft → in_review. Needs content.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","submit"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/submit","variable":[{"key":"id","value":""}]}}},{"name":"Withdraw to draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"in_review or approved → draft (a schedule is cancelled). Needs content.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","content","versions",":id","withdraw"],"raw":"{{baseUrl}}/api/v1/admin/content/versions/:id/withdraw","variable":[{"key":"id","value":""}]}}},{"name":"Serbest Tasarım: an area's sections drawn as a starting design","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bu sayfayı serbest tasarıma çevir\" (ADR-0104 §4): the area's current sections — a page's working copy (else its live version; the home page inside the theme's home template), or a theme area's template or section group (the draft's, else the live theme's) — drawn as markup and unscoped CSS in the language, with the sections it drew and the ones it left out and why. Writes nothing: the editor loads the result, and saving it is the area's ordinary save. Needs content.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","free-design","convert"],"raw":"{{baseUrl}}/api/v1/admin/free-design/convert"}}},{"name":"Serbest Tasarım: the starter designs of an area","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The ready designs a merchant may begin an area with (ADR-0104 §4), in the picker's order, with their names in the asked language (else Turkish) and the storefront path of their 960×600 preview; page:\u003cid\u003e lists the page starters. The designs themselves are read one at a time. Writes nothing. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","free-design","starters"],"raw":"{{baseUrl}}/api/v1/admin/free-design/starters"}}},{"name":"Serbest Tasarım: one starter design","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One starter's design (GrapesJS project data, markup, unscoped CSS) to load into the editor; taking it is an ordinary save of the area, checked like any design. Writes nothing. Needs content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","free-design","starters",":id"],"raw":"{{baseUrl}}/api/v1/admin/free-design/starters/:id","variable":[{"key":"id","value":""}]}}},{"name":"List the store's menus","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The theme's two menus (main, footer) first, then the store's own named menus (ADR-0071), with their link counts. The footer panel's columns are not listed. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","menus"],"raw":"{{baseUrl}}/api/v1/admin/menus"}}},{"name":"Create a named menu","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A menu with a name and links (three levels at most), live at once; emits content.menus_changed; audited (store_menu.create). The handle is made from the name (Turkish letters to plain ones) unless given. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","menus"],"raw":"{{baseUrl}}/api/v1/admin/menus"}}},{"name":"Read a menu with its links","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its links with library pictures resolved; for main and footer whether the theme draft holds other links. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","menus",":handle"],"raw":"{{baseUrl}}/api/v1/admin/menus/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Change a menu","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Name, links and place in the list; live at once. main and footer are checked against the theme's limits and the theme draft's copy follows (its revision moves on). Emits content.menus_changed; audited (store_menu.update). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","menus",":handle"],"raw":"{{baseUrl}}/api/v1/admin/menus/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Delete a named menu","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One of the store's own menus; the theme's two cannot be deleted (409 builtin_menu). A builder or section that named it shows nothing in its place. Emits content.menus_changed; audited. Needs theme.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","menus",":handle"],"raw":"{{baseUrl}}/api/v1/admin/menus/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Clean a rich-text document as a save would","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The block document editor's clean (ADR-0086): the document comes back rebuilt from the named profile of kernel/core/richtext_profiles.json — what a save would store — with what the HTML blocks' allow-list took out (a script, an inline event handler, a style, an iframe and its host …), so the editor can show it at once. Nothing is stored. A document the profile does not describe is refused with the path of the offending node, as on save. Needs content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","richtext","clean"],"raw":"{{baseUrl}}/api/v1/admin/richtext/clean"}}},{"name":"List stories","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: content.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stories"],"raw":"{{baseUrl}}/api/v1/admin/stories"}}},{"name":"Create a story","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A picture (https or a store path), an optional short video and link. Right: content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stories"],"raw":"{{baseUrl}}/api/v1/admin/stories"}}},{"name":"Replace a story","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stories",":id"],"raw":"{{baseUrl}}/api/v1/admin/stories/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a story","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: content.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stories",":id"],"raw":"{{baseUrl}}/api/v1/admin/stories/:id","variable":[{"key":"id","value":""}]}}},{"name":"The theme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Live version, draft, history, the font allow-list and colour tokens. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme"],"raw":"{{baseUrl}}/api/v1/admin/theme"}}},{"name":"Choose the theme package","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Points the theme draft (started from the live settings if there is none) at a package version; it goes live with the next publish. A package that is not installed is 404; one incompatible with this engine is 409. Needs theme.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","activate"],"raw":"{{baseUrl}}/api/v1/admin/theme/activate"}}},{"name":"The store's sample-content imports","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every time a theme's sample content was added to this store (\"Bu temayı kullan\" with import_sample), newest first, with what it created by kind and whether it was removed. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","demo-imports"],"raw":"{{baseUrl}}/api/v1/admin/theme/demo-imports"}}},{"name":"Add a theme's sample content","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds a gallery theme's sample content to this store without touching the theme (\"Örnek ürünleri göster (gizli taslak olarak)\"): categories, collections, products with their pictures, size guides, pages and articles. Products arrive hidden (drafts) and pages as drafts; nothing is visible to shoppers until the merchant publishes them (POST …/{id}/publish). Audited theme.demo_import. Needs theme.write, catalog.write and content.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","demo-imports"],"raw":"{{baseUrl}}/api/v1/admin/theme/demo-imports"}}},{"name":"Remove sample content","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Deletes every record the import created and nothing else, newest first: products (one that has been ordered is archived instead, so its orders keep their lines), collections, categories, size guides, pages and articles, and the pictures it added unless the store now uses them elsewhere. Removing twice is harmless. Audited theme.demo_remove. Needs theme.write, catalog.write and content.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","demo-imports",":id"],"raw":"{{baseUrl}}/api/v1/admin/theme/demo-imports/:id","variable":[{"key":"id","value":""}]}}},{"name":"Publish sample products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A merchant's sample products arrive hidden (drafts): no storefront listing, search, sitemap, feed or checkout shows them, and the sample categories and collections stay out of sight with them. This puts the import's still-hidden products on sale (draft → active); a product the merchant has since archived or published is left as it is. Audited theme.demo_publish. Needs theme.write, catalog.write and content.write. A removed import is 409.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","demo-imports",":id","publish"],"raw":"{{baseUrl}}/api/v1/admin/theme/demo-imports/:id/publish","variable":[{"key":"id","value":""}]}}},{"name":"Tasarım Doktoru: which links lead nowhere, and the theme's sample texts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The server's half of the design checker (ADR-0101). The customizer's preview checks the store's pages as they are drawn; it sends here the store paths a page links to (at most 400, with or without the language: /tr/urun/kahve, /products/kahve) and learns which lead nowhere — a product (active), collection, category, page or article (published) that does not exist, or a path no route serves and no redirect rule catches. The answer also carries the theme's own sample texts (its templates', section groups' and demo pack's phrases of four words or more), so the panel can tell words a merchant has not replaced yet. Writes nothing. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","doctor"],"raw":"{{baseUrl}}/api/v1/admin/theme/doctor"}}},{"name":"Save the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Validated (colours #rrggbb, fonts from the allow-list, logo from the media library, safe menu links). Needs theme.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","draft"],"raw":"{{baseUrl}}/api/v1/admin/theme/draft"}}},{"name":"Open the theme customizer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Everything the customizer (ADR-0064) opens with: the draft — or the live theme while there is no draft (revision 0) — as global setting values by id and every template and section group as the storefront would render them; the package's settings schema and the schemas of every section the editor may show or add; template and group names; the fonts; the live version; the areas changed since the last publish. ETag is the revision. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor"}}},{"name":"Save a save point of the draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records a save point of the whole draft for an area ('' the whole draft, settings, settings:\u003cgroup\u003e, template:\u003cname\u003e[/\u003csection\u003e], group:\u003ctype\u003e[/\u003csection\u003e]) — the customizer's \"Kaydet\" under an area — or a named one. \"Geri al\" under an area returns to the newest save point that holds it. At most 50 per draft. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","checkpoints"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/checkpoints"}}},{"name":"Save changes to the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies operations to the draft (starting one from the live theme when there is none): set_setting {id, value} (null: the theme's default), set_template / set_group {name, sections}, reset_template / reset_group {name} (the theme's own again). The whole result is validated against the package — settings against its schema and manifest, sections against the registry (types, placement, limits, fields, blocks) — and nothing is written unless every operation is valid; an error's details name the op, area, section_id, block_id and field. The revision the change was made on goes in the body or If-Match; a stale one is refused with 409. Not audited one by one (the revision and the save points are the record). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","draft"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/draft"}}},{"name":"Serbest Tasarım: one theme area's design in a language","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The theme draft's design of a theme area (header, footer, product, collection, search, cart, blog, article, notfound) in a language — else the live theme's — with the draft's revision (also the ETag), the languages the area has a design in, and whether this one is live as it is (ADR-0104). entry is null when the area has none: the storefront draws the theme's own layout there. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","free-design"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/free-design"}}},{"name":"Serbest Tasarım: save one theme area's design in a language into the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The draft op set_free_design as one save (ADR-0104): the design is checked like a page's (sanitized markup, CSS scoped to the area, the editor's project rewritten from an allow-list, every live component of a known type naming this store's products, collections, menus and blog — else 400 with details.reason) and stored in the theme draft (started from the live theme when there is none), on the revision named in the body or If-Match (409 stale_revision otherwise). design null removes the area's design in the language (the theme's own layout again; always allowed). With vb_free_design off a new or changed design is refused (feature_off). Every theme design together is at most 4 MiB. Answers the design as stored and the new revision (also the ETag). Audited as a theme draft save. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","free-design"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/free-design"}}},{"name":"The theme's version history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The draft's save points, newest first, and the last 30 published versions. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","history"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/history"}}},{"name":"Claim, keep, take over or leave the editing lock","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An editor window's heartbeat (every 30 s; the lock is free after two minutes without one). Advisory: saves are guarded by the draft revision, never refused for the lock. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","presence"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/presence"}}},{"name":"A preview link for the customizer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A preview token for the customizer's frame: the theme draft (settings, templates, groups) over the published pages. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","preview-token"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/preview-token"}}},{"name":"Publish the theme draft the customizer shows","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes the draft live — its settings, templates and groups (written to the theme instance) and the store's menus and identity — when it is the revision named; a newer draft is refused with 409. Audited (theme.publish), event theme.published. Needs theme.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","publish"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/publish"}}},{"name":"Restore the draft from a save point or a published version","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes an area (or everything) from a save point of the draft or from a published version of the same theme into the draft — never straight to the live theme. The draft as it was is kept as an automatic save point first. The store's own menus and identity are never touched. Audited (theme.restore). Needs theme.write. Since ADR-0102 a save point of any draft of the store (a named one of an earlier draft included) may be restored, and a whole version or save point of another theme brings that theme back into the draft (theme_changed); an area of another theme is refused with 409. The answer names the save point kept first (undo_checkpoint_id).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","restore"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/restore"}}},{"name":"Undo an area's unsaved changes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns an area of the draft to its newest save point that holds it, or to the live theme when it has none (\"Bu bölümdeki değişiklikleri geri al\"). The draft as it was is kept as an automatic save point first. Audited (theme.revert). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","revert"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/revert"}}},{"name":"The store's saved sections","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Sections saved for reuse (ADR-0068), newest first; each says whether the theme being edited has its type. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","saved-sections"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/saved-sections"}}},{"name":"Save a section for reuse","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Keeps a configured section (settings and blocks) under a name, checked against the theme being edited. At most 100 per store; a name is used once (any case). Audited (theme.section_save). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","saved-sections"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/saved-sections"}}},{"name":"Rename a saved section","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (theme.section_rename). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","saved-sections",":id"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/saved-sections/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a saved section","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Sections already put in a template stay (they are copies). Audited (theme.section_delete). Needs theme.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","saved-sections",":id"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/saved-sections/:id","variable":[{"key":"id","value":""}]}}},{"name":"Schedule the draft's publish","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The draft at the named revision goes live at publish_at, by a job (theme.publish_scheduled); if the draft changed after scheduling, nothing goes live and the schedule is marked stale. A pending schedule is replaced. Audited (theme.schedule). Needs theme.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","schedule"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/schedule"}}},{"name":"Cancel the scheduled publish","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited (theme.unschedule). Needs theme.publish.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","schedule"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/schedule"}}},{"name":"The theme's history: published versions and save points","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The Zaman Makinesi (ADR-0102): a page of the theme's history, newest first — every published version (who, when, its name, the areas it changed from the version before it, whether it is live) and, on the first page, every save point of the draft and the named save points of drafts published since (why an automatic one was taken). Each entry carries the material of its small picture: its colours, its two faces and the home page's sections, read from the version itself (nothing is drawn at publish time). `before` (a version number) reads the older versions. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","timeline"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/timeline"}}},{"name":"A preview link of a version or save point","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bu hâlini göster\" (ADR-0102): a link (an hour) that draws the store with that published version's or save point's theme over the published pages, read through the storefront's preview like the customizer's own. Writes nothing but the link. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","timeline","preview-token"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/timeline/preview-token"}}},{"name":"Name a published theme version","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Gives a published version a name in the history (\"\" takes it away); its content stays as it was published (ADR-0102). Audited. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","editor","versions",":id"],"raw":"{{baseUrl}}/api/v1/admin/theme/editor/versions/:id","variable":[{"key":"id","value":""}]}}},{"name":"The Temalar gallery","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every installed theme package, the default first: its preset's tagline, vertical, settings (for the preview card) and home page section types, whether it is compatible, live (active) or the theme draft's (draft). Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","gallery"],"raw":"{{baseUrl}}/api/v1/admin/theme/gallery"}}},{"name":"Start a theme draft from a gallery theme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bu temayı kullan\": writes the theme draft (the package, the preset's settings with what the choice keeps) and, with content.write, a home page draft in each language the store serves — mapped (the store's sections laid into the preset's, the rest kept after them), replaced, or left alone. A language whose home page is in review or approved is skipped. Nothing is published. Needs theme.write; audited (theme.apply_preset). An unpublished theme draft (or, with home \"replace\", a home page draft) is replaced only with overwrite_drafts; otherwise 409. Every home page document is built and validated before anything is written.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","gallery",":id","apply"],"raw":"{{baseUrl}}/api/v1/admin/theme/gallery/:id/apply","variable":[{"key":"id","value":""}]}}},{"name":"Preview a gallery theme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A one-hour preview token. A theme that ships a demo pack (ADR-0072) is previewed on its own demo store, prepared on first use: the answer says demo: true and the storefront opens it with ?demo=\u003ctoken\u003e (GET /theme/demo resolves the store), so the gallery shows the theme's own catalogue and pages, never the store's products. Otherwise the storefront accepts it as ?preview=: the theme reads as the preset merged with what the choice keeps, and the home page as applying the choice would make it. Nothing of the store is written. A package without a preset is 409. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","gallery",":id","preview"],"raw":"{{baseUrl}}/api/v1/admin/theme/gallery/:id/preview","variable":[{"key":"id","value":""}]}}},{"name":"The live theme's logo, favicon and share picture","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Mağaza › Logo ve simgeler: the pictures the storefront shows now (the published theme's, empty when no theme is published), each with its media library id, alt text and current address. Right: theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","identity"],"raw":"{{baseUrl}}/api/v1/admin/theme/identity"}}},{"name":"Put a new logo, favicon or share picture live","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Changes only the pictures named (a field left out keeps its value; `logo` with `media_id: null`, or `favicon` / `share_image` null, removes the picture). It goes live at once as a new theme version: the live version with the store's own menus and identity as they are, plus the new pictures (theme.published follows as for any publish). An open theme editor draft takes the same pictures and nothing else, so every other unpublished change in it stays unpublished; its revision moves, so an editor open elsewhere reloads before its next save. Each picture must be an image of the store's media library. Audited (theme.publish, from: identity, with the fields changed). Right: theme.publish.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","identity"],"raw":"{{baseUrl}}/api/v1/admin/theme/identity"}}},{"name":"The store's theme library","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One theme instance per theme the store has published (ADR-0061): its settings as last published, template and group overrides; the live one first. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","instances"],"raw":"{{baseUrl}}/api/v1/admin/theme/instances"}}},{"name":"A favicon and a share card from a logo","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes a 512 × 512 PNG favicon (the logo's mark, square, with room round it; a cut-out logo stays see-through) and a 1200 × 630 PNG share card (the logo on the look's ground with a band of its main colour) and adds both to the media library (the same picture is not stored twice). The answer is what the customizer's identity part stores as favicon and share_image; nothing is applied here. Needs media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","looks","brand-icons"],"raw":"{{baseUrl}}/api/v1/admin/theme/looks/brand-icons"}}},{"name":"A logo's colours and three looks built on them","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Logodan Marka Kiti (ADR-0100): reads a PNG, JPEG or GIF logo from the store's media library (at most 16 megapixels; nothing leaves the server), finds its main colours (a plain ground round the mark is left out) and builds three looks on them — the brand colour on white, on cream, and the second colour (or cool greys) — with the same guarantees and preview links as the dice. Fonts, corners and spacing are left as they are. Writes nothing but the preview links. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","looks","brand-kit"],"raw":"{{baseUrl}}/api/v1/admin/theme/looks/brand-kit"}}},{"name":"Roll the dice: ready looks for the theme being edited","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stil Zarı (ADR-0100): up to six finished looks for the theme being edited (the draft, else the live theme) — colours re-tinted from the theme's own palette, a curated font pair, the type scale, corners and buttons, spacing — every one checked before it is offered (WCAG 2.x 4.5:1 for text and button text, 3:1 for buttons and marks, the theme's schemes told apart, only values the theme's schema allows). Each comes with the values and parts the customizer applies as one draft change, and a preview link (an hour) that shows the store's own home page in the look without writing anything. The same seed and round deal the same looks; the first round starts with the theme's own look. `lock` keeps the store's main colour now (or `brand`) on every look. Writes nothing but the preview links. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","looks","deal"],"raw":"{{baseUrl}}/api/v1/admin/theme/looks/deal"}}},{"name":"Theme packages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Installed theme packages with their manifests, whether each works with this engine (and why not) and which one the live theme uses. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","packages"],"raw":"{{baseUrl}}/api/v1/admin/theme/packages"}}},{"name":"One installed theme package","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A theme package as the editor reads it (theme engine 2.0.0, ADR-0061): format (2.0, or 1.1 through the adapter), manifest, settings schema, style variations, templates, groups, its own sections, the engine's template sections and its strings. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","packages",":id",":version"],"raw":"{{baseUrl}}/api/v1/admin/theme/packages/:id/:version","variable":[{"key":"id","value":""},{"key":"version","value":""}]}}},{"name":"Publish the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"No review step (owner decision). Emits theme.published. Needs theme.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","publish"],"raw":"{{baseUrl}}/api/v1/admin/theme/publish"}}},{"name":"The open share links of the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Arkadaşına Göster (ADR-0102): the store's open share links, newest first — their names, who made them, until when they open and how often they were opened. Never their secrets. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","share-links"],"raw":"{{baseUrl}}/api/v1/admin/theme/share-links"}}},{"name":"Make a share link of the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A link that shows the theme draft over the published pages to whoever holds it, read only and without a login, for 1–14 days (7 when not said), until it is closed: the storefront marks every page \"Taslak önizleme\", never caches or indexes it, and the link opens nothing else (no page working copy, no saved template, no admin route). Its secret is answered only now (only its hash is kept). At most 20 open at once (409, details.reason share_limit); 403 with details.reason feature_off without vb_fearless. Audited. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","share-links"],"raw":"{{baseUrl}}/api/v1/admin/theme/share-links"}}},{"name":"Close a share link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The link opens nothing from now on (ADR-0102). Audited. Needs theme.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","share-links",":id"],"raw":"{{baseUrl}}/api/v1/admin/theme/share-links/:id","variable":[{"key":"id","value":""}]}}},{"name":"The design step of the setup (Mağazanı Anlat)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Mağazanı Anlat (ADR-0103): what the setup wizard's design step opens with — the sectors (each with its card picture, a path on the storefront), the four moods (their typical faces, colours and corners), the curated brand colours, the store's name, the answers given last time and where the step stands (new, open, skipped, applied). Reads only. Needs theme.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","tell-us"],"raw":"{{baseUrl}}/api/v1/admin/theme/tell-us"}}},{"name":"Apply a proposal to the theme draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mağazanı Anlat (ADR-0103): rebuilds the proposal named by the answers, seed, round and index and writes it into the theme draft — the theme, its settings, templates and groups — after an automatic save point of the theme as it was (Zaman Makinesi, reason \"proposal\"). Products, pages, menus, the store's identity and the live theme are never touched; nothing is live until the draft is published. The same proposal again changes nothing (unchanged). Audited (theme.tell_us_apply). Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","tell-us","apply"],"raw":"{{baseUrl}}/api/v1/admin/theme/tell-us/apply"}}},{"name":"A logo's colours for the colour card","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mağazanı Anlat (ADR-0103): reads a PNG, JPEG or GIF logo of the media library (at most 16 megapixels) and answers its main colour and the others, as the brand kit reads them (ADR-0100). Writes nothing. Needs theme.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","tell-us","logo-colors"],"raw":"{{baseUrl}}/api/v1/admin/theme/tell-us/logo-colors"}}},{"name":"Three finished home pages from the answers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mağazanı Anlat (ADR-0103): three proposals built from the answers — the sector's own theme and two that share the mood, each in a look of the Stil Zarı engine (the brand colour on the main colour; every contrast guarantee of ADR-0100), the logo in the header, and a home page from the theme's own sections with the store's name, one plain sentence of what it sells, the merchant's photos (focal point at the subject) or the sector's sample photos, and the store's own products and reviews — never a sample store's words. The same answers, seed and round give the same proposals; the next round others. Each comes with a preview link (an hour) that draws the store's home page as the proposal would make it, over the published pages. Keeps the answers (for the theme page's \"Mağazanı anlat, yeniden öner\"); writes nothing else. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","tell-us","proposals"],"raw":"{{baseUrl}}/api/v1/admin/theme/tell-us/proposals"}}},{"name":"Skip the design step","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mağazanı Anlat (ADR-0103): the setup wizard does not offer the design step again (the theme page still does). A store that applied a proposal stays applied. Needs theme.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","tell-us","skip"],"raw":"{{baseUrl}}/api/v1/admin/theme/tell-us/skip"}}},{"name":"Restore an earlier theme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Publishes a copy of an earlier published theme as a new version. Needs theme.publish; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","theme","versions",":id","rollback"],"raw":"{{baseUrl}}/api/v1/admin/theme/versions/:id/rollback","variable":[{"key":"id","value":""}]}}}],"name":"admin:content"},{"item":[{"name":"The live chat inbox","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Open chats first, then the newest; status=open|closed filters. Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats"],"raw":"{{baseUrl}}/api/v1/admin/chats"}}},{"name":"A chat with its messages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Reading marks it read. Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Deletes the chat and its messages for good; the visitor's token reaches nothing after. Right: contact.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id","variable":[{"key":"id","value":""}]}}},{"name":"Answer a chat with a file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: contact.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id","attachments"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id/attachments","variable":[{"key":"id","value":""}]}}},{"name":"A file of a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id","attachments",":file"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id/attachments/:file","variable":[{"key":"id","value":""},{"key":"file","value":""}]}}},{"name":"Close a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The visitor's next message opens it again. Right: contact.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id","close"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id/close","variable":[{"key":"id","value":""}]}}},{"name":"Answer a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: contact.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chats",":id","messages"],"raw":"{{baseUrl}}/api/v1/admin/chats/:id/messages","variable":[{"key":"id","value":""}]}}},{"name":"List company accounts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each with its buyers. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","companies"],"raw":"{{baseUrl}}/api/v1/admin/companies"}}},{"name":"Create a company account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Its buyers are put in its price group. A buyer belongs to one company. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","companies"],"raw":"{{baseUrl}}/api/v1/admin/companies"}}},{"name":"Replace a company account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","companies",":id"],"raw":"{{baseUrl}}/api/v1/admin/companies/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a company account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its buyers keep their accounts and price group. Right: groups.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","companies",":id"],"raw":"{{baseUrl}}/api/v1/admin/companies/:id","variable":[{"key":"id","value":""}]}}},{"name":"Export a customer's data","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Everything the store holds about one email address (customer record, orders with lines, consents, suppressions, notifications, carts, group memberships) as one JSON document for a KVKK/GDPR access request. Logged in privacy requests (hash only) and audited. Needs customers.read and data.export.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customers","data-export"],"raw":"{{baseUrl}}/api/v1/admin/customers/data-export"}}},{"name":"Erase a customer's personal data","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Anonymises one email address across the store without rewriting order history: orders keep their number, lines and amounts and lose the email (replaced), name, phone and street address (the country stays). Deletes the customer record and group memberships; anonymises the notification log and carts. Invoices, the buyer tax id, accepted legal texts, consent records, the do-not-send list and the audit trail are retained. Refused while an order is in progress, a return is open or a refund is pending. confirm_email must repeat the address. Logged (hash only) and audited. Needs customers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customers","erasure"],"raw":"{{baseUrl}}/api/v1/admin/customers/erasure"}}},{"name":"List privacy requests","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's logged data exports and erasures, newest first. The subject is a hash. Needs customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","privacy-requests"],"raw":"{{baseUrl}}/api/v1/admin/privacy-requests"}}}],"name":"admin:customers"},{"item":[{"name":"Download an export through its link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Unauthenticated: the link is the credential. The first request spends it; the operator who asked for it is loaded again and must still hold the export's rights (a role narrowed since is refused with 403). The file streams as it is written (`Cache-Control: no-store`, `Referrer-Policy: no-referrer`). An unknown or malformed link is a 404; a used or expired one a 410. Audited (`export.download`).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export-downloads",":token"],"raw":"{{baseUrl}}/api/v1/admin/export-downloads/:token","variable":[{"key":"token","value":""}]}}},{"name":"Ask for a one-shot download link to a data export","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs data.export. `kind` is products, orders, customers, inventory or categories; `params` are the filters the matching `GET /export/admin-*` route takes in its query string (products: q, status, collection_id, category_id; orders: every orders-list filter and `ids`; customers: q, sort, order), checked now — a bad filter is a 400 here, not a broken file later. `format` is nerocart (default) or shopify (not for categories). The link is bound to this tenant and store, expires in five minutes, works once and is served without credentials to whoever holds it; only a hash of it is stored. Audited (`export_link.create`). Customers are the current store's.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export-links"],"raw":"{{baseUrl}}/api/v1/admin/export-links"}}},{"name":"Export the category tree as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The tree written down: one row per category, the trail from the root in one cell — `Apparel / Clothing / Shirts`, the same thing the product file's `category` column says. Columns are `path, slug, position, products, metadata`. Rows come depth first, so a parent is always above its children and the file reads back in one pass. `products` is counted from the products filed directly under the category; it is written for the reader and ignored on the way in. The tree has one dialect: `format=shopify` is refused, because Shopify's category export is its taxonomy file, which `/api/admin/import/taxonomy` reads.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export","admin-categories"],"raw":"{{baseUrl}}/api/v1/admin/export/admin-categories"}}},{"name":"Export customers as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One row per person who ordered from the current store (the listing's scope: X-Store-Id, or the tenant's first store) — the mailing list a shop actually asks this screen for. A customer is a reading of the orders and not a table (see GET /api/admin/customers), so the columns are the same aggregates the listing shows: name, phone and address from that person's most recent order, orders not cancelled, and lifetime spend as `spent_minor` plus `currency` rather than a formatted amount. `q` and `sort` are the listing's own, so a file taken off a filtered screen is the rows on that screen. This reading has no import of its own; customer records (with consent) are imported by the import job, `kind=customers`.\n\n`format=shopify` writes Shopify's customers export column for column, the name split at its last space into First Name and Last Name, Total Spent as a decimal, and `no` in every consent column, because nothing here has recorded a consent.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export","admin-customers"],"raw":"{{baseUrl}}/api/v1/admin/export/admin-customers"}}},{"name":"Export every count at every location as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The stock-take's file: one row per variant per location, whether or not the shelf has a row yet, so there is a cell for the empty one. The store's own layout is `sku, product_title, variant_label, location, on_hand, reserved, available`, the location by code. `format=shopify` writes Shopify's inventory export column for column — Handle, Title, the option columns, SKU, HS Code, COO, Location (the location's name), Incoming, Unavailable, Committed (what is reserved here), Available, On hand.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export","admin-inventory"],"raw":"{{baseUrl}}/api/v1/admin/export/admin-inventory"}}},{"name":"Export orders as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One row per order line, with the order's columns repeated — the shape an accountant's pivot table wants.\n\n`format=shopify` writes Shopify's orders export column for column — Name (`#` and the number), Financial Status, Fulfillment Status, decimal amounts, Lineitem columns, billing and shipping blocks — with the order's own columns on its first line only, as Shopify writes them. Columns this store has no value for (risk level, employee, note attributes) are present and blank. The filters are the orders list's own (one function parses both), and the file is the current store's orders, as the list is.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export","admin-orders"],"raw":"{{baseUrl}}/api/v1/admin/export/admin-orders"}}},{"name":"Export the catalog as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One row per variant. Cells beginning with =, +, - or @ are prefixed with an apostrophe, because a spreadsheet executes those on open; import strips exactly one back, so the round trip stays lossless. It takes the same filters as the admin product listing — q, status, vendor, product_type, tag, category_id and collection_id — so a reconciliation can export exactly the rows a screen is showing. There is no paging: an export streams every row that matched. Row order stays p.id, v.position, v.id whatever the filters are, because the importer requires a product's variant rows to be contiguous.\n\nTwo dialects, one model: `format=shopify` writes Shopify's product export column for column (Handle, Title, Body (HTML), Option1 Name … Variant Price, Image Src, Variant Image, Cost per item, Status), with prices as decimals in the store's currency, one row per variant and a row of nothing but a picture for each one past the last variant. The store's own layout carries the same fields — vendor, product_type, tags, category, seo_title, seo_description, cost_minor, taxable, weight_unit — plus `images`, `image_alts` and `variant_images`, which are picture URLs; site-relative ones leave as absolute addresses under the request's own host.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","export","admin-products"],"raw":"{{baseUrl}}/api/v1/admin/export/admin-products"}}},{"name":"List CSV imports","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs data.import. The tenant's recent imports, newest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import-jobs"],"raw":"{{baseUrl}}/api/v1/admin/import-jobs"}}},{"name":"Upload a CSV for import","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs data.import, and for a translation file catalog.write, collections.write and categories.write, for a stock file inventory.write, a category file categories.write, a customer file customers.write. The request body is the CSV file itself (at most 32 MiB). The import is stored and a background job checks it: the real importer runs in rehearsal (in transactions that are rolled back) and its report — rows to create and to update, row errors, and a row-by-row `plan` — becomes `report`. Nothing changes until `POST /import-jobs/{id}/apply`. Every kind sets rather than adds, so applying the same file twice converges.\n\n`kind`:\n- `products` — products, variants, prices per currency as `price_minor:\u003cCUR\u003e` / `compare_at_price_minor:\u003cCUR\u003e`, stock per location.\n- `inventory` — counts per SKU and location (`sku`, `location`, `on_hand` or `available`, optional `reason_code`; Shopify's inventory file too). `reason_code` (query) is required and labels every stock movement; a row's own `reason_code` cell overrides it. The plan shows the count before and after (`sku@location`).\n- `categories` — the tree by path (`path` as `Parent / Child`, `slug`, `position`, `metadata`); missing steps are built, nothing is moved or deleted.\n- `customers` — customer records of the current store keyed by `email` (`first_name`, `last_name`, `phone`, `note`; a blank cell changes nothing) and commercial-message consent: `email_consent` / `sms_consent` = yes | no | empty, `consent_note`, `consent_date` (YYYY-MM-DD, not in the future), `recipient_type` (BIREYSEL | TACIR). A consent is granted only with a note saying where it was given — the row's `consent_note` or the import's `consent_note` (query); a row without one is a row error. Imported consents have source `import`, the note, file name and import id as proof, `consent_date` as their date, and are queued for İYS. `no` withdraws a consent the store holds; it needs no note.\n\nAudited (`import_job.create`); customer and consent changes write their own audit rows.\n\n`kind=translations` takes a translation file (`GET /translations/export`: columns entity, id, handle, language, field, source_text, translation, status, source — one row per record, language and field) and needs catalog.write, collections.write and categories.write as well; each record is written as an imported translation — a draft published through review. An empty translation cell changes nothing and a record whose text is unchanged is skipped; the dry run checks entity, id, language, field and explicit slugs and lists glossary warnings.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import-jobs"],"raw":"{{baseUrl}}/api/v1/admin/import-jobs"}}},{"name":"Read a CSV import","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs data.import. `rows_done` of `rows_total` is the progress of the step running now; `report` is the dry run's result, `result` the real run's.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import-jobs",":id"],"raw":"{{baseUrl}}/api/v1/admin/import-jobs/:id","variable":[{"key":"id","value":""}]}}},{"name":"Apply a checked CSV import","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs data.import. Only a `validated` import; a background job runs the importer for real and the file's bytes are dropped when it is done. Audited (`import_job.apply`). The kind's own right is checked again (inventory.write, categories.write or customers.write).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import-jobs",":id","apply"],"raw":"{{baseUrl}}/api/v1/admin/import-jobs/:id/apply","variable":[{"key":"id","value":""}]}}},{"name":"Cancel a checked CSV import","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs data.import. Only a `validated` import; its file is dropped. Audited (`import_job.cancel`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import-jobs",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/import-jobs/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Add and update categories from a CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`path` is required and is the identity: a row whose trail already exists updates that category's position, slug and metadata, and a row whose trail does not builds every missing step on the way to it. Either separator is read, `/` or `\u003e`. Running the same file twice therefore changes nothing the second time. The file cannot move or delete a category — a typo in a path would otherwise drag a subtree and the products under it somewhere else with no undo; moving stays on the screen that has the cycle check and the product count. A blank cell leaves a field alone, a slug another category already holds is a row error, and the whole file is one transaction, so a tree is never half built. `dry_run=1` reports what would happen and writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","categories"],"raw":"{{baseUrl}}/api/v1/admin/import/categories"}}},{"name":"Import the attribute dictionary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An empty body imports the embedded dictionary; a body is the operator's own file in the two-section `handle = Label : v | v` then `gid : handle, handle` format. It attaches field lists to categories already carrying a taxonomy id, so it follows the tree rather than preceding it — against a tree from somewhere else every line is unmatched. The dictionary rows themselves are upserted, so a store's own entries survive. Same extended deadlines as the tree import.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","category-attributes"],"raw":"{{baseUrl}}/api/v1/admin/import/category-attributes"}}},{"name":"Add and update handpicked collections from a CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For migrating brands, look-books and other groupings from another platform. Columns: `title` (required), `slug`, `description`, `seo_title`, `seo_description`, `position` and `products` (product slugs separated by `|`, in the order shown). A row adds the collection, or updates the columns the file has when the slug exists. A product slug the store does not have is a row error and leaves that collection as it was. `dry_run=1` reports what would happen and writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","collections"],"raw":"{{baseUrl}}/api/v1/admin/import/collections"}}},{"name":"Import pages and blog articles from a JSON file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For migrating WordPress posts and pages with their languages. `items` are pages or articles with a `languages` map (title, description, TipTap `document`, excerpt, cover image, author, seo_title, `published_at`); every language goes in published, dated as the old site dated it. An article has one address for all languages, a page its own per language (`slugs`). `blog_categories` are added when missing. An item whose address already belongs to a page is skipped, so a file can be run again; one that fails is removed again so no half-built page stays. `dry_run=1` validates everything and writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","content"],"raw":"{{baseUrl}}/api/v1/admin/import/content"}}},{"name":"Set counts from a CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One row per variant per location, each in its own transaction, keyed by SKU and location — the code in the store's own layout (blank for the default), the name or the code in Shopify's. `on_hand` (On hand) is the count; when it is blank, `available` (Available) is read against what is reserved there right now. The rules are the product file's: a count cannot drop below what is reserved, a closed location takes nothing in, and a row naming a SKU or location the store does not have is a row error, not a failed file. Shopify's `not stocked` leaves the row alone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","inventory"],"raw":"{{baseUrl}}/api/v1/admin/import/inventory"}}},{"name":"Import historical orders from CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For migrating from another platform. It does not touch inventory — those stock movements happened on the old system — and it fires no events unless `fire_events` is set, because importing five thousand orders must not send five thousand confirmation emails. An order whose number already exists is skipped, so re-importing an export is a no-op.\n\nShopify's orders export is read as it is — the dialect is recognised by its Name and Lineitem columns — so a store moving here brings its history unchanged: `#1001` becomes order 1001, Financial Status becomes the payment status, a fulfilled order arrives shipped, a Cancelled at makes it cancelled, amounts are read as decimals in the file's currency, and the shipping address is used, or the billing one when there is only that.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","orders"],"raw":"{{baseUrl}}/api/v1/admin/import/orders"}}},{"name":"Import products from CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Upserts by SKU. Rows for one product must be contiguous — which is what export produces — so a large file streams instead of being held in memory. A bad row is reported with its line number and never aborts the file.\n\nA `stock_on_hand:\u003ccode\u003e` cell that raises the count at a closed location fails that row, naming the code: stock moves out of a closed location, never into it. A cell at or below the current count is accepted, so an unedited export of a closed location's zeros still imports.\n\nThe dialect is read off the header — a Shopify file has a Handle column — unless `format` says. A column the file does not have says nothing about that field, so a price list updates prices and leaves everything else as it was. Pictures are linked by URL: `images` (or Image Src rows) replace the product's list in the file's order, `variant_images` (Variant Image) set a variant's own, and a URL the media library already holds is reused. In Shopify's dialect a blank Variant SKU is given the handle, numbered when the product has options; Variant Inventory Qty lands at the default location; Product Category is matched to the store's tree by its full path.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","products"],"raw":"{{baseUrl}}/api/v1/admin/import/products"}}},{"name":"Import product reviews from CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For migrating from another platform: reviews and star ratings with the date, rating, text and name the shopper gave. Columns: `product_slug` (or `sku`), `rating` (1-5), `body` (may be empty: the old shop counted stars alone), `author_name`, and optionally `title`, `email`, `verified` (the old shop's statement, not checked here), `status` (approved by default, pending or rejected), `locale`, `created_at` (RFC 3339 or YYYY-MM-DD) and `source_id`. A review without an email gets a placeholder at import.invalid derived from `source_id`, so a second run of the same file creates nothing. Nothing is generated. The whole file is one transaction; `dry_run=1` reports what would happen and writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","reviews"],"raw":"{{baseUrl}}/api/v1/admin/import/reviews"}}},{"name":"Import a category tree","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An empty body imports the embedded Shopify taxonomy — ~14,000 categories, idempotent on (parent, title), so running it twice adds only what is missing. A body is the operator's own file in the published `gid : A \u003e B \u003e C` format. The embedded set also imports the field definitions in the same call, because they match on the taxonomy id this import writes and a tree from anywhere else has nothing to match. One transaction: half a taxonomy is worse than none. It can take minutes; the request extends its own read and write deadlines past the server's, and a client that disconnects rolls the transaction back.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","taxonomy"],"raw":"{{baseUrl}}/api/v1/admin/import/taxonomy"}}},{"name":"Import products from an XML feed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A supplier's or another platform's product feed (Ticimax, IdeaSoft, ikas, Google Merchant…), by address (fetched over the public internet, no redirects, 90 s) or pasted, up to 20 MB. The repeating product element is found and its fields read by the names such feeds use; the result is an ordinary product import job (dry run first, then apply). Right: data.import.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","import","xml"],"raw":"{{baseUrl}}/api/v1/admin/import/xml"}}}],"name":"admin:data"},{"item":[{"name":"Inventory settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's low-stock threshold and the stock adjustment reason codes. Needs inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","inventory","settings"],"raw":"{{baseUrl}}/api/v1/admin/inventory/settings"}}},{"name":"Set the low-stock threshold","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs inventory.write. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","inventory","settings"],"raw":"{{baseUrl}}/api/v1/admin/inventory/settings"}}}],"name":"admin:inventory"},{"item":[{"name":"List invoices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices"],"raw":"{{baseUrl}}/api/v1/admin/invoices"}}},{"name":"Read an invoice","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With its return documents and the cancel deadline.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices",":id"],"raw":"{{baseUrl}}/api/v1/admin/invoices/:id","variable":[{"key":"id","value":""}]}}},{"name":"Cancel an invoice","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only inside the 8-day window from delivery; after it the answer is 409 and a return document is recorded instead. An e-Fatura is cancelled outside the integrator and recorded here with external_reference.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/invoices/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"The invoice's printable copy","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The PDF from the integrator, to print into the parcel.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices",":id","pdf"],"raw":"{{baseUrl}}/api/v1/admin/invoices/:id/pdf","variable":[{"key":"id","value":""}]}}},{"name":"Send a failed invoice again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Optionally with the TCMB exchange rate a foreign-currency invoice was missing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices",":id","retry"],"raw":"{{baseUrl}}/api/v1/admin/invoices/:id/retry","variable":[{"key":"id","value":""}]}}},{"name":"Record a return document","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"After the cancel window: the business buyer's iade faturası or the seller's own document for a consumer return.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoices",":id","return-documents"],"raw":"{{baseUrl}}/api/v1/admin/invoices/:id/return-documents","variable":[{"key":"id","value":""}]}}},{"name":"Invoicing status and settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Installed providers, whether invoicing is live for this store, and its settings.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoicing"],"raw":"{{baseUrl}}/api/v1/admin/invoicing"}}},{"name":"Replace the invoicing settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Carrier map (code → unvan, VKN), payment types, exemption code. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","invoicing","settings"],"raw":"{{baseUrl}}/api/v1/admin/invoicing/settings"}}},{"name":"An order's invoices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every invoice of the order, cancelled ones included.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","invoices"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/invoices","variable":[{"key":"id","value":""}]}}},{"name":"Issue an invoice by hand","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For an order that shipped before invoicing was set up, or whose invoice was cancelled.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","invoices"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/invoices","variable":[{"key":"id","value":""}]}}}],"name":"admin:invoicing"},{"item":[{"name":"The store's cookie banner settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether the storefront asks for cookie consent, the current consent version and the optional wording per language (ADR-0038). Defaults (on, version 1, the storefront's own wording) when the store never saved any.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cookie-consent"],"raw":"{{baseUrl}}/api/v1/admin/cookie-consent"}}},{"name":"Replace the store's cookie banner settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Switches the banner on or off and replaces the optional wording (per two-letter language: a one-line title up to 120 characters and a plain-text body up to 1000, no markup). `bump_version` raises the consent version by one, which asks every visitor again — for a changed cookie policy or a new tool. The version is never set directly. Switching the banner off also stops every non-essential tag. Audited as cookie_consent.settings_update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cookie-consent"],"raw":"{{baseUrl}}/api/v1/admin/cookie-consent"}}},{"name":"Aggregate cookie consent counts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Counts of the choices recorded over the last `days` (1–400, default 30): in total, for the current version, by action and by optional category accepted, and the number of distinct consent ids. Counts only — the records hold no personal data and none is listed. Needs reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cookie-consent","stats"],"raw":"{{baseUrl}}/api/v1/admin/cookie-consent/stats"}}},{"name":"The contracts' seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whose details the contracts name as the seller. Reading carries no right, like the legal settings.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-contract-identity"],"raw":"{{baseUrl}}/api/v1/admin/legal-contract-identity"}}},{"name":"Set the contracts' seller","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Chooses the company details or details written for the contracts alone. Audited (legal.contract_identity_update). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-contract-identity"],"raw":"{{baseUrl}}/api/v1/admin/legal-contract-identity"}}},{"name":"List legal documents","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every version, newest first per kind and language, with the placeholder catalogue.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents"}}},{"name":"Draft a legal document","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates the next version of its kind and language as a draft. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents"}}},{"name":"Read a legal document","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One version.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Edit a draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only a draft changes; published text is never edited because orders point at it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Preview a version","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Rendered with the store's details; order placeholders show as dashes.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents",":id","preview"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents/:id/preview","variable":[{"key":"id","value":""}]}}},{"name":"Publish a draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes the draft the live version of its kind and language and archives the one it replaces. Checkout then requires acceptance of the required kinds. A contract engine draft (ADR-0148) is the owner's approval: its placeholders are filled in now (the owner's values, the store's details, the approval date); one that nothing fills refuses the publish with 400 legal_fields_missing, details.placeholders naming them.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-documents",":id","publish"],"raw":"{{baseUrl}}/api/v1/admin/legal-documents/:id/publish","variable":[{"key":"id","value":""}]}}},{"name":"The contract engine's state","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The contract engine (ADR-0148, Sözleşme Motoru) for the store: whether it is on, whether an AI key is set (the store's own or the platform's), every category that holds an active product with its legal class (EK-C) — `needs_review` when the AI was unsure (confidence below 0.5) or named an obstacle to selling it online, until the owner confirms it — the last pass and its progress, the last document plan (EK-D), the newest draft of each document type with its audit against the checklist (EK-A: verdicts, legal basis, a proposed text per finding), the newest audit of each published text, and the fields the drafts leave for the owner with the values they will be filled with at publishing. No right needed, like the legal texts.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine"}}},{"name":"Audit one of the store's texts as it reads now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mevcut metni denetle: ÖZ-DENETİM on the text as rendered (with the store's details), the template-residue check without the model, and a proposed text per finding, in the background (202). 400 for a text the engine does not draft (its kind and language map to no document type). 409 as for a pass. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","audits"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/audits"}}},{"name":"Confirm or change a category's legal class","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The owner's class (and optional second class) for a category; 0 is the active products in no category. Confirms it. An obstacle the AI named stays while the class is unchanged. 404 for a category the store does not have. Audited. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","classes",":category_id"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/classes/:category_id","variable":[{"key":"category_id","value":""}]}}},{"name":"Put a finding's proposed text into a draft","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Into the engine's draft of the document while it is a draft; otherwise (an audited published text, or a draft since published) into a new draft made from the live text. The paragraph the finding was about is replaced while it is still there word for word, else the clause is added at the end. Nothing is published. 409 without a proposal, or for a draft written with the document editor. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","documents",":id","findings",":code","apply"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/documents/:id/findings/:code/apply","variable":[{"key":"id","value":""},{"key":"code","value":""}]}}},{"name":"Propose a text for one finding (DÜZELTME ÖNERİSİ)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks the store's AI now for a clause that meets the checklist item: the problem, the item's own legal basis, the proposed text and why. Replaces an earlier proposal. 409 for an item that is met; 409 ai_not_configured without a key; 502 when the AI fails or answers out of form. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","documents",":id","findings",":code","suggest"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/documents/:id/findings/:code/suggest","variable":[{"key":"id","value":""},{"key":"code","value":""}]}}},{"name":"Set the values of the drafts' fields","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The owner's values for the placeholders the drafts leave ([MERSİS NO], [KEP ADRESİ], …), filled in when a draft is published. An empty value removes the owner's value (the store's details fill it again where they can). Values may not contain brackets. Audited. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","fields"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/fields"}}},{"name":"Start a contract engine pass","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`classify` puts every category but those the owner set into a legal class (SINIFLANDIRMA, 20 categories with up to five sample products per call); a pass that leaves a category for the owner ends `waiting`. `prepare` classifies the categories still without a class, then plans the documents (BELGE PLANI, settled against EK-D) and drafts each one (ÜRETİM, continued with DEVAM when cut), audits it in batches of twelve items (ÖZ-DENETİM), revises it once when an item is not met (REVİZYON), audits it again and proposes a text per finding left (DÜZELTME ÖNERİSİ). Drafts land among the store's legal texts as drafts; publishing them is the owner's approval. Runs in the background (202). 409 while the engine is off, with no AI key (code ai_not_configured) or while another pass runs. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","runs"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/runs"}}},{"name":"Switch the contract engine on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Opts the store in or out. Off stops the regeneration sweep; drafts and classes stay. Audited as legal_document.settings_update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-engine","settings"],"raw":"{{baseUrl}}/api/v1/admin/legal-engine/settings"}}},{"name":"The seller's legal details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"MERSİS, tax office, KEP, web address and the periods printed into the texts.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-settings"],"raw":"{{baseUrl}}/api/v1/admin/legal-settings"}}},{"name":"Replace the seller's legal details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-settings"],"raw":"{{baseUrl}}/api/v1/admin/legal-settings"}}},{"name":"The engine's skeleton for a kind","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The engine's standard text in Turkish (default), English or German, with placeholders and a review banner ('hukukçu tarafından gözden geçirilmelidir' / 'must be reviewed by a lawyer' / 'von einem Rechtsanwalt geprüft werden'). Not legal advice; other languages answer 404.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","legal-templates",":kind"],"raw":"{{baseUrl}}/api/v1/admin/legal-templates/:kind","variable":[{"key":"kind","value":""}]}}},{"name":"What an order accepted","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each accepted text as rendered at checkout, with its hash and time, and the contract emails sent for the order.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","legal-acceptances"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/legal-acceptances","variable":[{"key":"id","value":""}]}}},{"name":"An order's accepted contract as a file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The accepted contract as a PDF (HTML for a right-to-left language such as Arabic). Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","legal-acceptances",":kind","file"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/legal-acceptances/:kind/file","variable":[{"key":"id","value":""},{"key":"kind","value":""}]}}}],"name":"admin:legal"},{"item":[{"name":"List partners","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each with clicks, credited orders, revenue and commission by state. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates"],"raw":"{{baseUrl}}/api/v1/admin/affiliates"}}},{"name":"Create a partner","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Their link is /{locale}/partner/{code}; an order using their discount code is theirs too. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates"],"raw":"{{baseUrl}}/api/v1/admin/affiliates"}}},{"name":"Read a partner","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates",":id"],"raw":"{{baseUrl}}/api/v1/admin/affiliates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Replace a partner","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates",":id"],"raw":"{{baseUrl}}/api/v1/admin/affiliates/:id","variable":[{"key":"id","value":""}]}}},{"name":"A partner's credited orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, at most 500. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates",":id","orders"],"raw":"{{baseUrl}}/api/v1/admin/affiliates/:id/orders","variable":[{"key":"id","value":""}]}}},{"name":"Settle a partner's commissions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"approve: pending → approved; pay: approved → paid (paid outside the platform). Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","affiliates",":id","settle"],"raw":"{{baseUrl}}/api/v1/admin/affiliates/:id/settle","variable":[{"key":"id","value":""}]}}},{"name":"A discount's single-use codes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Oldest first, each with whether it was used. Right: discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","codes"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/codes","variable":[{"key":"id","value":""}]}}},{"name":"Make single-use codes of a discount","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"count (1–1000) codes, each usable once and giving what the discount gives; prefix (up to 16 letters, digits, dashes; default the discount's own code) starts each. Each code is a copy of the discount with usage limit 1, left out of the discounts list. At most 1000 per discount. Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","discounts",":id","codes"],"raw":"{{baseUrl}}/api/v1/admin/discounts/:id/codes","variable":[{"key":"id","value":""}]}}},{"name":"List e-mail campaigns","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, at most 500. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns"}}},{"name":"Create an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A draft; nothing is sent until send. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns"}}},{"name":"Read an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Edit an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only a draft or a scheduled one. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Not while it is sending; its recipient list goes with it. Right: groups.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Stop an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A scheduled one, or one sending: who has had it keeps it. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Send an e-mail campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Now, or at `at` (at most a year ahead). Each recipient's copy is a commercial message: only those who consent receive it, with the opt-out link. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id","send"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id/send","variable":[{"key":"id","value":""}]}}},{"name":"Send a campaign to one address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Marked as a test; not counted, not in the recipient list. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","email-campaigns",":id","test"],"raw":"{{baseUrl}}/api/v1/admin/email-campaigns/:id/test","variable":[{"key":"id","value":""}]}}},{"name":"List gift cards","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's gift cards, newest first; q matches the last four characters, the recipient or the note. Right: discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-cards"],"raw":"{{baseUrl}}/api/v1/admin/gift-cards"}}},{"name":"Issue a gift card","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Issues a card by hand; send e-mails the code to the recipient. The answer carries the whole code, once — the store keeps only its hash. Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-cards"],"raw":"{{baseUrl}}/api/v1/admin/gift-cards"}}},{"name":"A gift card with its movements","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-cards",":id"],"raw":"{{baseUrl}}/api/v1/admin/gift-cards/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a gift card","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Status (active, disabled), expiry, note, or a hand adjustment of the balance (adjust_minor, signed). Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-cards",":id"],"raw":"{{baseUrl}}/api/v1/admin/gift-cards/:id","variable":[{"key":"id","value":""}]}}},{"name":"The store's loyalty programme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its defaults when never saved. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","loyalty"],"raw":"{{baseUrl}}/api/v1/admin/loyalty"}}},{"name":"Save the store's loyalty programme","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Points per unit of the base currency on paid orders (what gift cards and store credit did not pay), a point's worth as store credit, the least to redeem, and referral points. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","loyalty"],"raw":"{{baseUrl}}/api/v1/admin/loyalty"}}},{"name":"Move a customer's points by hand","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Signed: positive gives, negative takes. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","loyalty","adjust"],"raw":"{{baseUrl}}/api/v1/admin/loyalty/adjust"}}},{"name":"A customer's points","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Balance, its worth and the last 50 movements. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","loyalty","customer"],"raw":"{{baseUrl}}/api/v1/admin/loyalty/customer"}}},{"name":"List the automatic e-mails","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every kind — welcome, win_back, birthday, post_purchase — saved or with its starting text, and how many went out in the last 30 days. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","marketing-automations"],"raw":"{{baseUrl}}/api/v1/admin/marketing-automations"}}},{"name":"Save an automatic e-mail","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sent hourly to those who became due in the last 3 days, once per reason (account, order, year); only to customers who accept marketing e-mail. A win-back waits at least 7 days; a birthday e-mail goes on the day. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","marketing-automations",":kind"],"raw":"{{baseUrl}}/api/v1/admin/marketing-automations/:kind","variable":[{"key":"kind","value":""}]}}},{"name":"Send an automatic e-mail to one address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Marked as a test. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","marketing-automations",":kind","test"],"raw":"{{baseUrl}}/api/v1/admin/marketing-automations/:kind/test","variable":[{"key":"kind","value":""}]}}},{"name":"List product sets","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-sets"],"raw":"{{baseUrl}}/api/v1/admin/product-sets"}}},{"name":"Create a product set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Two to ten products sold together at a price off. The price off is an automatic promotion of the set's own, written in step: every product of the set in the basket → the percentage (value_bp) or amount (value_minor, off the set as a whole) off those lines. Stock is untouched. Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-sets"],"raw":"{{baseUrl}}/api/v1/admin/product-sets"}}},{"name":"A product set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: discounts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-sets",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-sets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Rewrite a product set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Its products, price off and switch; its promotion is written anew. Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-sets",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-sets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a product set","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With its promotion. Right: discounts.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","product-sets",":id"],"raw":"{{baseUrl}}/api/v1/admin/product-sets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Web push settings, subscribers and messages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","push"],"raw":"{{baseUrl}}/api/v1/admin/push"}}},{"name":"Switch the storefront's notifications on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The first time on makes the store's VAPID key pair. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","push"],"raw":"{{baseUrl}}/api/v1/admin/push"}}},{"name":"Send a notification to every subscriber","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queued and sent in the background, eight at a time; a browser its push service no longer knows is forgotten. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","push","campaigns"],"raw":"{{baseUrl}}/api/v1/admin/push/campaigns"}}},{"name":"List customer segments","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each with how many customers it holds now. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments"],"raw":"{{baseUrl}}/api/v1/admin/segments"}}},{"name":"Create a customer segment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Members are worked out from the rules whenever asked, never stored. Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments"],"raw":"{{baseUrl}}/api/v1/admin/segments"}}},{"name":"Preview a segment's rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The first 20 customers and how many there are, before saving. Right: customers.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments","preview"],"raw":"{{baseUrl}}/api/v1/admin/segments/preview"}}},{"name":"Read a customer segment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments",":id"],"raw":"{{baseUrl}}/api/v1/admin/segments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Replace a customer segment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments",":id"],"raw":"{{baseUrl}}/api/v1/admin/segments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a customer segment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Campaigns that named it keep their figures; one not yet sent must pick another segment. Right: groups.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments",":id"],"raw":"{{baseUrl}}/api/v1/admin/segments/:id","variable":[{"key":"id","value":""}]}}},{"name":"A segment's customers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The first 200, by amount spent, and the total. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","segments",":id","members"],"raw":"{{baseUrl}}/api/v1/admin/segments/:id/members","variable":[{"key":"id","value":""}]}}}],"name":"admin:marketing"},{"item":[{"name":"Sales regions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's sales regions (ADR-0147): each market with its countries, currency, KDV, delivery term and shipping fee by basket total. Right: catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-regions"],"raw":"{{baseUrl}}/api/v1/admin/sales-regions"}}},{"name":"Add a sales region","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates a market with its region settings. A country belongs to one region at most; one region may name no country (the rest of the world). Audited (sales_region.save). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-regions"],"raw":"{{baseUrl}}/api/v1/admin/sales-regions"}}},{"name":"Replace a sales region","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the region's market and settings; every product row that follows regions takes the new countries. Audited (sales_region.save). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-regions",":id"],"raw":"{{baseUrl}}/api/v1/admin/sales-regions/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a sales region","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes the region (its market, settings and brackets); a product row left with no region has no country and is held. Audited (sales_region.delete). Right: store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-regions",":id"],"raw":"{{baseUrl}}/api/v1/admin/sales-regions/:id","variable":[{"key":"id","value":""}]}}},{"name":"Switch a region's offline payments","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Havale / EFT and cash on delivery on or off for addresses in the region; a field left out keeps its state. The checkout refuses either where it is off. Audited (sales_region.payments). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-regions",":id","payments"],"raw":"{{baseUrl}}/api/v1/admin/sales-regions/:id/payments","variable":[{"key":"id","value":""}]}}}],"name":"admin:markets"},{"item":[{"name":"AI logo and banner generation: state","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Media \u003e Create with AI (ADR-0129). The four providers (openai, imagen, stability, fal) with whether the store entered a key, whether the ai-images plugin is on and at least one provider is ready (`ready`), the store's monthly limit and what it used this month, and the styles and aspects offered. Keys are never returned. Right: media.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","image-generation"],"raw":"{{baseUrl}}/api/v1/admin/image-generation"}}},{"name":"Make logos or banners with AI","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes 1 to 4 pictures from a description with the chosen provider and the store's own key, and stores each in the media library as a PNG or WebP upload tagged yapay-zeka. The month's count is reserved first (429 image_limit_reached over the limit) and handed back for a picture that fails. 409 image_generation_not_configured without a key; 422 image_key_refused / image_prompt_declined; 402 image_provider_quota; 429 image_provider_busy; 502 image_provider_error. Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","image-generation"],"raw":"{{baseUrl}}/api/v1/admin/image-generation"}}},{"name":"List the media library","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, which is what \"select existing\" wants: the file you just uploaded is usually the one you want. Every filter narrows in the store, so a page of results is a page of the whole library rather than of what a client already holds. The usage filter and usage_count count every place a file is used (ADR-0065): by key live, by name in text through an index the kernel rebuilds when that text changed.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media"],"raw":"{{baseUrl}}/api/v1/admin/media"}}},{"name":"Upload a file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A multipart form with a `file` field, and optionally `alt`, `title`, `language` (the texts' language; the store's default when empty), `folder_id`, `tags` (comma separated) and `keep_duplicate`. What the file is comes from its bytes: JPEG, PNG, GIF, WebP and AVIF images (20 MiB, 40 MP), MP4, MOV and WebM video and GLB, glTF and USDZ models (64 MiB in one request; up to 500 MiB through /media/uploads), and PDF documents (100 MiB) without active content (scripts, embedded files, automatic actions) — served as downloads only. SVG, HEIC and anything else are refused (details.reason: type, too_large, image_size, damaged, pdf_active, pdf_web_code). Private metadata is removed from a stored JPEG, PNG or WebP (EXIF with GPS, XMP, IPTC, text chunks; the orientation is kept) before it is hashed. When the library already holds the same bytes, nothing is stored and 200 answers {duplicate: true, media} — unless keep_duplicate. A JPEG or PNG gets responsive variants at the standard widths narrower than itself, made before it is stored, and its URL then ends in -\u003cw\u003ex\u003ch\u003e.\u003cext\u003e (ADR-0039); stored bytes, variants and kept revisions included, count against the max_media_bytes entitlement. The uploaded filename is never used as a path — it is kept for display only. At most 60 uploads a minute per store (429). Returns 501 when the store has nowhere to put files; the library still records media by URL in that case.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media"],"raw":"{{baseUrl}}/api/v1/admin/media"}}},{"name":"Move, tag or write alt text for many files","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 100 ids. Each item stands alone: one refusal does not undo the others, and each comes back with ok or a reason (not_found …). `move` takes folder_id (null: the top level), `tag`/`untag` take tags, `set_alt` takes alt (and language). Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","bulk"],"raw":"{{baseUrl}}/api/v1/admin/media/bulk"}}},{"name":"Delete many files","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 100 ids. Each file nothing uses is deleted (with its stored files and earlier revisions, audited as media.delete); each file still in use is refused with reason in_use and the places it is used. Right: media.delete.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","bulk-delete"],"raw":"{{baseUrl}}/api/v1/admin/media/bulk-delete"}}},{"name":"The library's folders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every folder, by position and name, with how many files each holds directly. Right: media.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","folders"],"raw":"{{baseUrl}}/api/v1/admin/media/folders"}}},{"name":"Create a folder","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most three levels deep; a name (1–80 characters) unique among its siblings (409 folder_exists). Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","folders"],"raw":"{{baseUrl}}/api/v1/admin/media/folders"}}},{"name":"Rename, move or reorder a folder","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Each field changes only when sent; parent_id null moves it to the top. Never into itself or below its own folders, never deeper than three levels. Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","folders",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/folders/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete an empty folder","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Refused (409 folder_not_empty) while it holds files or folders. Right: media.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","folders",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/folders/:id","variable":[{"key":"id","value":""}]}}},{"name":"Record media hosted elsewhere","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds a library entry for a file this store does not hold. No storage key is recorded, so deleting it only ever removes the row — nothing is ever deleted from someone else's server.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","link"],"raw":"{{baseUrl}}/api/v1/admin/media/link"}}},{"name":"Modern image formats: state","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Media › Modern formats (ADR-0128). Whether the store switched the formats on (plugin media-nextgen), what the server can write (`formats`), how many library files still wait for a copy (`pending`), how many copies were made, not kept because they were not smaller (`larger`), skipped (colour profile, animation, transparency for AVIF) or failed, and the bytes saved. Right: media.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","nextgen"],"raw":"{{baseUrl}}/api/v1/admin/media/nextgen"}}},{"name":"Convert the library now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets the skipped and failed files so the background job looks at them again and queues a pass. The job converts a few pictures at a time at the lowest priority and steps aside while the server is busy. Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","nextgen","run"],"raw":"{{baseUrl}}/api/v1/admin/media/nextgen/run"}}},{"name":"Start a resumable upload","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For a file of up to 500 MiB (a video, a long PDF), sent in chunks of chunk_size bytes (8 MiB; the last one shorter). The quota (max_media_bytes) is checked against the declared size plus the uploads in flight; at most 10 uploads and 2 GiB may be in flight per store (429 too_many_uploads). The options are applied when it completes; replace_media_id makes it a new file for that item. Expires after 24 hours. Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","uploads"],"raw":"{{baseUrl}}/api/v1/admin/media/uploads"}}},{"name":"Cancel a resumable upload","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes the session and its chunks. Right: media.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","uploads",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/uploads/:id","variable":[{"key":"id","value":""}]}}},{"name":"Send one chunk","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The body is the chunk's bytes (application/octet-stream): exactly chunk_size bytes, the last chunk the rest. Sending a chunk again rewrites it (idempotent). Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","uploads",":id","chunks",":n"],"raw":"{{baseUrl}}/api/v1/admin/media/uploads/:id/chunks/:n","variable":[{"key":"id","value":""},{"key":"n","value":""}]}}},{"name":"Finish a resumable upload","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Runs the upload pipeline on the assembled file (sniffed, metadata stripped, checked, quota under its lock) and answers the new item — or the existing one when the library holds the same bytes. 409 upload_incomplete lists the missing chunks. Completing again answers the item again. Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","uploads",":id","complete"],"raw":"{{baseUrl}}/api/v1/admin/media/uploads/:id/complete","variable":[{"key":"id","value":""}]}}},{"name":"Read a resumable upload","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Which chunks arrived, so a client resumes with the missing ones. 410 upload_expired after 24 hours. Right: media.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media","uploads",":id","status"],"raw":"{{baseUrl}}/api/v1/admin/media/uploads/:id/status","variable":[{"key":"id","value":""}]}}},{"name":"Get one library item","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a file's texts, folder, tags, poster or focal point","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Each field changes only when it is sent (at least one is required). The texts (alt, title, caption, description) are in `language` (the store's default when empty); `translations` sets other languages' texts whole (all empty removes one). `filename` is the display and download name — the address never changes. folder_id null is the top level; poster_media_id (a picture) is a video's poster; focal_point null clears it back to the centre. Text changes are audited (media.alt_set when only the default alt changed, else media.update); a move, tags and the focal point are not.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove media","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Refused with 409 (details.reason in_use, details.uses the places) while anything uses the file: a product or variant, a collection's or category's picture, a vendor's logo, a video's poster, the theme (draft or live), a theme instance, the store identity or menus, a page version other than an archived one, or catalogue text that embeds it. With `drafts=1` it goes ahead when every remaining use is a draft nobody sees. The file, its variants and its earlier revisions are removed only when this store holds them. Audited (media.delete). Right: media.delete (owner by default, ADR-0065).","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id"],"raw":"{{baseUrl}}/api/v1/admin/media/:id","variable":[{"key":"id","value":""}]}}},{"name":"Bring the first uploaded file back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The first upload becomes the item's file again; the edited file is kept as a revision, so this too can be undone by editing. 409 `not_edited` when the item shows its original, `original_gone` when it is no longer kept. Audited (media.restore). Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id","restore-original"],"raw":"{{baseUrl}}/api/v1/admin/media/:id/restore-original","variable":[{"key":"id","value":""}]}}},{"name":"Give an item a new file (edit or replace)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A multipart form with `file` and `reason` (`edit` from the image editor, or `replace`). The new file goes through the upload pipeline (sniffed, metadata stripped, variants made) and must be the same kind as the item. The item keeps its id, so every place that names it by id shows the new file; its address changes (stored files are cached as immutable), the previous file is kept as a revision (a page that pasted its address keeps working; counted in media storage), and the first upload is kept for restore-original. Audited (media.replace). Right: media.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id","revisions"],"raw":"{{baseUrl}}/api/v1/admin/media/:id/revisions","variable":[{"key":"id","value":""}]}}},{"name":"Where a file is used","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every place that uses the file, read live: by key (a product's or a variant's pictures, a vendor's logo, a collection's or a category's picture, a video's poster) and by name in text (the live and draft theme — logo, favicon, share picture —, theme instances, store identity and menus, page versions other than archived ones, product and catalogue text that embeds its address, also an earlier revision's). `live` says whether shoppers see the place now. Right: media.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","media",":id","usage"],"raw":"{{baseUrl}}/api/v1/admin/media/:id/usage","variable":[{"key":"id","value":""}]}}},{"name":"A product's media, in display order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Read this before writing: PUT replaces the whole ordered list, so a client that attaches one file without knowing the current one silently discards the rest.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","media"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/media","variable":[{"key":"id","value":""}]}}},{"name":"Set a product's media, in order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The body is the whole list, in order — a reorder and an add are the same request. Media already on the product keeps its position row, and with it any variant that nominated it; removing a file from the list also removes any variant's nomination of it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","media"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/media","variable":[{"key":"id","value":""}]}}},{"name":"Set or clear a variant's pictures","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the list of the product's pictures this variant shows, in the order given. Every id in `media_ids` must already be on the variant's product — a variant nominates some of the product's pictures rather than owning files, which is what lets every size of a colour show the same photographs stored once, and attaching from here would put a picture at a position in the product's ordered list that nobody chose. Send `[]` to clear. `media_id` is the shape from before there was a list — one picture, or `null` to clear — and still works. One of the two is required: an omitted field is a 400 rather than a guess, because guessing is how pictures get removed by a request that never mentioned them.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","variants",":id","media"],"raw":"{{baseUrl}}/api/v1/admin/variants/:id/media","variable":[{"key":"id","value":""}]}}}],"name":"admin:media"},{"item":[{"name":"Cart reminders: settings and report (Pazarlama › Sepet hatırlatma)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The switch, the steps (defaults when never saved), which channels can send, and the last `days` (default 30) of sequences: started, reached, clicked, recovered and the recovered orders' revenue. Right: carts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cart-recovery"],"raw":"{{baseUrl}}/api/v1/admin/cart-recovery"}}},{"name":"Save the cart reminder settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One to three steps; each enabled step comes later than the one before; delays 30 minutes to 14 days; discount 0–50%. Audited (cart_recovery.update). Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cart-recovery"],"raw":"{{baseUrl}}/api/v1/admin/cart-recovery"}}},{"name":"A step's message with a sample basket","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Rendered from the store's wording (Ayarlar › Bildirimler) in `language`. Right: carts.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cart-recovery","preview"],"raw":"{{baseUrl}}/api/v1/admin/cart-recovery/preview"}}},{"name":"The baskets being reminded","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first; `status` active, recovered, stopped or expired. Right: carts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cart-recovery","sequences"],"raw":"{{baseUrl}}/api/v1/admin/cart-recovery/sequences"}}},{"name":"Send a step's message to yourself","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A sample basket to `to` (email or SMS). 409 when no sender is set up. Right: discounts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cart-recovery","test"],"raw":"{{baseUrl}}/api/v1/admin/cart-recovery/test"}}},{"name":"Consents to commercial messages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's consent register (ETK / İYS), most recently changed first. overdue=true lists changes not yet in İYS past their three-business-day deadline.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","consents"],"raw":"{{baseUrl}}/api/v1/admin/consents"}}},{"name":"Record a consent","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A consent taken outside the checkout (a paper form, an import). It is owed to İYS within three business days.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","consents"],"raw":"{{baseUrl}}/api/v1/admin/consents"}}},{"name":"Record a withdrawal","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Honoured at once; owed to İYS within three business days.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","consents","revoke"],"raw":"{{baseUrl}}/api/v1/admin/consents/revoke"}}},{"name":"A consent's history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every grant and withdrawal, oldest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","consents",":id","events"],"raw":"{{baseUrl}}/api/v1/admin/consents/:id/events","variable":[{"key":"id","value":""}]}}},{"name":"Sender identity of commercial messages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The unvan, MERSİS number and contact every commercial message must carry.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","messaging","profile"],"raw":"{{baseUrl}}/api/v1/admin/messaging/profile"}}},{"name":"Set the sender identity","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Commercial messages are refused until the legal name and the MERSİS number are set.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","messaging","profile"],"raw":"{{baseUrl}}/api/v1/admin/messaging/profile"}}},{"name":"Do-not-send list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Recipients the store must not write to: commercial messages only, or everything.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notification-suppressions"],"raw":"{{baseUrl}}/api/v1/admin/notification-suppressions"}}},{"name":"Stop writing to a recipient","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds or replaces a suppression.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notification-suppressions"],"raw":"{{baseUrl}}/api/v1/admin/notification-suppressions"}}},{"name":"Lift a suppression","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notification-suppressions",":id"],"raw":"{{baseUrl}}/api/v1/admin/notification-suppressions/:id","variable":[{"key":"id","value":""}]}}}],"name":"admin:messaging"},{"item":[{"name":"The store's e-mail address book","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every contact and group, by name. Right: notifications.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-contacts"],"raw":"{{baseUrl}}/api/v1/admin/mail-contacts"}}},{"name":"Add a contact","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An address once per store; at most 1000. Audited. Right: notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-contacts"],"raw":"{{baseUrl}}/api/v1/admin/mail-contacts"}}},{"name":"Replace a contact","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited. Right: notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-contacts",":id"],"raw":"{{baseUrl}}/api/v1/admin/mail-contacts/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a contact","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited. Right: notifications.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-contacts",":id"],"raw":"{{baseUrl}}/api/v1/admin/mail-contacts/:id","variable":[{"key":"id","value":""}]}}},{"name":"Add a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A name once per store; at most 100. Audited. Right: notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-groups"],"raw":"{{baseUrl}}/api/v1/admin/mail-groups"}}},{"name":"Rename a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited. Right: notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-groups",":id"],"raw":"{{baseUrl}}/api/v1/admin/mail-groups/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its contacts stay, out of it; a mail naming it reaches no one through it. Audited. Right: notifications.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-groups",":id"],"raw":"{{baseUrl}}/api/v1/admin/mail-groups/:id","variable":[{"key":"id","value":""}]}}}],"name":"admin:notifications"},{"item":[{"name":"The store's health report","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The same checks `nerocart doctor` runs and the MCP `store_health` tool returns — the database, the migration ledger, admin access, the outbox, stock reservations, carts, the catalog, the registered providers, this contract, admin route gating, fulfillment, refunds, returns, the stock ledger and discounts.\n\nIt answers 200 even when `ok` is false, because the report is the answer rather than the error: a non-2xx would send a client down its error path at the one moment the detail matters most. `/health/ready` keeps its 503 because an orchestrator needs a status code; a person needs the detail.\n\nA check that failed because it could not run records the underlying driver text separately from its finding, and this response never carries it — a pgx error names a host, a port and a user, and the rest of this API refuses to send those to a client. It is written to the store's log instead. `nerocart doctor` and `doctor -json` still print it.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","diagnostics"],"raw":"{{baseUrl}}/api/v1/admin/diagnostics"}}},{"name":"Force a delivery pass on the outbox","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Delivers every event that is due, synchronously, instead of waiting for the dispatcher's poll. It is the same delivery path the background dispatcher runs, and the two can run at once: `FOR UPDATE SKIP LOCKED` keeps their claims disjoint.\n\n`delivered` counts rows claimed, not rows a handler accepted. A handler that errors leaves its row for the dispatcher's backoff, which is what at-least-once means. And a drain does not resurrect dead-lettered rows — those are excluded from the claim by design, and requeueing one is a separate act.\n\nThe pass has a 30-second budget, checked between batches and never inside one: a batch is claimed whole before any of it is dispatched, so cutting one short would burn a retry on every event it had claimed and not yet reached. `capped: true` therefore means a partial pass, not a failure. One pass at a time per process; a second request while one is running is refused rather than queued.\n\nThe body is ignored — send `{}`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","maintenance","drain-outbox"],"raw":"{{baseUrl}}/api/v1/admin/maintenance/drain-outbox"}}},{"name":"Sweep the carts now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Runs the three cart phases in one pass: an expired basket holding something is marked abandoned and announced as `cart.abandoned`, an expired basket holding nothing is deleted, and an abandoned one is deleted once `Config.CartRetention` has run out. The route runs the same service method the engine's own five-minute ticker runs — there is no second state machine and no panel-only maintenance path.\n\nEach phase is bounded, so a store carrying a backlog clears it over successive presses rather than in one statement; `capped` says a phase filled its batch and there is more to do.\n\nThe body is ignored — send `{}`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","maintenance","sweep-carts"],"raw":"{{baseUrl}}/api/v1/admin/maintenance/sweep-carts"}}},{"name":"Release stock held by unpaid orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Cancels pending orders whose payment never settled — pending or failed — past their reservation window, returning their stock to the shelf. Each cancellation is its own transaction and emits the ordinary `order.cancelled` event with the reason \"payment not completed in time\". The route runs the same service method the engine's own five-minute ticker runs — there is no second state machine and no panel-only maintenance path.\n\nOne pass, never a loop, and safe to press twice: cancelling an already-cancelled order does nothing. An order the service could not cancel is logged and skipped, which lowers `cancelled` without lowering what the pass found — which is why `capped` is derived from what was found.\n\nThe body is ignored — send `{}`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","maintenance","sweep-unpaid"],"raw":"{{baseUrl}}/api/v1/admin/maintenance/sweep-unpaid"}}},{"name":"Metrics for this store's tenant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"OpenMetrics text: outbox and job queue depth and age, dead events and jobs, payments awaiting their provider or flagged for an amount mismatch, shipments being booked, refunds in flight, and responses served by status class. Only the requesting tenant's numbers.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","metrics"],"raw":"{{baseUrl}}/api/v1/admin/metrics"}}}],"name":"admin:ops"},{"item":[{"name":"List automations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Triggers order.created, order.paid, order.cancelled; conditions total_minor gt/lt, country eq, payment_method eq, first_order eq true/false, product_tag eq; actions add_tag, assign (a team member's e-mail), email_customer (subject, body; {ad} and {siparis} filled). Each rule runs once per order. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","automation-rules"],"raw":"{{baseUrl}}/api/v1/admin/automation-rules"}}},{"name":"Create an automation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Triggers order.created, order.paid, order.cancelled; conditions total_minor gt/lt, country eq, payment_method eq, first_order eq true/false, product_tag eq; actions add_tag, assign (a team member's e-mail), email_customer (subject, body; {ad} and {siparis} filled). Each rule runs once per order. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","automation-rules"],"raw":"{{baseUrl}}/api/v1/admin/automation-rules"}}},{"name":"Replace an automation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","automation-rules",":id"],"raw":"{{baseUrl}}/api/v1/admin/automation-rules/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete an automation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: orders.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","automation-rules",":id"],"raw":"{{baseUrl}}/api/v1/admin/automation-rules/:id","variable":[{"key":"id","value":""}]}}},{"name":"Carriers, or the ones a tracking number could belong to","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Without `tracking`, every carrier the engine can name. With it, the ones whose numbering the number fits, best first.\n\nThat is a list rather than a verdict on purpose. A tracking number is not self-describing: several carriers issue bare ten- to fourteen-digit numbers, so a twelve-digit number is genuinely ambiguous. Where a number carries something distinctive — UPS's `1Z`, the S10 standard's country suffix, DHL's `JJD` — the list has one entry and a client can fill the field in. Where it does not, the operator picks. Guessing would hand the customer a tracking link that goes nowhere, which reads as the shop having lost their parcel.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","carriers"],"raw":"{{baseUrl}}/api/v1/admin/carriers"}}},{"name":"List carts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Baskets that have not become orders yet: what is in them, what they are worth, and the address to reach the shopper on. Read-only and tokenless - a cart's token is a live credential, so it is never returned here and a cart is addressed by its numeric row id. `state` is derived from the status column AND `expires_at`, so a cart the five-minute sweeper has not reached yet still reports as abandoned.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","carts"],"raw":"{{baseUrl}}/api/v1/admin/carts"}}},{"name":"Get a cart","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One basket and what is in it, addressed by the numeric id the listing reports. Each line carries both coordinates - the price as snapshotted and the price now - so an operator can see whether the basket is still worth chasing. Still no token.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","carts",":id"],"raw":"{{baseUrl}}/api/v1/admin/carts/:id","variable":[{"key":"id","value":""}]}}},{"name":"List the chargebacks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Open disputes first, by deadline. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks"}}},{"name":"Record a chargeback","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Against one of the store's orders; the deadline defaults to seven days after it was opened. Audited as chargeback.create. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks"}}},{"name":"Read a chargeback","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With its evidence files (never their bytes). Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks",":id"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a chargeback","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"open → responded, accepted, won, lost; responded → won, lost. Audited as chargeback.update. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks",":id"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks/:id","variable":[{"key":"id","value":""}]}}},{"name":"Add evidence to a chargeback","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"multipart/form-data, the file in \"file\": a PDF, JPG or PNG up to 10 MB, kept encrypted like the document vault. Audited as chargeback.document_upload. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks",":id","documents"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks/:id/documents","variable":[{"key":"id","value":""}]}}},{"name":"Download a chargeback's evidence","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A private download; every read is in the audit log (chargeback.document_view). Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","chargebacks",":id","documents",":doc"],"raw":"{{baseUrl}}/api/v1/admin/chargebacks/:id/documents/:doc","variable":[{"key":"id","value":""},{"key":"doc","value":""}]}}},{"name":"List payment links","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, at most 200. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","checkout-links"],"raw":"{{baseUrl}}/api/v1/admin/checkout-links"}}},{"name":"Create a payment link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Products (variants and quantities), and if wanted a discount code and the customer's e-mail. Whoever opens the link gets a basket of those lines in their market at today's prices and pays with any method. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","checkout-links"],"raw":"{{baseUrl}}/api/v1/admin/checkout-links"}}},{"name":"Switch a payment link on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","checkout-links",":id"],"raw":"{{baseUrl}}/api/v1/admin/checkout-links/:id","variable":[{"key":"id","value":""}]}}},{"name":"Import cash-on-delivery remittances","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Rows of a carrier's remittance report. Each row that matches what the courier was to collect marks its order paid (audited as order.cod_remit); a different amount is recorded and leaves the order unpaid; a reference seen before is a no-op. Rows are applied one by one and each says what it did.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cod","remittances"],"raw":"{{baseUrl}}/api/v1/admin/cod/remittances"}}},{"name":"Delivered, not remitted","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Delivered cash-on-delivery shipments whose money has not come back, oldest first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cod","unremitted"],"raw":"{{baseUrl}}/api/v1/admin/cod/unremitted"}}},{"name":"The contact inbox (Müşteriler › Mesajlar)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Messages from the storefront's contact form, newest first. `status` new, read, archived or all (absent: everything but archived); `q` matches the name, address, topic and message. Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","contact-messages"],"raw":"{{baseUrl}}/api/v1/admin/contact-messages"}}},{"name":"How many contact messages are new, read and archived","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"For the inbox's tabs and the menu's badge. Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","contact-messages","counts"],"raw":"{{baseUrl}}/api/v1/admin/contact-messages/counts"}}},{"name":"One contact message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: contact.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","contact-messages",":id"],"raw":"{{baseUrl}}/api/v1/admin/contact-messages/:id","variable":[{"key":"id","value":""}]}}},{"name":"Mark a contact message read, archived or new","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Reading sets read_at once; marking it new again clears it. Right: contact.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","contact-messages",":id"],"raw":"{{baseUrl}}/api/v1/admin/contact-messages/:id","variable":[{"key":"id","value":""}]}}},{"name":"Answer a contact message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends the store's answer to the visitor's address through the store's mail sender — the wording of the form's reply message (contact.auto_reply), the visitor's own message quoted under it — and records it on the message (replies) with who answered and when; a new message becomes read. 409 with details.reason mail_not_configured when the store has no mail sender. Right: contact.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","contact-messages",":id","reply"],"raw":"{{baseUrl}}/api/v1/admin/contact-messages/:id/reply","variable":[{"key":"id","value":""}]}}},{"name":"Ship an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Books a shipment against some or all of an order, and lets the order's status follow what has gone out: `shipped` when nothing is left, `partial` while units are still owed. Omitting `lines` ships everything the order still owes, so the same request sent twice ships the whole order and then the remainder. With the built-in `manual` provider an operator packs the box and types the tracking number; a carrier module reads `meta` for its own options, such as courier choice or pickup slot. The shipment is reserved before the carrier is asked and settled after; a carrier that refuses leaves it recorded as failed with its units free again. All lines of one shipment must come from one location (see fulfillment-groups).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","create-fulfillment"],"raw":"{{baseUrl}}/api/v1/admin/create-fulfillment"}}},{"name":"The store's customer records","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. `q` matches an email or a name. Records belong to the store the request acts on (X-Store-Id). Requires customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records"],"raw":"{{baseUrl}}/api/v1/admin/customer-records"}}},{"name":"Add a customer record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Unique by email within the store (409 otherwise). Requires customers.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records"],"raw":"{{baseUrl}}/api/v1/admin/customer-records"}}},{"name":"One customer record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id","variable":[{"key":"id","value":""}]}}},{"name":"Edit a customer record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires customers.write; audited with what changed.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a customer record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Their orders keep their own snapshot. Requires customers.write; audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id","variable":[{"key":"id","value":""}]}}},{"name":"A customer's address book","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The addresses the shopper keeps under Adreslerim (ADR-0049), read on the customer's record by the store's operator — for a customer without an account too. Defaults first.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id","addresses"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id/addresses","variable":[{"key":"id","value":""}]}}},{"name":"Add an address to a customer's address book","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The same rules as the shopper's own edit: the first address is the default for delivery and for the invoice, one default of each kind, at most 20 addresses. The audit row names the operator and never holds the address.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id","addresses"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id/addresses","variable":[{"key":"id","value":""}]}}},{"name":"Change an address of a customer's address book","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A field left out stays as it is.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id","addresses",":addressId"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id/addresses/:addressId","variable":[{"key":"id","value":""},{"key":"addressId","value":""}]}}},{"name":"Remove an address from a customer's address book","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id","addresses",":addressId"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id/addresses/:addressId","variable":[{"key":"id","value":""},{"key":"addressId","value":""}]}}},{"name":"Email the customer a password reset link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"For a customer record with a storefront account (ADR-0049). Nobody at the store ever sees or sets a shopper's password; this sends the shopper the same link \"forgot my password\" does (1 hour, single use). Audited. Requires customers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-records",":id","password-reset"],"raw":"{{baseUrl}}/api/v1/admin/customer-records/:id/password-reset","variable":[{"key":"id","value":""}]}}},{"name":"The orders, grouped by who placed them","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"There is no customer resource behind this. Guest checkout is a permanent guarantee (D22), so a shopper never has an account and an order carries its own snapshot of who bought it — which means a customer can only be every order sharing an email. Name, phone and address come from that person's most recent order. Orders counts everything they placed that was not cancelled; spent totals only what was actually paid, so an order awaiting cash on delivery is a real order and not yet money. Correcting a customer means correcting an order, which is why there is no GET by id, PATCH or DELETE here.\n\nScoped like the orders list: the current store's orders (X-Store-Id, or the tenant's first store); a request with no store (the static token without one) reads the tenant's.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customers"],"raw":"{{baseUrl}}/api/v1/admin/customers"}}},{"name":"Dealer applications (Müşteriler › Bayi başvuruları)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. `status` pending (the default), approved, rejected, revoked or all; `q` matches the company, the address and the tax number. Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications"}}},{"name":"Dealer applications per status","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications","counts"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications/counts"}}},{"name":"One dealer application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: customers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications",":id"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications/:id","variable":[{"key":"id","value":""}]}}},{"name":"Approve a dealer application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A waiting application's address joins a dealer group (`group_id`, else the store's default, else \"Bayiler\", made and made the default). From then on the dealer sees hidden prices and the group's prices; their open baskets are priced again in the same transaction. The applicant is emailed. Audited (dealer_application.approve). 409 unless waiting. Right: customers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications/:id/approve","variable":[{"key":"id","value":""}]}}},{"name":"Reject a dealer application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A waiting application is closed with a `reason` the applicant reads (required). The applicant is emailed. Audited (dealer_application.reject). 409 unless waiting. Right: customers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications",":id","reject"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications/:id/reject","variable":[{"key":"id","value":""}]}}},{"name":"Revoke a dealership","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An approved application ends with a `reason`: the address leaves every dealer group of the store and its open baskets are priced again at once — hidden prices are gone, and the checkout refuses a dealer-only line still in a basket (dealer_only). Audited (dealer_application.revoke). 409 unless approved. Right: customers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dealer-applications",":id","revoke"],"raw":"{{baseUrl}}/api/v1/admin/dealer-applications/:id/revoke","variable":[{"key":"id","value":""}]}}},{"name":"The ETGB days","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The days the store closed or changed, newest first: the daily record (günlük kayıt). Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days"}}},{"name":"A day's ETGB sheet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A closed day as it was recorded; an open day built now from its export shipments (outside Türkiye, not digital, not gifts or samples — those are listed under `gifts`), with the typed cells over the automatic values, rows added by hand and rows left out. Each row says whether it is prepared (e-invoice, label and commercial invoice present) and whether it needs an A.TR. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day","variable":[{"key":"day","value":""}]}}},{"name":"Type over a cell of a day's sheet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A typed value survives every refill of the automatic values; `clear` takes it off. 404 for a row or column the day does not have, 409 for a closed day. Audited (etgb.cell_set). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","cells"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/cells","variable":[{"key":"day","value":""}]}}},{"name":"Close a day","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records the day as it stands — its rows and the papers of its shipments; a shipment it recorded is in no later day, and a shipment booked after the closing goes to the next day. Audited (etgb.day_close). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","close"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/close","variable":[{"key":"day","value":""}]}}},{"name":"Leave a shipment off a day's sheet, or put it back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A shipment left off is in neither the sheet nor the folder, and a closed day keeps it so no later day takes it. Audited (etgb.row_exclude). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","exclude"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/exclude","variable":[{"key":"day","value":""}]}}},{"name":"Download a day's folder","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A zip laid out as DD.MM.YYYY/: each export shipment's commercial invoice and e-invoice, the sheet, labels/, atr/ (the A.TR shipments' papers again and the A.TR sheet) and gift/ (gifts and samples, with label/). A paper that could not be fetched is listed in eksik_belgeler.txt. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","folder"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/folder","variable":[{"key":"day","value":""}]}}},{"name":"Open a closed day again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Typed cells and rows are kept; the automatic values are filled anew. 409 when the day is not closed. Audited (etgb.day_reopen). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","reopen"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/reopen","variable":[{"key":"day","value":""}]}}},{"name":"Add a row by hand to a day's sheet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An empty row; its cells are typed. 409 for a closed day. Audited (etgb.row_add). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","rows"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/rows","variable":[{"key":"day","value":""}]}}},{"name":"Remove a row typed by hand","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Only a row added by hand (`m…`); a shipment's row is left out with /exclude instead. Audited (etgb.row_remove). Needs orders.fulfill.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","rows",":row"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/rows/:row","variable":[{"key":"day","value":""},{"key":"row","value":""}]}}},{"name":"Download a day's sheet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The sheet as an .xlsx file (numbers as numbers, the invoice date as a date); `kind=atr` keeps the rows that need an A.TR. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","days",":day","sheet"],"raw":"{{baseUrl}}/api/v1/admin/etgb/days/:day/sheet","variable":[{"key":"day","value":""}]}}},{"name":"The scheduled ETGB e-mails","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every send time evaluated, newest first: queued (with each recipient's delivery status), skipped (nothing prepared) or failed. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","mail-log"],"raw":"{{baseUrl}}/api/v1/admin/etgb/mail-log"}}},{"name":"The ETGB workspace set-up","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"ADR-0144: the sheet's columns (each filled from a field of the catalog, a fixed text or typed by hand), sheet and file names, the defaults for the goods description, GTİP and Incoterm, the A.TR rule, the daily closing time and the scheduled e-mail. The owner's 19-column form until the store changes it. `fields` is the catalog; `mail_ready` says whether the store has an e-mail sender. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","settings"],"raw":"{{baseUrl}}/api/v1/admin/etgb/settings"}}},{"name":"Save the ETGB workspace set-up","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the whole set-up; `columns` empty puts the owner's form back, `atr_countries` empty is the 27 EU member states and `atr_threshold_minor` 0 is 150 (in `atr_currency`, EUR by default). The signature is sanitised HTML. Switching the daily e-mail on needs at least one recipient and one send time. Audited (etgb.settings_update). Needs shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","settings"],"raw":"{{baseUrl}}/api/v1/admin/etgb/settings"}}},{"name":"Put the ETGB sheet back to the default form","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The owner's 19 columns, sheet name and file name again; typed cells stay with their column keys. Audited (etgb.columns_reset). Needs shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","etgb","settings","reset"],"raw":"{{baseUrl}}/api/v1/admin/etgb/settings/reset"}}},{"name":"Correct a shipment's tracking number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Typing a tracking number is the one step of shipping a parcel nobody else checks, so it is the one that gets mistyped. This changes what was recorded about the shipment and nothing about the order: the parcel left either way, and correcting the number is not un-shipping it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","fulfillments",":id"],"raw":"{{baseUrl}}/api/v1/admin/fulfillments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a shipment recorded in error","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The order follows it. \"Shipped\" was true because that record existed, so removing the last one that says so puts the order back to confirmed — leaving it shipped with nothing shipping it would be a state no operation could explain and no operator could correct.\n\nRefused on a delivered order: a parcel somebody received is not a record to erase, and undoing the delivery first is the operation that says so.\n\nReturns the order, whose status may have moved with the shipment.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","fulfillments",":id"],"raw":"{{baseUrl}}/api/v1/admin/fulfillments/:id","variable":[{"key":"id","value":""}]}}},{"name":"Record a shipment as delivered","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One parcel reached the customer. When it is the last parcel of an order that shipped in full, the order is delivered too. Usually recorded by the tracking job.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","fulfillments",":id","deliver"],"raw":"{{baseUrl}}/api/v1/admin/fulfillments/:id/deliver","variable":[{"key":"id","value":""}]}}},{"name":"Record a failed delivery","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The carrier could not hand the parcel over. The units still count as sent.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","fulfillments",":id","delivery-failed"],"raw":"{{baseUrl}}/api/v1/admin/fulfillments/:id/delivery-failed","variable":[{"key":"id","value":""}]}}},{"name":"A shipment's label","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The label bytes the carrier returned, stored by the engine and served as an attachment to staff only — a label carries the customer's name, phone and address.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","fulfillments",":id","labels",":position"],"raw":"{{baseUrl}}/api/v1/admin/fulfillments/:id/labels/:position","variable":[{"key":"id","value":""},{"key":"position","value":""}]}}},{"name":"What the store told its shoppers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every notification the store sent — or tried to, or only logged — newest first. Filter by channel, status, event, or search by recipient or order number. Needs orders.read: a notification is an order's communication.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications"],"raw":"{{baseUrl}}/api/v1/admin/notifications"}}},{"name":"One notification","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications",":id"],"raw":"{{baseUrl}}/api/v1/admin/notifications/:id","variable":[{"key":"id","value":""}]}}},{"name":"Send a notification again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Delivers the recorded message again through whatever backends the store has now — the one that failed last week may be fixed, and one that only reached the log may have an email module behind it today. The new attempt is its own row, pointing at this one, and is what comes back. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications",":id","resend"],"raw":"{{baseUrl}}/api/v1/admin/notifications/:id/resend","variable":[{"key":"id","value":""}]}}},{"name":"The store's order tags","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Most used first, at most 200. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-tags"],"raw":"{{baseUrl}}/api/v1/admin/order-tags"}}},{"name":"Tags and assignees of orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"For the ids given (comma separated, at most 500); orders with neither are left out. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-tags","orders"],"raw":"{{baseUrl}}/api/v1/admin/order-tags/orders"}}},{"name":"Orders with a tag or an assignee","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Their ids, newest first, at most 500. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-tags","search"],"raw":"{{baseUrl}}/api/v1/admin/order-tags/search"}}},{"name":"List your saved order views","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.read. The signed-in operator's own views of the orders list, by name.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-views"],"raw":"{{baseUrl}}/api/v1/admin/order-views"}}},{"name":"Save a order view","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs orders.read. `query` is the list's query string as the panel writes it; `id`, `page` and token-like keys are dropped. The same name replaces the operator's view. At most 50 per list. Audited (`saved_view.create`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-views"],"raw":"{{baseUrl}}/api/v1/admin/order-views"}}},{"name":"Delete a saved order view","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.read. Only the operator's own view. Audited (`saved_view.delete`).","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-views",":id"],"raw":"{{baseUrl}}/api/v1/admin/order-views/:id","variable":[{"key":"id","value":""}]}}},{"name":"List orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":" In a multi-store tenant the list is the current store's (X-Store-Id), matching the dashboard's counts.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders"],"raw":"{{baseUrl}}/api/v1/admin/orders"}}},{"name":"Place an order on a customer's behalf","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The phone order, the trade counter, the replacement parcel. It builds a cart and checks it out rather than inserting an order, so the result is indistinguishable from one a shopper placed: stock is reserved under the same lock, prices are snapshotted the same way, and the same order.created event reaches every notifier. The order carries an access token, so the customer can look it up without an account. Distinct from POST /api/admin/import/orders, which records orders that already happened elsewhere and deliberately moves no stock.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders"],"raw":"{{baseUrl}}/api/v1/admin/orders"}}},{"name":"Apply one action to several orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies the verb an operator has on one order to each order named, in turn, each in its own transaction, and reports every order's outcome; one refusal never stops the rest. `mark_paid` is POST /api/admin/orders/{id}/mark-paid, `fulfill` ships everything an order still owes by hand (POST /api/admin/create-fulfillment with the manual provider; needs `orders.fulfill` as well), `deliver` is POST /api/admin/orders/{id}/deliver, `cancel` is POST /api/admin/orders/{id}/cancel, `cancel_refund` is POST /api/admin/orders/{id}/cancel-and-refund (money at a gateway voided before the bank's end of day, refunded after; needs `orders.refund` as well). `ship` and `complete` are the WooCommerce-style \"set the status to\" choices: each runs only the steps the order still needs, in order — marked paid when it is not, shipped by hand — and `complete` then marks it delivered; both need `orders.fulfill`. `trash` cancels the order first through the same cancellation (its stock goes back; an order that has shipped, holds money or has goods returned is refused) and moves it to the trash; `restore` takes it back out, still cancelled; `delete` deletes a trashed order for good, refused when money ever moved for it or it has an invoice, a shipment, a return, licence codes or a marketplace behind it. Trashed orders are deleted for good after 30 days by the same rule. The verbs that move an order on refuse one in the trash. A refused order carries `reason`, a stable code: order_shipped, order_paid, order_paid_offline, order_returned, order_cancelled, order_refunded, order_not_confirmed, order_not_shipped, order_in_trash, order_not_in_trash, order_keeps_records, not_found, approval_required (the refund waits for a second approval, ADR-0135) — or none, when `message` is all there is. Another tenant's order is not_found.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders","bulk"],"raw":"{{baseUrl}}/api/v1/admin/orders/bulk"}}},{"name":"Get an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id","variable":[{"key":"id","value":""}]}}},{"name":"Correct an order's contact details and payment record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An email with a typo in it means the customer never hears from the shop again; an address with the wrong house number means the parcel goes to the wrong door; a payment reference is what somebody reconciles against a bank statement. None of them is a state change, and each is a field a person typed once.\n\nCorrecting an address does not move a parcel that has already gone out.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id","variable":[{"key":"id","value":""}]}}},{"name":"Read an order's guest access token back out","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The customer rang: they have lost the \"view your order\" link. The access token is their only credential — guest checkout is permanent (D22), so there is no account to sign into — and it is returned at checkout and by nothing else, which left a support desk with no answer at all.\n\nIt reveals the existing token rather than issuing a new one. Rotating would answer the same question while silently breaking the link in the confirmation mail the customer already has, so an operator helping with a mislaid link would be destroying the mislaid copy.\n\nPOST, not GET, and `orders.write`, not `orders.read`: handing out a bearer credential is an act, and it is recorded as one. Every call writes an `order.token_reveal` row naming the operator, in the same transaction as the read — the token itself is deliberately not in that row, because an append-only table nothing can delete from is the last place a live credential should be copied into. No body.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","access-token"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/access-token","variable":[{"key":"id","value":""}]}}},{"name":"What the automatic preparation did with an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The order's automatic preparation (ADR-0142): its state, the reason it left the order to the operator (a word the panel says in a sentence, with a detail such as the SKUs that fell short or the carrier's refusal), the hidden stock taken, the shipment and invoice it made. `data` is null when the order was never handed to it. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","auto-preparation"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/auto-preparation","variable":[{"key":"id","value":""}]}}},{"name":"Hand an order to the automatic preparation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues the order again: one that waited (the hidden stock was short) or failed, or a paid order from before the switch was on. The background job decides as it does for a new paid order. 409 `auto_preparation_off` while the store's switch is off; 409 for a test order or one already prepared. Audited (order.auto_prepare). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","auto-preparation"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/auto-preparation","variable":[{"key":"id","value":""}]}}},{"name":"Cancel an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns the inventory. Which movement is correct depends on how far the order got: a pending order only ever reserved stock, while a confirmed one has already taken it off the shelf. An order that has shipped cannot be cancelled — that is a return.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Cancel an order and give its money back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"ADR-0007's cancel saga for an order whose money is still at the payment provider: everything `/cancel` refuses for goods (shipped, returned) is refused first, before any money moves; then every payment is settled — an authorization with nothing captured is voided, a capture is refunded for what it captured less what was already refunded — and the order is cancelled. Idempotent: a retry skips what is settled. An order paid outside a gateway (cash on delivery marked paid) is refused: record the manual refund, then cancel. Needs orders.write and orders.refund. A refund at or above the store's second-approval threshold, asked by anyone but the owner, does not run: the answer is a 409 with code approval_required and the waiting approval in details.approval (ADR-0135).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","cancel-and-refund"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/cancel-and-refund","variable":[{"key":"id","value":""}]}}},{"name":"List an order's changes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every order change of the order, oldest first — edits (EditLines records each as a confirmed edit), exchanges and claims.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes","variable":[{"key":"id","value":""}]}}},{"name":"Open an order change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates a pending edit, exchange or claim and prices it against the order as it stands: the same code confirming runs, inside a savepoint that is rolled back, so stock, tax and the return cap are checked now. An order has at most one pending change. Each action is validated by the engine against the state the actions before it left (Medusa's calculateOrderChange). Announces order_change.requested.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes","variable":[{"key":"id","value":""}]}}},{"name":"Read an order change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One change of the order.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes",":changeId"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes/:changeId","variable":[{"key":"id","value":""},{"key":"changeId","value":""}]}}},{"name":"Cancel an order change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Drops a pending change; nothing it described happens. Announces order_change.cancelled. A confirmed change is refused — a new change undoes it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes",":changeId","cancel"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes/:changeId/cancel","variable":[{"key":"id","value":""},{"key":"changeId","value":""}]}}},{"name":"Confirm an order change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies a pending change: new lines (stock sold, each taxed on its own, the order total moved by exactly them), the returns it asks for (authorized, and received when the change receives them), added or removed shipping charges, credit lines — and an edit's lines through the EditLines path. One transaction with order_change.confirmed and the audit row. Confirming again is a no-op; a cancelled change is refused.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes",":changeId","confirm"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes/:changeId/confirm","variable":[{"key":"id","value":""},{"key":"changeId","value":""}]}}},{"name":"Preview an order change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Prices a pending change again against the order as it stands now and keeps the figures on it. Writes no event: nothing about the order changed. A change no longer pending is returned as it is.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","changes",":changeId","preview"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/changes/:changeId/preview","variable":[{"key":"id","value":""},{"key":"changeId","value":""}]}}},{"name":"Mark an order delivered","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","deliver"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/deliver","variable":[{"key":"id","value":""}]}}},{"name":"An order's export (İHRACAT) customs details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"IN4: the Incoterms delivery term and place, the transport mode, the ETGB or GTB customs declaration and office, and the foreign buyer's own tax number, recorded for an order delivered abroad. `data` is null when none were entered. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","export"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/export","variable":[{"key":"id","value":""}]}}},{"name":"Record an order's export customs details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"IN4: with these details the order's invoice is an export (İHRACAT) e-Fatura to the GTB's mailbox, issued through the e-invoice integrator the store has configured — provided that integrator can issue export invoices, and every product has its GTIP (the variant's hs_code or its invoice item's tariff number). Without them the invoice stays the plain export-exempt one. 409 for an order delivered at home. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","export"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/export","variable":[{"key":"id","value":""}]}}},{"name":"Take an order's export customs details off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"IN4: the order's invoice is the plain export-exempt one again. Needs orders.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","export"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/export","variable":[{"key":"id","value":""}]}}},{"name":"List an order's fulfillment groups","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The order's lines grouped by their source — the location they were allocated to, or for a supplied line the supplier and its location (ADR-0082) — with what each line still owes and each group's status (unfulfilled, partially_fulfilled, fulfilled). A shipment leaves from one group.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","fulfillment-groups"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/fulfillment-groups","variable":[{"key":"id","value":""}]}}},{"name":"Mark an order as a gift or a sample","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"kind gift (a present) or sample (a free sample) marks the order as not a sale: its customs invoice says GIFT or SAMPLE, and automatic invoicing leaves it out when the gift settings say so; kind \"\" makes it a sale again. Without kind, gift true is a present. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","gift"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/gift","variable":[{"key":"id","value":""}]}}},{"name":"Burn an order's codes (chargeback, fraud)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every code the order holds is burned, delivered or not, and never sold again; the money is the refund's business. A reason is required. Audited as licence_key.burn. Needs orders.write and orders.refund.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","licence-keys","burn"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/licence-keys/burn","variable":[{"key":"id","value":""}]}}},{"name":"Release an order's codes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The operator's approval of an order held for review (the pool's review_before_delivery), and the way to fill codes a short pool left missing: the lines get the codes they lack (409 when the pool is still short), the hold is lifted, and a paid order's codes are delivered — the shopper is e-mailed and the digital delivery completes. Audited as licence_key.release. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","licence-keys","release"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/licence-keys/release","variable":[{"key":"id","value":""}]}}},{"name":"Replace a code that does not work","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The code is burned and the line gets another from the pool, delivered at once when the order is paid (6502 m.11: a code that does not work is a defective good); one more unit leaves the pool's shelf (409 when the pool is empty). The shopper is e-mailed the order's codes again (licence_key.replaced). Audited as licence_key.replace. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","licence-keys",":keyId","replace"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/licence-keys/:keyId/replace","variable":[{"key":"id","value":""},{"key":"keyId","value":""}]}}},{"name":"Read one of an order's codes in the clear","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (licence_key.reveal) in the same transaction as the read; answered no-store. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","licence-keys",":keyId","reveal"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/licence-keys/:keyId/reveal","variable":[{"key":"id","value":""},{"key":"keyId","value":""}]}}},{"name":"Change what is on an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the order's lines with the set given. A line the order already has is named by its id; one being added names a variant instead, and is priced as that variant is priced today. A line the request leaves out is removed, and an order may not be left with none — cancel it instead. Stock moves with the change: an order that has only reserved its stock has its reservation adjusted, one that has already taken the units off the shelf gives them back or takes more. The money is not settled here — the response reports the totals either side of the edit and the balance between them, and collecting or refunding it is a payment operation with its own record. An order that has shipped, been cancelled or been refunded cannot be edited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","lines"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/lines","variable":[{"key":"id","value":""}]}}},{"name":"Record a manual refund","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records money the merchant sent back outside the store — a bank transfer back to the customer, cash — against an order paid by an offline method (cash on delivery, bank transfer; see ProviderInfo.refunds = manual). Nothing is sent to a provider: the refund is reserved under the order lock, bound by what is still refundable (the total less what went back and what is in flight) and by a captured payment when the order has one, then settled exactly as a gateway refund — refunded, payment_status and the order.refunded event (with refund.method = manual) move together, audited as order.refund_manual. A method the store refunds through is refused with 409. An Idempotency-Key header is required: the same key on the same order answers with the first record; with a different amount it is a 400. Needs orders.refund.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","manual-refund"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/manual-refund","variable":[{"key":"id","value":""}]}}},{"name":"Record payment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"How cash on delivery is settled, and the same call a gateway module makes from its webhook. It also confirms a pending order — without that, a paid order would wait forever for a step nobody performs. Idempotent: a replayed webhook does not commit stock twice.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","mark-paid"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/mark-paid","variable":[{"key":"id","value":""}]}}},{"name":"Record a payment attempt that did not succeed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The order stays where it is — it is not cancelled and its stock is not released — so the shopper can try again. Its reservation stays in the sweeper's reach, so an attempt nobody retries eventually cancels the order and returns the stock on its own.\n\nTwo deliberate no-ops answer 200 and change nothing: an order whose payment is already failed, and an order that has been cancelled. The cancelled case is checked first, so a late gateway callback for an order the sweeper already cancelled is recorded as nothing rather than refused — a 409 there is a webhook retried forever.\n\nRefused with 409 on an order that is already paid, and on one that was refunded, where money really did move.\n\n`POST /api/admin/orders/{id}/mark-unpaid` takes a recorded failure back.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","mark-payment-failed"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/mark-payment-failed","variable":[{"key":"id","value":""}]}}},{"name":"Take back a payment status recorded in error","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A correction, not a refund: it says the money never arrived and somebody marked the wrong order, so it leaves no refund behind. It moves the payment status and nothing else — a confirmed order awaiting payment is not a broken state, it is what every cash-on-delivery order already is, and un-confirming would put stock back on the shelf while the order is still live. An operator who wants the stock back cancels the order instead.\n\nRefused on a refunded order, where money really did move, and on a cancelled one.\n\nIt clears a recorded failure as well: an order whose payment is `failed` goes back to `pending` and loses its payment reference, silently — the failure was never announced, so its reversal announces nothing. On an already-pending order it does nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","mark-unpaid"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/mark-unpaid","variable":[{"key":"id","value":""}]}}},{"name":"List an order's notes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.read. Oldest first, internal and customer notes together.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","notes"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/notes","variable":[{"key":"id","value":""}]}}},{"name":"Write a note on an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs orders.write. `internal` notes are staff-only; `customer` notes are shown to the buyer with the order (behind the order's access token). Notes are never edited: delete and write again. Audited (`order.note_add`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","notes"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/notes","variable":[{"key":"id","value":""}]}}},{"name":"Remove a note from an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.write. The audit row (`order.note_delete`) keeps the text.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","notes",":noteId"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/notes/:noteId","variable":[{"key":"id","value":""},{"key":"noteId","value":""}]}}},{"name":"Say you have an order open (heartbeat)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs orders.read; asking for the edit claim needs orders.write. A soft lock: the panel sends this while the order is open (well within `ttl_seconds`), and the answer names everybody present and who is editing. At most one operator holds the edit claim; a second one stays a viewer and is told who has it, unless `take_over` is set (audited, `order.edit_takeover`). An expired claim never blocks. Nothing on the commerce path reads it: presence warns, it does not lock order writes. Needs a signed-in operator (the static token has no person).","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","presence"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/presence","variable":[{"key":"id","value":""}]}}},{"name":"Close an order (leave)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.read. Takes the caller off the order and lets go of their edit claim.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","presence"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/presence","variable":[{"key":"id","value":""}]}}},{"name":"Refund an order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Goes back through the provider that took the money. A method that cannot refund — cash on delivery, for one — reports that plainly rather than pretending. Omit the amount to send back everything that has not been refunded yet. An order may be refunded in parts; payment_status stays paid until they add up to the total, and refunded carries the running figure. This moves money only: goods coming back are recorded as a return, which is what puts them on the shelf. A refund at or above the store's second-approval threshold, asked by anyone but the owner, does not run: the answer is a 409 with code approval_required and the waiting approval in details.approval (ADR-0135).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","refund"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/refund","variable":[{"key":"id","value":""}]}}},{"name":"Settle a refund that was never heard back about","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The recovery path for a process that died between the gateway accepting a refund and the store recording it. The engine cannot know whether the money left; a person looking at the gateway can, and this is how they say so — rather than by writing SQL against the ledger. A refund younger than fifteen minutes may still be in flight and is refused.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","refunds",":refund_id","settle"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/refunds/:refund_id/settle","variable":[{"key":"id","value":""},{"key":"refund_id","value":""}]}}},{"name":"Request a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Starts the return lifecycle: a return in requested, holding its units against each line — two requests cannot claim the same unit, and the cap counts every return that still stands against what went out. No stock moves until the goods are received. shipping_refund_minor is the shipping refund policy for this return, decided by the operator: how much of the order's shipping to offer back, at most what the order charged less what other returns already offer. Announces return.requested. POST /api/admin/orders/{id}/returns records a return already in hand in one step.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","return-requests"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/return-requests","variable":[{"key":"id","value":""}]}}},{"name":"Record a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records goods coming back off a shipped, partly shipped or delivered order, and puts back on the shelf the lines marked to restock. It moves no money: refunding is POST /api/admin/orders/{id}/refund, a separate operation with its own right and its own record, and the two are recorded separately on purpose. Quantities are per line and cumulative across returns — more than is still owed is refused — and on a partly shipped order only what has actually gone out can come back. The order's status and payment_status are untouched, because the delivery still happened.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns","variable":[{"key":"id","value":""}]}}},{"name":"Withdraw a return recorded in error","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Takes back a return that should not have been recorded. The row survives with status withdrawn — how much is still returnable is counted from these rows, and a return whose row is gone is a stock movement nobody can account for — and the units it put back come off the shelf again. Withdrawing an already-withdrawn return is a silent no-op. It is refused when those units have since gone out again, because taking them off would push the count below what other orders have reserved.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Authorize a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"requested → authorized: the store agrees to take the goods back. Announces return.authorized. Asking again is a no-op.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","authorize"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/authorize","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Cancel a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"requested or authorized → cancelled, before anything arrived; the units are free again. A received return is withdrawn instead (DELETE on the return). Announces return.cancelled.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","cancel"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/cancel","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Close a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"received or inspected → closed: the store is done with it. Whether money went back is the refund's record, not a condition. Announces return.closed.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","close"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/close","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Record an inspection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"received → inspected, with an optional note on what was found. Announces return.inspected.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","inspect"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/inspect","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"A return label file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The return label the carrier issued, as an attachment.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","label"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/label","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Ask the carrier for a return label","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks the carrier that shipped the order for a return code or label; asking again answers with the one issued.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","label"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/label","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Receive a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"authorized → received: what arrived, per line — how many (at most what was requested; a line not named arrived with nothing, which frees what it held), whether they go back on sale, and on which shelf. Restocked units go back in the same transaction. Announces order.returned, the event goods coming back has always announced. Asking again is a no-op.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","receive"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/receive","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Refund a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends back what a received return is worth through the refund saga: the refund is reserved, the provider is asked outside every transaction — a gateway payment only out of what it captured — and the result settled with order.refunded. The amount is the return's proposed_refund unless a smaller amount_minor is named. Idempotent: a return has one live refund, so asking again answers with the first instead of sending the money twice; a refund the provider declined does not count. Needs orders.refund. With manual = true the refund is recorded as made outside the store (see POST /orders/{id}/manual-refund); the one live refund per return still applies. A refund at or above the store's second-approval threshold, asked by anyone but the owner, does not run: the answer is a 409 with code approval_required and the waiting approval in details.approval (ADR-0135).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","refund"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/refund","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"Reject a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"requested → rejected, with an optional note saying why; the units are free again. Announces return.rejected. Asking again is a no-op.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","returns",":returnId","reject"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/returns/:returnId/reject","variable":[{"key":"id","value":""},{"key":"returnId","value":""}]}}},{"name":"An order's risk score","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"0–100 with low/medium/high and the reasons, from the store's own orders: a first order far above the usual, the buyer's earlier cancelled or unpaid orders, several orders in a day, shipping and billing countries apart, a throwaway e-mail, digits in the name, failed payments, a large quantity on a first order. A hint, never a block. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","risk"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/risk","variable":[{"key":"id","value":""}]}}},{"name":"An order's money position","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the order comes to after credit and returns, what was paid and refunded, and the pending difference: what the customer owes (positive) or is owed (negative).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","summary"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/summary","variable":[{"key":"id","value":""}]}}},{"name":"Replace an order's tags and assignee","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 12 tags of 40 characters; an empty assignee is nobody. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","tags"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/tags","variable":[{"key":"id","value":""}]}}},{"name":"An order's history","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every state change writes its event and its audit record in the same transaction that caused it, so this is the order's history rather than a log kept beside it: what happened, in what order, who did it, and whether the notification it triggered actually went out. An act that announced something renders once, carrying both halves.\n\n`published_at` is set only once every subscribed handler accepted the event; `attempts` above one and `dead` say a consumer is failing, and `last_error` says why — that field is returned only to an operator carrying `store.operate`, and is absent otherwise. Entries with no actor are ones the trail did not record: everything that happened before it existed, and the engine's own sweeps before they were attributed.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","timeline"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/timeline","variable":[{"key":"id","value":""}]}}},{"name":"Take back a delivery recorded in error","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The order returns to shipped, and so do the fulfillments that were marked delivered with it. Nothing moved when the delivery was recorded — no stock, no money — so nothing moves back. Refused from any status but delivered.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","undeliver"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/undeliver","variable":[{"key":"id","value":""}]}}},{"name":"The payment block list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Cards, e-mails and IPs are kept as hashes; the label is what can be shown. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-block-list"],"raw":"{{baseUrl}}/api/v1/admin/payment-block-list"}}},{"name":"Add to the block list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A card as its first 6 and last 4 digits (435508|1234), an e-mail, an IP, a BIN or a country; or a fraud check's card, e-mail, IP or BIN (from_event). Audited as payment.block_list_change. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-block-list"],"raw":"{{baseUrl}}/api/v1/admin/payment-block-list"}}},{"name":"Remove from the block list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited as payment.block_list_change. Needs store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-block-list",":id"],"raw":"{{baseUrl}}/api/v1/admin/payment-block-list/:id","variable":[{"key":"id","value":""}]}}},{"name":"List the fraud rules' checks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each card payment the store's fraud rules checked, newest first; pending=1 lists the orders held for review. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-risk"],"raw":"{{baseUrl}}/api/v1/admin/payment-risk"}}},{"name":"Decide a held order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"approved lets the order ship; rejected keeps it held (cancel and refund it from the order). Audited as payment.risk_review. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-risk",":id","review"],"raw":"{{baseUrl}}/api/v1/admin/payment-risk/:id/review","variable":[{"key":"id","value":""}]}}},{"name":"List the routing decisions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every POS choice the card router made for a payment, newest first: the card read from its BIN, the candidates and why each was or was not eligible, the POS chosen and why, and the commission of the choice and of the store's first eligible POS (ADR-0140). Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-routing","decisions"],"raw":"{{baseUrl}}/api/v1/admin/payment-routing/decisions"}}},{"name":"The routing's savings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Per routed payment that kept money, the commission of the POS chosen against the store's first eligible POS, summed per currency: \"bu ay X TL tasarruf\". Estimates from the commissions typed in the routing. The default window is this month. Needs payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-routing","savings"],"raw":"{{baseUrl}}/api/v1/admin/payment-routing/savings"}}},{"name":"List the payment callbacks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Providers' callbacks as kept by the webhook queue (never their bodies). Without status: the failed and the dead ones. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-webhooks"],"raw":"{{baseUrl}}/api/v1/admin/payment-webhooks"}}},{"name":"Apply a failed callback again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies a failed or dead callback's events again now. Audited as payment.webhook_retry. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-webhooks",":id","retry"],"raw":"{{baseUrl}}/api/v1/admin/payment-webhooks/:id/retry","variable":[{"key":"id","value":""}]}}},{"name":"List the store's payments","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every payment across orders, newest first, with its POS, an estimated commission and why it needs a look. Needs payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payments"],"raw":"{{baseUrl}}/api/v1/admin/payments"}}},{"name":"What each POS took in a window","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Per POS and currency: payments, captured, refunded, net, estimated commission and after fees. Default: the last 30 days. Needs payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payments","summary"],"raw":"{{baseUrl}}/api/v1/admin/payments/summary"}}},{"name":"Record a sale at the shop's counter","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Placed through the same checkout as the storefront (prices, promotions, stock, tax), nothing charged for sending; recorded paid (cash or card) and handed over at once — or, with tender qr, left pending with its stock held for 30 minutes and its pay page in pay_url for the till's QR code, handed over once the customer's card has paid. The order's address is the shop's: its location's address, else the company address on the store profile. With no e-mail the walk-in customer gets an address under .invalid, which no message is sent to. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","pos","sales"],"raw":"{{baseUrl}}/api/v1/admin/pos/sales"}}},{"name":"The print queue","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Documents waiting to be printed (Yazdırılacaklar, ADR-0142): a shipment's labels and the carrier's papers (commercial invoice, …) and the order's e-invoice, oldest first; `status=printed` lists the printed ones, newest first. Each item's file is at `file_url`; an invoice is `ready` once the integrator has issued it. A print agent pulls the same list. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","print-queue"],"raw":"{{baseUrl}}/api/v1/admin/print-queue"}}},{"name":"Mark print queue items printed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Marks the named waiting items of the store printed (who and when are recorded); an id that is not one of them is passed over. Audited (store.print_queue_mark). Needs orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","print-queue","printed"],"raw":"{{baseUrl}}/api/v1/admin/print-queue/printed"}}},{"name":"A print queue item's file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The label, paper or invoice PDF, served as an attachment to staff only. An invoice not issued yet is a 409. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","print-queue",":id","file"],"raw":"{{baseUrl}}/api/v1/admin/print-queue/:id/file","variable":[{"key":"id","value":""}]}}},{"name":"List return reasons","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's return reasons, each heading before its sub-reasons. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","return-reasons"],"raw":"{{baseUrl}}/api/v1/admin/return-reasons"}}},{"name":"Create a return reason","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs orders.write. Audited as return_reason.create.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","return-reasons"],"raw":"{{baseUrl}}/api/v1/admin/return-reasons"}}},{"name":"Get a return reason","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","return-reasons",":id"],"raw":"{{baseUrl}}/api/v1/admin/return-reasons/:id","variable":[{"key":"id","value":""}]}}},{"name":"Update a return reason","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns that named it keep the label they had. Needs orders.write. Audited as return_reason.update.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","return-reasons",":id"],"raw":"{{baseUrl}}/api/v1/admin/return-reasons/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a return reason","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A reason with sub-reasons is refused (409) until they are deleted. Return lines that named it keep its label. Needs orders.write. Audited as return_reason.delete.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","return-reasons",":id"],"raw":"{{baseUrl}}/api/v1/admin/return-reasons/:id","variable":[{"key":"id","value":""}]}}},{"name":"Product reviews to moderate (Müşteriler › Değerlendirmeler)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. `status` pending, approved, rejected or all (absent: all); `product_id`; `q` matches the name, the address, the title, the text and the product. Right: review.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews"],"raw":"{{baseUrl}}/api/v1/admin/reviews"}}},{"name":"How many reviews wait, are published and were rejected","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: review.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews","counts"],"raw":"{{baseUrl}}/api/v1/admin/reviews/counts"}}},{"name":"One review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: review.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id","variable":[{"key":"id","value":""}]}}},{"name":"Approve, reject or put back a review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited (review.approved / review.rejected / review.pending). Publishing or withdrawing announces product.updated, so the product's cached pages and stars refresh. Right: review.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited. Right: review.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id","variable":[{"key":"id","value":""}]}}},{"name":"Show or hide one photo of a review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`approved` shows it with the published review, `rejected` hides it. Audited (review.photo_approved / review.photo_rejected). Right: review.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id","photos",":media_id"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id/photos/:media_id","variable":[{"key":"id","value":""},{"key":"media_id","value":""}]}}},{"name":"Remove one photo of a review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Takes it off the review and deletes the library file (unless the store has attached that file to a product). Audited (review.photo_removed). Right: review.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id","photos",":media_id"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id/photos/:media_id","variable":[{"key":"id","value":""},{"key":"media_id","value":""}]}}},{"name":"Reply to a review as the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Writes or rewrites the store's reply (1–2000 characters). Served with the review on store reads as {text, at}; the staff member's name stays in the panel. Audited (review.replied); announces product.updated when the review is published. Right: review.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id","reply"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id/reply","variable":[{"key":"id","value":""}]}}},{"name":"Remove the store's reply","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Audited (review.reply_removed); announces product.updated when the review is published. Right: review.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reviews",":id","reply"],"raw":"{{baseUrl}}/api/v1/admin/reviews/:id/reply","variable":[{"key":"id","value":""}]}}},{"name":"Read the automatic preparation settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's \"Otomatik hazırlama\" (ADR-0142), off by default: the carrier that books the parcels and its service, the parcel weight rule, whether the invoice is issued and the orders it covers. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","auto-preparation"],"raw":"{{baseUrl}}/api/v1/admin/settings/auto-preparation"}}},{"name":"Save the automatic preparation settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Switching it on needs `provider`: an installed carrier module that books parcels (never manual) and is set up (409 otherwise). From then on every paid order is looked at by a background job: when the hidden stock covers every line that ships, it is taken, the parcel is booked through the same path as create-fulfillment, the invoice is issued (when `issue_invoice` and an integrator is live) and the label, the carrier's papers and the invoice go to the print queue; otherwise nothing is taken and the order waits for the operator. Audited (store.auto_preparation_update). Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","auto-preparation"],"raw":"{{baseUrl}}/api/v1/admin/settings/auto-preparation"}}},{"name":"List shoppers' repeat orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Active and paused first by next date; at most 500. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","subscriptions"],"raw":"{{baseUrl}}/api/v1/admin/subscriptions"}}},{"name":"Change a shopper's repeat order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Pause, resume, cancel, skip the next or change the interval. Right: orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","subscriptions",":id"],"raw":"{{baseUrl}}/api/v1/admin/subscriptions/:id","variable":[{"key":"id","value":""}]}}}],"name":"admin:orders"},{"item":[{"name":"Send an unpaid order's payment link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends the order's own pay page (with its access token) to the shopper by e-mail or SMS, in the order's language. Only while the order waits for its payment. Audited as order.payment_link. Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","payment-link"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/payment-link","variable":[{"key":"id","value":""}]}}},{"name":"Read an order's payment panel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every payment with its POS, kind, receipt, end-of-day state, captured/refunded/refundable, the estimated commission and net, and every call made to the provider with who made it; the refunds waiting for a second approval and the channels a payment link can go on. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","payment-panel"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/payment-panel","variable":[{"key":"id","value":""}]}}},{"name":"List an order's payments","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every provider payment opened for the order, newest last.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","payments"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/payments","variable":[{"key":"id","value":""}]}}},{"name":"Price a refund by lines","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"What refunding these lines' units (and the shipping) comes to: each line net of its own promotions, plus its tax share where prices exclude it. Moves nothing. Needs orders.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","orders",":id","refund-quote"],"raw":"{{baseUrl}}/api/v1/admin/orders/:id/refund-quote","variable":[{"key":"id","value":""}]}}},{"name":"Capture an authorization","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes money an authorization holds: all that is left when the amount is omitted, or part of it when the provider can capture in parts. The order is paid once the captures cover its total.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payments",":id","capture"],"raw":"{{baseUrl}}/api/v1/admin/payments/:id/capture","variable":[{"key":"id","value":""}]}}},{"name":"Ask the provider about a payment","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queries the provider for the payment's state and applies the answer — the manual form of the reconciliation job.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payments",":id","reconcile"],"raw":"{{baseUrl}}/api/v1/admin/payments/:id/reconcile","variable":[{"key":"id","value":""}]}}},{"name":"Void an authorization, or give back a capture","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Lets an authorization with nothing captured go. The order stays unpaid and can then be cancelled. A gateway that voids only on the day of the payment (iyzico) refuses an authorization after that day with 409. A payment that has captured money is given back instead: the rest of what it captured is refunded through the refund saga, which voids rather than refunds while the gateway's same-day window is open (ADR-0023). A refund at or above the store's second-approval threshold, asked by anyone but the owner, does not run: the answer is a 409 with code approval_required and the waiting approval in details.approval (ADR-0135).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payments",":id","void"],"raw":"{{baseUrl}}/api/v1/admin/payments/:id/void","variable":[{"key":"id","value":""}]}}},{"name":"List the refunds waiting for a second approval","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs orders.refund.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","refund-approvals"],"raw":"{{baseUrl}}/api/v1/admin/refund-approvals"}}},{"name":"Approve a refund","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A second person with orders.refund — never the one who asked — approves; the refund then runs as them. Approving again answers with it. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","refund-approvals",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/refund-approvals/:id/approve","variable":[{"key":"id","value":""}]}}},{"name":"Reject a refund","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A second person with orders.refund — never the one who asked — rejects; nothing moves. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","refund-approvals",":id","reject"],"raw":"{{baseUrl}}/api/v1/admin/refund-approvals/:id/reject","variable":[{"key":"id","value":""}]}}},{"name":"Read the store's test mode","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether the store is in test mode (ADR-0137) and until when, who switched it on, how many test orders it has, and the payment methods its checkout offers while it is on (the test card, gateways in their test environment, offline methods) and the live ones it hides. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","test-mode"],"raw":"{{baseUrl}}/api/v1/admin/settings/test-mode"}}},{"name":"Switch the store's test mode on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"On for `hours` (1–24, two by default) — needs `confirm: true` (400 `test_mode_confirm` without it): while on, a shopper's checkout places a test order (orders.is_test), paid only with the built-in test card or a gateway in its test environment; every live POS is hidden and card routing is off. Test orders stay out of reports, are never invoiced, never booked with a carrier and send nothing to analytics or ad networks. Off at once with `on: false`; it also turns itself off when its time is up. Audited (payment_method.test_mode). Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","test-mode"],"raw":"{{baseUrl}}/api/v1/admin/settings/test-mode"}}},{"name":"Delete the store's test orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Deletes the context store's test orders for good (up to 500 a call), each in its own transaction: reserved stock is released, committed stock restocked, promotion uses and gift-card spending undone; an audit row (order.test_delete) remains. Never an order that is not a test order, never another store's. A test order with licence codes on it stays (`kept`). Needs orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","test-mode","delete-orders"],"raw":"{{baseUrl}}/api/v1/admin/settings/test-mode/delete-orders"}}}],"name":"admin:payments"},{"item":[{"name":"What the outbox has tried to deliver","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A page of `outbox_events`, newest first, behind `store.operate`. The three states partition the table: `published` is `published_at IS NOT NULL`, `dead` is `dead AND published_at IS NULL`, `pending` is the rest — so a row that raced into both flags is counted once, as published. Rows omit `payload`, because a page of order payloads is megabytes and the list is for finding the row rather than reading it; `last_error` is included, because it is what an operator scans the list for. An empty page is `\"data\": []` and never null.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","events"],"raw":"{{baseUrl}}/api/v1/admin/events"}}},{"name":"Un-park the dead letters","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requeues up to 500 dead letters per call, optionally narrowed to one event name — the same `UPDATE … SET dead = false, attempts = 0` an operator used to run in psql, run by the engine and logged with their name. `remaining` is counted inside the same transaction, so the pair cannot disagree and the panel can say \"Retried 500 of 3,214\" rather than a bare 500; a non-zero `remaining` means call it again. The claim takes `FOR UPDATE SKIP LOCKED`, so two operators clearing a backlog take disjoint sets and neither can stall the dispatcher. No request body is read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","events","retry-dead"],"raw":"{{baseUrl}}/api/v1/admin/events/retry-dead"}}},{"name":"One event, with its payload","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The row the list found, plus the `payload` the handlers were given. The payload is the event verbatim, so for an order it carries the buyer's email, phone and name and every line they bought — which is why `store.operate` is owner-only by default.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","events",":id"],"raw":"{{baseUrl}}/api/v1/admin/events/:id","variable":[{"key":"id","value":""}]}}},{"name":"Make one event deliverable again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Two repairs behind one verb, chosen by the row's state under the lock. A **dead** row is un-parked — `dead = false, attempts = 0, available_at = now()` — with a fresh twelve-attempt budget; nothing else can recover it, because the dispatcher's claim filters `NOT dead`. A **pending** row is only brought forward: `available_at = now()`, attempts untouched, because backoff reaches fifteen minutes but the twelve-attempt bound is the whole dead-letter policy and an operator must not be able to hold a broken event in retry forever. A **published** row is refused 409: redelivering a delivered event is a replay, and this engine has no verb for that. Neither act clears `last_error`. No request body is read. The dispatcher is nudged after the commit, so delivery normally follows within milliseconds.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","events",":id","retry"],"raw":"{{baseUrl}}/api/v1/admin/events/:id/retry","variable":[{"key":"id","value":""}]}}},{"name":"The store's background jobs","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A page of the tenant's `jobs`, newest first, behind `store.operate` (P1-11, ADR-0014). Rows omit `payload`: the list is for finding a job, the single read is for reading it. `last_error` is included, because it is what an operator scans the list for. `failed` is a valid filter but nothing writes it: a failure that will be retried is `queued` again and one that will not is `dead`. An empty page is `\"data\": []`.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","jobs"],"raw":"{{baseUrl}}/api/v1/admin/jobs"}}},{"name":"One job, with its payload redacted","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The row the list found, plus its `payload` with every secret-looking value replaced by `[redacted]`: any value whose key names a token, secret, password, key, credential, signature, session or the like, and any string that is a sealed secret (`enc:v1:`) or an Authorization value, at any depth. The stored payload is untouched; the handler still receives it.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","jobs",":id"],"raw":"{{baseUrl}}/api/v1/admin/jobs/:id","variable":[{"key":"id","value":""}]}}},{"name":"Stop a queued job before it runs","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only a `queued` job; a running one is a 409 (its handler is already doing the work). Race-safe with the worker's claim: whichever takes the row lock first wins, and a cancelled job is never claimed. Audited as `job.cancel`. No request body is read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","jobs",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/jobs/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Give a dead job one more run","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only a `dead` job: it is queued to run now with `max_attempts = attempts + 1`, so it runs exactly once more and, if its cause is not fixed, is dead again rather than retried on its backoff. Of two clicks racing, one wins and the other is a 409. `last_error` is kept until the next run. Audited as `job.retry`. No request body is read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","jobs",":id","retry"],"raw":"{{baseUrl}}/api/v1/admin/jobs/:id/retry","variable":[{"key":"id","value":""}]}}},{"name":"The recurring job types and this store's switches","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every recurring type this build registers, sorted by type, with whether it is on for the tenant and whether it may be switched off. A type the scheduler has not reached yet is on.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","recurring-jobs"],"raw":"{{baseUrl}}/api/v1/admin/recurring-jobs"}}},{"name":"Switch a recurring job type on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Switching off stops the scheduler enqueuing the type for this tenant; an instance already queued still runs unless cancelled, and work enqueued on request (a nudge) is not affected. A `required` type cannot be switched off (409): work that keeps money, stock, legal retention or the platform's bookkeeping correct. Audited as `recurring_job.disable` / `recurring_job.enable` when the switch changes.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","recurring-jobs",":type"],"raw":"{{baseUrl}}/api/v1/admin/recurring-jobs/:type","variable":[{"key":"type","value":""}]}}}],"name":"admin:platform"},{"item":[{"name":"The latest visits, or the live ones","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","analytics","sessions"],"raw":"{{baseUrl}}/api/v1/admin/analytics/sessions"}}},{"name":"One visit with its pages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","analytics","sessions",":id"],"raw":"{{baseUrl}}/api/v1/admin/analytics/sessions/:id","variable":[{"key":"id","value":""}]}}},{"name":"The store's own visits over a period","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","analytics","summary"],"raw":"{{baseUrl}}/api/v1/admin/analytics/summary"}}},{"name":"What needs the operator today","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One read for the admin's home screen (MERCHANT_ADMIN §1): counts of orders to ship, payments to check, refunds and returns in progress, failed invoices and deliveries, low stock, and today's orders. Needs orders.read; `low_stock` is null for an operator without inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","dashboard"],"raw":"{{baseUrl}}/api/v1/admin/dashboard"}}},{"name":"The measurement check (Ölçüm doğrulama)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's GA4 measurement id, Tag Manager container and tracking method, whether a Measurement Protocol API secret is set and whether the store is in test mode; and its last 20 orders with the purchase mark the storefront served on each confirmation and every refund or cancellation queued for, sent to or skipped by GA4 (ADR-0137). Ids, amounts and states only. Needs reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","measurement","check"],"raw":"{{baseUrl}}/api/v1/admin/measurement/check"}}},{"name":"Preview an order's purchase push","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the storefront pushes to the data layer for this order's purchase, in order: `{ecommerce: null}`, then `{event: \"purchase\", ecommerce: {...}}` — the order number as transaction_id, the total as value, tax, shipping (0 for an order with nothing to send), a discount code and the lines (SKU, title, variant, unit price, quantity). Never anything personal. Needs reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","measurement","orders",":id","purchase-preview"],"raw":"{{baseUrl}}/api/v1/admin/measurement/orders/:id/purchase-preview","variable":[{"key":"id","value":""}]}}},{"name":"The custom reports this store has saved","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom"}}},{"name":"Save a custom report","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires reports.write, which only owner carries by default: a report reads any table the engine can, so saving one decides what everyone with reports.read may look at. The SQL is checked here as well as at run time, because a report that cannot run is not worth keeping and now is when its author can fix it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom"}}},{"name":"Run a query without saving it","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires reports.write, because this is writing a report — it has just not been kept. Runs inside a read-only transaction with a 15-second statement timeout, always rolled back, so PostgreSQL refuses every write regardless of what the query says. A parse also rejects anything that is not a single SELECT or a read-only WITH — comments stripped first, so a verb cannot hide behind one — which exists so the operator reads \"a report may only read\" rather than a driver error.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom","run"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom/run"}}},{"name":"Change a saved report","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A partial update: only the keys present in the body change, and a key left out keeps its saved value; an empty description clears it. The path wins over any id in the body: a PATCH to /42 carrying id 7 is a typo, and guessing which was meant is how one report overwrites another.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom",":id"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a saved report","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A report holds no data of its own, so there is nothing to keep a record of.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom",":id"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom/:id","variable":[{"key":"id","value":""}]}}},{"name":"Run a saved report","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires reports.read rather than reports.write: the point of saving a report is that somebody else can run it, and its SQL was reviewed by whoever could write it. Runs inside a read-only transaction with a 15-second statement timeout, always rolled back, so PostgreSQL refuses every write regardless of what the query says. A parse also rejects anything that is not a single SELECT or a read-only WITH — comments stripped first, so a verb cannot hide behind one — which exists so the operator reads \"a report may only read\" rather than a driver error.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","custom",":id","run"],"raw":"{{baseUrl}}/api/v1/admin/reports/custom/:id/run","variable":[{"key":"id","value":""}]}}},{"name":"Customer value: cohorts, lifetime value, RFM","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Cohorts by first-order month with how many ordered in each later month (last 3–24 months, default 12); lifetime value, orders per customer and repeat rate; RFM groups (champions, loyal, promising, new, at_risk, hibernating, lost) by days since the last order and number of orders. Spend is paid orders less refunds in the base currency. Right: reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","customer-value"],"raw":"{{baseUrl}}/api/v1/admin/reports/customer-value"}}},{"name":"Ask for a one-shot download link to a report as CSV","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs reports.read (stock-value also inventory.read). `kind`: `sales` and `refunds` (params from, to, group_by, tz — as GET /reports/sales; a row per bucket and a total row per currency, amounts as decimals), `top-products` (from, to, tz, currency, by, sort — the whole ranking, at most 10 000 rows), `stock-value` (location_id), `custom-report` (id of a saved report; the report's 1000-row cap applies). The file starts with a UTF-8 byte-order mark for spreadsheet programs. Same link rules as POST /export-links. Audited (`export_link.create`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","export-links"],"raw":"{{baseUrl}}/api/v1/admin/reports/export-links"}}},{"name":"The conversion funnel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Of the store's visits in the last days (1–90, default 30): how many looked at a product, opened the basket, reached checkout and ordered, from the store's own visit analytics. Right: reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","funnel"],"raw":"{{baseUrl}}/api/v1/admin/reports/funnel"}}},{"name":"The home screen's statistics over a period","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One store over a period that ends now — today since midnight (`days=1`, hourly buckets) or the last N days with today included (daily buckets), in the store's time zone — beside the same span one period earlier (yesterday until this hour, the N days before), so a change never compares a partial day with a whole one. Sales are orders whose status is neither pending nor cancelled, per currency in integer minor units, never added across currencies; refunds are succeeded refunds by the day they went out; visits, pages, countries, devices and channels are the store's own cookieless visits; new customers are customer records created, members are accounts opened; best sellers are in the store's currency by units, with each product's lead picture; the most-viewed products are storefront product pages matched by slug. No ratio is computed: the client divides the counts it is given. Needs reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","overview"],"raw":"{{baseUrl}}/api/v1/admin/reports/overview"}}},{"name":"What each payment method took, and what went back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Per currency, per payment method: the paid sales it charged, what was refunded on exactly those orders, the net, and what it is still owed. A sale is an order whose stock has left the shelf, the same definition the sales report uses, so the two agree. This is the store's own ledger counted by the day the order was placed — not a settlement statement: the engine does not know when a gateway paid out, what it withheld in fees, or which orders it grouped into one transfer, so the difference from a bank statement is fees and settlement lag. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","payouts"],"raw":"{{baseUrl}}/api/v1/admin/reports/payouts"}}},{"name":"Sales totals per day, week or month","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A reading of the orders, added up in the database rather than in the client. A sale is an order whose stock has left the shelf — confirmed, partly shipped, shipped or delivered — so a cash-on-delivery order counts from the moment checkout confirms it, a partly shipped one counts in full, and an in-flight pending checkout that the unpaid sweeper may cancel does not. Pending and cancelled orders are reported beside the totals in `excluded`, never inside them. Payment does not decide whether a sale happened: it splits the same money into `paid`, `outstanding` (pending or failed) and `refunded`, which sum to `total` exactly. Money that has actually gone back is reported rather than netted off — `paid.refunded` for partial refunds, with `paid.net_collected` beside it. `net` is items less discount, and less tax when the prices contained it, so `total = net + tax + shipping` holds under either tax mode. Buckets are calendar day, ISO week (Monday) or month cut in `tz`, and the window's own edges are resolved in that same zone; the first and last bucket carry `partial` when the window clips them. Figures are grouped by the order's own currency and never summed across currencies.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","sales"],"raw":"{{baseUrl}}/api/v1/admin/reports/sales"}}},{"name":"What shoppers searched for","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The most searched terms of the last days (1–365, default 30) and the most searched that found nothing, from the storefront's results page. Right: reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","search-terms"],"raw":"{{baseUrl}}/api/v1/admin/reports/search-terms"}}},{"name":"Stock value","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"On-hand units of tracked variants (positive balances), valued at cost (variants with a recorded cost) and at their base-currency price, per location and in total. Needs reports.read and inventory.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","stock-value"],"raw":"{{baseUrl}}/api/v1/admin/reports/stock-value"}}},{"name":"Best sellers over a window","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The order lines of sales — confirmed, partly shipped, shipped or delivered orders — grouped by product or by variant, within one currency. Title, SKU and variant label are the newest snapshot the lines carry, so a renamed or deleted product still reports under a name somebody recognises; `product_id` is null once the product is gone, and two deleted products stay two rows. `revenue` is line value excluding tax under either tax mode, and BEFORE any order-level discount: a discount is recorded once per order and never allocated to lines, so summing these rows exceeds the sales report's `net` by exactly the discounts in the window.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","top-products"],"raw":"{{baseUrl}}/api/v1/admin/reports/top-products"}}},{"name":"Favorilere eklenme: favourites per product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"How many signed-in customers keep each product as a favourite, most first (guests' favourites stay in their browser and are not counted). `limit` 1–500, default 100. Right: reports.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","reports","wishlist"],"raw":"{{baseUrl}}/api/v1/admin/reports/wishlist"}}}],"name":"admin:reports"},{"item":[{"name":"The store's role/right matrix","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What each role may do here, what the engine ships for it, and the closed list of rights to draw from. Behind `roles.write` with the writes, because a map of the store's access is of use only to the people who may redraw it — an operator's own rights reach them on their record.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles"],"raw":"{{baseUrl}}/api/v1/admin/roles"}}},{"name":"Define a custom role","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A store's own role beside the engine's four: a key (2–40 lower-case letters, digits, '-' or '_'), a title, and rights drawn from the same catalogue, keeping the floor (catalog.read). It is resolved exactly like a system role for operators and API keys. Requires roles.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles"],"raw":"{{baseUrl}}/api/v1/admin/roles"}}},{"name":"Replace what a role may do","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The body is the whole set the role should carry, not a change to it. A set matching the engine's default is stored as no override at all, so the role goes back to tracking it. Refused: the owner role (403), a right this engine does not have (400), a set missing catalog.read (400), and removing roles.write from your own role (403) — which would lock you out of this endpoint with no way back short of a static admin token.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles",":role"],"raw":"{{baseUrl}}/api/v1/admin/roles/:role","variable":[{"key":"role","value":""}]}}},{"name":"Rename a role and describe it","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"What the store calls a role, which is separate from what the role may do. The role's key — `owner`, `manager`, `staff` — is an identifier written on every operator's record and cannot be changed; only the display title and the description can. All three roles are editable here, owner included: owner's *rights* are unstorable because a store that could narrow them could lock everybody out, and a name locks nobody out of anything. Both fields are optional: one left out (or null) keeps what the store saved, and a blank one puts that field back to the engine's own words — clearing both drops the override, so there is no separate reset. Answers with the role's whole row, rights included, because the screen that renamed it is showing both. Needs roles.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles",":role"],"raw":"{{baseUrl}}/api/v1/admin/roles/:role","variable":[{"key":"role","value":""}]}}},{"name":"Return a role to the engine's defaults","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes the store's override rather than writing the defaults down, so the role tracks them again from here on. Idempotent: a role that was never customised is already in this state. For a custom role (M8) there is no override to drop: the role itself is deleted (204), refused with 409 while a member, a live API key or an open invitation holds it.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles",":role"],"raw":"{{baseUrl}}/api/v1/admin/roles/:role","variable":[{"key":"role","value":""}]}}},{"name":"Require a second factor for a role","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Members holding the role must enroll a second factor before they can do anything but enroll it. Applies to every role, owner included. Requires roles.write; audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","roles",":role","mfa"],"raw":"{{baseUrl}}/api/v1/admin/roles/:role/mfa","variable":[{"key":"role","value":""}]}}}],"name":"admin:roles"},{"item":[{"name":"The account's standing","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The tenant's status (a suspension, a scheduled deletion), plan entitlements and usage, active platform announcements, resolved feature flags and its export archives. Any operator.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","account"],"raw":"{{baseUrl}}/api/v1/admin/account"}}},{"name":"Export the whole account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The owner's request for an archive of the account's catalogue, customers, orders and content, built by a job. Needs data.export and the owner role.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","account","exports"],"raw":"{{baseUrl}}/api/v1/admin/account/exports"}}},{"name":"Download an account export","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The gzip'd JSON archive, while it is ready (7 days). Needs data.export and the owner role.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","account","exports",":id"],"raw":"{{baseUrl}}/api/v1/admin/account/exports/:id","variable":[{"key":"id","value":""}]}}},{"name":"Whose Google key the address help uses","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Retired 2026-10-29 (owner): the Google address help is removed and this operation is no longer served (404). Kept here for the v1 contract only. The checkout's address help (ADR-0048) uses the store's own key (Vitrin eklentileri › Google adres önerisi) when it has one, else NeroCart's, counted per store and month against the platform's limit; past it the help is off until the month turns. `source` is store, platform or none. Right: plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","address-assist"],"raw":"{{baseUrl}}/api/v1/admin/address-assist"}}},{"name":"Check a Google Maps key with Google","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Retired 2026-10-29 (owner): the Google address help is removed and this operation is no longer served (404). Kept here for the v1 contract only. Asks Google once for a suggestion (Places API (New)) and once for a validation (Address Validation API) with the typed key, else the store's stored one, and names each outcome in a word. Saves nothing. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","address-assist","test"],"raw":"{{baseUrl}}/api/v1/admin/address-assist/test"}}},{"name":"The API keys this store has issued","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Revoked keys are listed too, after the active ones: the question asked after an incident is what had access and when it stopped, and a deleted row answers neither. Nothing here can be turned back into a credential — the secret is returned once, when the key is made, and is not stored.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys"],"raw":"{{baseUrl}}/api/v1/admin/api-keys"}}},{"name":"Mint an API key","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires apikeys.write, which only owner carries by default: a role that can mint a key can mint one carrying more rights than itself. A key may be bound to one store and narrowed by scopes. The secret comes back here, once: only its hash is stored, and a lost key is revoked and replaced. Revoking removes it from the credential index at once.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys"],"raw":"{{baseUrl}}/api/v1/admin/api-keys"}}},{"name":"Every key's last 24 hours","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Keyed by key id: the calls made and how many answered 4xx or 5xx.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys","requests","summary"],"raw":"{{baseUrl}}/api/v1/admin/api-keys/requests/summary"}}},{"name":"Revoke an API key","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Stops the key working and keeps its row, so there is still a record of what had access and when it stopped. Revoking one already revoked succeeds: the caller wanted it off, and it is off.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys",":id"],"raw":"{{baseUrl}}/api/v1/admin/api-keys/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a revoked API key","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Deletes a revoked or expired key's row for good; the audit log keeps that it existed, was revoked and was removed. An active key is refused (409): revoke it first.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys",":id","remove"],"raw":"{{baseUrl}}/api/v1/admin/api-keys/:id/remove","variable":[{"key":"id","value":""}]}}},{"name":"The calls an API key made","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, 30 days kept: method, v1 path (never the query), status, duration, caller address and request id. Paginated like every list.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys",":id","requests"],"raw":"{{baseUrl}}/api/v1/admin/api-keys/:id/requests","variable":[{"key":"id","value":""}]}}},{"name":"Read a key back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Since M8 a key is stored only as its hash, so its secret cannot be shown again: this answers 409 for a key that exists and 404 for one that does not. Kept so an older panel gets an explanation rather than a missing route.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","api-keys",":id","secret"],"raw":"{{baseUrl}}/api/v1/admin/api-keys/:id/secret","variable":[{"key":"id","value":""}]}}},{"name":"Apps listed for stores, and the ones this store let in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: apikeys.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","apps"],"raw":"{{baseUrl}}/api/v1/admin/apps"}}},{"name":"Remove an app","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Revokes the API key the app was given. Right: apikeys.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","apps","installs",":id"],"raw":"{{baseUrl}}/api/v1/admin/apps/installs/:id","variable":[{"key":"id","value":""}]}}},{"name":"The shopping assistant's settings and this month's counts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The switch (off by default), the greetings and the tone; whether the store's own AI key is set up (the assistant never runs on NeroCart's key); this month's conversations, answers and answers given without the AI. Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","assistant"],"raw":"{{baseUrl}}/api/v1/admin/assistant"}}},{"name":"Save the shopping assistant's settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The switch, the greetings per language and the tone. Switching on needs the store's own AI key (409 ai_not_configured otherwise). Audited (plugin.shopping_assistant_set). Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","assistant"],"raw":"{{baseUrl}}/api/v1/admin/assistant"}}},{"name":"Try the shopping assistant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The panel's \"Dene\": one question answered as a visitor would get it, with the store's tone, whether the assistant is on or not. Spends the store's AI budget; not counted. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","assistant","try"],"raw":"{{baseUrl}}/api/v1/admin/assistant/try"}}},{"name":"The store's company record","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The company record and document vault (ADR-0136): the company type, what was typed for it (prefilled from the store settings when there is no record yet), what is missing before it can be sent, gentle warnings (an IBAN holder that does not match the title, a number or title read off a document that differs from what was typed, a document about to expire), progress 0–100, the documents and who opened them lately, and every company type's template. `state` is none, incomplete, submitted, approved or rejected; `exempt` means the store sold before this release and the payments gate does not apply to it. Needs store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile"],"raw":"{{baseUrl}}/api/v1/admin/company-profile"}}},{"name":"Save the company record (a draft may be incomplete)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the type and the details as typed, sealed at rest. Never refuses a half-filled form: an invalid number is kept and reported in `missing`. Refused while the platform reviews the record (409, details.reason under_review); a change to an approved or rejected record makes it a draft again (the last approved record stays in force). 409 vault_unavailable when the server has no secrets key. Audited as company_profile.update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile"],"raw":"{{baseUrl}}/api/v1/admin/company-profile"}}},{"name":"Upload a company document","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"multipart/form-data with `kind` (one of the type's document kinds), optional `expires_on` (YYYY-MM-DD, for a document that has a validity date) and then `file`: a PDF, JPG or PNG up to 10 MB, checked by its bytes (a picture loses its metadata, a PDF with scripts or embedded files is refused; details.reason type, too_large, empty, damaged, pdf_active). Kept encrypted under a key of its own; read on this server in the background (OCR) and compared with what was typed. Refused while under review. Audited as kyc_document.upload. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile","documents"],"raw":"{{baseUrl}}/api/v1/admin/company-profile/documents"}}},{"name":"Change a document's validity date","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only before the document is approved (uploaded or rejected). Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile","documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/company-profile/documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a company document","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Refused while the platform reviews the record (409). Removing a document after a decision makes the record a draft again. Audited as kyc_document.delete. Needs store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile","documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/company-profile/documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Download one of the store's company documents","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The decrypted file as a private download (`Content-Disposition: attachment`, `Cache-Control: private, no-store`, nosniff, a sandboxing CSP); the read is written to the document log. Never a public address. Needs store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile","documents",":id","file"],"raw":"{{baseUrl}}/api/v1/admin/company-profile/documents/:id/file","variable":[{"key":"id","value":""}]}}},{"name":"Send the company record for review","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends a complete record to the platform: status submitted, the documents not yet read become checking. 400 details.reason incomplete with details.missing when something is missing. Idempotent while submitted. Audited as company_profile.submit. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","company-profile","submit"],"raw":"{{baseUrl}}/api/v1/admin/company-profile/submit"}}},{"name":"Duties-inclusive pricing (DDP)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Pazarlar › Gümrük dahil fiyat (DDP): each market's duties mode, the DAP note, the preferential-origin switch, where parcels leave from, the default duty and the duty rules by HS / GTİP prefix, with the embedded EU standard VAT table (read-only). Off for a store that never saved it. Right: taxes.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cross-border"],"raw":"{{baseUrl}}/api/v1/admin/cross-border"}}},{"name":"Replace the duties-inclusive pricing settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces everything the GET returns except the read-only fields (effective_origin, eu_vat_rates). A market code the store does not have, a mode other than ddp / dap / off, an HS prefix outside 2–12 digits, a rate outside 0–10000 basis points or a prefix listed twice is a 400. Audited as cross_border.update. Right: taxes.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cross-border"],"raw":"{{baseUrl}}/api/v1/admin/cross-border"}}},{"name":"The landed-cost calculator","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The duties and import VAT one product would cost sent to a country, in the store's base currency, the price taken as net (without VAT): the same estimate the checkout charges in a DDP market (ADR-0123), with each assumption named. `settings` previews the form before it is saved. Writes nothing. A variant the store does not have is a 404. Right: taxes.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","cross-border","preview"],"raw":"{{baseUrl}}/api/v1/admin/cross-border/preview"}}},{"name":"Set the www/apex policy","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"none, www_to_apex or apex_to_www; enforced at the edge. Needs store.write. Audited (`domain.redirect`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domain-redirect"],"raw":"{{baseUrl}}/api/v1/admin/domain-redirect"}}},{"name":"List the store's domains","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Hosts routed (active) or waiting for verification (pending) to the store, primary first, with the DNS records to create. `target` is the host custom domains point at (empty when the platform has not configured one). Needs store.write. With an edge configured (W8) a verified host goes on through dns_pending and ssl_pending to active; `edge` names it, `steps` are its instructions per host not yet active, `redirect` is the store's www/apex policy. With the route53 edge and the Cloudflare for SaaS layer on (ADR-0106) a domain passes cf_pending (still routing) after ssl_pending, and its www host appears beside it (provider cloudflare_saas).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains"],"raw":"{{baseUrl}}/api/v1/admin/domains"}}},{"name":"Add a domain","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds a host as pending with a verification token; it routes nothing until POST /domains/{host}/verify finds the TXT record. A host already connected to any store is refused without naming the store. Needs store.write. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains"],"raw":"{{baseUrl}}/api/v1/admin/domains"}}},{"name":"Remove a domain","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Stops routing the host to the store. The primary domain cannot be removed. Needs store.write. Audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host","variable":[{"key":"host","value":""}]}}},{"name":"Check a domain again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Takes the host as far along its lifecycle as it goes now: ownership, DNS, certificate (with an edge configured). Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","check"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/check","variable":[{"key":"host","value":""}]}}},{"name":"Apply a mail-provider setup","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Computes the diff again against the zone as it is now and writes it: adds and replaces first, removals last (the domain always has an MX host). Idempotent: a second call writes nothing (`pending` 0). Audited as domain.mail_setup. Writes only the apex MX and TXT, _dmarc, \u003cselector\u003e._domainkey and autodiscover. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","mail-setup"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/mail-setup","variable":[{"key":"host","value":""}]}}},{"name":"Live check of a domain's mail records","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Looks the domain's MX, SPF, DKIM (the selectors in its zone, or the provider's usual ones) and DMARC up in public DNS, as a mail server sees them; each is ok, warn, missing, error or unchecked. Needs store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","mail-setup","check"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/mail-setup/check","variable":[{"key":"host","value":""}]}}},{"name":"Preview a mail-provider setup","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The diff the setup would write in the domain's DNS zone, nothing written: each record to add, replace (with the value it replaces), remove (other MX hosts, SPF records folded into the one) or keep. The SPF include is merged into the one v=spf1 record; a starter DMARC (p=none) only where none exists. 400 for a pasted value of the wrong shape; 404 for a host that is not the store's; 409 when the domain is not on NeroCart's nameservers. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","mail-setup","preview"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/mail-setup/preview","variable":[{"key":"host","value":""}]}}},{"name":"Make a domain primary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The storefront's canonical host. Only an active host can be primary. Needs store.write. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","primary"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/primary","variable":[{"key":"host","value":""}]}}},{"name":"Verify a domain","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Looks up the TXT record _cos-verify.\u003chost\u003e and activates the host when it carries the token. A lookup failure is reported in `error`, not as an HTTP error. Needs store.write. Audited when it activates.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","domains",":host","verify"],"raw":"{{baseUrl}}/api/v1/admin/domains/:host/verify","variable":[{"key":"host","value":""}]}}},{"name":"The store's gift shipping settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether gift orders are offered on the order page, and whether automatic invoicing leaves them out. Right: orders.read (the order page reads it too).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-shipping"],"raw":"{{baseUrl}}/api/v1/admin/gift-shipping"}}},{"name":"Save the gift shipping settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","gift-shipping"],"raw":"{{baseUrl}}/api/v1/admin/gift-shipping"}}},{"name":"The launch checklist","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the store still needs before it can sell (MERCHANT_ADMIN, constitution §12B onboarding): store details, a tax rate, a shipping zone with a rate, a payment method switched on, the legal texts published, a listed product, a routed domain, email sending; İYS and SMS as optional. Each item is computed from the store's own state and names the admin screen that fixes it. Reads only. Needs store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","launch-checklist"],"raw":"{{baseUrl}}/api/v1/admin/launch-checklist"}}},{"name":"Hide or show the launch checklist","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Puts the launch checklist away on the store's home screen, or shows it again (owner 2026-10-26). Only this is written; the checklist is still computed. Returns the checklist. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","launch-checklist"],"raw":"{{baseUrl}}/api/v1/admin/launch-checklist"}}},{"name":"Ready mail-provider setups","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Alan adları › E-posta (MX) kurulumu (ADR-0118): the catalogue of mailbox providers (Google Workspace, Microsoft 365, Yandex 360, Zoho Mail EU and global, Other) with their documented MX set, SPF include, verification shape, DKIM selectors and signup/admin links, and the store's own domains (`managed`: on NeroCart's nameservers, so the setup can write it). Needs store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","mail-setup"],"raw":"{{baseUrl}}/api/v1/admin/mail-setup"}}},{"name":"List the store's markets","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Where the store sells (M3, ADR-0004): countries, currency and languages, the default first. Needs catalog.read, because the product editor prices a variant per market currency.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","markets"],"raw":"{{baseUrl}}/api/v1/admin/markets"}}},{"name":"Add a market","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs store.write. Country codes are upper-cased and de-duplicated, language tags lower-cased. The store's first market is its default whatever the input says; `is_default` on a later one moves the flag. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","markets"],"raw":"{{baseUrl}}/api/v1/admin/markets"}}},{"name":"Read a market","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs catalog.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","markets",":id"],"raw":"{{baseUrl}}/api/v1/admin/markets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a market","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs store.write. An absent field is kept. Setting `is_default` true moves the flag from the old default; setting it false on the default is a 409 — make another market the default instead. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","markets",":id"],"raw":"{{baseUrl}}/api/v1/admin/markets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a market","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs store.write. The default market cannot be removed (409). Orders placed in the market keep their snapshot. Audited.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","markets",":id"],"raw":"{{baseUrl}}/api/v1/admin/markets/:id","variable":[{"key":"id","value":""}]}}},{"name":"Control-plane links for the signed-in person","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"google_cloud is true only when the signed-in merchant user is also an active platform staff member with a second factor whose roles read the Google Cloud page. It decides whether the admin shows a link; the control plane asks for its own sign-in and checks its own rights on every route. Always false for an API key, the static token or a vendor. Any operator.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","me","platform-access"],"raw":"{{baseUrl}}/api/v1/admin/me/platform-access"}}},{"name":"The store's NeroPay card and balances","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"NeroPay (ADR-0138) as the store sees it: documents_missing, reviewing or active (from the company record, ADR-0136, and the store's sub-merchant record at the institution NeroPay runs on); whether NeroCart has an institution switched on; checkout_ready (an institution on, the payments gate passed and the store an active sub-merchant — the checkout offers NeroPay only from Faz 5b); the rate that applies; the store's own balances per currency by settlement state (Hakediş) and its latest journals, its own entries only. Needs payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","neropay"],"raw":"{{baseUrl}}/api/v1/admin/neropay"}}},{"name":"The order emails, to the store and to the customer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every order email with how the store has it: the messages to the store (a new order, a cancelled order, a card payment that failed — never sent to the shopper) with their recipients, and the messages to the customer. With nothing set each is on, and a message to the store goes to the store profile's email (else the contract archive address, else the published theme's contact address). The wording of each is under /api/admin/notifications/templates. Needs notifications.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","order-emails"],"raw":"{{baseUrl}}/api/v1/admin/notifications/order-emails"}}},{"name":"Switch an order email on or off, address a message to the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`enabled` switches the message on or off; `recipients` (a message to the store only) replaces its list of the store's addresses — at most 10; an entry may hold several separated by commas — and an empty list returns it to the default. An absent field stays. Audited as notification_template.update (key order_email/{event}). Needs notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","order-emails",":event"],"raw":"{{baseUrl}}/api/v1/admin/notifications/order-emails/:event","variable":[{"key":"event","value":""}]}}},{"name":"The wording of what the store sends","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every message the store can send — the engine's order events and the ones modules add — with its effective subject and body: the operator's wording where one is stored, the default otherwise. Needs notifications.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","templates"],"raw":"{{baseUrl}}/api/v1/admin/notifications/templates"}}},{"name":"Reword one message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the operator's subject and body for one message. Both are Go text/template over the event's data and are parsed before they are stored, so a typo is refused here rather than on the next sale. Needs notifications.write; audited as notification_template.update.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","templates",":channel",":event"],"raw":"{{baseUrl}}/api/v1/admin/notifications/templates/:channel/:event","variable":[{"key":"channel","value":""},{"key":"event","value":""}]}}},{"name":"Restore a message's default wording","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Drops the operator's wording; the default in code stands again. Needs notifications.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","templates",":channel",":event"],"raw":"{{baseUrl}}/api/v1/admin/notifications/templates/:channel/:event","variable":[{"key":"channel","value":""},{"key":"event","value":""}]}}},{"name":"Preview a notification template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Renders a draft (subject/body; empty body means the effective wording) with sample data for the event's variables, merged with `data`. With `locale` (tr, en, de) it renders that language's effective wording and formats amounts as that language writes them; empty is the every-language wording. Needs notifications.read.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","templates",":channel",":event","preview"],"raw":"{{baseUrl}}/api/v1/admin/notifications/templates/:channel/:event/preview","variable":[{"key":"channel","value":""},{"key":"event","value":""}]}}},{"name":"Send a test notification","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends the effective wording filled with sample data (and data.test = \"true\") to one address through the store's backends; the attempt is in the delivery log and is returned. With `locale` it sends that language's wording; empty is the store's message language. Needs notifications.write. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","templates",":channel",":event","test"],"raw":"{{baseUrl}}/api/v1/admin/notifications/templates/:channel/:event/test","variable":[{"key":"channel","value":""},{"key":"event","value":""}]}}},{"name":"This month's sending against the limits","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the tenant sent this calendar month (UTC), per channel, against its sending limits (NOTIFICATIONS §10): a monthly quota, a hard ceiling for transactional messages (a percentage of the quota) and a per-minute burst cap. The limits are the platform's defaults (kernel configuration) unless the platform set the tenant's own; no tenant route changes them. Marketing messages stop at the quota; order and shipping messages go on to the ceiling and the store's contact address is emailed once when the quota is passed and once at the ceiling; an operator's password reset, an invitation and the alert itself are never stopped and not counted. A message over the burst cap waits for the next minute. `sent` counts messages a provider accepted, `over_quota` those among them sent past the quota, `blocked` those not sent because of a limit. Needs notifications.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","notifications","usage"],"raw":"{{baseUrl}}/api/v1/admin/notifications/usage"}}},{"name":"What an app asks for (the consent page)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Checks the app's client id, return address and requested rights (space-separated; empty: all it registered). Right: apikeys.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","oauth","authorize"],"raw":"{{baseUrl}}/api/v1/admin/oauth/authorize"}}},{"name":"Approve an app","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes a one-time code (ten minutes; PKCE S256 when the app sent a challenge) and answers the address to send the owner back to with it. Right: apikeys.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","oauth","authorize"],"raw":"{{baseUrl}}/api/v1/admin/oauth/authorize"}}},{"name":"The order minimum per currency","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The smallest basket the store takes, per market currency; none listed: no minimum. Right: store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-minimums"],"raw":"{{baseUrl}}/api/v1/admin/order-minimums"}}},{"name":"Set the order minimums","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces them; an empty list removes the minimum. The cart answers minimum_order and below_minimum; the checkout refuses a basket below it with 409 and BelowMinimum details (an operator's order is not held to it). Audited (store.order_minimum). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","order-minimums"],"raw":"{{baseUrl}}/api/v1/admin/order-minimums"}}},{"name":"The store's requests to the platform","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, with the platform's status and reply. An operator with store.write (and the static token) sees the store's requests; anyone else sees their own. No screenshot here (`has_image`); GET one request for it.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","owner-requests"],"raw":"{{baseUrl}}/api/v1/admin/owner-requests"}}},{"name":"Send a suggestion or request to the platform","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The panel's \"Öneri gönder\" button: any operator (no right needed) writes what they would like in their own words, and the panel adds the page they were on. Plain text only: control characters are removed and nothing is parsed; `body` 1–5000 characters, `page_path` a panel path (≤ 500), `page_title` one line (≤ 200), `priority` normal (default) or urgent. `image` is an optional screenshot as a data: URL (PNG, JPEG or WebP by its bytes, at most 2 MB). The platform is emailed in the background. Each operator may send 30 an hour: 429 `rate_limited` with Retry-After. Audited as owner_request.create.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","owner-requests"],"raw":"{{baseUrl}}/api/v1/admin/owner-requests"}}},{"name":"One request to the platform","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"With its screenshot as a data: URL. In the same scope as the list: another operator's request is 404 unless the caller has store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","owner-requests",":id"],"raw":"{{baseUrl}}/api/v1/admin/owner-requests/:id","variable":[{"key":"id","value":""}]}}},{"name":"List the store's BIN rows","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's own BIN rows (imported over the kernel's built-in table), how many rows the built-in table has, and the card programmes. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-card-bins"],"raw":"{{baseUrl}}/api/v1/admin/payment-card-bins"}}},{"name":"Import BIN rows","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds or replaces BIN rows: rows, or CSV text (prefix, bank, family, scheme, type, country). Every row is checked before anything is written. Audited as payment.card_bins_import. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-card-bins","import"],"raw":"{{baseUrl}}/api/v1/admin/payment-card-bins/import"}}},{"name":"Read a BIN","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the store's rows, then the built-in table, say about a card's first 6–8 digits. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-card-bins","lookup"],"raw":"{{baseUrl}}/api/v1/admin/payment-card-bins/lookup"}}},{"name":"Remove a BIN row","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes one of the store's rows. Needs store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-card-bins",":prefix"],"raw":"{{baseUrl}}/api/v1/admin/payment-card-bins/:prefix","variable":[{"key":"prefix","value":""}]}}},{"name":"Read the decline dictionary","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The active gateways' known decline codes with the store's words over them, the store's own entries, and the codes nobody has words for yet. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-declines"],"raw":"{{baseUrl}}/api/v1/admin/payment-declines"}}},{"name":"Suggest a shopper's sentence in other languages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Translates one sentence with the store's machine translator, as a suggestion to review. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-declines","translate"],"raw":"{{baseUrl}}/api/v1/admin/payment-declines/translate"}}},{"name":"Give a decline code words","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The category, a note for the team and the shopper's sentence per store language; the code leaves the unmapped list. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-declines",":provider",":code"],"raw":"{{baseUrl}}/api/v1/admin/payment-declines/:provider/:code","variable":[{"key":"provider","value":""},{"key":"code","value":""}]}}},{"name":"Drop the store's words for a decline code","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The built-in words apply again. Needs store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-declines",":provider",":code"],"raw":"{{baseUrl}}/api/v1/admin/payment-declines/:provider/:code","variable":[{"key":"provider","value":""},{"key":"code","value":""}]}}},{"name":"The POS health board","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every set-up POS: resting or not and why, its last error, and its calls, success rate, technical error rate and response time over the rules' window, the last hour and the last day. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-health"],"raw":"{{baseUrl}}/api/v1/admin/payment-health"}}},{"name":"Bring a resting POS back","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Ends a POS's rest by hand. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-health",":provider","resume"],"raw":"{{baseUrl}}/api/v1/admin/payment-health/:provider/resume","variable":[{"key":"provider","value":""}]}}},{"name":"The store's bank transfer settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether bank transfer (havale/EFT) is offered, the accounts a shopper may pay into, the due period and the payment reference format (W24, ADR-0036). Defaults when the store never saved any. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","bank-transfer"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/bank-transfer"}}},{"name":"Replace the store's bank transfer settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Every account is checked: a Turkish IBAN with valid check digits, a bank name, the account holder (alıcı unvanı) and a currency; the same IBAN may not appear twice. Switching bank transfer on needs at least one account. `due_hours` (1–720, default 72) is how long an order waits for its money before the unpaid sweep cancels it and releases its stock; `reference_format` contains `{order_number}` once. Audited as payment_method.update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","bank-transfer"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/bank-transfer"}}},{"name":"The store's cash on delivery switch","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether the store offers cash on delivery. On when the store never saved a choice. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","cod"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/cod"}}},{"name":"Switch the store's cash on delivery on or off","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Off: the checkout no longer offers it and refuses a checkout that names it; an order placed by hand without a method then uses the first method the store offers. The last payment method that is on cannot be switched off (400). Audited as payment_method.update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","cod"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/cod"}}},{"name":"The order the store offers its payment methods in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every installed method in the order the checkout offers them: the store's saved order first, the rest in the default (alphabetical) order. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","order"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/order"}}},{"name":"Set the order the store offers its payment methods in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The full priority list of method codes. The checkout lists methods in this order and preselects the first ready one; installed methods left out follow in the default order. An unknown or repeated code is refused (400). Audited as payment_method.update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-methods","order"],"raw":"{{baseUrl}}/api/v1/admin/payment-methods/order"}}},{"name":"Read the fraud and health rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's fraud rules and POS health rules; both off until switched on. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-orchestration"],"raw":"{{baseUrl}}/api/v1/admin/payment-orchestration"}}},{"name":"Save the fraud and health rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Audited as payment.orchestration_update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-orchestration"],"raw":"{{baseUrl}}/api/v1/admin/payment-orchestration"}}},{"name":"Read the payment routing","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Several card POS behind one card choice: the rules, the POS in order with their bank and commissions, the POS it may use with their health. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-routing"],"raw":"{{baseUrl}}/api/v1/admin/payment-routing"}}},{"name":"Save the payment routing","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only set-up POS whose card form posts to the bank; at least two when on; a commission is 0–5000 basis points for a count 1–36. Audited as store_settings.update. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","payment-routing"],"raw":"{{baseUrl}}/api/v1/admin/payment-routing"}}},{"name":"Whether the caller may open platform management","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Platform management inside the admin (ADR-0093, amended 2026-10-12: no step-up code). In the platform operator's admin, for a person's own session: `available` for the owner (every permission; their platform account is made on first use) or a member a platform super admin gave platform roles in Yetkililer; `permissions` draw the menu. The admin session itself then reaches /api/v1/platform. Every other store, an API key, the static token or a vendor: `available: false`, never an error.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","platform","access"],"raw":"{{baseUrl}}/api/v1/admin/platform/access"}}},{"name":"List plugins","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every plugin this binary can run — core's storefront features and the ones modules registered — with its state. Secrets are masked. Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","plugins"],"raw":"{{baseUrl}}/api/v1/admin/plugins"}}},{"name":"Read one plugin","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","plugins",":key"],"raw":"{{baseUrl}}/api/v1/admin/plugins/:key","variable":[{"key":"key","value":""}]}}},{"name":"Switch a plugin, or change its settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Settings are merged over what is stored and validated against the plugin's fields: an unknown field, a select outside its options or a URL that is not absolute is a 400 naming the field. A secret sent as its mask is kept. Audited as plugin.update.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","plugins",":key"],"raw":"{{baseUrl}}/api/v1/admin/plugins/:key","variable":[{"key":"key","value":""}]}}},{"name":"The review request: settings and the last days' counts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Whether the store asks its customers for a review after delivery, after how many days, the optional thank-you code and the discount it copies, whether an e-mail sender is set up; and the requests of the last `days` days (default 30): waiting, sent, reviewed, skipped. The wording, preview and test send are the notification templates' (email, event review.request). Needs notifications.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","review-requests"],"raw":"{{baseUrl}}/api/v1/admin/review-requests"}}},{"name":"Save the review request settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Switches the review request on or off (off until the store turns it on), the days after delivery (1–60; without a reported delivery the shipment plus three more days counts), and the thank-you: `reward_enabled` with `reward_discount_id`, one of the store's discounts that each single-use code copies, usable for `reward_days` (1–365). Audited as notification_template.update (key review_request). Needs notifications.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","review-requests"],"raw":"{{baseUrl}}/api/v1/admin/review-requests"}}},{"name":"A sales area's checklist","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The area's health checklist from the store's own data (ADR-0143): domestic — base_currency, domestic_payment, domestic_carrier, e_invoice, company; international — export_company (the legal name and tax number: the ETGB's sender and V.D. number), foreign_markets, exchange_rates, foreign_payment, foreign_carrier, hs_codes (products on sale that ship without a GTİP on a variant or their invoice item), export_invoice, export_defaults, etgb_mail, atr_mail, duties. Each line is ok, todo or info, with the count it states. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","sales-areas",":area"],"raw":"{{baseUrl}}/api/v1/admin/sales-areas/:area","variable":[{"key":"area","value":""}]}}},{"name":"What this store is configured as","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Read-only: everything here is a decision the binary was started with, and changing the settlement currency mid-flight would change what every order in flight means. No right is required — every screen has to format money before it can draw anything, so an operator who could not read this would read prices in the wrong currency and the wrong number of decimals. Nothing may be added to this payload that is not \"what this store is configured as\": diagnostics and secrets belong on a route with a right. `notifier_channels` is the one entry here that can be bad news — a channel with no delivery backend sends nothing and reports success — and it belongs anyway, because what it reports is which backends the binary was composed with.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings"],"raw":"{{baseUrl}}/api/v1/admin/settings"}}},{"name":"Change the store settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The settings a merchant decides for the store: languages, default language, order prefix, whether prices include tax, flat shipping and how shipping is taxed. An absent field is kept. The base currency is not changeable here — every order in flight is denominated in it. Needs store.write. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings"],"raw":"{{baseUrl}}/api/v1/admin/settings"}}},{"name":"Read the second-approval threshold","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The amount per currency from which a refund asked by anyone but the owner waits for a second person. Off by default. Needs orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","refund-approval"],"raw":"{{baseUrl}}/api/v1/admin/settings/refund-approval"}}},{"name":"Set the second-approval threshold","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the thresholds; zero or a missing currency is off. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","settings","refund-approval"],"raw":"{{baseUrl}}/api/v1/admin/settings/refund-approval"}}},{"name":"The store's site verification page","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Site doğrulama: every provider (search engines, social and ad platforms, trust and payment) with the token the storefront publishes for it now (`token`, \"\" when none; Google's, Bing's and Yandex's while their plugin is on), the provider's page where the code is made (`url`), and the stored verification files (without bodies). Right: plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","site-verification"],"raw":"{{baseUrl}}/api/v1/admin/site-verification"}}},{"name":"Store a verification file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores or replaces the file served at the domain's root under `name` (one of the providers' shapes; 400 otherwise). The body is text up to 16 KB (Apple Pay's file 32 KB); an HTML body is kept without script, frames, objects, links, forms, event handlers, javascript:/data: addresses, comments and meta refreshes; an XML body must be well formed, with no DOCTYPE. Content type from the extension. Audited (site_verification.file_set). Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","site-verification","files",":name"],"raw":"{{baseUrl}}/api/v1/admin/site-verification/files/:name","variable":[{"key":"name","value":""}]}}},{"name":"Remove a verification file","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The storefront answers its address with 404 from now on. 404 when the file was not set. Audited (site_verification.file_delete). Right: plugins.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","site-verification","files",":name"],"raw":"{{baseUrl}}/api/v1/admin/site-verification/files/:name","variable":[{"key":"name","value":""}]}}},{"name":"Set a provider's verification code","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`value` is the bare code, the whole \u003cmeta\u003e tag the provider shows (content=\"…\" is read; a tag of another provider is refused), the name=code form, or for ETBİS the registry link (…/sitedogrulama/{code}) or badge. Checked against the provider's shape (400 otherwise). Google's, Bing's and Yandex's code goes to their plugin, which is switched on (audited as plugin.update); the others are audited as site_verification.tag_set. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","site-verification","tags",":provider"],"raw":"{{baseUrl}}/api/v1/admin/site-verification/tags/:provider","variable":[{"key":"provider","value":""}]}}},{"name":"Remove a provider's verification code","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The storefront stops publishing it. A plugin-held code is cleared in its plugin, which is otherwise left as it was. Audited (site_verification.tag_delete or plugin.update). Right: plugins.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","site-verification","tags",":provider"],"raw":"{{baseUrl}}/api/v1/admin/site-verification/tags/:provider","variable":[{"key":"provider","value":""}]}}},{"name":"The social media feeds' state","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Entegrasyonlar › Sosyal medya: every platform's feed — switched on, set up, the account it shows, how many posts it holds, the last sync and its error, and (Instagram) when the token expires. Right: plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds"}}},{"name":"Choose the Facebook Page to show","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"After a Facebook login that reached more than one Page (social_result=choose_page; the Pages are SocialFeedStatus.pages): connects the chosen one — its token sealed, the feed on. A Page the login did not reach is refused. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds","facebook","page"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds/facebook/page"}}},{"name":"Start a one-click social feed connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Instagram ile bağlan\" / \"Facebook ile bağlan\" / \"TikTok ile bağlan\": answers the provider's consent page through the platform's own app (one app per provider for every store). The state on it is signed (HMAC) and single-use for ten minutes, and names this store and return_url — an admin page (/admin/…) on one of this store's own hosts; any other is refused. The provider returns to the one platform redirect URI (redirect_uri), which stores the token sealed, switches the feed on and sends the browser back to return_url with ?social=\u003cplatform\u003e\u0026social_result=connected|choose_page|cancelled|not_professional|no_pages|not_configured|failed. 409 NOT_CONFIGURED: the platform administrator has not added the provider's app; 422 NO_CONNECT: X, LinkedIn (addresses), YouTube (channel) and Pinterest (username) have no login. Limited to a few attempts a minute per store. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds",":platform","connect"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds/:platform/connect","variable":[{"key":"platform","value":""}]}}},{"name":"Disconnect a social feed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bağlantıyı kes\": asks the provider to revoke the grant where it offers a way (Facebook, TikTok; Instagram has none), removes the tokens, switches the feed off and deletes its stored posts and their pictures. Answers the feed's state. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds",":platform","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds/:platform/disconnect","variable":[{"key":"platform","value":""}]}}},{"name":"Sync a social media feed now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Şimdi eşitle\": fetches the platform's posts now, copies new pictures into the media library and replaces the stored feed — what the social_feeds.sync job does every three hours. A platform's refusal is the result's error (and the feed's last error); the stored posts stay. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds",":platform","sync"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds/:platform/sync","variable":[{"key":"platform","value":""}]}}},{"name":"Test a social media feed's connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"\"Bağlantıyı test et\": calls the platform with the saved settings (whether or not the feed is switched on) and answers the account reached and how many posts it would show, or the platform's refusal. Stores nothing. Right: plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","social-feeds",":platform","test"],"raw":"{{baseUrl}}/api/v1/admin/social-feeds/:platform/test","variable":[{"key":"platform","value":""}]}}},{"name":"The store's own name, address and contact details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the shop calls itself on the documents a buyer keeps: an invoice, a packing slip, the foot of an email. Carries no right, for the same reason GET /api/admin/settings does not — a shop's own address is not a secret from its own staff, and several screens need it. Every field is a string and every one may be empty; a store that has never filled this in gets blanks rather than a 404.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store"],"raw":"{{baseUrl}}/api/v1/admin/store"}}},{"name":"Change the store's name, address and contact details","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Requires store.write: this is the shop's legal identity, and it is what appears on documents a buyer keeps. A partial update: only the keys present in the body change; a key that is absent or null is left as it is, and an empty string clears that field. An unknown key is refused with 400. The response is the whole saved profile. A body carrying every field behaves as a full replace. Each text field is capped at 200 characters and trimmed; the country is an ISO 3166-1 alpha-2 code. Audited as store.profile_update with the before and after of each changed field; a body that changes nothing writes nothing.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store"],"raw":"{{baseUrl}}/api/v1/admin/store"}}},{"name":"The store's base currency","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The currency the variants' own prices, the reports and every order are in; `changeable` is false once the store has an order or a payment (an order snapshots its currency). `rates` are the store's own rates per extra currency (a rate fixed by hand, else the last daily rate): what a conversion multiplies by. Right: store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","base-currency"],"raw":"{{baseUrl}}/api/v1/admin/store/base-currency"}}},{"name":"Change the store's base currency","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Allowed while the store has no order and no payment (409 `base_currency_has_orders` otherwise) and its tenant has one store (409 `base_currency_shared_catalogue`). `prices: convert` converts the variants' prices, compare-at prices, costs and the flat shipping fee — a price the store already has in the new currency is taken as it is, the rest go by the store's own rate, else the European Central Bank's rate of the day (409 `base_currency_no_rate` when there is none); `prices: keep` keeps the numbers as typed. The sales regions keep their currencies: a region still selling in the old currency gets today's prices set by hand in it. Fixed discounts without a currency are pinned to the old one. Audited (store.settings_update); queues a refresh of the automatic prices. Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","base-currency"],"raw":"{{baseUrl}}/api/v1/admin/store/base-currency"}}},{"name":"What the store tells search engines","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Site haritası ve robots.txt: whether the store hides from search engines, its own robots.txt lines, whether AI crawlers are turned away, which parts the sitemap leaves out and whether it lists pictures. The storefront builds robots.txt and sitemap.xml from these. Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","crawl"],"raw":"{{baseUrl}}/api/v1/admin/store/crawl"}}},{"name":"Change what the store tells search engines","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the store's choices. robots_extra takes User-agent, Allow, Disallow and Crawl-delay lines and # comments only (at most 100 lines, 4000 characters); sitemap_exclude names parts from products, collections, categories, pages, blog and legal. Audited. Needs store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","crawl"],"raw":"{{baseUrl}}/api/v1/admin/store/crawl"}}},{"name":"What the store sells","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store kind (physical, digital, both, services), the merchant's overrides, the kind's defaults and the effective set of what is shown (order tracking, shipping settings, shipping texts; ADR-0071). No right needed, like GET /admin/store.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","kind"],"raw":"{{baseUrl}}/api/v1/admin/store/kind"}}},{"name":"Save what the store sells","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The kind and the overrides, both replaced; audited (store_profile.update). The storefront reads the effective set in the site answer (surfaces). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","kind"],"raw":"{{baseUrl}}/api/v1/admin/store/kind"}}},{"name":"The store's social links and payment marks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Store-owned (every theme reads them): the saved links, the owner's payment-mark list (null while it follows the switched-on payment methods), the suggestion and the choices. No right needed, like GET /admin/store.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","presence"],"raw":"{{baseUrl}}/api/v1/admin/store/presence"}}},{"name":"Save the store's social links and payment marks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Each link's value is normalised to the network's https address (@handle → profile URL, a WhatsApp number → https://wa.me/\u003cdigits\u003e); an address on another site is refused (400 with details.index). An empty value drops the link. The order is kept. Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","presence"],"raw":"{{baseUrl}}/api/v1/admin/store/presence"}}},{"name":"Where the store sells","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's sales mode (domestic, international or both; ADR-0143): its own choice, or — while it has not chosen (`chosen: false`) — the mode derived from what it uses (a market abroad or in another currency, prices in another currency, a foreign payment system or carrier connected, the ETGB workspace in use → both; otherwise domestic). Each panel area (Yurtiçi / Yurtdışı Satışlar) says whether the mode sells in it, whether the panel lists it and what the store uses in it; `modules` classifies every installed payment and carrier module (and cash on delivery, bank transfer) by area. The admin only: the storefront and the checkout never read it. No right needed, like GET /admin/store/kind.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","sales-mode"],"raw":"{{baseUrl}}/api/v1/admin/store/sales-mode"}}},{"name":"Choose where the store sells","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records the store's sales mode; audited (store.profile_update). It changes which areas the panel lists, nothing else: no market, price or connection is touched, and an area the store uses stays listed with a note. Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","store","sales-mode"],"raw":"{{baseUrl}}/api/v1/admin/store/sales-mode"}}},{"name":"The stores the caller may act on","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"For the panel's store switcher: the tenant's stores the caller's membership reaches (all of them when `store_ids` is empty). Send one as `X-Store-Id`. No right is needed, like /me: it names only what the caller already reaches.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","stores"],"raw":"{{baseUrl}}/api/v1/admin/stores"}}},{"name":"List tax classes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Needs taxes.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-classes"],"raw":"{{baseUrl}}/api/v1/admin/tax-classes"}}},{"name":"Add a tax class","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Needs taxes.write. The code is lower-cased and unique in the tenant. Audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","tax-classes"],"raw":"{{baseUrl}}/api/v1/admin/tax-classes"}}},{"name":"The store's spam protection (Cloudflare Turnstile keys)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Spam koruması (ADR-0096). The store's own site key and whether a secret is kept (never the secret); `active`: what guards the forms on the host the admin is on (`store`, `platform` or `none`); `platform_covered`: the platform's keys guard the store's NeroCart address; `own_hosts`: the store's hosts outside NeroCart's domain, where its own keys apply. Right: store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","turnstile"],"raw":"{{baseUrl}}/api/v1/admin/turnstile"}}},{"name":"Set or remove the store's Cloudflare Turnstile keys","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A site key with a secret (an empty secret keeps the stored one; a new site key without a stored secret needs one); both empty removes the keys. The secret is sealed (ADR-0042) and never returned. `token` is ignored here. Audited (store.settings_update, label turnstile). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","turnstile"],"raw":"{{baseUrl}}/api/v1/admin/turnstile"}}},{"name":"Check Cloudflare Turnstile keys with Cloudflare","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks Cloudflare's siteverify about the typed secret (else the stored one): with `token` (the widget's answer, rendered with the typed site key) the pair, `checked: widget`; without, the secret alone with Cloudflare's dummy token, `checked: secret`. Saves nothing. Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","turnstile","test"],"raw":"{{baseUrl}}/api/v1/admin/turnstile/test"}}},{"name":"The store's wholesale choices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Toptan satış (ADR-0091). Right: store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","wholesale"],"raw":"{{baseUrl}}/api/v1/admin/wholesale"}}},{"name":"Set the store's wholesale choices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces them. The default group must be one of the store's dealer groups. Writes store.wholesale_changed (the storefront's cache scope moves with who sees prices). Audited (store.wholesale). Right: store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","wholesale"],"raw":"{{baseUrl}}/api/v1/admin/wholesale"}}}],"name":"admin:settings"},{"item":[{"name":"Shipping fee by basket total","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each currency's hand-entered brackets (ADR-0146): a basket of at least min_total_minor pays fee_minor, up to the next bracket. A currency with brackets charges its bracket's fee for every table rate (a carrier's live price stays the carrier's), offers one option when no rate covers the address, and charges nothing when every physical line's price includes shipping. Right: shipping.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","brackets"],"raw":"{{baseUrl}}/api/v1/admin/shipping/brackets"}}},{"name":"Set the shipping fee by basket total","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces every currency's brackets; a currency left out has none (its rates as they are). Audited (shipping.brackets_update). Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","brackets"],"raw":"{{baseUrl}}/api/v1/admin/shipping/brackets"}}}],"name":"admin:shipping"},{"item":[{"name":"Change a membership: status, stores, second factor","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Suspending ends the member's sessions in this store at once and keeps the account and its history; the last active owner cannot be suspended, and nobody suspends themselves. `store_ids` limits the member to those stores (empty: every store). `mfa_required` demands a second factor of this member whatever their role says. Requires team.write. Every change is audited.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id","membership"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id/membership","variable":[{"key":"id","value":""}]}}},{"name":"Change what an operator may do","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Separate from PATCH on the superuser because it is a different act: changing somebody's email is administration, changing their role is granting or taking away access. The roles are owner, manager and staff, and what each carries is fixed — see the rights list on the operator record. A store keeps at least one owner: `team.write` is the only right that can hand out roles, and demoting the last owner would leave a team where nobody carries it — so the survivors could not promote anybody, including themselves, and the way back in would be a database client. It is refused.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","superusers",":id","role"],"raw":"{{baseUrl}}/api/v1/admin/superusers/:id/role","variable":[{"key":"id","value":""}]}}}],"name":"admin:superusers"},{"item":[{"name":"Open a basket reminder's link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The basket to put back in the browser (its token, for the storefront's own HttpOnly cookie), its market and the discount code to apply. 404 LINK_EXPIRED: unknown or older than 14 days; 404 CART_GONE; 409 ALREADY_ORDERED.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","cart-recovery","restore"],"raw":"{{baseUrl}}/api/v1/store/cart-recovery/restore"}}},{"name":"Stop a basket's reminders","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The reminder's \"stop these reminders\" link: the basket's sequence ends. Idempotent.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","cart-recovery","stop"],"raw":"{{baseUrl}}/api/v1/store/cart-recovery/stop"}}},{"name":"Open a cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns the cart id, which is an unguessable token. Possessing it is the authorisation — there is no account, and there never has to be.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts"],"raw":"{{baseUrl}}/api/v1/store/carts"}}},{"name":"Get a cart","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId","variable":[{"key":"cartId","value":""}]}}},{"name":"Where to reach the shopper of a basket","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The checkout's email, phone and language, and the commercial-message boxes the shopper ticked: a ticked box is recorded as a consent at once (source checkout; only for a basket with something in it), so an abandoned basket can be reminded about (ADR-0074). The email is a contact only: it never decides a price.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","contact"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/contact","variable":[{"key":"cartId","value":""}]}}},{"name":"Price a basket for the signed-in customer","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"With the customer's session (X-Customer-Session) and a verified email: their groups' price lists apply to the basket from now on and every line is priced again. An unverified account prices as a guest. 401 without a session.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","customer"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/customer","variable":[{"key":"cartId","value":""}]}}},{"name":"Price a basket as a guest's again","request":{"auth":{"type":"noauth"},"description":"On sign-out: group prices no longer apply and every line is priced again. Needs no session.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","customer"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/customer","variable":[{"key":"cartId","value":""}]}}},{"name":"Set the shopper's email on a cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The address an abandoned-cart flow reaches the shopper on. A shopper types it into the checkout form mid-session, before checkout exists to capture it, and this is where it is recorded. An empty string clears it, which is the shopper's own way to withdraw the address. Like every cart mutation it extends the cart's TTL, and it revives a cart the sweeper has already marked `abandoned`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","email"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/email","variable":[{"key":"cartId","value":""}]}}},{"name":"The gift cards on a cart","request":{"auth":{"type":"noauth"},"description":"The usable cards the shopper applied; they pay at checkout what they can of the total.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","gift-cards"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/gift-cards","variable":[{"key":"cartId","value":""}]}}},{"name":"Apply a gift card to a cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The code is posted, never put in a URL. The card must be active, unexpired, with a balance, in the cart's currency (else 422 gift_card_unusable; an unknown code is 404 gift_card_unknown). At most five cards per cart. Spends the visitor's lookup budget.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","gift-cards"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/gift-cards","variable":[{"key":"cartId","value":""}]}}},{"name":"Take a gift card off a cart","request":{"auth":{"type":"noauth"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","gift-cards",":id"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/gift-cards/:id","variable":[{"key":"cartId","value":""},{"key":"id","value":""}]}}},{"name":"Add a variant to the cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adding records the price now. Checkout is what makes a price authoritative, and it refuses rather than silently repricing. A personalised product's line carries `personalisation`: its values are checked against the product's fields (required, length, characters, the choice, the font, a date, a picture this basket uploaded for the field) and what they add goes into the line's unit price. The same variant with the same values adds to its line; other values make a line of their own. 400 details: reason `personalisation_invalid`, field, problem (unknown, required, too_long, characters, choice, font, date, image, image_type, image_size, image_small, unavailable, currency, duplicate, not_fillable) and product_slug (a quick add from a listing can send the shopper to the product's page). A variant with a quantity rule (ADR-0091 §1) takes only quantities its rule allows over all its lines in the basket: 400 quantity_rule with QuantityRefusal details. A product sold to dealers only is refused to anybody else: 403 dealer_only with DealerOnlyRefusal details.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","line-items"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/line-items","variable":[{"key":"cartId","value":""}]}}},{"name":"Change a line's quantity or how often it repeats","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A quantity of zero removes the line, which is what a stepper stepping down to nothing means. subscription_days changes how often the line repeats (0: a one-off); a body with only it leaves the quantity alone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","line-items",":lineId"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/line-items/:lineId","variable":[{"key":"cartId","value":""},{"key":"lineId","value":""}]}}},{"name":"Remove a line","request":{"auth":{"type":"noauth"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","line-items",":lineId"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/line-items/:lineId","variable":[{"key":"cartId","value":""},{"key":"lineId","value":""}]}}},{"name":"Upload a picture for a personalised line","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A picture the shopper wants on their piece — a photo to print, a drawing to engrave — for one image field of one product (ADR-0089). multipart/form-data with `file`, `product_id` and `field`. The bytes go through the media pipeline: sniffed against JPEG, PNG and WebP only (no SVG, no HTML, no polyglot), EXIF/XMP and text chunks stripped, sized variants made; then checked against the field (its types, its byte limit — 10 MiB unless the merchant set another, never above 20 MiB — and its minimum pixels). The picture belongs to this basket: only its lines can use it, by `upload_id` in AddLineItem's `personalisation`. The order claims the pictures its lines use; the rest are removed hourly once the basket is gone or checked out, or a week after upload. 400 details: reason `personalisation_invalid`, field, problem (unknown, image_type, image_size, image_small, unavailable). 409 a checked-out basket; 409 `demo_store` on a theme demo store. 429 `rate_limited`: 20 pictures per basket, 120 an hour per store.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":cartId","uploads"],"raw":"{{baseUrl}}/api/v1/store/carts/:cartId/uploads","variable":[{"key":"cartId","value":""}]}}},{"name":"Put a discount code on a cart","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Answers with what the code is worth for this basket, computed as checkout computes it: the code together with every automatic promotion the basket also gets (a richer automatic promotion may leave the code less to take). That amount is a preview, not a promise: nothing is consumed here, and checkout decides again under its own lock. A code that is valid now and exhausted in ten minutes is refused then, which is the only honest place to refuse it. A cart that has already been checked out refuses this: there is nothing left to discount, and the row would be one nothing reads. A scoped code is refused when this basket holds none of the products, collections or categories it names — a valid code can be refused for this basket alone, and the message says so. A refused code answers 400 (404 for an unknown code, 409 for a checked-out cart) with `details` a `DiscountRefusal`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":token","discount"],"raw":"{{baseUrl}}/api/v1/store/carts/:token/discount","variable":[{"key":"token","value":""}]}}},{"name":"Take the discount code off a cart","request":{"auth":{"type":"noauth"},"description":"Clearing the code is the same write as setting one, with an empty code. A cart that has already been checked out refuses this for the same reason PUT does.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","carts",":token","discount"],"raw":"{{baseUrl}}/api/v1/store/carts/:token/discount","variable":[{"key":"token","value":""}]}}},{"name":"Open a payment link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes a new basket of the link's lines (those that cannot go in are skipped and counted), with its discount code and e-mail, and answers its token. A link switched off or expired is 410 checkout_link_gone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout-links",":token","open"],"raw":"{{baseUrl}}/api/v1/store/checkout-links/:token/open","variable":[{"key":"token","value":""}]}}},{"name":"A gift card's balance","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The code is posted. Status is active, disabled or expired. Spends the visitor's lookup budget.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","gift-cards","balance"],"raw":"{{baseUrl}}/api/v1/store/gift-cards/balance"}}}],"name":"cart"},{"item":[{"name":"The brands of the store's products","request":{"auth":{"type":"noauth"},"description":"Each vendor of an active, listed product, with its page address, logo and words when saved; by name.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","brands"],"raw":"{{baseUrl}}/api/v1/store/brands"}}},{"name":"The category tree","request":{"auth":{"type":"noauth"},"description":"Nested by default, because a storefront menu is nested. `?flat=1` returns the same rows depth-first, which is what an indented picker wants: every row carries `depth` and `child_count`, so a client can indent and expand without rebuilding the tree. Titles, descriptions and slugs are served in the request language (?lang= or Accept-Language) with a per-field fallback to the default language; a slug may be the language's own or the default one.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","categories"],"raw":"{{baseUrl}}/api/v1/store/categories"}}},{"name":"A category and the products filed under it","request":{"auth":{"type":"noauth"},"description":"Descendants are included, because that is what picking a category means: someone who asks for Apparel wants the shirts too, and a filter that returned only products filed at the exact node would show an empty page for every branch. The meta describes the products, since they are the pageable part. Titles, descriptions and slugs are served in the request language (?lang= or Accept-Language) with a per-field fallback to the default language; a slug may be the language's own or the default one.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","categories",":slug"],"raw":"{{baseUrl}}/api/v1/store/categories/:slug","variable":[{"key":"slug","value":""}]}}},{"name":"List the markets this store sells in","request":{"auth":{"type":"noauth"},"description":"Public. The store's default market first, then by code. A storefront sends a market's `code` as the X-Market header; product reads, carts and checkout then price in its currency.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","markets"],"raw":"{{baseUrl}}/api/v1/store/markets"}}},{"name":"A product's shown fields","request":{"auth":{"type":"noauth"},"description":"By slug: the store's shown fields that have a value, in order, for the product page's specification table.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-fields"],"raw":"{{baseUrl}}/api/v1/store/product-fields"}}},{"name":"What several products cost this visitor","request":{"auth":{"type":"noauth"},"description":"GET /api/product-pricing/{id} for up to 60 products at once (`ids=1,2,3`): the storefront lays a signed-in dealer's prices over a cached listing (ADR-0091 §2). A product not for sale here is left out; one sold to dealers only answers `prices_hidden` and no variant to anybody else. Personal (no-store) with a session; Vary: X-Customer-Session.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-pricing"],"raw":"{{baseUrl}}/api/v1/store/product-pricing"}}},{"name":"What a product costs this visitor","request":{"auth":{"type":"noauth"},"description":"Per variant, in the request's market: one unit's price for this visitor (a signed-in member's group price), the price for everybody, and the quantity breaks that lower it — by the rule the cart and the checkout apply (ADR-0074). Personal (no-store) with a session. A product sold to dealers only answers prices_hidden and no variant to anybody else (ADR-0091 §2); Vary: X-Customer-Session.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-pricing",":id"],"raw":"{{baseUrl}}/api/v1/store/product-pricing/:id","variable":[{"key":"id","value":""}]}}},{"name":"A product's published questions","request":{"auth":{"type":"noauth"},"description":"By slug, newest first, at most 50; the asker's first name and an initial only.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-questions"],"raw":"{{baseUrl}}/api/v1/store/product-questions"}}},{"name":"Ask about a product","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Held until the store answers or publishes it; the answer is e-mailed when an address is given. The bot check applies; an automated-looking post is answered the same and dropped.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-questions"],"raw":"{{baseUrl}}/api/v1/store/product-questions"}}},{"name":"A product's picked products, by slug","request":{"auth":{"type":"noauth"},"description":"The merchant's picks, active products only, in their order; and what was bought together with it.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-relations"],"raw":"{{baseUrl}}/api/v1/store/product-relations"}}},{"name":"The live sets a product is in","request":{"auth":{"type":"noauth"},"description":"For the product page: every set the product (by slug) is in whose products are all active and whose promotion is live; titles in the request's language.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","product-sets"],"raw":"{{baseUrl}}/api/v1/store/product-sets"}}},{"name":"List active products","request":{"auth":{"type":"noauth"},"description":"Only active products are visible. A draft or archived product is reported as not found rather than forbidden, because its existence is not a shopper's business. Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there. Text is served in the request language (?lang= or Accept-Language) with a per-field fallback to the default language, and q also matches the product's translation in that language.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","products"],"raw":"{{baseUrl}}/api/v1/store/products"}}},{"name":"A listing's filters with counts","request":{"auth":{"type":"noauth"},"description":"Colour and size (the products' own options: colour is an option whose display is `color`, or, left automatic, one named Renk/Color/Colour/Farbe; size by name), in stock, on sale and the price span over the same base set GET /products lists (search, collection, category, attributes, channel), in the request's market. Counts are disjunctive: a value's count keeps every other current filter (ADR-0063).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","products","facets"],"raw":"{{baseUrl}}/api/v1/store/products/facets"}}},{"name":"Get a product by one of its variant SKUs","request":{"auth":{"type":"noauth"},"description":"SKU is the catalog's stable key for import and export, which makes it the natural handle for a storefront deep link too. Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","products","sku",":sku"],"raw":"{{baseUrl}}/api/v1/store/products/sku/:sku","variable":[{"key":"sku","value":""}]}}},{"name":"Get an active product by slug","request":{"auth":{"type":"noauth"},"description":"Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there. The slug may be the product's slug in the request language or its default-language slug; the response carries the localized slug and every language's slug in localization.slugs.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","products","slug",":slug"],"raw":"{{baseUrl}}/api/v1/store/products/slug/:slug","variable":[{"key":"slug","value":""}]}}},{"name":"Get an active product","request":{"auth":{"type":"noauth"},"description":"Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","products",":id"],"raw":"{{baseUrl}}/api/v1/store/products/:id","variable":[{"key":"id","value":""}]}}},{"name":"The pack selector's cards for a variant","request":{"auth":{"type":"noauth"},"description":"Vitrin eklentileri › Paket seçici (ADR-0157): for each quantity the store offers (at most four), N of the variant at this visitor's price before and after the store's automatic promotions, evaluated as the cart read evaluates them (promotions that do not combine included, ADR-0156) with no lock and no usage. `offers` is empty when the add-on is off, the product is not among those it shows on, or the variant has no price in the market's currency. Personal (no-store) with a session; Vary: X-Customer-Session. Since addendum 2: only the promotions the merchant chose count (all when none), `layout` says side or stacked, and a set card (`set_id`, `items`) prices a product set's products together, the set's own promotion included; `available` is false when one of them cannot be sold now.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","quantity-offers"],"raw":"{{baseUrl}}/api/v1/store/quantity-offers"}}},{"name":"A review request link: what it asks about","request":{"auth":{"type":"noauth"},"description":"The storefront's review page (/{lang}/review/{token}, Turkish /tr/yorum/{token}): the product the link asks about (in the request's language), how the review will be signed (first name and the initial of the surname) and whether the link was already used. 404 `LINK_EXPIRED`: unknown here, or older than 60 days.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","review-requests",":token"],"raw":"{{baseUrl}}/api/v1/store/review-requests/:token","variable":[{"key":"token","value":""}]}}},{"name":"Write the review a request link asks for","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The review written from the e-mail's link: `rating` (1–5), `title` (optional), `body` (10–4000 characters), `consent` and `consent_text`; the product, the e-mail and the name come from the link, never the client. Recorded as a verified purchase and waits for the store's moderation; the link is used up. When the store gives a thank-you, the receipt carries a single-use code — for every review, whatever its rating. Photos: multipart/form-data with the review as JSON in `review` and up to 3 files in `photos`, as POST /api/reviews. 404 `LINK_EXPIRED`; 409 `already_reviewed` (the link was used, or this product was already reviewed from this address).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","review-requests",":token"],"raw":"{{baseUrl}}/api/v1/store/review-requests/:token","variable":[{"key":"token","value":""}]}}},{"name":"No more review requests","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The e-mail's opt-out link: the address gets no review request from this store again, and its waiting requests are dropped. Idempotent; works however old the link is.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","review-requests",":token","unsubscribe"],"raw":"{{baseUrl}}/api/v1/store/review-requests/:token/unsubscribe","variable":[{"key":"token","value":""}]}}},{"name":"A product's approved reviews and their summary","request":{"auth":{"type":"noauth"},"description":"Only approved reviews; never an address. `sort` newest (default), helpful (most helpful first), rating_desc or rating_asc (highest and lowest are the older names); `with_photos=1` lists only reviews with an approved photo (meta.total then counts those). Each review carries its approved photos, its helpful count and the store's reply. A product not for sale in this store is 404 (ADR-0063).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","reviews"],"raw":"{{baseUrl}}/api/v1/store/reviews"}}},{"name":"Write a review","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Waits for the store's moderation. Verified when the signed-in account (X-Customer-Session) has a paid or shipped order of the product, or `order_number` names such an order with this email. A honeypot, a form sent within 3 s or without `started_at` is answered the same and dropped. 409 `already_reviewed`: one per product and address while pending or approved. 429 `rate_limited`: 5 an hour per visitor address, 120 per store. Photos: send multipart/form-data with the review as JSON in `review` and up to 3 files in `photos` (JPEG, PNG or WebP, at most 5 MiB each; sniffed, metadata stripped, filed in the media library's \"Değerlendirmeler\" folder, served only once the review is approved). A refused photo is 400 with details.field `photos` and details.reason (type, too_large, count, image_size, damaged, unavailable); 60 photos an hour per store (429). Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","reviews"],"raw":"{{baseUrl}}/api/v1/store/reviews"}}},{"name":"The store's newest approved reviews","request":{"auth":{"type":"noauth"},"description":"For a home \"testimonials\" section: approved reviews of products this store sells, newest first, `limit` 1–48 (default 6), `min_rating` 1–5, `with_photos=1` only those with an approved photo. Each carries its product (slug, title, picture) in the request's language.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","reviews","recent"],"raw":"{{baseUrl}}/api/v1/store/reviews/recent"}}},{"name":"Mark a review helpful","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"One vote per visitor and review: the storefront's cookie token (`voter_token`) when given, else the visitor's address, stored only as a hash. Only approved reviews (any other is 404). A second vote is answered 200 with `already_voted` and counts nothing. 429 `rate_limited`: 30 an hour per address, 3 per review and address a day, 600 an hour per store.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","reviews",":id","helpful"],"raw":"{{baseUrl}}/api/v1/store/reviews/:id/helpful","variable":[{"key":"id","value":""}]}}},{"name":"The size guide a product shows","request":{"auth":{"type":"noauth"},"description":"The guide naming the product, else one naming a collection it is in, else the store's default; 404 when none (ADR-0063).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","size-guide"],"raw":"{{baseUrl}}/api/v1/store/size-guide"}}},{"name":"Ask to be told once","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"back_in_stock (default) on a sold-out variant — 409 IN_STOCK when it can be bought — or price_drop (the market's price now is remembered). The box must be ticked with its wording. A repeat is the same request. 404 ALERTS_OFF when the store takes none; 429 rate_limited (10 an hour from one address). Sent once, then done; every message carries a link that cancels the person's other requests. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","stock-alerts"],"raw":"{{baseUrl}}/api/v1/store/stock-alerts"}}},{"name":"Whether the store takes stock alerts","request":{"auth":{"type":"noauth"},"description":"For the product page's \"Gelince haber ver\" form: on, and whether a phone number is taken (ADR-0074).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","stock-alerts","config"],"raw":"{{baseUrl}}/api/v1/store/stock-alerts/config"}}},{"name":"Cancel a person's waiting alerts","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A message's link: every waiting request of that recipient at this store is cancelled. 404 LINK_EXPIRED for an unknown link.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","stock-alerts","unsubscribe"],"raw":"{{baseUrl}}/api/v1/store/stock-alerts/unsubscribe"}}},{"name":"List a product's variants","request":{"auth":{"type":"noauth"},"description":"Variants are their own collection rather than a sub-path of a product: `/api/products/{id}/variants` would collide with the slug and sku lookups. Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","variants"],"raw":"{{baseUrl}}/api/v1/store/variants"}}},{"name":"Get a variant","request":{"auth":{"type":"noauth"},"description":"Variant prices are in the request's market (see `X-Market`); `for_sale` says whether each variant can be bought there.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","variants",":id"],"raw":"{{baseUrl}}/api/v1/store/variants/:id","variable":[{"key":"id","value":""}]}}}],"name":"catalog"},{"item":[{"name":"Storefronts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One catalogue can be served as several storefronts, differing in what is published to them and what it costs. They deliberately do not differ in currency: D14 settled one settlement currency per store and snapshots it onto every order.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","channels"],"raw":"{{baseUrl}}/api/v1/admin/channels"}}},{"name":"Create a channel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","channels"],"raw":"{{baseUrl}}/api/v1/admin/channels"}}},{"name":"One channel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","channels",":id"],"raw":"{{baseUrl}}/api/v1/admin/channels/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a channel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","channels",":id"],"raw":"{{baseUrl}}/api/v1/admin/channels/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a channel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its publication rows go with it, which widens the products that named it back to every channel — the state they were in before somebody narrowed them, and the only honest answer once the narrowing is gone. Carts and orders keep their history and lose only the reference.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","channels",":id"],"raw":"{{baseUrl}}/api/v1/admin/channels/:id","variable":[{"key":"id","value":""}]}}},{"name":"Which channels a product is narrowed to","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"An empty list means every channel, not none — see PUT below.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","channels"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/channels","variable":[{"key":"id","value":""}]}}},{"name":"Narrow a product to channels","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the narrowing whole. **An empty list clears it, which puts the product back in every channel rather than in none.** A product with no publication rows sells everywhere; publication is a narrowing an operator opts into, product by product. Reading it the other way would empty a catalogue the moment a store created its first channel.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","channels"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/channels","variable":[{"key":"id","value":""}]}}}],"name":"channels"},{"item":[{"name":"One suggestion's address, as checkout form fields","request":{"auth":{"type":"noauth"},"description":"Retired 2026-10-29 (owner): the Google address help is removed and this operation is no longer served (404). Kept here for the v1 contract only. The address of a suggested place (Places API (New) Place Details with the address fields only), mapped onto the checkout form: for Türkiye `state` is the il, `city` the ilçe, and `line1` the mahalle with the street and `No:` building number; `line2` a subpremise. Kept briefly per store. A Google failure is `address: null`.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","address","place"],"raw":"{{baseUrl}}/api/v1/store/address/place"}}},{"name":"Address suggestions as the shopper types (Google Places)","request":{"auth":{"type":"noauth"},"description":"Retired 2026-10-29 (owner): the Google address help is removed and this operation is no longer served (404). Kept here for the v1 contract only. Up to five addresses matching what was typed, from Google Maps Platform's Places API (New) Autocomplete, called by the kernel with the store's own key (ADR-0048); the browser never calls Google. Limited to the countries of the store's google-maps-address plugin, and to `country` when it is one of them (another country gets none). A query under three characters, or any Google failure, is an empty list, not an error. Needs an open cart. The query is never logged.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","address","suggest"],"raw":"{{baseUrl}}/api/v1/store/address/suggest"}}},{"name":"Check an address before the order is placed (Google Address Validation)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Retired 2026-10-29 (owner): the Google address help is removed and this operation is no longer served (404). Kept here for the v1 contract only. Asks Google's Address Validation API about the address and answers a hint: `CONFIRMED`, `UNCONFIRMED`, `SUSPICIOUS` (with the suspicious component types) or `UNKNOWN` (the country is not one of the plugin's, or Google could not answer), and Google's corrected address as form fields when it differs from what was typed. Checkout never consults it: the shopper may place the order whatever it says. Needs an open cart; the address is never logged.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","address","validate"],"raw":"{{baseUrl}}/api/v1/store/address/validate"}}},{"name":"List the payment methods this store accepts","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout"],"raw":"{{baseUrl}}/api/v1/store/checkout"}}},{"name":"Carrier tracking callback","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A core-owned route for carrier callbacks. The carrier's module verifies the signature (401 when it cannot) and maps the event onto the engine's tracking states; the engine finds the shipment by the carrier's reference or tracking number, deduplicates by the event id and applies it — delivered, failed delivery and returned to sender move the shipment, the rest are recorded and announced as fulfillment.tracking_updated. A cash-on-delivery remittance in the event settles the order.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout","carriers",":code","webhook"],"raw":"{{baseUrl}}/api/v1/store/checkout/carriers/:code/webhook","variable":[{"key":"code","value":""}]}}},{"name":"What it costs to send this basket there","request":{"auth":{"type":"noauth"},"description":"A quote rather than a price list: the price depends on what is in the cart, so the cart's own token is the input rather than a subtotal the caller could invent. An empty rates array is an answer, not an error - this store does not deliver to that destination - and a storefront has to render it either way. A store with no rates configured is still on Config.FlatShippingMinor, and this returns nothing. Only the rates written in the basket's currency are offered, their band read against the basket's subtotal in it; a market whose currency has no rate for the destination gets an empty list.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout","rates"],"raw":"{{baseUrl}}/api/v1/store/checkout/rates"}}},{"name":"Check out with a payment method","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Validates the cart, reserves inventory and creates the order in one transaction, then starts payment outside it — a gateway having a slow day must not become the store having a slow day.\n\nIf a line's price changed, its product went inactive, or stock ran out, the whole checkout is refused with 409 and per-line detail; the cart is refreshed to current prices so the shopper can confirm again. With `expected_total`, a total that no longer holds is refused with 409 too, `details` then being a `TotalChanged` object (`reason` = `total_changed`) instead of the per-line array.\n\nSend an `Idempotency-Key` header. The same key replays the original result instead of creating a second order; if the first attempt created the order but payment initiation failed, a retry resumes payment on that same order. A replayed or resumed answer carries the order's `access_token` like the first one, so a shopper whose answer was lost can still open their order. A chosen `shipping_rate_id` that no longer covers the basket is a 409 with `details.reason` = `shipping_rate_unavailable`; an address the store does not deliver to (in the basket's currency) is a 400 with `details.reason` = `no_delivery`.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout",":code"],"raw":"{{baseUrl}}/api/v1/store/checkout/:code","variable":[{"key":"code","value":""}]}}},{"name":"Installment options for a card","request":{"auth":{"type":"noauth"},"description":"Asks the payment provider what a card, known by its first digits (BIN), may be split into for an amount, and what each count costs the shopper in all. Only for a payment method that quotes installments; an idle (not yet configured) method answers 404 like a missing one. The answer is the provider's and is not stored: checkout still sends the chosen count in `installments`, and what was actually charged comes back on the payment.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout",":code","installments"],"raw":"{{baseUrl}}/api/v1/store/checkout/:code/installments","variable":[{"key":"code","value":""}]}}},{"name":"Gateway callback","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A core-owned route for payment callbacks. A gateway that parses its own callbacks has each event verified by its signature, matched to its payment, deduplicated by the provider's event id and applied by the engine; a bad signature is refused with 401. Older modules receive the raw request body and verify it themselves.\n\nA provider that sends no event id (iyzico, PayTR) has one derived from the event's content, so a repeat is still a no-op; a provider that expects a particular answer gets it (PayTR: the plain-text body `OK`).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","checkout",":code","webhook"],"raw":"{{baseUrl}}/api/v1/store/checkout/:code/webhook","variable":[{"key":"code","value":""}]}}},{"name":"What an opt-out link withdraws","request":{"auth":{"type":"noauth"},"description":"The link every commercial message carries. GET shows what it would withdraw (masked) and changes nothing; POST withdraws the consent at once — also what RFC 8058 List-Unsubscribe-Post sends.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","consents","opt-out",":token"],"raw":"{{baseUrl}}/api/v1/store/consents/opt-out/:token","variable":[{"key":"token","value":""}]}}},{"name":"Opt out of commercial messages","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The link every commercial message carries. GET shows what it would withdraw (masked) and changes nothing; POST withdraws the consent at once — also what RFC 8058 List-Unsubscribe-Post sends.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","consents","opt-out",":token"],"raw":"{{baseUrl}}/api/v1/store/consents/opt-out/:token","variable":[{"key":"token","value":""}]}}},{"name":"An il's ilçeler","request":{"auth":{"type":"noauth"},"description":"The ilçeler of an il, in Turkish alphabetical order. From PTT's official postal code list, embedded; the same for every store; cached a day (ADR-0120).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","geo","tr","districts"],"raw":"{{baseUrl}}/api/v1/store/geo/tr/districts"}}},{"name":"An ilçe's mahalleler with their postal codes","request":{"auth":{"type":"noauth"},"description":"The mahalleler (and köyler) of an ilçe with their postal codes — one almost always; a few large mahalleler have several, the first is the commonest guess. From PTT's official postal code list, embedded; the same for every store; cached a day (ADR-0120).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","geo","tr","neighbourhoods"],"raw":"{{baseUrl}}/api/v1/store/geo/tr/neighbourhoods"}}},{"name":"Where a Turkish postal code is","request":{"auth":{"type":"noauth"},"description":"Every mahalle with the postal code (empty when the list does not know it). From PTT's official postal code list, embedded; the same for every store; cached a day (ADR-0120).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","geo","tr","postal-codes",":code"],"raw":"{{baseUrl}}/api/v1/store/geo/tr/postal-codes/:code","variable":[{"key":"code","value":""}]}}},{"name":"Türkiye's iller","request":{"auth":{"type":"noauth"},"description":"The 81 iller with their plate numbers, in Turkish alphabetical order, for the checkout's il select. From PTT's official postal code list, embedded; the same for every store; cached a day (ADR-0120).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","geo","tr","provinces"],"raw":"{{baseUrl}}/api/v1/store/geo/tr/provinces"}}},{"name":"Complete a payment after the shopper returns","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Called by the storefront when the shopper comes back from a hosted payment page or a 3-D Secure challenge, with the data the provider appended to the return URL. The engine asks the provider what happened; the browser's word alone never marks anything paid. Answers with the payment's state only.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","payments",":id","complete"],"raw":"{{baseUrl}}/api/v1/store/payments/:id/complete","variable":[{"key":"id","value":""}]}}}],"name":"checkout"},{"item":[{"name":"List the collections a storefront should show","request":{"auth":{"type":"noauth"},"description":"Only collections holding at least one active product are listed. A collection that is empty, or that holds nothing but drafts, is a work in progress, and linking to it would produce an empty page. Titles, descriptions and slugs are served in the request language (?lang= or Accept-Language) with a per-field fallback to the default language; a slug may be the language's own or the default one.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","collections"],"raw":"{{baseUrl}}/api/v1/store/collections"}}},{"name":"Get a collection and the active products in it","request":{"auth":{"type":"noauth"},"description":"`meta` describes the embedded products: the collection itself is a single record, and the only thing on this response a client can page through is what is in it. Products come back in the order they were curated. Titles, descriptions and slugs are served in the request language (?lang= or Accept-Language) with a per-field fallback to the default language; a slug may be the language's own or the default one.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","collections",":slug"],"raw":"{{baseUrl}}/api/v1/store/collections/:slug","variable":[{"key":"slug","value":""}]}}}],"name":"collections"},{"item":[{"name":"A template for the editor's preview","request":{"auth":{"type":"noauth"},"description":"The storefront draws a template before it is inserted (the editor's preview at three widths, ADR-0085 VB-7): its sections with library pictures at their current address. Only under a valid preview token of the store and with vb_kits; never cached.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","builder","templates",":ref"],"raw":"{{baseUrl}}/api/v1/store/builder/templates/:ref","variable":[{"key":"ref","value":""}]}}},{"name":"Send a message through the store's contact form","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The storefront's contact_form section (ADR-0062). Validates name (1–120), email, phone (optional, digits and + ( ) - ), topic (≤ 80), message (10–5000) and the KVKK acknowledgement (`consent` true with the `consent_text` shown). `website` is a honeypot and `started_at` the time the form was rendered (Unix ms): a filled honeypot, a form sent within 3 seconds of being shown, or one without `started_at` is answered 202 like any other and dropped. At most 5 messages an hour per visitor address and 60 per store: 429 `rate_limited` with Retry-After. A stored message is emailed to the store's contact address and announced on the staff channels (Telegram, WhatsApp) without the visitor's details; it is kept 12 months. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","contact"],"raw":"{{baseUrl}}/api/v1/store/contact"}}},{"name":"Blog articles","request":{"auth":{"type":"noauth"},"description":"Articles published in a language, pinned ones first, then newest; filtered by category, tag or author, or the articles nearest another (`related`: the same category first, then shared tags; ADR-0073).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","articles"],"raw":"{{baseUrl}}/api/v1/store/content/articles"}}},{"name":"An article's comments","request":{"auth":{"type":"noauth"},"description":"The approved comments under an article in a language, oldest first (at most 200), each with the store's answer. Never the writer's email.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","articles",":slug","comments"],"raw":"{{baseUrl}}/api/v1/store/content/articles/:slug/comments","variable":[{"key":"slug","value":""}]}}},{"name":"Comment on an article","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A reader's comment (ADR-0073). Refused (409) when the store's comments are off or the article's are closed. A filled honeypot (`website`) or a form sent within 3 seconds of being shown is answered like a held comment and dropped. At most 5 per address and 60 per store an hour (429 with Retry-After). In `moderated` mode every comment waits for the store; in `auto` it is shown at once unless it looks like spam (many links, shouting). Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","articles",":slug","comments"],"raw":"{{baseUrl}}/api/v1/store/content/articles/:slug/comments","variable":[{"key":"slug","value":""}]}}},{"name":"The blog's index","request":{"auth":{"type":"noauth"},"description":"The blog's categories (with their live articles in the language), the authors who have live articles, the 100 most used tags, the comment mode and the page size (ADR-0073): for archive pages, filters and the RSS feed.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","blog"],"raw":"{{baseUrl}}/api/v1/store/content/blog"}}},{"name":"Coupon widgets' discounts","request":{"auth":{"type":"noauth"},"description":"Resolves the discounts coupon widgets name (ADR-0085 §10): only ids a published page or popup of the store holds (or, with a preview token, the page it opens) are answered, so the read cannot list discounts. `code` is set only while the discount can be used (active, started, not ended, under its limit); usage counts and limits are never exposed. Never cached.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","coupons"],"raw":"{{baseUrl}}/api/v1/store/content/coupons"}}},{"name":"A legal page","request":{"auth":{"type":"noauth"},"description":"The live legal text of a kind from the legal module (unchanged: its version and hash are what a checkout accepts), with the store's introduction page for that kind when published.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","legal",":kind"],"raw":"{{baseUrl}}/api/v1/store/content/legal/:kind","variable":[{"key":"kind","value":""}]}}},{"name":"Published pages","request":{"auth":{"type":"noauth"},"description":"Slugs live in a language, for a sitemap.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","pages"],"raw":"{{baseUrl}}/api/v1/store/content/pages"}}},{"name":"A published page","request":{"auth":{"type":"noauth"},"description":"The live section document of a page (the home page is `home`) in one language; no fallback to another language. With a valid preview token, the working copy.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","pages",":slug"],"raw":"{{baseUrl}}/api/v1/store/content/pages/:slug","variable":[{"key":"slug","value":""}]}}},{"name":"The live popups","request":{"auth":{"type":"noauth"},"description":"The popups published in a language (ADR-0085 §9, VB-5) whose schedule is on, highest priority first, each with its rules and its document (free layouts, media addresses current). With `path` (a storefront path, with or without the language), only those whose page conditions take it; none at all on the checkout, an order's or the account's pages. The visitor's side of the rules (device, new or returning visitor, cart, trigger, frequency, consent) is the storefront's to apply. With the store's time zone, which the weekdays and hours of the rules are in.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","popups"],"raw":"{{baseUrl}}/api/v1/store/content/popups"}}},{"name":"A unique coupon's code for this visitor","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A published popup's coupon widget in \"unique\" mode (ADR-0133) hands each visitor a single-use code minted from its discount (a copy with a usage limit of 1, listed under the discount's codes). The visitor is the storefront's random token (kept in its own HttpOnly cookie), stored only as a hash: the same token gets the same code again, and no request reaches another visitor's. The discount is read from the popup's live version, never from the request; a discount that ended, is off or is used up answers 409 campaign_ended. Limited per address. Never cached.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","popups",":id","coupon"],"raw":"{{baseUrl}}/api/v1/store/content/popups/:id/coupon","variable":[{"key":"id","value":""}]}}},{"name":"Count a popup's view, close, conversion, code copied or sign-up","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds one to today's (UTC) count of a published popup: a view, a close, a conversion (its form sent, its coupon copied or applied), or — counted as a conversion too — a code copied or a sign-up (ADR-0133). Counts only; a conversion, a copy or a sign-up also notes the store's daily visitor hash (visits.go, no cookie) with the time, so an order placed later in the same visit counts toward the popup's revenue.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","popups",":id","events"],"raw":"{{baseUrl}}/api/v1/store/content/popups/:id/events","variable":[{"key":"id","value":""}]}}},{"name":"Spin a popup's wheel for this visitor","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The wheel of a published popup (ADR-0133): the server draws the segment by the weights its live version holds (crypto random; a segment whose discount ended, is off or is used up is out of the draw) and answers it with, for a prize, a single-use code minted from the segment's discount. Once per visitor token (the same answer again) and, when the wheel asks for an e-mail, once per address (409 already_spun). The page never chooses the segment, the prize or the discount. A ticked permission box asks the address to confirm the newsletter (double opt-in) in the wheel's own wording. Limited per address. Never cached.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","popups",":id","spin"],"raw":"{{baseUrl}}/api/v1/store/content/popups/:id/spin","variable":[{"key":"id","value":""}]}}},{"name":"Redirect rules","request":{"auth":{"type":"noauth"},"description":"Every redirect rule of the store, for the storefront's middleware. A rule for one language wins over a rule for every language.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","redirects"],"raw":"{{baseUrl}}/api/v1/store/content/redirects"}}},{"name":"The published theme","request":{"auth":{"type":"noauth"},"description":"Colours, fonts, logo (resolved URL) and menus; version 0 when none is published. With a valid preview token, the draft.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","content","theme"],"raw":"{{baseUrl}}/api/v1/store/content/theme"}}},{"name":"The store's identity","request":{"auth":{"type":"noauth"},"description":"The store's own details a theme lays out (ADR-0061): announcement, footer text, social links, contact, payment icons and footer trust badges, WhatsApp number and message, free-shipping amount, instalment and delivery lines. With a preview token: the theme draft's copy.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","identity"],"raw":"{{baseUrl}}/api/v1/store/identity"}}},{"name":"One of the store's menus","request":{"auth":{"type":"noauth"},"description":"A store-owned menu (ADR-0061): main (the header), footer, footer-1 … footer-4 (the footer's columns). Menus belong to the store, not to a theme, and survive every theme switch. With a preview token: the theme draft's copy.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","menus",":handle"],"raw":"{{baseUrl}}/api/v1/store/menus/:handle","variable":[{"key":"handle","value":""}]}}},{"name":"Ask to subscribe to the newsletter (double opt-in)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records a sign-up request with the wording shown and emails a one-time confirmation link (notify queue). No consent exists until the address confirms (POST /newsletter/confirm). Answers the same whether or not the address is known or already subscribed. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","newsletter"],"raw":"{{baseUrl}}/api/v1/store/newsletter"}}},{"name":"Confirm a newsletter subscription","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Turns the emailed link's token into the e-mail consent (source newsletter_form), with the request's and the confirmation's proof. Opening the link again answers the same. Cache-Control: no-store.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","newsletter","confirm"],"raw":"{{baseUrl}}/api/v1/store/newsletter/confirm"}}},{"name":"Ask for a quote (\"Teklif iste\")","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A quote request for a basket (`cart_id`) or the products named (`lines`), stored in the contact inbox as a message of kind quote with its lines — never a price (ADR-0091 §4). The store is told as for a contact message; the buyer gets a copy. The contact form's honeypot, fill time and hourly limits apply (429). 404 quotes_disabled when the store takes none. Cloudflare Turnstile (ADR-0096): when keys apply to the request's host — the platform's on a NeroCart host, the store's own on its own domain — the `X-Turnstile-Token` header must carry a token Cloudflare confirms, else 400 `turnstile_failed` (details.field `turnstile`). Cloudflare unreachable lets the request through on the route's other protections.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","quote-requests"],"raw":"{{baseUrl}}/api/v1/store/quote-requests"}}},{"name":"The store's active stories","request":{"auth":{"type":"noauth"},"description":"In order, at most 30; the home page's row of stories.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","stories"],"raw":"{{baseUrl}}/api/v1/store/stories"}}},{"name":"The theme's alternate templates","request":{"auth":{"type":"noauth"},"description":"The live theme's alternates of the product, collection and page templates (ADR-0068), for the screens where a product, collection or page picks one. Public: template names only.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","theme","alternate-templates"],"raw":"{{baseUrl}}/api/v1/store/theme/alternate-templates"}}},{"name":"The demo store a theme gallery preview opens","request":{"auth":{"type":"noauth"},"description":"Resolves a gallery preview token of this store (POST /admin/theme/gallery/{id}/preview answered demo: true) to the theme's own demo store: the storefront renders the preview on that host's store, so the gallery shows the theme with its own demo catalogue and pages, never the merchant's products (ADR-0072). A token of another store, an expired one or one that is not a demo preview is 403; a theme whose demo store is not seeded is 404. Never cached.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","theme","demo"],"raw":"{{baseUrl}}/api/v1/store/theme/demo"}}},{"name":"A template of the store's theme","request":{"auth":{"type":"noauth"},"description":"The template the store's theme renders a page with (theme engine 2.0.0, ADR-0061): its sections in order, each with its settings and blocks, and the theme's section groups. The theme instance's override when the store has one, else the package's; a 1.x package answers the engine's 1.1 template set. An alternate (product.wide) falls back to its base, category and search to collection. With a preview token: the theme draft's, or a gallery theme's choice. An engine section's look setting left unset follows the theme's global setting of the same meaning.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","theme","template",":name"],"raw":"{{baseUrl}}/api/v1/store/theme/template/:name","variable":[{"key":"name","value":""}]}}}],"name":"content"},{"item":[{"name":"Can the store buy a domain","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","domains-dna","offer"],"raw":"{{baseUrl}}/api/v1/admin/x/domains-dna/offer"}}},{"name":"The store's domain purchases","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","domains-dna","purchases"],"raw":"{{baseUrl}}/api/v1/admin/x/domains-dna/purchases"}}},{"name":"Buy a domain for the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Checks the name is on sale and free, records the purchase with a one-time store code and answers the platform store's page to pay on. After payment the domain is registered and connected to this store. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","domains-dna","purchases"],"raw":"{{baseUrl}}/api/v1/admin/x/domains-dna/purchases"}}},{"name":"Search a domain for the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Availability and the price per year across the extensions NeroCart sells. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","domains-dna","search"],"raw":"{{baseUrl}}/api/v1/admin/x/domains-dna/search"}}}],"name":"domains-dna"},{"item":[{"name":"Automatic SMTP settings for the store's address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's address (or ?email=) names its domain; the domain's MX records name the mailbox provider (Google Workspace, Microsoft 365, Yandex 360, Zoho, iCloud+), whose submission server, port, security and DKIM selector are answered with the address as user name and sender, so the form asks only for the password. An unknown provider gets mail.\u003cdomain\u003e and known false. 409 when the store has no address. Right: plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","email-smtp","autoconfig"],"raw":"{{baseUrl}}/api/v1/admin/x/email-smtp/autoconfig"}}},{"name":"Check the sender domain's SPF, DMARC and DKIM","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Looks up, now, the DNS records of the saved sender address's domain: the SPF record (exactly one `v=spf1` TXT; warns when it ends in +all or does not include the SPF domain of a known SMTP service such as Yandex, Office 365, Gmail, Amazon SES, Brevo, Mailgun), the DMARC record on `_dmarc.\u003cdomain\u003e` (or inherited from the parent domain; p=none is a warning) and, when a DKIM selector is saved, the key on `\u003cselector\u003e._domainkey.\u003cdomain\u003e`. Answers with each record's state and the records to add or replace at the DNS provider. Advice only: nothing is stored and sending is never blocked by the result (`blocking` is always false). Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","email-smtp","sender-domain"],"raw":"{{baseUrl}}/api/v1/admin/x/email-smtp/sender-domain"}}},{"name":"Send a test email","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends one message now, synchronously, through the stored SMTP settings (saved, whether or not the integration is switched on yet), in the store's language, and answers with what the server said. It goes only to the signed-in operator's own address — never to a stranger (no open relay); a script holding the static admin token names the address in `to`. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","email-smtp","test"],"raw":"{{baseUrl}}/api/v1/admin/x/email-smtp/test"}}}],"name":"email-smtp"},{"item":[{"name":"The ERP connectors, their last sync and what failed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Logo, Mikro and Netsis (OR8): for each, whether it is switched on and set up, the latest pass of each kind (`items` in; `customers`, `orders`, `invoices` out) with how many it saw, changed and failed and the lines that failed, the documents that failed too often and wait for a person, and how many paid orders have not gone out yet. Needs plugins.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","erp-sync","status"],"raw":"{{baseUrl}}/api/v1/admin/x/erp-sync/status"}}},{"name":"Sync an ERP now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues the sync job for this connector in this store; it runs in the background like the recurring pass every 15 minutes, and its outcome appears in the status. 409 when the connector is not switched on and set up. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","erp-sync",":connector","sync"],"raw":"{{baseUrl}}/api/v1/admin/x/erp-sync/:connector/sync","variable":[{"key":"connector","value":""}]}}},{"name":"Test an ERP connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Signs in with the saved address, user, password and company, and reads one page of stock cards, whether or not the connector is switched on yet. `ok` is true when the ERP answered; otherwise `error` says why (never the password). Nothing is written at the ERP. 409 when the address, user or password is missing. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","erp-sync",":connector","test"],"raw":"{{baseUrl}}/api/v1/admin/x/erp-sync/:connector/test","variable":[{"key":"connector","value":""}]}}}],"name":"erp-sync"},{"item":[{"name":"Accounts the store's own grant can reach (merchant mode)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Discovered with the store's own merchant-mode OAuth grant. Right: channels.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","accounts"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/accounts"}}},{"name":"Choose the merchant-mode account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The id must be one Google lists for this store's own grant; owned mode is refused (its account comes from configuration). Right: channels.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","accounts","select"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/accounts/select"}}},{"name":"The module's audit trail","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The newest 100 google.merchant.* events of this store: mode, account id, status, error code, correlation id. Right: channels.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","audit"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/audit"}}},{"name":"Start a Google OAuth authorization","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns Google's authorization URL (scope `https://www.googleapis.com/auth/content` only, offline access, consent, PKCE S256) and when the single-use state expires (10 minutes). `owned` is allowed only for the tenant that owns NeroCart's Merchant Center; the account id never comes from the request. Right: channels.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","oauth","start"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/oauth/start"}}},{"name":"Register NeroCart's GCP project (owned mode)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Access test, developer registration read, registerGcp only when the expected project number is not yet registered (idempotent), API_DEVELOPER check for the developer email. Owner tenant only; takes no body. 202 when Google was unavailable or rate limiting and a retry job is queued. Right: channels.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","register"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/register"}}},{"name":"Add the service account to NeroCart's account with ADMIN (owned mode)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Through the Merchant API's user management (accounts.users), with the owned OAuth grant of an account admin: lists the account's users; creates the service account named by the configured key file with ADMIN if it is absent, adds ADMIN to its rights if it lacks it, and changes nothing if it already holds it. If Google then reports the user PENDING, the service account verifies itself with its own token (PATCH accounts/{account}/users/me:verifySelf, body {}); the response must say VERIFIED with ADMIN. A VERIFIED user is not verified again. The access test is not run here (Google refuses the service account for about a minute after verifySelf); use service-account/test. The request carries no email and no account id. No invitation email is involved. Owner tenant only. Right: channels.write. A Google failure answers 424 with details.google (and details.grant when verifySelf failed after the user was added).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","service-account","grant"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/service-account/grant"}}},{"name":"Test the service account's access (owned mode)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mints a service-account token (JWT bearer, content scope) and reads NeroCart's Merchant Center account. On PERMISSION_DENIED answers SERVICE_ACCOUNT_MERCHANT_ACCESS_REQUIRED with the steps to grant access by hand; nothing is granted and no invitation is sent. Owner tenant only. Right: channels.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","service-account","test"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/service-account/test"}}},{"name":"Connection and registration status","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's connections (no tokens), the owned account's registration status, gcpIds and API_DEVELOPER check, and for the owner tenant the service account's last test. Right: channels.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-merchant","status"],"raw":"{{baseUrl}}/api/v1/admin/x/google-merchant/status"}}}],"name":"google-merchant"},{"item":[{"name":"Google Ads conversion check","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Reads the bound Google Ads customer's purchase and add-to-cart conversion actions (status, label, last conversion day and count of the last 30 days), whether their website goals count for bidding, how the storefront reports the conversions (direct Google tag or Tag Manager container) and NeroCart's own count of paid orders to compare against. Writes nothing. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","ads","conversion-check"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/ads/conversion-check"}}},{"name":"Module audit trail and binding ledger","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The newest 100 events and the newest 100 field writes (previous value, new value, provenance, actor, operation id). Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","audit"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/audit"}}},{"name":"Service catalogue and support matrix","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every service with its aliases, scopes per level, required APIs, the batch that brings its provider and its DISCOVER/CREATE/CONFIGURE/VERIFY/BIND_TO_NEROCART/ACTIVATE/SYNC row. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","catalog"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/catalog"}}},{"name":"Connected Google accounts","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"No token is ever returned. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","connections"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/connections"}}},{"name":"Disconnect a Google account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"NeroCart forgets its copy of the grant; Google resources, bindings and other connections stay. With revoke, the grant is revoked at Google too and every connection of the same account is listed as affected and marked. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","connections",":id","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/connections/:id/disconnect","variable":[{"key":"id","value":""}]}}},{"name":"Find existing services","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Runs every selected service's discovery with the connection (the newest healthy one when unnamed). A service without its scopes answers NEEDS_GOOGLE_CONSENT; a provider that is not in this build answers UNSUPPORTED; a Google failure of one never stops the others. Nothing is written. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","discover"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/discover"}}},{"name":"Gmail inbox: the latest messages (metadata only)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The newest messages Gmail reported to the store's watched mailbox (the gmail_inbox option): sender, subject, date, labels and an 'open in Gmail' link — never a body, snippet or attachment. Rows are kept 30 days. A sender that is one of the store's customers (customer record or orders with that address) is linked, only for an operator who also holds customers.read and orders.read. Every text field is untrusted mail header text: render it as text, never as HTML. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","gmail","inbox"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/gmail/inbox"}}},{"name":"Send a Gmail test email","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends one test message now through the bound Gmail mailbox (whether or not it is the sender yet), only to the signed-in operator's own address (a static token names one) and only when the request confirms the recipient. Google's acceptance is not delivery. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","gmail","test"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/gmail/test"}}},{"name":"Start a Google OAuth authorization","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns Google's authorization URL: scopes derived from the selected services (catalogue only, never cloud-platform), offline access, consent, PKCE S256, OIDC nonce, include_granted_scopes. The state is single use (10 minutes) and bound server side to the actor, tenant, store, purpose and scope set. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","oauth","start"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/oauth/start"}}},{"name":"Google Services overview","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's facts (hosts, country, language, currency, timezone), connected Google accounts (no tokens), one card per service with real status, needed action, bound NeroCart fields, the latest plan and run, and the readiness diagnostic. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","overview"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/overview"}}},{"name":"List plans","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's newest 20 plans. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","plans"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/plans"}}},{"name":"Make a setup plan","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Discovers, diffs and records a draft plan: per service what to bind, create or verify, the NeroCart fields that would change (with their current values), the external actions, and the plan hash an approval must name. Publishing actions appear only when their option was chosen. Older drafts are superseded. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","plans"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/plans"}}},{"name":"One plan with its latest run","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","plans",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/plans/:id","variable":[{"key":"id","value":""}]}}},{"name":"Approve a plan","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The trusted approval: the caller names the plan's hash exactly; the settings the plan snapshotted must not have moved (409 PLAN_STALE otherwise). Creates the run and its journal idempotently (a second click finds the same run) and queues the job. Approving grants nothing on Cloud, IAM or DNS. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","plans",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/plans/:id/approve","variable":[{"key":"id","value":""}]}}},{"name":"OAuth readiness","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What this deployment has (client, redirect URI) and what each service needs (scopes, APIs); the consent screen and app verification are HUMAN_ACTION_REQUIRED by nature. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","readiness"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/readiness"}}},{"name":"One run with its steps","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The durable journal: each step's dependency, attempt, request and operation ids, external result and local result kept apart. Right: google-services.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","runs",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/runs/:id","variable":[{"key":"id","value":""}]}}},{"name":"Sync a binding","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Refreshes NeroCart's copy of a bound resource's settings: the provider re-reads Google and the fields it returns are written through the binding adapter (snapshot, conflict check, ledger with provenance 'synced'). Merchant: re-queues the product sync when it is on. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","services",":service","sync"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/services/:service/sync","variable":[{"key":"service","value":""}]}}},{"name":"Verify a binding","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Re-checks the service's existing binding with its provider and records the state. Right: google-services.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","google-services","services",":service","verify"],"raw":"{{baseUrl}}/api/v1/admin/x/google-services/services/:service/verify","variable":[{"key":"service","value":""}]}}}],"name":"google-services"},{"item":[{"name":"The ads (Pazarlama › Reklamlar)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The campaigns the hub launched with their one plain status and this month's cost, the budget policies, and whether the server and the caller may launch. Reads NeroCart's rows only. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","ads"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/ads"}}},{"name":"Pause an ad","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Pauses the campaign on its platform at once. Always allowed with marketing.write: it never waits for the kill switch, ads.spend or a person. The wish is recorded first; if the platform does not answer, the hourly sync pauses it. Switching it on again is an ads_resume plan. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","ads","campaigns",":id","pause"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/ads/campaigns/:id/pause","variable":[{"key":"id","value":""}]}}},{"name":"Stop an ad","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stops (removes) the campaign on its platform for good. Always allowed with marketing.write. The wish is recorded first; if the platform does not answer, the sync stops it. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","ads","campaigns",":id","stop"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/ads/campaigns/:id/stop","variable":[{"key":"id","value":""}]}}},{"name":"Check an ad before launching it","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Builds the campaign from the wizard's answer (the products, the goal, the daily budget; Performance Max when the goal is sales and a Merchant Center account is linked to Google Ads, otherwise Search), checks Google's limits and the budget, and asks Google to validate the exact request (validate_only). Writes nothing anywhere and spends nothing; works with ad spend off on the server. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","ads","preflight"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/ads/preflight"}}},{"name":"Live visitors (GA4 Realtime)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Who is on the store's site now: active users of the last 30 and 5 minutes, per minute, top pages, countries, devices and add_to_cart/purchase events, from the bound GA4 property's Realtime report. Calls Google at most once per store every 20 seconds (answers are kept in memory, never stored). A missing connection, grant, binding or quota is a 200 with that status. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","analytics","realtime"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/analytics/realtime"}}},{"name":"Ad budget","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's ad budget per currency, this month's ad spend from the stored Google Ads numbers (no provider call), the latest draft plan and whether a raise can be approved here. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","budget"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/budget"}}},{"name":"Social sales channels","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The Satış Kanalları cards (ADR-0131): each channel's account, status, setup steps, product choice and catalog. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","channels"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/channels"}}},{"name":"Products the catalogs refused","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Items Meta or TikTok rejected or could not take, with the reason. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","channels","catalog","problems"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/channels/catalog/problems"}}},{"name":"Sync the catalogs now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends what changed without waiting for the quiet time. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","channels","catalog","sync"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/channels/catalog/sync"}}},{"name":"Run the channels' setup again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues the setup chain (catalog, sync, WhatsApp catalog, webhooks, templates, Page). Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","channels","setup"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/channels/setup"}}},{"name":"Switch a channel or choose its products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Switching on runs the setup chain. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","channels",":channel"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/channels/:channel","variable":[{"key":"channel","value":""}]}}},{"name":"Connections","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One card per provider: one state, one recognisable id, one message code and the screen that connects it. Google, Bing and Yandex are borrowed from their modules; the others are not built yet (ready=false). No token or key. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections"}}},{"name":"Meta assets to choose from","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Reads the Pages (with their Instagram accounts), the ad account's business's catalogs and the ad account's pixels from Meta, and the current choice. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","meta","assets"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/meta/assets"}}},{"name":"Choose the Meta assets","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the Page, Instagram account, catalog (or creates one, adopting one of the same name) and pixel (or creates one), each checked against Meta; then, each only when asked: registers the feed, switches the pixel plugin on. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","meta","assets"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/meta/assets"}}},{"name":"Read the Meta assets again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The same read as GET, for a screen's \"read again\". Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","meta","assets","refresh"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/meta/assets/refresh"}}},{"name":"TikTok pixels to choose from","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Reads the advertiser's pixels from TikTok and the current choice. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","tiktok","assets"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/tiktok/assets"}}},{"name":"Choose the TikTok pixel","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the pixel (its code, checked against what TikTok lists), then, each only when asked: switches the storefront's TikTok pixel plugin on, and turns the Events API (server-side CompletePayment) on. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","tiktok","assets"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/tiktok/assets"}}},{"name":"Issue the TikTok product feed address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Issues a new capability URL for the store's product feed (tiktok.csv), to give TikTok's Catalog Manager as a Data Feed Schedule source. A new address replaces the old one at once. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections","tiktok","feed"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/tiktok/feed"}}},{"name":"Choose the ad account","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Chooses one of the ad accounts the grant reaches (by id or number); its currency and time zone are read from the provider. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections",":provider","account"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/:provider/account","variable":[{"key":"provider","value":""}]}}},{"name":"Read the ad accounts again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Lists the ad accounts the grant reaches again. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections",":provider","accounts","refresh"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/:provider/accounts/refresh","variable":[{"key":"provider","value":""}]}}},{"name":"Disconnect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets NeroCart's copy of the grant; the account at the provider is untouched. Refused (409 ADS_RUNNING) while the hub's ads may still spend on it. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","connections",":provider","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/connections/:provider/disconnect","variable":[{"key":"provider","value":""}]}}},{"name":"Server-side conversions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the store's server-side conversions did in the last seven days, per destination (meta, tiktok): how they are sent (connection, the Meta pixel's own Conversions API token, or off), whether a Meta test event code is set, how many paid orders were sent, skipped for want of marketing consent, failed or still queued, when the last went and the last failure's code. No token. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","conversions"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/conversions"}}},{"name":"Marketing overview","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's search, visitor and index numbers for a period ending yesterday, read from the stored snapshots only (no provider is called). Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","dashboard"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/dashboard"}}},{"name":"Unified inbox","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"WhatsApp conversations and Instagram/Messenger threads, newest first (ADR-0131). Right: whatsapp.inbox.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox"}}},{"name":"Instagram/Messenger reply","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Text inside the 24-hour window only (WINDOW_CLOSED otherwise), sent with the Page's token. Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox","social",":id","reply"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/social/:id/reply","variable":[{"key":"id","value":""}]}}},{"name":"Send a product or a payment link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A product card (utm_source=\u003cchannel\u003e\u0026utm_medium=dm) or a 48-hour payment link kept as a chat cart. Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox","social",":id","send"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/social/:id/send","variable":[{"key":"id","value":""}]}}},{"name":"Inbox conversation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A conversation with its last 200 messages and its customer. Right: whatsapp.inbox.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox",":kind",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/:kind/:id","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"Assign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Assign to a person (null: no one). Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox",":kind",":id","assign"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/:kind/:id/assign","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"Mark read","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Unread to 0. Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox",":kind",":id","read"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/:kind/:id/read","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"Open or close","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Open or close a conversation (a new message reopens a social thread). Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","inbox",":kind",":id","status"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/inbox/:kind/:id/status","variable":[{"key":"kind","value":""},{"key":"id","value":""}]}}},{"name":"Publish on Instagram","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The product's lead picture with the caption, tagged with the product when it is in the Meta catalog. Right: marketing.write; plan switch social_shop.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","instagram","publish"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/instagram/publish"}}},{"name":"Connect an owned provider","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Starts the provider's consent (ADR-0054, ADR-0055): a single-use state (stored hashed, ten minutes) and a PKCE challenge; the owner returns at /x/hub/oauth/{provider}/callback. Answers 409 NOT_CONFIGURED until the platform's app is set. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","oauth",":provider","start"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/oauth/:provider/start","variable":[{"key":"provider","value":""}]}}},{"name":"Propose a budget change or an ad","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes a draft plan against the state as it is now; a newer draft of the same subject supersedes the older. Nothing changes until it is approved. budget_policy: the ad budget. ads_launch: a campaign from the \"Reklam ver\" wizard; it must pass the preflight (422 ADS_PREFLIGHT_FAILED) and the budget (409 ADS_NO_BUDGET, ADS_OVER_DAILY_MAX, ADS_OVER_MONTHLY_CAP, ADS_CAP_REACHED). ads_resume / ads_budget: switch a paused campaign on again, change its daily budget. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","plans"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/plans"}}},{"name":"A plan and its run","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","plans",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/plans/:id","variable":[{"key":"id","value":""}]}}},{"name":"Approve a plan","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The trusted approval: the caller names the plan's hash exactly and, for a plan that sets an ad budget, echoes its monthly_max_minor and currency (409 AMOUNT_MISMATCH otherwise). A plan that can raise spend also needs ads.spend, a signed-in person (no token, API key or platform staff) and COS_ADS_SPEND=on on the server (403 ADS_SPEND_RIGHT / ADS_SPEND_NEEDS_PERSON / ADS_SPEND_OFF \"Reklam harcaması bu sunucuda kapalı\"); one that only lowers spend needs marketing.write alone. The budget must still be the one the plan was made against (409 PLAN_STALE). Creates the run idempotently (a second approval returns the same run) and queues it. An ads plan (launch, resume, a higher daily budget) is a raise: it also needs the budget to hold it at approval and again when the run switches it on (409 ADS_NO_BUDGET, ADS_OVER_DAILY_MAX, ADS_OVER_MONTHLY_CAP, ADS_CAP_REACHED). The run creates a campaign PAUSED, re-reads it and enables it last; a failure leaves it paused. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","plans",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/plans/:id/approve","variable":[{"key":"id","value":""}]}}},{"name":"Refresh the numbers","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues a refresh of one source (or every source) of the caller's store; a source refreshed by hand less than 15 minutes ago is reported as throttled. Calls no provider itself. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","refresh"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/refresh"}}},{"name":"Telegram card","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's Telegram bot (ADR-0057): its state, @username, the linked chats and what each hears. Read from NeroCart's rows only (Telegram is not called); never the token. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram"}}},{"name":"Connect the Telegram bot","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Checks the token @BotFather gave (getMe), keeps it sealed and points the bot's webhook at https://\u003cstore's primary domain\u003e/x/hub/in/telegram/\u003croute token\u003e with a secret header (only their hashes are kept; allowed_updates message and my_chat_member). An empty token with a bot connected sets the webhook again with the stored token (new route token and secret). Another bot replaces the old one and its linked chats. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","connect"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/connect"}}},{"name":"Disconnect the Telegram bot","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets the bot, its linked chats and its link codes, and asks Telegram to stop sending updates (best effort). The bot itself stays at @BotFather. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/disconnect"}}},{"name":"A link to connect a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Issues a one-time code (15 minutes; only its hash is kept) as two Telegram links: url opens a private chat with the bot (t.me/\u003cbot\u003e?start=\u003ccode\u003e), group_url adds the bot to a group (?startgroup=\u003ccode\u003e). The chat that sends /start with the code is linked. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","link"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/link"}}},{"name":"Choose what a chat hears","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sets the kinds one linked chat hears (order_new, order_paid, owner_request, ads_cap, connection, contact_message). Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","recipients",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/recipients/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a chat","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Unlinks one chat (\"Kaldır\"); it hears nothing more. Right: marketing.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","recipients",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/recipients/:id","variable":[{"key":"id","value":""}]}}},{"name":"Send a test message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues \"NeroCart deneme mesajı\" to every active linked chat (whatever it chose to hear); a job sends it. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","telegram","test"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/telegram/test"}}},{"name":"WhatsApp settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's WhatsApp number on the Meta connection (ADR-0058): state, number, display name and its review, quality, templates and their review, this month's template messages and the cap, order updates switch, the store's own numbers, a number change in progress. Read from NeroCart's rows only. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp"}}},{"name":"WhatsApp campaigns","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's marketing campaigns, newest first, each with its report (sent, delivered, read, failed, replies). Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns"}}},{"name":"Draft a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An approved MARKETING template, its values, the audience filter and the count as it is now. Nothing is sent. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns"}}},{"name":"Count the audience","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"How many customers a campaign would reach: a granted commercial MESAJ consent that İYS confirmed, not suppressed, narrowed by the filter; the estimated cost when a per-message price is set. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns","audience"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns/audience"}}},{"name":"A campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One campaign with its report. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns/:id","variable":[{"key":"id","value":""}]}}},{"name":"Cancel a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stops a draft or a sending campaign: what was not queued yet is never sent. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Send a campaign","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends a draft. It costs money, so it is guarded like raising ad spend (ADR-0052): ads.spend, a signed-in person (ADS_SPEND_NEEDS_PERSON) and COS_ADS_SPEND=on (ADS_SPEND_OFF); confirm_count must be the audience now (COUNT_CHANGED) and the campaign must fit under the monthly template cap (WA_CAP). The recipients are recorded once; a job sends within Meta's messaging limit. A campaign already sending answers 200 with itself. Right: ads.spend.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","campaigns",":id","send"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/campaigns/:id/send","variable":[{"key":"id","value":""}]}}},{"name":"WhatsApp conversations","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's conversations, newest first, with whether the customer service window is open. Right: whatsapp.inbox.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","conversations"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/conversations"}}},{"name":"A conversation","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The last 200 messages and the approved Utility templates a reply may use outside the window. Right: whatsapp.inbox.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","conversations",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/conversations/:id","variable":[{"key":"id","value":""}]}}},{"name":"Mark read","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","conversations",":id","read"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/conversations/:id/read","variable":[{"key":"id","value":""}]}}},{"name":"Reply","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Free-form text only inside the customer service window (WINDOW_CLOSED otherwise), or an approved template with its parameters; a Marketing template needs the customer's MESAJ consent confirmed in İYS (NO_CONSENT). Queued; a job sends. Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","conversations",":id","reply"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/conversations/:id/reply","variable":[{"key":"id","value":""}]}}},{"name":"Send a product, a product list, the catalog or a payment link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Inside the customer's 24-hour window only; a payment link is kept as a chat cart. Right: whatsapp.inbox.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","conversations",":id","send"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/conversations/:id/send","variable":[{"key":"id","value":""}]}}},{"name":"Forget the WhatsApp number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Releases the route, unsubscribes the app (best effort) and forgets the templates; conversations stay under their retention. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/disconnect"}}},{"name":"Choose the WhatsApp number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Checks the WABA and number against Meta's answer, claims the WABA's inbound route (ROUTE_TAKEN when another store holds it), subscribes the app to the WABA's webhooks and reads its templates. Choosing another number of the same account switches numbers. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number"}}},{"name":"Register the number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Registers the store's chosen number on the Cloud API (Meta answered 133010 on a send) with a new six-digit two-step PIN, sealed and in this answer only. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","activate"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/activate"}}},{"name":"Add a new number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds the number (cc + national number, verified_name: the display name; the store's name by default) to the store's WABA, or adopts it when it is already in the WABA's list. Sending stays on the current number until the new one is registered. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","new"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/new"}}},{"name":"Cancel the number change","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets the pending number; the store keeps its number. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","new","cancel"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/new/cancel"}}},{"name":"Send the verification code","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Meta sends the pending number a code by SMS or a voice call (language tr). NUMBER_IN_USE when Meta will not (the number is probably still on the WhatsApp app). Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","new","code"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/new/code"}}},{"name":"Register the new number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Makes a six-digit two-step verification PIN (kept sealed), registers the verified number for the Cloud API and only then switches the store to it. The PIN is in this answer only. Optionally takes the old number off the Cloud API (deregister_old). Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","new","register"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/new/register"}}},{"name":"Verify the code","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","new","verify"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/new/verify"}}},{"name":"Reset the PIN","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sets a new two-step verification PIN on the store's number; the PIN is in this answer only. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","number","pin"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/number/pin"}}},{"name":"WhatsApp numbers the grant reaches","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Read from Meta: the WhatsApp Business Accounts of the person's business portfolios (owned and client) and those the grant's granular scopes name (debug_token), each with its phone numbers. NEEDS_REAUTH when the grant lacks whatsapp_business_management / whatsapp_business_messaging. Right: marketing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","numbers"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/numbers"}}},{"name":"WhatsApp switches","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Order updates to shoppers who asked (customer_notify) and the monthly cap on template messages (template_cap, default 1000). Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/settings"}}},{"name":"Add a staff number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adds one of the store's own numbers (E.164; Türkiye by default) with the kinds it hears. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","staff"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/staff"}}},{"name":"Change a staff number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Kinds and active. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","staff",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/staff/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a staff number","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right: marketing.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","staff",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/staff/:id","variable":[{"key":"id","value":""}]}}},{"name":"Write a marketing template","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Submits a MARKETING template (Turkish) to the WABA for Meta's review; a template of that name is never submitted twice. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","templates"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/templates"}}},{"name":"Read the templates again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Reads the WABA's message templates and their review from Meta. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","templates","refresh"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/templates/refresh"}}},{"name":"Submit the standard templates","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Submits NeroCart's Utility templates in Turkish (siparis_alindi, kargoya_verildi, teslim_edildi, yeni_siparis_bildirimi) that the WABA does not have yet, each found by name first; Meta reviews them. Right: marketing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","hub","whatsapp","templates","standard"],"raw":"{{baseUrl}}/api/v1/admin/x/hub/whatsapp/templates/standard"}}}],"name":"hub"},{"item":[{"name":"Test the Paraşüt connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Signs in to Paraşüt now with the saved settings (whether or not the integration is switched on yet) — a fresh OAuth password grant with the client id and secret, user and password — and reads GET /v4/me with the user's companies, the cheapest authenticated call. `ok` is true when the sign-in worked and the saved company number is one of the user's companies. Nothing is created at Paraşüt and nothing is stored; the answer never carries a credential or a token. 409 when the settings are incomplete. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","invoicing-parasut","test"],"raw":"{{baseUrl}}/api/v1/admin/x/invoicing-parasut/test"}}}],"name":"invoicing-parasut"},{"item":[{"name":"The store's cookie consent configuration","request":{"auth":{"type":"noauth"},"description":"What the storefront's cookie banner asks and which third-party tags each answer allows (ADR-0038): whether the banner is on, the consent version a stored choice must name (a visitor whose choice names an older one is asked again), the store's own wording per language if any, the four categories with the tools (enabled plugins) in each, and the tags grouped by category. `active` is whether the banner must be shown: on, and at least one non-essential tag to ask about. While the banner is off no tag is handed out: nothing non-essential may load without consent. Not cacheable by intermediaries.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","cookie-consent"],"raw":"{{baseUrl}}/api/v1/store/cookie-consent"}}},{"name":"Record a visitor's cookie choice (anonymous)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores one choice made in the banner or the preferences dialog as an anonymous record: a random consent id (the one sent back, if the browser kept an earlier one, else a new one), the categories, the version answered, the time and a user agent class (desktop, mobile, tablet, bot, other). No IP address is stored in any form and no full user agent. `accept_all` must accept every category, `reject_all` none; `withdraw` takes back a category granted earlier. A version other than the store's current one answers 409 `consent_version_changed` (ask again); a store whose banner is off answers 409 `cookie_consent_off`. Limited per client and store (10 a minute) besides the general limits: 429 `rate_limited` with Retry-After. Records are deleted after 730 days.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","cookie-consent"],"raw":"{{baseUrl}}/api/v1/store/cookie-consent"}}},{"name":"The store's published legal texts","request":{"auth":{"type":"noauth"},"description":"One live version per kind, in the reader's language (else the store's default, else Turkish).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","legal"],"raw":"{{baseUrl}}/api/v1/store/legal"}}},{"name":"A published legal text, rendered","request":{"auth":{"type":"noauth"},"description":"The live version with the seller's details filled in, and — when cart_id is given — the basket's products, shipping, tax, total including every tax, payment method and delivery, figured for the checkout's choices so far (payment_method, shipping_rate, country, state): what the shopper reads before accepting. A basket with nothing to send reads digital delivery with no address, and the text's {{#physical}}…{{/physical}} / {{#digital}}…{{/digital}} sections keep only what applies to the basket.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","legal",":kind"],"raw":"{{baseUrl}}/api/v1/store/legal/:kind","variable":[{"key":"kind","value":""}]}}}],"name":"legal"},{"item":[{"name":"The store domain's aliases","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Mail to an alias goes to another address. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","aliases"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/aliases"}}},{"name":"Add an alias","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"On the store's mail domain. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","aliases"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/aliases"}}},{"name":"Delete an alias","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The address must be on the store's mail domain. Right store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","aliases",":source"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/aliases/:source","variable":[{"key":"source","value":""}]}}},{"name":"The mail domain's DNS records","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The records to publish, their live state and, on NeroCart's DNS, the change an apply would make. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","dns"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/dns"}}},{"name":"Write the mail records","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"On NeroCart's DNS only: writes MX, SPF, DKIM and a starter DMARC through the ready mail setup (an MX pointing elsewhere is replaced). Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","dns","apply"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/dns/apply"}}},{"name":"Set up the mail domain","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Puts the store's live domain at Uzman Posta (organization, domain, DKIM); running it again changes nothing. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","domain"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/domain"}}},{"name":"The store domain's group addresses","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each with its members. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","groups"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/groups"}}},{"name":"Add a group address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Mail to it goes to every member. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","groups"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/groups"}}},{"name":"Set a group's members","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces the members. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","groups",":email"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/groups/:email","variable":[{"key":"email","value":""}]}}},{"name":"Delete a group address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The address must be on the store's mail domain. Right store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","groups",":email"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/groups/:email","variable":[{"key":"email","value":""}]}}},{"name":"The store domain's mail and sign-in log","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"kind=signin for sign-ins; else direction in|out (last 30 days, 100 at most), optionally one address. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","logs"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/logs"}}},{"name":"Add a mailbox","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The free mailbox when it is still to come; otherwise a paid 1 GB mailbox waiting for payment. The password is answered once. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes"}}},{"name":"Delete a mailbox","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Deletes the mailbox and its mail at Uzman Posta. Right store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id","variable":[{"key":"id","value":""}]}}},{"name":"A mailbox's folders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Signed in as the mailbox. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","folders"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/folders","variable":[{"key":"id","value":""}]}}},{"name":"A folder's messages","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first, a page at a time. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","messages"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/messages","variable":[{"key":"id","value":""}]}}},{"name":"Read a message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Marks it read at the provider. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","messages",":mid"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/messages/:mid","variable":[{"key":"id","value":""},{"key":"mid","value":""}]}}},{"name":"Mark or move a message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"read, unread, flag, unflag, trash, spam or unspam. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","messages",":mid","action"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/messages/:mid/action","variable":[{"key":"id","value":""},{"key":"mid","value":""}]}}},{"name":"Set a mailbox password","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An empty password generates one; the new password is answered once. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","password"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/password","variable":[{"key":"id","value":""}]}}},{"name":"Give a mailbox a new address","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Same domain; the mail, password and package stay. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","rename"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/rename","variable":[{"key":"id","value":""}]}}},{"name":"Send a message","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"From the mailbox, as plain text; reply_to answers a message. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","send"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/send","variable":[{"key":"id","value":""}]}}},{"name":"A mailbox's settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Name, auto-reply, a copy of incoming mail, signature, sending stopped, last sign-in. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/settings","variable":[{"key":"id","value":""}]}}},{"name":"Change a mailbox's settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only the fields given change; answers the settings fresh. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/settings","variable":[{"key":"id","value":""}]}}},{"name":"Ask for a bigger quota","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records a request for a bigger package at the platform's price; NeroCart applies it once paid. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","mailboxes",":id","upgrade"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/mailboxes/:id/upgrade","variable":[{"key":"id","value":""}]}}},{"name":"Moves from the old mail server","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store domain's moves with their progress. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","moves"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/moves"}}},{"name":"Move mail from the old server","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Copies an old mailbox's mail into one of the store's mailboxes over IMAP or POP3. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","moves"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/moves"}}},{"name":"Stop a move","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The move must be the store domain's. Right store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","moves",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/moves/:id","variable":[{"key":"id","value":""}]}}},{"name":"The store's mail","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The mail domain, the mailboxes with the quota in use, the packages on sale and whether the free mailbox is still to come. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","overview"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/overview"}}},{"name":"The store's mailbox requests","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Newest first. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","requests"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/requests"}}},{"name":"Withdraw a request","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only one still waiting for payment; a mailbox that waited for it goes. Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","requests",":id","cancel"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/requests/:id/cancel","variable":[{"key":"id","value":""}]}}},{"name":"Pay a request on NeroCart's store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Readies a request waiting for payment for the operator store's checkout and answers the platform storefront address that puts it in the basket and opens the checkout with the method chosen (card: applied the moment the payment succeeds; bank_transfer: waits for NeroCart to confirm the money). A request with a transfer already placed is refused (409, reason transfer_placed). Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","requests",":id","pay"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/requests/:id/pay","variable":[{"key":"id","value":""}]}}},{"name":"Senders always let in or refused","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store domain's incoming rules. Right store.write.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","senders"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/senders"}}},{"name":"Add a sender rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An address or a domain, let in (allow) or refused (block). Right store.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","senders"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/senders"}}},{"name":"Delete a sender rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The rule must be the store domain's. Right store.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","mail-mxlayer","senders",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/mail-mxlayer/senders/:id","variable":[{"key":"id","value":""}]}}}],"name":"mail-mxlayer"},{"item":[{"name":"Count an opening of a partner's link","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The storefront calls it when its partner link is opened. 404 for no active partner with the code.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","affiliates",":code","click"],"raw":"{{baseUrl}}/api/v1/store/affiliates/:code/click","variable":[{"key":"code","value":""}]}}}],"name":"marketing"},{"item":[{"name":"Marketplaces","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every installed marketplace for this store: the credential fields, whether it is connected (never a secret), its settings and the counts worth a line (live, waiting, problems, orders needing attention, returns and questions waiting). Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace","overview"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/overview"}}},{"name":"Find brands","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The marketplace's brands by name (at least two letters, at most 30 answers). Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","brands"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/brands","variable":[{"key":"code","value":""}]}}},{"name":"Find categories","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Leaf categories of the marketplace (cached a week): by words (q), or the five best suggestions for one of the store's categories (for) by plain word overlap. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","categories"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/categories","variable":[{"key":"code","value":""}]}}},{"name":"Category attributes","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the marketplace asks of a product in one of its categories, with the values offered. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","categories",":external","attributes"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/categories/:external/attributes","variable":[{"key":"code","value":""},{"key":"external","value":""}]}}},{"name":"Category maps","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Every store category with its product count and the marketplace category (and fixed attribute answers) it is mapped to. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","category-maps"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/category-maps","variable":[{"key":"code","value":""}]}}},{"name":"Map a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Maps a store category (and the ones under it that have no map) to a leaf category of the marketplace, with the fixed answers to its required attributes (variant attributes come from each variant's options). Variants that waited for the map are queued again. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","category-maps",":category"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/category-maps/:category","variable":[{"key":"code","value":""},{"key":"category","value":""}]}}},{"name":"Unmap a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removes the map; listings already sent stay. Right: marketplace.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","category-maps",":category"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/category-maps/:category","variable":[{"key":"code","value":""},{"key":"category","value":""}]}}},{"name":"Returns","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The marketplace's returns, waiting ones first, and (when one waits) the reasons a refusal may give. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","claims"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/claims","variable":[{"key":"code","value":""}]}}},{"name":"Accept a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Accepts every waiting item of the return on the marketplace. The goods are received on the order's return screen when they arrive. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","claims",":id","approve"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/claims/:id/approve","variable":[{"key":"code","value":""},{"key":"id","value":""}]}}},{"name":"Refuse a return","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Opens a refusal on the marketplace with a reason and an explanation. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","claims",":id","reject"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/claims/:id/reject","variable":[{"key":"code","value":""},{"key":"id","value":""}]}}},{"name":"Connect a marketplace","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Checks the pasted credentials with one call to the marketplace, then stores them sealed (never returned) and starts the first sync. A refusal stores nothing. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","connect"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/connect","variable":[{"key":"code","value":""}]}}},{"name":"Disconnect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets the credentials and stops every job for this store; listings and orders stay as history. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/disconnect","variable":[{"key":"code","value":""}]}}},{"name":"List or stop products","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"list: queues every variant of the products to be sent (refused or failed ones are sent again; stopped ones sell again). stop: stops selling (quantity 0 on the marketplace); never-sent ones are dropped. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","listings"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/listings","variable":[{"key":"code","value":""}]}}},{"name":"Orders that need the store","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Marketplace orders that could not become orders here: stock short (retried every minute) or a line that names nothing the store sells. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","orders"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/orders","variable":[{"key":"code","value":""}]}}},{"name":"Cannot supply","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Tells the marketplace the store cannot supply the order (it cancels and refunds its customer) and cancels it here. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","orders",":id","unsupplied"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/orders/:id/unsupplied","variable":[{"key":"code","value":""},{"key":"id","value":""}]}}},{"name":"Products on the marketplace","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's products, each with one status line on this marketplace and the price it is asked. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","products"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/products","variable":[{"key":"code","value":""}]}}},{"name":"A product's own price","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sets (or, with null or 0, removes) the product's price on the marketplace, overriding the rule. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","products",":product","price"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/products/:product/price","variable":[{"key":"code","value":""},{"key":"product","value":""}]}}},{"name":"Customer questions","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Questions about the store's products, waiting ones first. Right: marketplace.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","questions"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/questions","variable":[{"key":"code","value":""}]}}},{"name":"Answer a question","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends the answer (10–2000 characters). Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","questions",":id","answer"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/questions/:id/answer","variable":[{"key":"code","value":""},{"key":"id","value":""}]}}},{"name":"Save settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Price rule, stock buffer, default brand, delivery promise; every live listing's price and quantity is sent again. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/settings","variable":[{"key":"code","value":""}]}}},{"name":"Sync now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Queues a sync pass (orders, listings, stock and prices, invoices, returns, questions). Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","sync"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/sync","variable":[{"key":"code","value":""}]}}},{"name":"Test the connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Calls the marketplace with the stored credentials and records the result. Right: marketplace.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","marketplace",":code","test"],"raw":"{{baseUrl}}/api/v1/admin/x/marketplace/:code/test","variable":[{"key":"code","value":""}]}}}],"name":"marketplace"},{"item":[{"name":"Trade an app's code for its access token (RFC 6749 §4.1.3)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Form-encoded: grant_type=authorization_code, code, redirect_uri, client_id and client_secret (or HTTP Basic), code_verifier when a challenge was sent. The token is an API key bound to the store, narrowed to the approved rights. Answers in RFC 6749's own shape.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","oauth","token"],"raw":"{{baseUrl}}/api/v1/store/oauth/token"}}}],"name":"oauth"},{"item":[{"name":"Download a file","request":{"auth":{"type":"noauth"},"description":"Counts one opening; 410 once the link has expired or was used up.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","downloads",":token"],"raw":"{{baseUrl}}/api/v1/store/downloads/:token","variable":[{"key":"token","value":""}]}}},{"name":"Find your own order by its number and e-mail address","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A shopper who kept neither the order's link nor an account finds the order with what they have: its number and the e-mail address it was placed with. A match answers the number and the access token — the credential of GET /api/orders/{number}. The number is taken as typed or in capitals, with or without a leading \"#\"; the address is compared whole, without regard to case. A number that does not exist and an address that is not the order's are the same 404, so the route does not say which numbers exist. Lookups are budgeted per visitor and per order number (429 with Retry-After). Answered Cache-Control: no-store.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders","lookup"],"raw":"{{baseUrl}}/api/v1/store/orders/lookup"}}},{"name":"Look up your own order","request":{"auth":{"type":"noauth"},"description":"Guest checkout means there is no account to log into, so the order's access token — returned once at checkout — is the credential. A wrong token is reported as not found, so this cannot be used to discover which order numbers exist.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number"],"raw":"{{baseUrl}}/api/v1/store/orders/:number","variable":[{"key":"number","value":""}]}}},{"name":"A paid order's download links","request":{"auth":{"type":"noauth"},"description":"For whoever holds the order's access token (the order page).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","downloads"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/downloads","variable":[{"key":"number","value":""}]}}},{"name":"What a guest accepted on their order","request":{"auth":{"type":"noauth"},"description":"The accepted legal texts as rendered at checkout, with their hashes; the order's access token is the credential.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","legal"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/legal","variable":[{"key":"number","value":""}]}}},{"name":"An accepted contract as a file","request":{"auth":{"type":"noauth"},"description":"The distance sales contract or the pre-contractual information form exactly as the shopper accepted it, as a PDF (HTML for a right-to-left language such as Arabic); the order's access token is the credential.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","legal",":kind","file"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/legal/:kind/file","variable":[{"key":"number","value":""},{"key":"kind","value":""}]}}},{"name":"Your order's codes","request":{"auth":{"type":"noauth"},"description":"The codes of a paid order that are delivered (not held for the store's review), with the order's access token as the credential — the same as GET /api/orders/{number}; a wrong token is not found. Answered Cache-Control: no-store. The first read of each code is recorded (viewed_at). The order read itself carries only counts (line_items[].licence_keys).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","licence-keys"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/licence-keys","variable":[{"key":"number","value":""}]}}},{"name":"Read the shop's notes on your order","request":{"auth":{"type":"noauth"},"description":"The notes the shop marked for the customer, behind the same access-token check as the order itself. A wrong token is reported as not found. Internal notes and their authors are never shown.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","notes"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/notes","variable":[{"key":"number","value":""}]}}},{"name":"Pay an unpaid order again (the shopper, with the order's link)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Starts a new payment for an order placed and not paid — the card was refused on the bank's 3-D Secure page, the shopper left the provider's page, or they want another method — without placing anything again (ADR-0134). The order's access token is the credential, as on GET /api/orders/{number}; a wrong number or token is a 404. `code` is any method the store offers now (GET /api/checkout), `card_router` included; not `in_store` or `on_account`. Choosing another method records it on the order (audited); a bank transfer writes its instructions, or refuses a currency it has no account in (400, `details.reason` = `payment_method_unavailable`), as does cash on delivery for an order with nothing to send. The amount is the order's due amount (gift cards already applied stay applied). An open payment with the same method is resumed (the provider sees the same initiation key); open payments with other methods are left as they are. Refused with 409 when the order is cancelled (`order_cancelled`), paid or holding money at a provider (`order_paid`), refunded (`order_refunded`), or not waiting for a payment from its page — confirmed for payment at the door, for one (`order_not_payable`). Send an `Idempotency-Key` header: the same key with the same body replays the first answer; with a different body it is a 400. Answers with the checkout's own shape: the order (with its `access_token`) and the payment intent to act on.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","pay",":code"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/pay/:code","variable":[{"key":"number","value":""},{"key":"code","value":""}]}}},{"name":"Note that the confirmation served the GA4 purchase mark","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The storefront says it rendered the order's purchase mark on its confirmation page (ADR-0137): one row per order, counted, for the admin's measurement check. The order's access token is the credential; a wrong number or token is a 404. A test order records nothing. No body.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","purchase-mark"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/purchase-mark","variable":[{"key":"number","value":""}]}}},{"name":"Ask for a return (the shopper, with the order's link)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The order's access token is the credential, as on GET /api/orders/{number}; a wrong number or token is a 404. Records a return in `requested` for the lines named, holding their units so two requests cannot claim the same unit; nothing moves until the store authorizes it, and the store may reject it. Only goods that left the store can be asked back: an order not yet shipped, a quantity above what was sold, shipped, or already asked back is a 400. The shopper decides nothing else — no shipping refund, no metadata (an unknown field is a 400). The request is audited as the customer's and announced as `return.requested`. Answers with the shopper's order, `return_requests` included. An `Idempotency-Key` header makes the request safe to repeat: the same key on the same order with the same lines and reason answers 201 with the order as the first request left it and asks for nothing again (header `Idempotent-Replayed: true`); the key with a different request is a 400. Without a key every request is its own.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","orders",":number","returns"],"raw":"{{baseUrl}}/api/v1/store/orders/:number/returns","variable":[{"key":"number","value":""}]}}}],"name":"orders"},{"item":[{"name":"Customer groups","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Groups a price list can be aimed at. Membership is by email address, because this engine has no customers table — a customer is an address that has ordered.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups"}}},{"name":"Create a customer group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups"}}},{"name":"One customer group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id","variable":[{"key":"id","value":""}]}}},{"name":"Rename or re-code a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a customer group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Takes its membership and the price lists aimed at it with it. Cascading rather than refusing, unlike a category with products under it: a product orphaned by a deleted category is still valuable and has merely lost its filing, while a price list whose audience has gone is meaningless — it would price for nobody and could never be reached again.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id","variable":[{"key":"id","value":""}]}}},{"name":"Who is in a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Takes `customers.read` rather than the discounts right the rest of these routes take: it answers with the shop's customer addresses, and somebody trusted to write a promotion is not thereby trusted to page through the customer list.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id","members"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id/members","variable":[{"key":"id","value":""}]}}},{"name":"Add an address to a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Adding one twice is not an error: the caller asked for it to be a member, and it is. The address travels in the body rather than the path because an email in a URL is an email in an access log.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id","members"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id/members","variable":[{"key":"id","value":""}]}}},{"name":"Remove an address from a group","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Removing one that is not in leaves the world as the caller asked, so it is not an error.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id","members"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id/members","variable":[{"key":"id","value":""}]}}},{"name":"Add or remove many addresses","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A paste or a CSV column; invalid entries are listed back. 409 AUTOMATIC_GROUP for the registered-customers group. Audited (customer_group.members). Right: groups.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","customer-groups",":id","members","bulk"],"raw":"{{baseUrl}}/api/v1/admin/customer-groups/:id/members/bulk","variable":[{"key":"id","value":""}]}}},{"name":"Price lists","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Highest priority first. A list prices a variant for a group, over a window, optionally at quantity breaks. Resolution takes the most specific break, then the higher priority, then the cheaper price.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists"],"raw":"{{baseUrl}}/api/v1/admin/price-lists"}}},{"name":"Create a price list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists"],"raw":"{{baseUrl}}/api/v1/admin/price-lists"}}},{"name":"One price list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change a price list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"`group_id` takes the nullable form: sending null makes the list everybody's, which is a real intention an absent field could not express.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id","variable":[{"key":"id","value":""}]}}},{"name":"Delete a price list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id","variable":[{"key":"id","value":""}]}}},{"name":"What a list prices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id","prices"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id/prices","variable":[{"key":"id","value":""}]}}},{"name":"Set one variant's price on a list","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"PUT rather than POST because the row is identified by what the body carries — list, variant and break — so sending it twice states the same fact twice rather than creating two prices.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id","prices"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id/prices","variable":[{"key":"id","value":""}]}}},{"name":"Remove one price","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","price-lists",":id","prices"],"raw":"{{baseUrl}}/api/v1/admin/price-lists/:id/prices","variable":[{"key":"id","value":""}]}}},{"name":"A product's group prices (Grup fiyatları)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's groups and, per group, the rows of its own price list (its highest-priority list in the base currency) for this product's variants. Right: pricing.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","group-prices"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/group-prices","variable":[{"key":"id","value":""}]}}},{"name":"Replace a product's group prices","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Replaces this product's rows on each group's own list (made, active, when the group has none). One price per group, variant and minimum quantity. Audited (product.group_prices); price.changed. Right: pricing.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","products",":id","group-prices"],"raw":"{{baseUrl}}/api/v1/admin/products/:id/group-prices","variable":[{"key":"id","value":""}]}}}],"name":"pricing"},{"item":[{"name":"Screens modules contributed","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the panel builds its module navigation from. Filtered by the caller's rights, so an entry is never offered to somebody it would answer 403 to — and filtered rather than refused outright, because this list *is* the nav: a 403 here would leave an operator with a panel missing entries instead of a panel without the ones they cannot use.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","screens"],"raw":"{{baseUrl}}/api/v1/admin/screens"}}}],"name":"screens"},{"item":[{"name":"Connect Bing Webmaster","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Stores the pasted API key (sealed plugin secret) when given, then reconciles: adopts the site when Bing already lists it, adds it otherwise (an 'already exists' answer re-reads the list), skips verification when Bing says verified, else publishes Bing's msvalidate.01 token and asks Bing to verify; submits the sitemap when asked; reads the crawl summary. Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","bing","connect"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/bing/connect"}}},{"name":"Forget the Bing key","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Removes the stored API key. The site at Bing, its verification and the published tag stay. Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","bing","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/bing/disconnect"}}},{"name":"Switch IndexNow","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"On: generates the store's IndexNow key when it has none and switches the IndexNow plugin on (the storefront serves /{key}.txt; page changes are submitted to api.indexnow.org at most once per 5 minutes). Off: nothing is queued or sent. Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","indexnow"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/indexnow"}}},{"name":"Search engine status","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"IndexNow, Bing and Yandex for this store: one state per engine (`not_connected`, `verifying`, `verified`, `failed`), the site, the sitemap, a summary and a problem code. No key or token. Right: search-engines.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","overview"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/overview"}}},{"name":"Forget the Yandex grant","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets NeroCart's copy of the Yandex grant. The host at Yandex, its verification and the published tag stay. Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","yandex","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/yandex/disconnect"}}},{"name":"Start the Yandex sign-in","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Returns Yandex's consent page URL (scopes webmaster:hostinfo webmaster:verify, PKCE S256, single-use state for 10 minutes). The owner signs in on Yandex's own page. Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines","yandex","start"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/yandex/start"}}},{"name":"Check an engine now","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Runs the engine's reconciliation now (adopt or add the site, verify when needed, sitemap, summary). Right: search-engines.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","search-engines",":engine","check"],"raw":"{{baseUrl}}/api/v1/admin/x/search-engines/:engine/check","variable":[{"key":"engine","value":""}]}}}],"name":"search-engines"},{"item":[{"name":"The shipping carbon estimate's settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Kargo › Kargo karbon tahmini göster: the switch (off by default), the \"En düşük salım\" tag, each rate's transport mode where the merchant chose one, the dispatch point, and the emission factors with their source (read-only). Right: shipping.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","carbon"],"raw":"{{baseUrl}}/api/v1/admin/shipping/carbon"}}},{"name":"Replace the shipping carbon estimate's settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A mode is road, van or air, keyed by a shipping rate id; origin_lat and origin_lon come together. Audited as cross_border.carbon_update. Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","carbon"],"raw":"{{baseUrl}}/api/v1/admin/shipping/carbon"}}},{"name":"Carriers' legal identities","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each carrier's unvan, VKN and tax office as the store's contract names them — what an invoice prints for the carrier.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","carrier-profiles"],"raw":"{{baseUrl}}/api/v1/admin/shipping/carrier-profiles"}}},{"name":"Find a carrier's legal identity","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"A carrier the engine knows answers with its unvan, VKN and tax office; for any other, a typed VKN or TCKN is looked up in the store's e-invoice integrator (the GİB user list) and answers with the company's unvan. Nothing found is found: false.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","carrier-profiles","lookup"],"raw":"{{baseUrl}}/api/v1/admin/shipping/carrier-profiles/lookup"}}},{"name":"Record a carrier's legal identity","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The VKN's check digit is verified.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","carrier-profiles",":carrier"],"raw":"{{baseUrl}}/api/v1/admin/shipping/carrier-profiles/:carrier","variable":[{"key":"carrier","value":""}]}}},{"name":"Ask a carrier to collect","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Books a courier pickup for shipments a carrier has booked and not yet collected.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","pickups"],"raw":"{{baseUrl}}/api/v1/admin/shipping/pickups"}}},{"name":"Price a method inside a zone","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The band is half-open: min_subtotal_minor is inclusive and max_subtotal_minor exclusive, so a Standard at 4900 below 200000 and a Standard at 0 from 200000 are one method the shopper recognises and cannot both claim a basket. Two bands of one name that do overlap are refused, because a shopper offered the same method at two prices has no way to choose.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","rates"],"raw":"{{baseUrl}}/api/v1/admin/shipping/rates"}}},{"name":"Change a rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A partial update: only the keys present in the body change, and a key left out keeps its value. max_subtotal_minor null removes the band's ceiling; active null is the same as leaving it out. An unknown key is refused with 400. A body carrying every field behaves as a full replace. Answers with the whole rate.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","rates",":id"],"raw":"{{baseUrl}}/api/v1/admin/shipping/rates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a rate","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","rates",":id"],"raw":"{{baseUrl}}/api/v1/admin/shipping/rates/:id","variable":[{"key":"id","value":""}]}}},{"name":"Where this store delivers, and what it charges","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Each zone carries its own rates: a zone with no prices is not something an operator can use, so the two are never shown apart.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","zones"],"raw":"{{baseUrl}}/api/v1/admin/shipping/zones"}}},{"name":"Add a zone","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Countries and states are ISO codes, and both empty is the catch-all zone that every more specific zone beats.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","zones"],"raw":"{{baseUrl}}/api/v1/admin/shipping/zones"}}},{"name":"Change a zone","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A partial update: only the keys present in the body change, and a key left out keeps its value. An array sent as [] or null is cleared. An unknown key is refused with 400. A body carrying every field behaves as a full replace. Answers with the whole zone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","zones",":id"],"raw":"{{baseUrl}}/api/v1/admin/shipping/zones/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a zone","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its rates go with it.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","shipping","zones",":id"],"raw":"{{baseUrl}}/api/v1/admin/shipping/zones/:id","variable":[{"key":"id","value":""}]}}},{"name":"What delivering one item costs, per destination country","request":{"auth":{"type":"noauth"},"description":"The checkout's own rate table asked without a cart, for a product page's structured data (OfferShippingDetails, P1-19): the subtotal is the item's price in the given currency, and every country is quoted with the most specific zone that names it without a state. Only table rates in that currency whose band holds the subtotal are listed; live carrier rates have no price without a cart and are left out; a country nothing covers is left out. A store with no rates configured (flat shipping) answers configured = false and no destinations.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","shipping","offers"],"raw":"{{baseUrl}}/api/v1/store/shipping/offers"}}}],"name":"shipping"},{"item":[{"name":"Test the Aras Kargo connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks Aras Kargo's booking service (GetBarcode) for the label of an integration code that does not exist, with the saved web service user — and, when the customer code is saved, its tracking service (GetQueryJSON) about the same code — whether or not the carrier is switched on yet. Nothing is booked at Aras Kargo and nothing is stored. `ok` is true when Aras Kargo accepted the credentials; otherwise `error` carries Aras Kargo's words, never a password. 409 when the required credentials are not saved yet. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-aras","test"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-aras/test"}}}],"name":"shipping-aras"},{"item":[{"name":"Test the MNG Kargo connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks MNG's Identity API (POST /mngapi/api/token) for a new token with the saved API Zone application, customer number and password, whether or not the carrier is switched on yet. Nothing is booked at MNG Kargo and nothing is stored. `ok` is true when MNG Kargo accepted the credentials; otherwise `error` carries MNG Kargo's words, never a password. 409 when the required credentials are not saved yet. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-mng","test"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-mng/test"}}}],"name":"shipping-mng"},{"item":[{"name":"Test the PTT Kargo connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks PTT's tracking service (GonderiTakipV2 gonderiSorgu_referansNo) about a reference that does not exist, with the saved customer number and password (or the tracking user), and checks the saved barcode range, whether or not the carrier is switched on yet. Nothing is booked at PTT Kargo and nothing is stored. `ok` is true when PTT Kargo accepted the credentials; otherwise `error` carries PTT Kargo's words, never a password. 409 when the required credentials are not saved yet. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ptt","test"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ptt/test"}}}],"name":"shipping-ptt"},{"item":[{"name":"Test the Sürat Kargo connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks Sürat Kargo's web service (KargoBarkodu) for the label of a tracking key that does not exist, with the saved customer code and web password, whether or not the carrier is switched on yet. Nothing is booked at Sürat Kargo and nothing is stored. `ok` is true when Sürat Kargo accepted the credentials; otherwise `error` carries Sürat Kargo's words, never a password. 409 when the required credentials are not saved yet. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-surat","test"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-surat/test"}}}],"name":"shipping-surat"},{"item":[{"name":"Create UPS shipments for several orders","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Books one UPS shipment per order (up to 25), each exactly as the single ship action does, and reports each order on its own: its tracking number, or why it was not booked. A failure on one order changes nothing on it and does not stop the others. Right: orders.fulfill.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","bulk"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/bulk"}}},{"name":"Connect UPS","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks UPS for an OAuth token with the given client id and secret (empty values keep what is stored). Only when UPS issues one are the credentials sealed and saved and the integration switched on; a refusal answers `ups_credentials_refused` and saves nothing. Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","connect"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/connect"}}},{"name":"Disconnect UPS","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets the client id and secret and switches the integration off. Shipments already booked keep their labels. Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/disconnect"}}},{"name":"Connect UPS Türkiye domestic","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Proves UPS Türkiye's web service user by opening a session (ws.ups.com.tr), then saves it: parcels within Türkiye, cash on delivery included, are booked through UPS Türkiye. An empty password keeps the stored one. 422 ups_tr_credentials_refused, 502 ups_unreachable. Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","domestic","connect"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/domestic/connect"}}},{"name":"Disconnect UPS Türkiye domestic","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Forgets UPS Türkiye's web service user; the integration stays on while the developer.ups.com app is connected. Right: shipping.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","domestic","disconnect"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/domestic/disconnect"}}},{"name":"UPS connection status","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One state (`connected` or `not_connected`), the environment, the UPS account number, the services a shipment can be booked with and the store's defaults. Never a credential. Right: orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-ups","status"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-ups/status"}}}],"name":"shipping-ups"},{"item":[{"name":"Test the Yurtiçi Kargo connection","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Asks Yurtiçi Kargo's web service (queryShipment) about a cargo key that does not exist, with the saved web service user — and the cash-on-delivery user when one is saved — whether or not the carrier is switched on yet. Nothing is booked at Yurtiçi Kargo and nothing is stored. `ok` is true when Yurtiçi Kargo accepted the credentials; otherwise `error` carries Yurtiçi Kargo's words, never a password. 409 when the required credentials are not saved yet. Needs plugins.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","shipping-yurtici","test"],"raw":"{{baseUrl}}/api/v1/admin/x/shipping-yurtici/test"}}}],"name":"shipping-yurtici"},{"item":[{"name":"Ask the store's shopping assistant","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A visitor's question with the conversation before it (kept by the browser only; at most the last 10 turns are read, each at most 1000 characters, the question last). The answer is grounded on the server: one AI call turns the conversation into searches, the store's own catalogue search runs them (published products, in stock first, priced in the request's market and language; a dealers-only price is never shown), and a second AI call writes a short answer from those facts alone, checked again — product cards only for products the search found, no price the facts do not hold, no health claim. With the store's AI budget spent or the provider failing, the answer is the plain search results with a polite line (fallback true). Uses the store's own AI key only. Nothing the visitor wrote is logged or stored; the store keeps monthly counters. A question about an order already placed (its status, where the parcel is, tracking) is never answered by the AI: the answer asks for the order number and the e-mail address used at checkout (ask_order true), which the chat sends back in the request's own `order` field. With `order` the request is an order lookup, answered from a template without the AI: the store's order with both matching (the e-mail ignoring case and spaces, the number with or without its prefix, #, dashes or spaces), else one generic not-found line; at most 5 lookups per 15 minutes per visitor and per address, and an order number is refused for 15 minutes after 5 failed attempts. The found order carries no address, name, phone, price or payment detail; neither value is logged. The answer is written in the language the visitor writes in (`language`), the product cards in the page's.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","assistant","chat"],"raw":"{{baseUrl}}/api/v1/store/assistant/chat"}}},{"name":"Meta's data deletion callback (platform)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Named in the platform Meta app's settings (Data deletion request URL). Verifies the signed_request against the Instagram app's and the Meta app's secret (and the modules' sharing the app); disconnects, in every store, the social feed connections made with that person's login (tokens, account name, id and picture, cached posts and their pictures), records the request and answers Meta's required JSON (top level, no envelope): the status page's address and a confirmation code. 400 when no secret verifies it; 503 when the work did not finish (Meta calls again).","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","meta","data-deletion"],"raw":"{{baseUrl}}/api/v1/store/meta/data-deletion"}}},{"name":"A Meta data deletion's status (public)","request":{"auth":{"type":"noauth"},"description":"The page Meta links the person to: with Accept: text/html a plain bilingual page (Turkish and English), otherwise JSON. Names no store and no person. 404 for a code nobody was given.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","meta","data-deletion","status"],"raw":"{{baseUrl}}/api/v1/store/meta/data-deletion/status"}}},{"name":"Meta's deauthorize callback (platform)","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Named in the platform Meta app's settings (Deauthorize callback URL). The same signed_request check; disconnects that person's social feed connections in every store and records the request.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","meta","deauthorize"],"raw":"{{baseUrl}}/api/v1/store/meta/deauthorize"}}},{"name":"The social feeds' OAuth callback (platform)","request":{"auth":{"type":"noauth"},"description":"The one redirect URI every store's merchant returns to from Instagram, Facebook or TikTok (registered once in each platform app: https://\u003cplatform domain\u003e/api/oauth/{provider}/callback). Verifies the state's signature and expiry, uses its nonce once, checks the return page is still on a host of the store it names, exchanges the code from the server and redirects (303) to that page with ?social=\u003cprovider\u003e\u0026social_result=\u003cword\u003e. A state that fails any check gets a static page (400) and no redirect. Never cached, never sent on as a referrer.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","oauth",":provider","callback"],"raw":"{{baseUrl}}/api/v1/store/oauth/:provider/callback","variable":[{"key":"provider","value":""}]}}},{"name":"The plugins a storefront should render","request":{"auth":{"type":"noauth"},"description":"Every enabled plugin with its public settings — the hello bar's message, the chat widget's key, the analytics tag — and nothing else. A storefront reads this once per page and renders what it finds.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","plugins"],"raw":"{{baseUrl}}/api/v1/store/plugins"}}},{"name":"Recent purchases for the storefront's note (Son satın alma bildirimi)","request":{"auth":{"type":"noauth"},"description":"While the store's recent-purchase-popup add-on is on: the latest orders of the last 14 days that went through (paid, or confirmed and on their way), one per product, newest first, at most 12 — the product's address, its title in the request's language, its picture, the city the order goes to and how long ago. Nothing else about the buyer. Off, 404 `recent_purchases_off`. Cacheable for 60 seconds.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","recent-purchases"],"raw":"{{baseUrl}}/api/v1/store/recent-purchases"}}},{"name":"The store this host serves (storefront runtime resolution)","request":{"auth":{"type":"noauth"},"description":"What the multi-tenant storefront runtime resolves a request's Host to (constitution §12A, ADR-0030): tenant and store, the store's hosts and canonical origin, its languages and the published theme version — the parts of every cache key. A host that routes to no store answers 404 `unknown_host` whatever the deployment's mode, and the storefront answers it with the platform 404. Edge-cacheable per host for 30 seconds.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","site"],"raw":"{{baseUrl}}/api/v1/store/site"}}},{"name":"A site-ownership file of the store","request":{"auth":{"type":"noauth"},"description":"The verification file a provider reads at the root of the store's domains (Ayarlar › Site doğrulama): the storefront answers /{name} (Apple Pay's file at /.well-known/apple-developer-merchantid-domain-association) with `body` as `content_type`. An HTML body is stored without any active part. 404 for a name outside the providers' shapes or not set.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","site-files",":name"],"raw":"{{baseUrl}}/api/v1/store/site-files/:name","variable":[{"key":"name","value":""}]}}},{"name":"A social media feed's posts","request":{"auth":{"type":"noauth"},"description":"The posts the store's feed of one platform shows (the theme section and the free-design live component \"Sosyal medya akışı\"), newest first, as the last sync stored them: pictures are copies in the store's media library, never the platform's CDN. A feed that is off answers enabled false and no posts. Players (embed_url) are third-party content the storefront loads only after the visitor's click or marketing consent. The answer carries the look the feed's plugin chose in its sheet (display): a section or live component applies the values named in display.chosen over its own unless it opts out.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","social-feeds",":platform"],"raw":"{{baseUrl}}/api/v1/store/social-feeds/:platform","variable":[{"key":"platform","value":""}]}}},{"name":"The store's name, logo and favicon","request":{"auth":{"type":"noauth"},"description":"Public and read only, resolved from the host like the other storefront routes: the store's name and the addresses of its live theme's logo and favicon (empty when none). The merchant admin's sign-in screen, shown before anyone signs in on the store's own host, and its side bar show them. Nothing else is in it. An address no store answers for is `404 unknown_host`. Cacheable per host for 30 seconds.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","store-brand"],"raw":"{{baseUrl}}/api/v1/store/store-brand"}}},{"name":"The store's canonical host","request":{"auth":{"type":"noauth"},"description":"The primary host, its https URL and the www/apex policy — what canonical links are built from, never the raw Host header.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","store-domain"],"raw":"{{baseUrl}}/api/v1/store/store-domain"}}},{"name":"Whether the store is open","request":{"auth":{"type":"noauth"},"description":"`open: false` while the account is suspended or closing: the storefront shows a neutral notice and no checkout is possible.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","store-status"],"raw":"{{baseUrl}}/api/v1/store/store-status"}}}],"name":"store"},{"item":[{"name":"Start a live chat","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Only while the store's live-chat add-on is on. Answers the chat's token, for the visitor's browser alone.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat"],"raw":"{{baseUrl}}/api/v1/store/chat"}}},{"name":"Send a file in the visitor's chat","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A picture, a PDF or a video, checked by its bytes. At most 20 files a chat and 15 an hour from one address.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","attachments"],"raw":"{{baseUrl}}/api/v1/store/chat/attachments"}}},{"name":"A file of the visitor's chat","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","attachments",":file"],"raw":"{{baseUrl}}/api/v1/store/chat/attachments/:file","variable":[{"key":"file","value":""}]}}},{"name":"Close the visitor's chat","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Both sides get the conversation by e-mail; writing again opens it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","close"],"raw":"{{baseUrl}}/api/v1/store/chat/close"}}},{"name":"Ask for a person","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Hands the chat from the store's assistant to the staff (once): a note to the visitor, and the store told as for a new chat.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","handover"],"raw":"{{baseUrl}}/api/v1/store/chat/handover"}}},{"name":"The visitor's chat messages after one","request":{"auth":{"type":"noauth"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","messages"],"raw":"{{baseUrl}}/api/v1/store/chat/messages"}}},{"name":"Write in the visitor's chat","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"At most 20 messages in ten minutes; a closed chat opens again.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","messages"],"raw":"{{baseUrl}}/api/v1/store/chat/messages"}}},{"name":"The visitor's chat and whose it is","request":{"auth":{"type":"noauth"},"description":"Whether the store's assistant still answers (mode bot) or a person does, and the messages after one.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","chat","view"],"raw":"{{baseUrl}}/api/v1/store/chat/view"}}},{"name":"Whether the store sends notifications, and its key","request":{"auth":{"type":"noauth"},"description":"The VAPID public key a browser subscribes with (RFC 8292); empty while notifications are off.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","push"],"raw":"{{baseUrl}}/api/v1/store/push"}}},{"name":"Subscribe a browser to the store's notifications","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The browser's PushSubscription (endpoint and keys). Only a browser push service's address is taken. A signed-in shopper's subscription carries their e-mail.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","push","subscriptions"],"raw":"{{baseUrl}}/api/v1/store/push/subscriptions"}}},{"name":"Forget a browser's subscription","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","push","unsubscribe"],"raw":"{{baseUrl}}/api/v1/store/push/unsubscribe"}}},{"name":"The storefront's own visitor beacon","request":{"auth":{"type":"noauth"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A page view, a heartbeat while the page is in front, or the order confirmation page. First-party and cookieless: the visitor is a hash of the day's random salt, the address and the browser, the salts are deleted after two days, and no address is stored. Bots and unknown kinds are dropped. Always 204 for a well-formed body.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","store","visits"],"raw":"{{baseUrl}}/api/v1/store/visits"}}}],"name":"storefront"},{"item":[{"name":"The supply ledger's consistency checks","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Journals balance; the seller's book equals the order snapshots; the supplier's book equals its supply orders; confirmed payments are posted once. Right supply-ledger.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","check"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/check"}}},{"name":"Ödemeyi onayla (supplier)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Confirms a payment a seller recorded: posted in both books. Idempotent. Right supply-ledger.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","payments",":id","confirm"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/payments/:id/confirm","variable":[{"key":"id","value":""}]}}},{"name":"Dispute a payment (supplier)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"An open flag with a note the seller sees; a confirmed payment cannot be disputed. Right supply-ledger.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","payments",":id","dispute"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/payments/:id/dispute","variable":[{"key":"id","value":""}]}}},{"name":"Alacaklarım (supplier)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What each seller owes this business, per currency, over an optional period. Right supply-ledger.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","sellers"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/sellers"}}},{"name":"A seller's statement (supplier)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"{id} is the seller's tenant. Right supply-ledger.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","sellers",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/sellers/:id","variable":[{"key":"id","value":""}]}}},{"name":"Tedarikçi bakiyeleri (seller)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What this store owes each supplier, per currency, over an optional period: brought forward, orders, cancellations, confirmed payments, carried; payments awaiting the supplier's confirmation beside. Right supply-ledger.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","suppliers"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/suppliers"}}},{"name":"A supplier's statement (seller)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Movements with a running balance and the recorded payments; {id} is the supplier's tenant. Right supply-ledger.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","suppliers",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/suppliers/:id","variable":[{"key":"id","value":""}]}}},{"name":"Ödeme yapıldı (seller)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Records a bank transfer the store made to the supplier; the supplier confirms or disputes it. Nothing moves money. Refused (409) under the platform PSP mode. Right supply-ledger.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","ledger","suppliers",":id","payments"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/ledger/suppliers/:id/payments","variable":[{"key":"id","value":""}]}}},{"name":"Keşfet","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The network catalogue in the platform operator's tenant, by category, company, search and filters; each card priced by the store's rule. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","catalog"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/catalog"}}},{"name":"A catalogue entry","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One entry with its description. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","catalog",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/catalog/:id","variable":[{"key":"id","value":""}]}}},{"name":"Mağazama ekle","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Copies the entry into the store as a draft product priced by the store's rule, routes it to the supplier's offer and asks for the grant on the standard terms. Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","catalog",":id","add"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/catalog/:id/add","variable":[{"key":"id","value":""}]}}},{"name":"A catalogue picture","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The n-th picture of an entry (the supplier's stored image, or a redirect to its https address). Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","catalog",":id","media",":n"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/catalog/:id/media/:n","variable":[{"key":"id","value":""},{"key":"n","value":""}]}}},{"name":"Network categories","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The network category tree or a search. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","categories"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/categories"}}},{"name":"Category mapping","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Network category → the store's own category. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","category-map"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/category-map"}}},{"name":"Map a category","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"category_id 0 removes the mapping. Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","category-map"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/category-map"}}},{"name":"Browse tree","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Children of a category that hold entries, with counts. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","category-tree"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/category-tree"}}},{"name":"Supplier companies","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The catalogue's company index. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","companies"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/companies"}}},{"name":"Mağazamdakiler","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's supply products with price, breakdown and warnings. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links"}}},{"name":"A supply product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One supply product of the store. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links/:id","variable":[{"key":"id","value":""}]}}},{"name":"Accept the suggested price","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Applies the price a cost change queued for review. Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links",":id","accept-suggestion"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links/:id/accept-suggestion","variable":[{"key":"id","value":""}]}}},{"name":"Price breakdown","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The breakdown at a price (default: the current one) or at the price a profit target needs. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links",":id","breakdown"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links/:id/breakdown","variable":[{"key":"id","value":""}]}}},{"name":"Set the retail price","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Writes the price through the kernel (price.changed). Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links",":id","price"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links/:id/price","variable":[{"key":"id","value":""}]}}},{"name":"Publish an imported product","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Puts the seller's copy on sale once the supplier has accepted; sold through the network's checkout. Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","links",":id","publish"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/links/:id/publish","variable":[{"key":"id","value":""}]}}},{"name":"An order's supply groups","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The seller's order page: one group per supplier with its status, lines as sold, margin snapshot and any refund. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","orders",":order"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/orders/:order","variable":[{"key":"order","value":""}]}}},{"name":"Pricing rules","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The store's pricing rules, most specific first. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","rules"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/rules"}}},{"name":"Save a pricing rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates or replaces the rule of a scope. Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","rules"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/rules"}}},{"name":"Delete a pricing rule","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right supply-network.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","rules",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/rules/:id","variable":[{"key":"id","value":""}]}}},{"name":"Supply settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Ayarlar › Tedarik: default markup, rounding, minimum margin, how cost changes apply. Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/settings"}}},{"name":"Save supply settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right supply-network.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/settings"}}},{"name":"Network terms","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The standard terms and fee inputs in force (defaults while the platform has set none). Right supply-network.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","network","terms"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/network/terms"}}},{"name":"Ürünlerim","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"This business's products, a row per variant, with each variant's offer. Right supply-offers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers"}}},{"name":"Network categories","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The network category tree (children of parent) or a search. Right supply-offers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers","categories"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/categories"}}},{"name":"A variant's offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The \"Ağda sat\" panel: the offer (or null), warehouses, supplier status, terms. Right supply-offers.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers","variants",":variant"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/variants/:variant","variable":[{"key":"variant","value":""}]}}},{"name":"Save a variant's offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Creates or edits the offer; a published offer's change bumps its version and is replicated. Needs an approved supplier. Right supply-offers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers","variants",":variant"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/variants/:variant","variable":[{"key":"variant","value":""}]}}},{"name":"Pause an offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"active → paused: off the catalogue, nothing new sold. Right supply-offers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers",":id","pause"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/:id/pause","variable":[{"key":"id","value":""}]}}},{"name":"Put an offer on the network","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"draft/paused → active; needs a price, a warehouse and a network category. Right supply-offers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers",":id","publish"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/:id/publish","variable":[{"key":"id","value":""}]}}},{"name":"Resume an offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"paused → active. Right supply-offers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers",":id","resume"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/:id/resume","variable":[{"key":"id","value":""}]}}},{"name":"Retire an offer","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"→ retired (final): withdrawn from the catalogue and from every seller. Right supply-offers.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","offers",":id","retire"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/offers/:id/retire","variable":[{"key":"id","value":""}]}}},{"name":"Siparişler (supplier)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Orders sellers placed for this business's network products, those awaiting acceptance first. Right supply-orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders"}}},{"name":"Supply order settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Automatic acceptance and the acceptance deadline. Right supply-orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/settings"}}},{"name":"Save supply order settings","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Right supply-orders.write; the business must be an approved supplier.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders","settings"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/settings"}}},{"name":"One supply order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Right supply-orders.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id","variable":[{"key":"id","value":""}]}}},{"name":"Accept a supply order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Tells the seller (supply_order.accepted). Right supply-orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id","accept"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id/accept","variable":[{"key":"id","value":""}]}}},{"name":"Kargoya verdim","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The supplier handed the labelled parcel to the courier: the seller's order is shipped (supply_shipment.handed_over). Idempotent. Right supply-orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id","handed-over"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id/handed-over","variable":[{"key":"id","value":""}]}}},{"name":"The label (SVG)","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Redeems a print link (xtenant.FetchLabel): sender = the seller's store, origin = the supplier's warehouse, the shipment code as a Code 128 barcode, the destination's district and province; an L2 label adds the recipient's name and address, never a phone or an e-mail. Recorded in the seller's and the supplier's trails. Right supply-orders.read and the token.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id","label"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id/label","variable":[{"key":"id","value":""}]}}},{"name":"A label print link","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Issues a single-use link to the order's label, valid for two minutes; recorded in the supplier's trail. Right supply-orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id","label-token"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id/label-token","variable":[{"key":"id","value":""}]}}},{"name":"Reject a supply order","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The units go back on the shelf; the seller refunds the shopper (supply_order.rejected). Right supply-orders.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","orders",":id","reject"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/orders/:id/reject","variable":[{"key":"id","value":""}]}}},{"name":"Ödeme hesabı","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The business's payout account at the payment institution under mode P, its one status in plain Turkish and what is missing. Right supply-payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","payout-account"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/payout-account"}}},{"name":"Ödeme hesabı bilgileri","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The business kind and the authorised person (TCKN sealed). Right supply-payouts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","payout-account"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/payout-account"}}},{"name":"Ödeme hesabını aç","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends the business to the payment institution as a sub-merchant of the platform's marketplace account (created, or updated). Right supply-payouts.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","payout-account","open"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/payout-account/open"}}},{"name":"Ödemelerim","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"This business's items held at the institution: Hesabınıza geçecek / geçti, with dates. Right supply-payouts.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","payouts"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/payouts"}}},{"name":"The supplier application and capabilities","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"This business's application to supply the network and where it stands (right supplier.read).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile"}}},{"name":"Save the supplier application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Saves a draft; refused (409) while the platform reviews it. Right supplier.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile"}}},{"name":"Add a document to the supplier application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"A tax certificate, identity copy or signature circular, kept private (G-07, KVKK): never in the media library, never at a public address, never swept. multipart/form-data with `file`: a PDF without scripts, embedded files or automatic actions, or a JPEG, PNG or WebP picture (its EXIF, GPS and text metadata removed); at most 10 MiB and 10 documents per application. Refused (409) while the platform reviews the application. Right supplier.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile","documents"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile/documents"}}},{"name":"Download one of the application's documents","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The business's own document, privately (never cached). Right supplier.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile","documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile/documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove a document from the application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Deletes the document for good. Refused (409) while the platform reviews the application. Right supplier.write.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile","documents",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile/documents/:id","variable":[{"key":"id","value":""}]}}},{"name":"Send the supplier application","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Checks the application is complete (company, tax number and office, address, contact, IBAN, at least one document) and asks the platform to approve it: the supplier capability becomes pending_approval. Right supplier.write.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","profile","submit"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/profile/submit"}}},{"name":"The supplier's catalog score","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"This supplier's score (shipping time, returns, complaints over the last 90 days), when it fell under the network's threshold and whether it dropped out of the shared catalog (ADR-0141). Right supplier.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","score"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/score"}}},{"name":"The supply network trail","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"What the network did in this business: application edits, the platform reading the application (who, when), holds taken for sellers, notices received. Newest first, at most 100. Right supplier.read.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","supply","trail"],"raw":"{{baseUrl}}/api/v1/admin/x/supply/trail"}}}],"name":"supply"},{"item":[{"name":"Liveness probe","request":{"auth":{"type":"noauth"},"description":"Reports that the process is running. Touches no dependency, so a database hiccup never causes an orchestrator to restart a healthy process.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["health"],"raw":"{{baseUrl}}/health"}}},{"name":"Readiness probe","request":{"auth":{"type":"noauth"},"description":"Reports that this process can serve traffic: the database answers, every migration this binary knows is applied, and, once the process serves, its outbox dispatcher and job loop are running. The body names the applied migrations this binary does not know (`migrations.unknown`) when it serves a newer schema by explicit allowance (ADR-0032).","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["health","ready"],"raw":"{{baseUrl}}/health/ready"}}}],"name":"system"},{"item":[{"name":"The delivery log","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"One row per event per endpoint. `state` is derived from the worker's own columns: pending, delivered, or dead once the attempts ran out.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","deliveries"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/deliveries"}}},{"name":"Queue a delivery again","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The only useful thing to do with one that gave up. It resets the attempt count as well as clearing the flag: a retry an operator asked for is a fresh start, not attempt thirteen of twelve. A delivery that already succeeded is not found.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","deliveries",":id","retry"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/deliveries/:id/retry","variable":[{"key":"id","value":""}]}}},{"name":"Registered endpoints","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"The signing secret is never in this response. `secret_hint` is its last four characters, which is enough to tell two endpoints apart and not enough to sign with.","header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints"}}},{"name":"Register an endpoint","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"The only response that carries the secret in full, along with the one from rotate-secret. Store it now: no later read returns it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints"}}},{"name":"One endpoint","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"header":[],"method":"GET","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints/:id","variable":[{"key":"id","value":""}]}}},{"name":"Change an endpoint's url, events or active flag","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PATCH","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints/:id","variable":[{"key":"id","value":""}]}}},{"name":"Remove an endpoint","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"description":"Its delivery log goes with it: the log records what this store told that endpoint, and the endpoint no longer exists.","header":[],"method":"DELETE","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints",":id"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints/:id","variable":[{"key":"id","value":""}]}}},{"name":"Issue a new signing secret","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"So that a leaked secret has an answer other than deleting the endpoint. Deliveries already queued are signed with the new secret when they are sent. The replaced secret keeps signing beside the new one for an overlap window (24 hours by default, `overlap_seconds` to change it for this rotation, 0 to end it at once): during the window X-NeroCart-Signature carries two `v1=` values, `t=\u003cts\u003e,v1=\u003cnew\u003e,v1=\u003cprevious\u003e`, and a receiver accepts the request when any `v1=` matches the secret it holds. Only one previous secret is kept; a second rotation inside the window replaces it.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints",":id","rotate-secret"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints/:id/rotate-secret","variable":[{"key":"id","value":""}]}}},{"name":"Send a test delivery","request":{"auth":{"bearer":[{"key":"token","type":"string","value":"{{apiKey}}"}],"type":"bearer"},"body":{"mode":"raw","options":{"raw":{"language":"json"}},"raw":"{}"},"description":"Sends one `webhook.test` event to the endpoint now, signed with its secret exactly as a real delivery (X-NeroCart-Signature and the other X-NeroCart-* headers), and answers what the endpoint said and how long it took. Nothing is queued, retried or written to the delivery log.","header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","url":{"host":["{{baseUrl}}"],"path":["api","v1","admin","x","webhooks","endpoints",":id","test"],"raw":"{{baseUrl}}/api/v1/admin/x/webhooks/endpoints/:id/test","variable":[{"key":"id","value":""}]}}}],"name":"webhooks"}],"variable":[{"key":"baseUrl","value":"https://yourstore.com"},{"key":"apiKey","value":""}]}