{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1de26304-d0ca-4c6f-8b93-131dae6ed020","name":"Seoclerks API","description":"The Seoclerks REST API for buyers and sellers. Everything a route decides, it decides through the website's own rules.\n\n## Authentication\nCreate a key at **Settings > API** on the website. The full key is shown once. Send it over HTTPS in exactly one header:\n\n    Authorization: Bearer sck1_...\n    X-API-Key: sck1_...\n\nBoth headers together are refused. A key in the query string is refused (400 `key_in_query`) and should be rotated. Plain HTTP is refused, never redirected (400 `https_required`). Keys expire after 30, 90 (default) or 365 days, or never; they can be renamed and revoked at any time, and at most ten are active per member. A key works on every Seoclerks storefront; the host decides which marketplace's data is read.\n\n## Scopes\nA key is created with the scopes it needs. `read` grants every read; a narrow read scope grants its own area only. `write` grants every ordinary write. Three scopes are never part of `write` and must be chosen on their own, with a second factor proved when the key is created: `checkout:write` (spend the balance), `deposits:write` (charge the member's saved card through their own Auto Reload) and `payouts:write` (ask for a withdrawal). A write scope never grants a read.\n\n## Responses\nSuccess is `{\"data\": ..., \"meta\": {\"request_id\": \"...\"}}`. Lists add `meta.limit` and `meta.next_cursor`. Errors are RFC 9457 problem details (`application/problem+json`) with a stable `code`; branch on `code`, not on `title`. A resource that does not exist and one the caller may not see give the same 404. Timestamps are ISO 8601 UTC. Money is `{\"amount\": \"12.50\", \"currency\": \"USD\"}`, the amount a string. Text fields hold stored content, not trusted HTML.\n\n## Pagination\nLists return 25 items by default, 100 at most (`limit`), newest first. To continue, send `meta.next_cursor` back as `cursor` with the same path and filters. A cursor is signed and bound to the key, the account, the host, the path and the filters; anything else is 422 `bad_cursor`.\n\n## Caching\nEvery response is private. GET responses carry a weak `ETag` and `Cache-Control: private, no-cache`; send it back in `If-None-Match` for a bodyless 304. Writes and errors are `no-store`. Nothing is served from a shared cache.\n\n## Rate limits\nPer key: 300 requests a minute overall, and 60 writes a minute within that. Every response carries `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds); 429 `rate_limited` adds `Retry-After`. A write's headers describe the write budget.\n\n## Writes and idempotency\nSend `Content-Type: application/json` and a JSON object of at most 65,536 bytes. Unknown fields are refused, never ignored. Writes take no query parameters. Every POST needs an `Idempotency-Key` (1-64 of `A-Z a-z 0-9 _ . -`); on PATCH and DELETE it is optional. A retry with the same key and the same request returns the first response with `Idempotency-Replayed: true`; the same key with a different request is 409 `idempotency_conflict`. Results are kept for at least 48 hours. Emails and other effects of a write are sent after it commits, at least once.\n\n## Step-up for withdrawals\nA key alone never withdraws. (1) `POST /me/step-ups` with the method and amount; you get an `approve_url`. (2) The member opens it logged in on the website and approves with a fresh second factor. They have ten minutes. (3) Within ten minutes of approval, send `POST /balance/withdrawal-requests` with the same body and the header `Step-Up: <id>`. A step-up works once, for exactly that request. No route changes where money is paid: payout destinations are set on the website only.\n\n## CORS\nBrowser calls are allowed only from origins the site has listed, exactly. Allowed request headers: `Authorization`, `X-API-Key`, `Content-Type`, `Idempotency-Key`, `Step-Up`, `If-None-Match`.\n\n## Versioning and deprecation\nThis is version 1, under `/api/v1/`. Fields and routes may be added; none is removed or changed in meaning within v1. Anything to be retired will be announced here and will answer with `Deprecation` and `Sunset` headers for at least 180 days first. The older keyless Service Ads API and the `consumer_key` API are separate and unchanged.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"58893648","team":46215132,"collectionId":"1de26304-d0ca-4c6f-8b93-131dae6ed020","publishedId":"2sBYHSxLRv","public":true,"publicUrl":"https://documenter-api.postman.tech/view/58893648/2sBYHSxLRv","privateUrl":"https://go.postman.co/documentation/58893648-1de26304-d0ca-4c6f-8b93-131dae6ed020","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The Seoclerks REST API for buyers and sellers."},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/d8d06146-81b9-47a1-ba20-ce5a4d06b507/ZmFjZWJvb2stMzIwLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/2359ab19-5c10-4752-a1bb-b6da3bffc8ac/ZmFjZWJvb2stMzIwLWRhcmsucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.10","publishDate":"2026-10-17T11:32:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"The Seoclerks REST API for buyers and sellers."},"logos":{"logoLight":"https://content.pstmn.io/2359ab19-5c10-4752-a1bb-b6da3bffc8ac/ZmFjZWJvb2stMzIwLWRhcmsucG5n","logoDark":"https://content.pstmn.io/d8d06146-81b9-47a1-ba20-ce5a4d06b507/ZmFjZWJvb2stMzIwLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/66a0f298324611f40327b54b0e5daf4eaa504a87f52872d116db8b5553c07915","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYHSxLRv"}