{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c67c4613-e81a-42cd-9355-9d779f9106e4","name":"API Uoou Solutions - Plataforma de E-commerce","description":"## Bem-vindo a API da Uoou Solutions!\n\nCom a nossa API de Integração é possível automatizar a visualização, criação, atualização e remoção de entidades da Plataforma de E-commerce da Uoou Solutions.\n\n# Visão Geral - API REST\n\nA API da Uoou Solutions é uma API RESTful baseada em requisições HTTPS que permite a integração de sistemas terceiros com a nossa plataforma de forma simples, rápida e segura.\n\nNeste documento você irá encontrar instruções de como nossa API funciona e quais funcionalidades estão disponíveis através da API.\n\nEsta documentação é constantemente atualizada. Tenha certeza de verificar se existem atualizações disponíveis antes de avançar em qualquer desenvolvimento em sua aplicação, mesmo já sendo familiarizado a trabalhar com a nossa API.\n\nPor fim, disponibilizamos um Portal para Desenvoldores com tutoriais úteis de como realizar as primeiras requisições e obter informações necessárias para começar a usar nossa API e resolver dúvidas comuns.\n\nPortal para Desenvolvedores: [https://developers.uoou.com.br/](https://developers.uoou.com.br/)\n\n---\n\n- **Versão**\n    \n\nAtualmente a versão estável da API é a \"v1\".\n\n# Conceitos Básicos\n\nAs chamadas para a API utilizam padrões que serão percebidos em todos os endpoints da API de Integração, facilitando assim a descoberta e utilização da API.\n\n- **Autenticação**\n    \n\nPara conseguir utilizar a API, será necessário entrar em contato com o Lojista (Clientes da Uoou Solutions) para liberação de um Token de Acesso e também de um usuário da API com permissões liberadas.  \n\\- [Ver artigo mostrando como criar um token de integração.](https://developers.uoou.com.br/solutions/article/26000050693-criando-um-token-para-integracao)  \n\\- [É um novo parceiro de integração? Ver artigo mostrando como receber um ambiente de testes para iniciar sua integração conosco.](https://developers.uoou.com.br/solutions/article/26000050694-qual-o-beneficio-de-se-tornar-um-parceiro-de-integracao)\n\n---\n\n- **Listagens - Paginação**\n    \n\nAs consultas da API são paginadas com um limite máximo de 100 registros por página (ex.: produtos, pedidos, etc.).\n\nCada endpoint de listagem possui seu próprio padrão de limite de registros por página.\n\nÉ possível enviar o parâmetro \"**limit**\" nos endpoints de listagem para mudar a quantidade de registros retornados por página.\n\nLimite máximo: As consultas da API são paginadas com um limite máximo de 100 registros por página.\n\nExemplo - Retornando 30 registros por página (listagem de produtos):\n\n> [https://api.uoou.com.br/api/v1/products/?limit=30](https://api.uoou.com.br/api/v1/products/?limit=30) \n  \n\n---\n\n- **Formato de Resposta**\n    \n\nO formato JSON é utilizando para o envio de requisições e também para o retorno das respostas da API.\n\n---\n\n- **Listagens - Filtrando regitros**\n    \n\nPara poder filtrar consultas de requisições de GET pode ser feito a seguinte forma:\n\nColocado o parâmetro \"criteria\" na URL.\n\nSegue o exemplo de produto:\n\n> [https://api.uoou.com.br/api/{{version}}/products/?criteria[createdAtFrom]=2021-10-01&criteria[createdAtTo]=2022-03-01&criteria[enabled]=1](https://api.uoou.com.br/api/%7B%7Bversion%7D%7D/products/?criteria%5BcreatedAtFrom%5D=2021-10-01&criteria%5BcreatedAtTo%5D=2022-03-01&criteria%5Benabled%5D=1) \n  \n\nNesse exemplo está sendo filtrado por produtos criados a partir de 01/10/2021 até 31/03/2022 e que estão ativos.\n\n---\n\n- **Ordenação**\n    \n\nPara poder ordenar de forma diferente as consultas de requisições de GET pode ser feito a seguinte forma:\n\nColocado o parâmetro \"sorting\" na URL.\n\nSegue o exemplo de produto:\n\n> [https://api.uoou.com.br/api/{{version}}/products/?sorting[createdAt]=asc](https://api.uoou.com.br/api/%7B%7Bversion%7D%7D/products/?sorting%5BcreatedAt%5D=asc) \n  \n\nNesse exemplo está sendo ordenado pelo criados do primeiro até o último criado.\n\n---\n\n- **Retornos comuns para todos os Endpoints**\n    \n\nQuando é feito uma requisição e o \"Usuário API\" não tem permissão será retornado status HTTP 403. Para evitar esse erro, entre em contato com o lojista, pedido mais liberações de acesso de permissão.\n\n---\n\n# Limites\n\n- **Limite de frequência**\n    \n\nAs chamadas à nossa API são limitadas a no máximo 3 requisições por segundo e no máximo 180 requisições por minuto.\n\n[>>> Clique para entender mais <<<](https://en.wikipedia.org/wiki/Rate_limiting)\n\nCaso seja ultrapassado o limite a requisição retornará o status 429 (too many requests) e a mensagem:  \nO limite de requisições foi atingido.\n\n- **Limites de registros**\n    \n\nTodas as requisições `GET` de listagem são limitadas por página com no máximo **100** registros cada. Por padrão as consultas são **50** regisitros por página, porém é possível alterar o limite com o parâmetro na url da requisição. Exemplo:\n\n> [https://api.uoou.com.br/api/v1/products/?limit=10](https://api.uoou.com.br/api/v1/products/?limit=10) \n  \n\nNo exemplo acima, a consulta retornará no máximo 10 produtos, porém estará páginado, somente sendo necessário alterar a página no parâmetro na url. Exemplo:\n\n> [https://api.uoou.com.br/api/v1/products/?limit=10&page=2](https://api.uoou.com.br/api/v1/products/?limit=10&page=2)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10041070","collectionId":"c67c4613-e81a-42cd-9355-9d779f9106e4","publishedId":"UVyoVcj7","public":true,"publicUrl":"https://api-docs.uoou.com.br","privateUrl":"https://go.postman.co/documentation/10041070-c67c4613-e81a-42cd-9355-9d779f9106e4","customColor":{"top-bar":"FFFFFF","right-sidebar":"001F49","highlight":"006AC1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API da Uoou Solutions Plataforma de E-commerce para integração com sistemas externos, permite automatizar diversas funções."},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/fcd457ba-9283-4f72-a658-581e0f3dd9b5/bG9nby11b291LWZ1bmRvLWJyYW5jby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"001F49","highlight":"1690ff"}},{"name":"light","logo":"https://content.pstmn.io/b54b1021-0047-47cd-9770-c4824fbbf896/Tm92byBQcm9qZXRvICgzKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"001F49","highlight":"006AC1"}}]}},"version":"8.10.1","publishDate":"2024-07-23T19:47:51.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"API da Uoou Solutions Plataforma de E-commerce para integração com sistemas externos, permite automatizar diversas funções."},"logos":{"logoLight":"https://content.pstmn.io/b54b1021-0047-47cd-9770-c4824fbbf896/Tm92byBQcm9qZXRvICgzKS5wbmc=","logoDark":"https://content.pstmn.io/fcd457ba-9283-4f72-a658-581e0f3dd9b5/bG9nby11b291LWZ1bmRvLWJyYW5jby5wbmc="}},"statusCode":200},"environments":[{"name":"Produção","id":"73096a3d-0231-4614-a161-14c0a661435a","owner":"4703032","values":[{"key":"url","value":"https://api.uoou.com.br/","enabled":true,"type":"default"}],"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/56c71e8c416d31e8140960f3bf35747a3a8c3b3aa9fd3d07a53d5ac58063bf09","favicon":"https://res.cloudinary.com/postman/image/upload/v1669475941/team/t2wa09hhf9mzklgznh1y.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":"Produção","value":"4703032-73096a3d-0231-4614-a161-14c0a661435a"}],"canonicalUrl":"https://api-docs.uoou.com.br/view/metadata/UVyoVcj7"}