{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"890cb0ab-afa2-44b8-a41d-f600329d9ffc","name":"API Vendizap","description":"# **Introdução**\n\nA API do Vendizap, permite uma integração com qualquer plataforma que consiga fazer requisições **HTTP**. Nela é possível realizar os cadastros que possuem dentro da plataforma, além de atualização de estoque e recebimento de pedidos através de webhook.\n\n# **Autenticação**\n\nPara o [Vendizap](https://vendizap.com) identificar qual é o usuário que está se comunicando com a API, é necessário que este usuário configure e ative uma integração no submenu **Integrações** do menu **Configurar** do Vendizap. Nesta tela será fornecido um **Id** e um **Secret** que será utilizado em todas as requisições como forma de identificação e autenticação do usuário respectivamente. Esses dados deverão ser enviados no Header como no exemplo abaixo:\n\n## _Header_\n\n```\nX-Auth-Id: 4754521\nX-Auth-Secret: ChpATl7F?Wi5jmfZnQy1LgJXeq0a8V%@\n\n ```\n\n> _\"Lembrando que os dados acima não são válidos, são apenas um exemplo.”_ \n  \n\n# **Retornos**\n\nO retorno dos métodos será sempre no formato **JSON** em caso de sucesso e com o respectivo **HTTP Status Code**, que poderá ser um dos seguintes:\n\n| HTTP Code | Nome | Descrição |\n| --- | --- | --- |\n| 200 | Success | Sucesso na requisição solicitada acompanhado do respectivo retorno |\n| 201 | Created | Sucesso ao inserir um novo registro através dos métodos POST acompanhado do respectivo **ID** e possíveis erros |\n| 400 | Bad Request | Erro na requisição que não foi possível ser completada, acompanhada do respectivo erro (nesses casos o erro será retornado em uma string e não em JSON) |\n| 401 | Unauthorized | Credenciais informadas inválidas |\n\n# **Limites de requisição**\n\nCada IP será avaliado de forma individual e caso envie muitas requisições para o servidor, esse IP pode ser temporáriamente bloqueado.\n\n**Limites por assinatura do cliente:**\n\nNa Vendizap existem dois planos que dão acesso à API, porém os limites de requisições em cada plano é diferente:  \n**Plano Profissional**: 150 requisições a cada hora;  \n**Plano Empresarial:** Não há limite por hora, mas não impede que o IP seja temporáriamente bloqueado, caso envie muitas requisições seguidas.\n\n## _Exemplos_\n\n### _GET_\n\nNestes casos serão retornados os campos referentes ao item solicitado, podendo ser um array com a lista dos objetos ou apenas um único objeto **JSON** caso tenha sido solicitado via **ID**.\n\n### _POST, PUT e PATCH_\n\nNa maioria dos casos de métodos POST, PUT e PATCH o retorno será o id do registro. Em casos de erros parciais, ou seja, que não impossibilitou o restante da execução do método, os mesmos serão retornados em um campo _array_ com o nome **erros**, conforme exemplo abaixo:\n\n```\n{\n       \"id\": \"6026ef37b6fa7c6ac6574a82\",\n       \"erros\": [\"Erro ao inserir imagem da posição 1: Formato da imagem inválido.\"]\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30601988","collectionId":"890cb0ab-afa2-44b8-a41d-f600329d9ffc","publishedId":"2sA2xfXD2T","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30601988/2sA2xfXD2T","privateUrl":"https://go.postman.co/documentation/30601988-890cb0ab-afa2-44b8-a41d-f600329d9ffc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"850AD6"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Integre seu sistema ERP com o Vendizap utilizando nossa API"},{"name":"title","value":"Documentação API - Vendizap"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/33189a6a-ff9b-4efa-b711-0dc6ca739c8a/Ykc5bmJ5QW9NU2t1Y0c1bi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"850AD6"}},{"name":"light","logo":"https://content.pstmn.io/33189a6a-ff9b-4efa-b711-0dc6ca739c8a/Ykc5bmJ5QW9NU2t1Y0c1bi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"850AD6"}}]}},"version":"8.10.1","publishDate":"2024-03-06T19:29:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação API - Vendizap","description":"Integre seu sistema ERP com o Vendizap utilizando nossa API"},"logos":{"logoLight":"https://content.pstmn.io/33189a6a-ff9b-4efa-b711-0dc6ca739c8a/Ykc5bmJ5QW9NU2t1Y0c1bi5wbmc=","logoDark":"https://content.pstmn.io/33189a6a-ff9b-4efa-b711-0dc6ca739c8a/Ykc5bmJ5QW9NU2t1Y0c1bi5wbmc="}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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/2sA2xfXD2T"}