{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"09c8b19e-5fa4-45db-8da8-c7402bf47dca","name":"API PedidoOK","description":"Integrando seu ERP com o PedidoOK, seus clientes terão a disposição um dos sistema de automação de vendas mais bem avaliado do segmento [(veja nossas avaliações na Google Play)](https://play.google.com/store/apps/details?id=br.com.releaseti.pedidookfit), em constante atualização, de fácil contratação e por um preço acessível.\n\nA integração com o PedidoOK é feita através de API REST utilizando o formato JSON.  \n\nAs APIs do PedidoOK suportam as operações CRUD em praticamente todos as entidades existentes no PedidoOK.\n\n# Primeiro passo\n\nO processo de integração com o PedidoOK é simples e sem burocracia, tudo o que você precisa para iniciar o desenvolvimento são dois tokens para autenticação (`token_parceiro` e `token_pedidook`).\n\n## token_parceiro  \n\nPara obter seu `token_parceiro`, acesse [https://www.pedidook.com.br/api](https://www.pedidook.com.br/api) e preencha o formulário de solicitação do token parceiro.\n\nNós enviaremos o `token_parceiro` para seu e-mail e criaremos uma conta para você utilizar nos testes no desenvolvimento.  \n\nNesse ponto, seu ERP aparecerá na lista de ERPs integrados ao PedidoOK com o status *'em desenvolvimento'*.  \n\n## token_pedidook  \n\nO `token_pedidook` é obtido diretamente em sua conta do PedidoOK na Plataforma PC ('Integrações' no menu lateral -> Selecione o seu ERP na lista -> clique no botão 'Configurar integração|Obter token_pedidook').\n\n# Autenticação\n\nA autenticação é feita através de 2 tokens (`token_parceiro` e `token_pedidook`) que devem ser enviados no header das requisições HTTP. \n\nOs headers das requisições devem ter os campos e valores abaixo:<br>\n\n>`token_parceiro` - [{obtido no primero passo}](#token_parceiro)\n>\n>`token_pedidook` - [{obtido na plataforma PC}](#token_pedidook)\n>\n>`Content-Type` - application/json\n\n**Todas as requisições devem ser feitas em https.**\n\n# Limite de requisições\n\n**As requisições são limitadas em 20.000 (vinte mil) requisições diárias por token_pedidook**\n\nEsse limite inclui todas as requisição (GET, POST, PUT, PATCH ou DELETE).\n\nUma integração bem implementada deve enviar somente registros que sofreram alterações desde sua última integração com o PedidoOK.\n\n# Homologação  \n\nO processo de homologação consiste basicamente na alteração do status do seu ERP de *'em desenvolvimento'* para *'ativo'*.  \n\nA homologação ocorre no momento em que o parceiro concluir que seu ERP está satisfatoriamente integrado ao PedidoOK (não há ncessidade de verificações adicionais por parte do PedidoOK).  \n\nA soliticação de homologação deve ser feita pelo e-mail **integracao@pedidook.com.br**.  \n\nApós seu ERP ser homologado, nós enviaremos um e-mail marketing para nossa base de clientes informando sobre a nova opção de integração com o PedidoOK, além do link para seu ERP constar em nosso site na seção de *'ERPs integrados'*.\n\n# id_parceiro\n\nDisponibilizamos nas entidades um campo chamado `id_parceiro` do tipo String(36), exclusivo para uso do parceiro, no qual deve-se armazenar um valor que identifique unicamente o registro dentro do seu ERP (por exemplo: id, código, uuid, etc).\n\n## id_parceiro no POST\n\nConsidere a seguinte situação: Seu ERP tenta inserir um novo PEDIDO no PedidoOK através da API com o método POST, contudo não recebe a resposta da API e sim um timeout. \n\nNessa situação fica a pergunta: O timeout ocorreu no envio da requsição ao servidor ou no recebimento da resposta ? o PEDIDO foi inserido ou não ? Posso reenviar o PEDIDO sem o risco de duplicidade ? \n\nSe você já utilizou APIs em integraçõse com outros sistemas, provavelmente já teve que lidar com essa situação.\n\n**O principal benefício do `id_parceiro` é a possibilidade de lidar com falhas de forma segura e simples.**\n\nO PedidoOK garante a unicidade do campo `id_parceiro` dentra da mesma entidade para cada parceiro, ou seja, no caso de falha no POST, você pode, seguramente, repetir a requisição do POST (**com o mesmo id_parceiro**) sem o risco de duplicidade.  \n*(caso o registro tenha sido inserido na primeira requisição, o PedidoOK retorna o erro: '24-Já existe um registro com o id_parceiro informado').*\n\nSe você quiser entender melhor sobre o assunto, [veja métodos HTTP não idempotentes](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods_and_web_applications)\n\n## id_parceiro no GET\n\nO `id_parceiro` pode ser utilizado como parâmentro de filtro nas APIs de busca.\n\n## id_parceiro no PUT/PATCH\n\nO `id_parceiro` pode ser alterado livremente (preservando a unicidade) através de requisições para APIs com métodos PUT ou PATCH.\n\n# Método PATCH\n\nVisando flexibilizar a integração com o PedidoOK, disponibilizamos APIs para alterações parciais nos registros com o método PATCH.\n\nAs APIs com método PATCH permitem alterações parciais *(algum(uns) campo(s))* nos registros, enquanto APIs com método PUT executam alterações totais *(todos os campos)* nos registros.\n\nPor exemplo, caso precise alterar somente o estoque de um produto, sem alterar o valor dos demais campos, você deve utilizar a respectiva API com método PATCH, enviando o JSON somente com o campo `estoque`.\n\n`{\"estoque\": 20}`\n\nPara maiores detalhes, [veja métodos HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods)\n\n# Dicas\n\n> - Uitlize o paramêtro `alterado_apos` disponível nos recursos GET (buscar todos) para uma melhor performance na integração;\n>\n> - Não se esqueça do campo `href_proxima_pagina` (disponívels no JSON de retorno dos métodos GET) ele facilita a paginação. Caso a valor desse campo seja null, indica que não existem mais registros nessa busca, caso contrário, o valor retornado nesse campo deve ser utilizado para buscar a próxima página de registros.  \nFormato: `https://api.pedidook.com.br/v1/clientes/?alterado_apos=2019-04-22T08:00:00&pagina=2`\n>\n> - Cuidado com campos omitidos no JSON dos métodos PUT, eles terão seus valores zerados (considere o [método PATCH](#metodo-patch)).\n>\n> - Uma boa ferramente para testes das APIs é o [Postman](https://www.getpostman.com/downloads/), vale a pena conhecer.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7046881","team":316228,"collectionId":"09c8b19e-5fa4-45db-8da8-c7402bf47dca","publishedId":"S17tPnTW","public":true,"publicUrl":"https://docs.api.pedidook.com.br","privateUrl":"https://go.postman.co/documentation/7046881-09c8b19e-5fa4-45db-8da8-c7402bf47dca","customColor":{"top-bar":"E55700","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-04-04T13:18:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Variaveis Servidor","id":"d036de67-0313-4736-9256-b788b89db5cf","owner":"7046881","values":[{"key":"token_pedidook","value":"{{token_pedidook}}","description":"","enabled":true},{"key":"token_parceiro","value":"{{token_parceiro}}","description":"","enabled":true},{"key":"id_cliente","value":"{{id_cliente}}","description":"","enabled":true},{"key":"id_fornecedor","value":"{{id_fornecedor}}","description":"","enabled":true},{"key":"id_produto","value":"{{id_produto}}","description":"","enabled":true},{"key":"id_vendedor","value":"{{id_vendedor}}","description":"","enabled":true},{"key":"id_tabela_preco","value":"{{id_tabela_preco}}","description":"","enabled":true},{"key":"url","value":"https://api.pedidook.com.br/v1","description":"","enabled":true},{"key":"id_cobranca","value":"{{id_cobranca}}","description":"","enabled":true},{"key":"id_cond_pagamento","value":"{{id_cond_pagamento}}","description":"","enabled":true},{"key":"id_pedido","value":"{{id_pedido}}","description":"","type":"text","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/bea4c3b0e118f38f5863ef6ed19d2a4b68c635c86e8835338e07bd1f20f7ec59","favicon":"https://res.cloudinary.com/postman/image/upload/v1554214915/team/zorkuw49pcvbjvl5421k.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":"Variaveis Servidor","value":"7046881-d036de67-0313-4736-9256-b788b89db5cf"}],"canonicalUrl":"https://docs.api.pedidook.com.br/view/metadata/S17tPnTW"}