{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"364c8bbf-a0c2-4648-9a4e-f4dba468b09f","name":"Arcadier API v2.0","description":"Authentication\r\n==============\r\n\r\nOur APIs use the [**Bearer token**](https://learning.postman.com/docs/sending-requests/authorization/#bearer-token) authorization method.\r\n\r\nThe \"token\" in question is a text string. Each persona (Buyer, Seller, Admin, Sub-Buyer and Sub-Merchants) on a marketplace possesses a unique token that enables them to use the APIs. \r\n\r\nThis \"token\" can be obtained in 2 ways: \r\n\r\n1. Authentication API\r\n\r\n   The [Log In/Get Admin Token API](https://apiv2.arcadier.com/#546294a8-cf01-4543-a994-5929c5be2c41) responds with user's `access_token` which can be used as token to authenticate our APIs. \r\n\r\n2. A cookie present in the session of a user logged in on a marketplace\r\n\r\n   The token within the cookie can be viewed by logging in to any page (including the Admin portal) as a registered user. \r\n    * Log in to any user's account on the marketplace (this can also be the admin portal)\r\n    * Right click on the page\r\n    * Click \"Inspect\"\r\n    * Once the Chrome Dev Tools open, go the the `Application` tab, then click on the `Cookies` dropdown, and find the 'webapitoken' cookie. That cookie's value is the user's token.\r\n\r\n  Alternatively, you can use JavaScript in your Plug-In to fetch the value of the 'webapitoken' cookie mentionned above.\r\n\r\n```javascript\r\nvar token = getCookie('webapitoken');\r\nvar settings = {\r\n\t\"url\": \"\", \r\n\t\"method\": \"\", \r\n\t\"headers\": { \r\n\t\t\"Content-Type\": \"application/json\",\r\n\t\t\"Authorization\": \"Bearer \" + token //notice the space character between \"Bearer\" and token\r\n\t}, \r\n\t\"data\": \"\" //JSON object\r\n};\r\n$.ajax(settings).done(function(response) { console.log(response); });\r\n\r\nfunction getCookie(name){\r\n\tvar value = '; ' + document.cookie;\r\n    var parts = value.split('; ' + name + '=');\r\n    if (parts.length === 2) {\r\n    \treturn parts.pop().split(';').shift();\r\n    }\r\n}\r\n```\r\n## Using the token in Postman\r\nOnce you have the token, you can prepend \"Bearer \" to it and use that as authorization in Arcadier's APIs. Arcadier's Postman collection already handles this for you.\r\n\r\nOnce you obtain the token value, replace the `{{admintoken}}` placeholder with that value. (Don't forget space between \"Bearer\" and the token)\r\n\r\n![Endpoint Example](https://bootstrap.arcadier.com/github/endpoint%20example.png)\r\n\r\nAlternatively, you can give fixed values to these placeholders and make them act as variables.\r\n\r\nClick on [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/346b915f84ec00600260) to download Postman with Arcadier's API collection\r\n   \r\nWhen the download is complete, click on \"Manage Environments\" on the top right\r\n<p align=center><img src=\"https://bootstrap.arcadier.com/github/Environment.png\"></p>\r\n\r\nClick on the \"Add\" button\r\n![Add Button](https://bootstrap.arcadier.com/github/Manage%20environment%20box.png)\r\n\r\nFill it up with the following variables, a paste your token's value in the \"admintoken\" row, in the \"CURRENT VALUE\" column.\r\n![Variables List](https://bootstrap.arcadier.com/github/variable%20list.png)\r\n\r\nYou can extend the same logic to all the other variables to make playing around with several APIs a much less tedious experience.\r\n\r\nPagination\r\n==========\r\n\r\nAll APIs that return an array/list of records will have the option to paginate the results obatined. Pagination can be done via query parameters in the URL. \r\n\r\nDefinition from [techtarget.com](https://whatis.techtarget.com/definition/pagination):\r\n> \"...pagination also refers to the automated process of adding consecutive numbers to identify the sequential order of pages. Some types of website content benefit from being broken into separate pages to make them more user-friendly, such as search engine results pages (SERP), blogs and discussion forums.\"\r\n\r\nIn Arcadier's APIs:\r\n\r\n`pageSize` specifies the number of results to display within 1 response.\r\n\r\n`pageNumber` specifies the page number\r\n\r\nIf an API reports `\"TotalRecords\": 20`, then\r\n\r\n* `?pageNumber=1&pageSize=10` will make the API respond with the first 10.\r\n* `?pageNumber=2&pageSize=10` will make the API respond with the next 10.\r\n* `?pageNumber=1&pageSize=20` will make the API respond with all of the 20.\r\n\r\n**Note**: Our APIs accept a `pageSize` of maximum value **500**. In Arcadier API responses.\r\n\r\n* It is advised to use extra filters when doing searches.\r\n* If the intention is to get 100% of Records, where the number of Records exceed 500, combine `pageSize` with `pageNumber` and do a couple of API calls.\r\n\r\nSome APIs that use pagination:\r\n* [Get All Users](https://apiv2.arcadier.com/?version=latest#5282732e-0930-43b5-b98f-eeb3d5ce94b8)\r\n* [Item Search APIs](https://apiv2.arcadier.com/?version=latest#75cfc057-f670-4c92-b07a-312acafd6fd4)\r\n* [Transaction History APIs](https://apiv2.arcadier.com/?version=latest#fd876791-d71f-43bd-be02-bfe6bf17747a)\r\n\r\n\r\nUser IDs\r\n========\r\n\r\nAdmin, Merchant and Buyer ID's can be found by inspecting the page when logged in as each of them.\r\n\r\n```html\r\n<input type=\"hidden\" id=\"userGuid\" value=\"{{userID}}\">\r\n```\r\n\r\nAPI Changelog\r\n=================\r\n\r\nAll past and upcoming changes in our APIs will be documented in our [API Changelog](https://arcadier.github.io/API-Changelog).\r\n\r\nFrequently Asked Questions\r\n==========================\r\n\r\nYou can visit our [Developer Community Support](https://github.com/Arcadier/Developer-Community-Support/issues) to view FAQ's and issues reported by developers. You can also submit your own questions, bug reports and feature requests.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"6410759","team":319599,"collectionId":"364c8bbf-a0c2-4648-9a4e-f4dba468b09f","publishedId":"2sBYHNXiHE","public":true,"publicUrl":"https://apiv2.arcadier.com","privateUrl":"https://go.postman.co/documentation/6410759-364c8bbf-a0c2-4648-9a4e-f4dba468b09f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2D525D"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore the Arcadier v2 API documentation: endpoints, request formats, and authentication for building custom marketplace integrations and apps."},{"name":"title","value":"Arcadier v2 API endpoints documentation"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/09b2306d-c2bc-4f4d-becf-c3cd13c73b99/bGlnaHQucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"AEFF83"}},{"name":"light","logo":"https://content.pstmn.io/2884a58b-886d-42df-b045-efee56504fe3/ZGFyay5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2D525D"}}]}},"version":"8.12.8","publishDate":"2026-10-05T01:20:51.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Arcadier v2 API endpoints documentation","description":"Explore the Arcadier v2 API documentation: endpoints, request formats, and authentication for building custom marketplace integrations and apps."},"logos":{"logoLight":"https://content.pstmn.io/2884a58b-886d-42df-b045-efee56504fe3/ZGFyay5wbmc=","logoDark":"https://content.pstmn.io/09b2306d-c2bc-4f4d-becf-c3cd13c73b99/bGlnaHQucG5n"}},"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/8badce0d7a0fd1afae26e28a209a3c778b8cd48831680d65c63be419ffa65458","favicon":"https://res.cloudinary.com/postman/image/upload/v1720165008/team/jggd6ugdkgo9h6tpkp7a.ico"},"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://apiv2.arcadier.com/view/metadata/2sBYHNXiHE"}