{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"93815129-5e8e-4e33-9e09-fc1bb7bb3877","name":"Retalia - Public API Documentation v1.0 and v1.1 Enhanced","description":"The Retalia Public API is for certified third-party integrators and customer IT teams who need to access Retalia data and business logic.\n\n# Start here\n\n## Choose an API version\n\nThis collection documents both supported API versions in one place:\n\n| Version | When to use it | Notes |\n| --- | --- | --- |\n| v1.0 | Existing integrations already built against v1.0 | Kept intact in this collection so current integrations can continue to reference the same examples and request bodies. |\n| v1.1 | New integrations and upgrades | Includes the latest v1.1 endpoints with detailed parameter, field, and response documentation. |\n\nSome v1.0 requests use the `{{API_VERSION}}` variable. Leave it as `1.0` when working with v1.0 examples. The v1.1 requests use explicit `/api/v1.1/...` paths.\n\n## Environments\n\n| Environment | Portal | Public API |\n| --- | --- | --- |\n| Development | `https://portal-dev.retalia.cloud` | `https://publicapi-dev.retalia.cloud` |\n| Release Candidate | `https://portal-rc.retalia.cloud` | `https://publicapi.retalia.cloud` |\n| Production | `https://portal.retalia.cloud` | `https://publicapi.retalia.cloud` |\n\nSet `API_URL` to the host you want to call, for example `publicapi.retalia.cloud`.\n\n## Authentication\n\nAll API requests use Bearer token authentication:\n\n`Authorization: Bearer {{API_ACCESS_TOKEN}}`\n\nUse the requests in the Authentication folder to create or refresh a token. Tokens expire after 60 minutes. Token generation is rate-limited to 5 tokens per minute, so integrations should reuse a token for its full lifetime where possible.\n\n## Field labels\n\n| Label | Meaning |\n| --- | --- |\n| Required | Explicitly required by the API schema. |\n| Recommended | Not marked as required, but non-nullable in the model. Send an explicit value to avoid unintended defaults. |\n| Optional | Can be omitted or is nullable according to the schema. |\n\n## Key concepts\n\n**Tenant**: a customer, system, or unique application instance. Each environment has isolated tenants and data.\n\n**Integrator**: the internal or external party building an integration.\n\n**Integration**: the pairing of an integrator to a tenant, with its own permissions and scope.\n\nFor tenant, integrator, or integration setup, contact `support@retalia.com`.\n\n## HTTP methods\n\n| Method | Use |\n| --- | --- |\n| GET | Read data |\n| POST | Create data or run a query/action |\n| PUT | Replace or upsert data; send the full resource where required |\n| PATCH | Partially update data |\n| DELETE | Delete data |\n\n## Rate limiting\n\nRate limiting applies to **v1.1 API requests only**. Requests made to v1.0 endpoints are not subject to these limits.\n\nThe following limits apply per client IP address:\n\n| Limit | Value |\n| --- | --- |\n| Requests per second | 4 |\n| Requests per minute | 240 |\n| Burst multiplier | 1 |\n\nIf the rate limit is exceeded, the API returns:\n\n`429 Too Many Requests`\n\nThe response includes a `Retry-After` header:\n\n`Retry-After: 60`\n\nClients should wait for the number of seconds specified by `Retry-After` before retrying the request.\n\nIntegrations should avoid unnecessary repeated requests and, where appropriate, queue or throttle requests to remain within these limits.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6694488","team":16285,"collectionId":"93815129-5e8e-4e33-9e09-fc1bb7bb3877","publishedId":"2sBY4VLHf3","public":true,"publicUrl":"https://publicapi-docs.retalia.cloud","privateUrl":"https://go.postman.co/documentation/6694488-93815129-5e8e-4e33-9e09-fc1bb7bb3877","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"b37cf6"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/8ecaaa55-6dde-4dd5-986e-982fea516f71/UmV0YWxpYUxvZ28ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"b37cf6"}},{"name":"light","logo":"https://content.pstmn.io/8ecaaa55-6dde-4dd5-986e-982fea516f71/UmV0YWxpYUxvZ28ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"b37cf6"}}]}},"version":"8.12.3","publishDate":"2026-08-07T12:01:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/8ecaaa55-6dde-4dd5-986e-982fea516f71/UmV0YWxpYUxvZ28ucG5n","logoDark":"https://content.pstmn.io/8ecaaa55-6dde-4dd5-986e-982fea516f71/UmV0YWxpYUxvZ28ucG5n"}},"statusCode":200},"environments":[{"name":"Retalia Imagine Public API","id":"ba4a04de-1000-0d7f-eeed-cccfb34d7d88","owner":"756998","values":[{"key":"API_VERSION","value":"1.0","enabled":true},{"key":"API_URL","value":"publicapi.retalia.cloud","enabled":true},{"key":"API_USER","value":"apiusername","enabled":true},{"key":"API_PASSWORD","value":"apipassword","enabled":true},{"key":"API_TOKEN","value":"","enabled":true},{"key":"INTEGRATION_ID","value":"","enabled":true},{"key":"access_token","value":"CfDJ8CvAMOQBtIFNkDt_c-MJ5WMEJn2EfvoI_gZoEqQIM-Gtx27a8NglOvLGim97eEl_YnGuRwREcrBGCfo4ITXxB2FaGwLMjD1JdG51DdVbM-WDymjbDFdfvIPXqa8fObzACFsnBx4kgbXooe6_KHyYR3P8a4ioA0tEXOyKNnOifyNqYq3knHK0LYsfQ1tkwCEE1Dfh3jPhcsCo7kV3EhRme4-1eaR7krc8qJjMaxR-Sp_kRjtaJuQJUb18vXwsvq4NGCM2aBuKFMGWVR-yOQ4rVRl8WhRkSBrO-urSg-G7NathOowfYln8G87RTqUECybrBPiDe21C3TbHVKafDDnwndkqpTv7RxvnlaaRntT5MvXtIrpzl1i_VMyToBKbDfBAyTv41tDBCADDU99GGCeUUMVpgY_meCWydYl0f4wUpArvRtoH8hnSjGkvrPPlXSRKSfvHcG4Ag9Gc9D0tAeIntsMIRn4gwBxOUF2Ju9ObwWRiD1iTjPS5uTyNYUxdlXvdzVU6f2pKC0iJb4UQWEbW2NjRxeHv2v2IxoId6O_qfbkfgESeVTWKbqDGlrCE26mPl2NRAKCEDMLWQQOMAopTbTGdJzOWErxvDWWwMIXd1Y4iK5-LOo-6QtBwhKkePnWRtgbebUvP_i3sqU_brNifljg9vsjTye2rNTlIQlW-u3vCPvP3g5qxqD_UbOofTg7JbGSzfY028wsY_dvLAGw7W_HbfiwnjH64e3G8ADeTl0Y7LWCuUtC6D0Vx_Srh56oraDUnk6TYxF4-fs5y3gskinlOh6wjzghz3atFL-J6oGH-HKVxCIUcX1vXx9GpP7wls3gb72jIBrJRzjr2wMbA6SMshc3wzC9Dy4EBrZLKZ1SFhzj2m0UYUhL0Ybn_HBDiGhlEqfCxn8zZ8bLChi5IXEGh5TGlB_K2x9vQz95ozdePTCKhgjCf4mPTvUpJ8TpB7vQBmq9P0Xp0KGuH2yI2hi1Xj3sxJBTSiB5rLdzSS0ptdVEg53agreEsGJ8CX8WM97-4uAO2t4u4axQs46dKV4LbrgHKZr7wfnjgztxhbXFyOkhRhplEJ3UNtZXa9BTyTqeJq6v58H-2apBujadcLG__RsBFVt_bY06knRxV4whEaDrUJjDjvYixAWx_R2LcCWxZ91sjMp-_quCvrWwTD4JGrcGcaAvUoinB4XJFDC9AwAnoxlCALhN-g28I0Gk-F0eObnGt-HVKUq8q_2JXiQS74cdUYH1D6ONt4enf1oa_-bkJfuhWveP1-FearVc460ymE5pF4g31c9TQC0_d4ZDcYhxLqfm3BckRO89YsBLH","enabled":false},{"key":"refresh_token","value":"CfDJ8CvAMOQBtIFNkDt_c-MJ5WPdhdfyZ7iEDAHCaMsEYH84UofcqxbBFZY_lb7kqyKmfBxlR5LF18YFAVqYS0n9IliP3pgkkFZoPovcZUZRCWCLPGLgw-dov_8IDfimOB4v1q7uiaPfvqfwQmsNapBF3hLCCyrh9IgnVjSpc4iJS_xE-Kj-TLM3Xf04HECQQang2XFv2D4Xmztjay6NHyavdS9-K3Nw51W8uM5pNFPx-Qch5Jh3NuTJpM6ESyrDxKWoE2hNFSqpJZu2TLqeRDh5gyMtyhwBKSHh3GF4cUEF_9RvNJjPMvMQ_ZkkUY7ilSL7hslfPeYX4LMIWjea3LlnK5LSbwAnMHbLoVC_pO_51vKHgiJI6Blh2LAq7bz8K88z1p5GSA6GhRnUdZO3ioQacXqhWGIHVr_6xIJuVq2ntSV3Xid3tVzu4fDzzha4vISN3epdUtZtMbbQogXe_UcGu9Uu7wTfLG3ifNLGCrDYFvgQj3tie6X-mSzt3OEYcibLil47qS-tnNb5V-iYOUz1tPE5Y5OmH8u6vzAXwWecnyWEPbammTm3PdVlSVjY5BlQWl1X48Ltw8pBBEhjM6gWPIa9zF0b69ek6i4-mGWT1V598ebn4M8TQ6idJ19Tvp6GBagT4dHgSut2th9NLNx_a0ssUlb1WMm9nLYkcMhIZfE4scsneSNjRQtSdYcnzSEfxC5bluUhZPAaYK1wtOm2v3XcyJmBlFXgTXQez49gmIvBg9Rs4u6d18Jc1yx3DiJFmQRfv0u1gLkTRV2tuS_Axlf96n7bxq3QZqsit-O2XemwVulpVsR8O_-s0DCVPxY9Byfp67eR0yuK0VQARy0LGQn8reWwdoaJpdNYCFjLWtpQkci4VBY0F3wNV5Qz8jUvtNKJ93VTaVEn6T2OKoJ8RKSE_U3f2tyfXkmh8E0rtYoQwKDMl_wnRwci3sCl2aEt4B8jhN3McIvVV8L_VhkogTVqEDbQVnFBwKOL_TULHUrLq3GIrXEmSFzb6hgAL_tt8h9OZiCgfHhlFwmFFtGjOYrrUKaeZ7BTiPB1kEFHwEStj-HOaY2wWlRJT7117CKT-XDhOR3MgiqDpO6eReQ1UQe-_WbXapTwVbgDm6DUuqH5p2gyOt1qobD2Cyw_AZra2oMXXllbhFQegUVUrV-PVWkUeJX7shLwxs8iqBELy2TyhRyoWyjCoIdUiLt_KkNflB9GvE2M6w-8pAqKbSLtVIM1E4dOzcHGYIP_ff3iO0t4QaRxxJraF2XkTPHcIKweG_oqkYakWaf4vxGo0lIZke8N5n6vIgLnhWnYVWYcodJ35TkdhBNc8TCcAIFv1v_Ktnam9Gem66sFRKNX6RNCGSmjl_enRZKbkV2xLZ9yOoLafZEn67BI0p5LfeZnbbOLon649GdVnBXcD3OVsFH2bSnwGp0nTSXXMssDehhFWlxNIF0fkQNwAQ4uLODowWgvtwSmTp54oTQbEwKod7WjZ4LjrrHvKThCzidPDcdyF8GvAaUPa_vTUipklmR726kbpWvFZ1Nkis6qk9PtzakUrfXk4EO5OB-_phAADteybmdBmIG8W2cCNaTM6azMr4H2YLH_0QjQHXPiBpyNt50-v_Y0IptLS9eAVQlKAPcX8KBGl085Q_p8ih1K5oJOwRFjFfg1PrsidQbJCitbEudGrYS48Z6rMznki4sIn_lrLM5K_TD8WZxCMvj5r5VdYU2r5L8c0wy_fXa9eKj_OMyXRfvbxVdUsCn30UwVOhCX849t3PEJhx7DoGriFBYWU_ds-LFxLA_9uuk-co3qUGyUKPkSOjCQBOVAVKMixAg5S45_FXjQ8fE_IMhBd0Puy7iS-zcVboBXpZuxMewf5uRgXuN9WVbD6_Ft9n_u9IbI-r7p_3FdwCAOTBrm17fRu7DX2SIHiN_F3d7jZrgD_06fIx3ZD_6SmGEr_fFk720ismJjz2-MaGr067UaDeXB_B6Gdn6HA5qLacRTR1fDnVvJArpgNzm6qBdOdu0_2GgIr79rFYmqs17JhB--btlvx5RWEGyFabG-29Uw3Myq-ZF9RfXcLRlPahbI2FycUj7frUgHh09dnpd1plkZtbm1WQciagt7G74Row1WtV5eJ6M9x3kqVgBoyjJU6xx9PqSbt53IH2P_T0aoomnE11roHBgp7jddFjha47QWvgn_MR7QFReteMVC660WrGTOVd6wCasBoEVrJZT1f6E6GIeu9cvJTtrqjab0u3RLpkIfKOV51AjZCyYly89WVa1p7UYmz1bfVEo4fqxC21Kls-zpRPICLfUbT1r0RvK9tVAHPVs7Ac5yhpcg3IvcR2r8HTC3zhq-MdYz4HJIabc8hCyrxFPl6jV2H7I_mi1IRqvq9tz_FxAVDH0mLeh2dgebSR0jjSJz","enabled":false},{"key":"BearerToken","value":null,"enabled":false},{"key":"RefreshToken","value":null,"enabled":false},{"key":"BearerToken","value":"","enabled":true},{"key":"RefreshToken","value":"","enabled":true},{"key":"access_token","value":"","enabled":true},{"key":"refresh_token","value":"","enabled":true},{"key":"tenantId","value":"","enabled":true}],"published":true}],"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/4ac86db69215e79511f011802945fe671bec2af0fcc1e71e6dce41dd07c346dd","favicon":"https://res.cloudinary.com/postman/image/upload/v1550480807/team/ovu1pv5hmc4qlsbnnlvq.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"},{"label":"Retalia Imagine Public API","value":"756998-ba4a04de-1000-0d7f-eeed-cccfb34d7d88"}],"canonicalUrl":"https://publicapi-docs.retalia.cloud/view/metadata/2sBY4VLHf3"}