{"info":{"_postman_id":"890cb0ab-afa2-44b8-a41d-f600329d9ffc","name":"API Vendizap","description":"

Introdução

A 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.

Autenticação

Para o Vendizap 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

X-Auth-Id: 4754521\nX-Auth-Secret: ChpATl7F?Wi5jmfZnQy1LgJXeq0a8V%@\n\n

\n
\"Lembrando que os dados acima não são válidos, são apenas um exemplo.”
\n

Retornos

O 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Code	Nome	Descrição
200	Success	Sucesso na requisição solicitada acompanhado do respectivo retorno
201	Created	Sucesso ao inserir um novo registro através dos métodos POST acompanhado do respectivo ID e possíveis erros
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)
401	Unauthorized	Credenciais informadas inválidas

Limites de requisição

Cada IP será avaliado de forma individual e caso envie muitas requisições para o servidor, esse IP pode ser temporáriamente bloqueado.

Limites por assinatura do cliente:

Na Vendizap existem dois planos que dão acesso à API, porém os limites de requisições em cada plano é diferente:
Plano Profissional: 150 requisições a cada hora;
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.

Exemplos

GET

Nestes 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.

POST, PUT e PATCH

Na 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       \"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","toc":[{"content":"Introdução","slug":"introducao"},{"content":"Autenticação","slug":"autenticacao"},{"content":"Retornos","slug":"retornos"},{"content":"Limites de requisição","slug":"limites-de-requisicao"}],"owner":"30601988","collectionId":"890cb0ab-afa2-44b8-a41d-f600329d9ffc","publishedId":"2sA2xfXD2T","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"850AD6"},"publishDate":"2024-03-06T19:29:26.000Z"},"item":[{"name":"Categorias","item":[{"name":"Cadastrar categoria","id":"44360a84-bedc-402d-88b4-fb02f97fa51a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Utensílios\",\r\n \"imagem\": \"https://www.vendizap.com/wp-content/themes/startit/assets/img/logo.png\",\r\n \"código\": \"api\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/categorias","description":"

Método utilizado para inserir novas categorias no sistema. Caso já exista uma categoria com a mesma descrição da que está sendo inserida, será retornado apenas o Id da categoria existente com status 200, pois não deve existir duas categorias com a mesma descrição. Caso a categoria não exista, ao criá-la, também retornará o Id, porém o status retornado será 201.

\n","urlObject":{"path":["api","categorias"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"d39b864a-0262-40ec-91fd-542535c390f7","name":"Cadastrar categoria","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Utensílios\",\r\n \"imagem\": \"https://www.vendizap.com/wp-content/themes/startit/assets/img/logo.png\",\r\n \"codigo\": \"api\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/categorias"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6048f2b4b6fa7c28844582d5\"\n}"}],"_postman_id":"44360a84-bedc-402d-88b4-fb02f97fa51a"},{"name":"Atualizar categoria","id":"627c5abe-2681-4b03-b8a7-a9d15e0e9fc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"imagem\": \"https://play-lh.googleusercontent.com/sVm17jdr0Zp96sKyL8wiXoV_oBsvX92wK-4UN4Fu3quA7GHNUEqkVT1xkcmAolY9O8k\",\r\n \"codigo\": \"1234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/categorias/3437d8bb6df10513fb742d56","description":"

Método utilizado para atualizar uma categoria existente através do seu ID ou Código.

\n","urlObject":{"path":["api","categorias","3437d8bb6df10513fb742d56"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"b3260e8b-0d44-4700-85f1-567f22ca40d7","name":"Atualizar categoria","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"imagem\": \"https://play-lh.googleusercontent.com/sVm17jdr0Zp96sKyL8wiXoV_oBsvX92wK-4UN4Fu3quA7GHNUEqkVT1xkcmAolY9O8k\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/categorias/3437d8bb6df10513fb742d56"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6048f2b4b6fa7c28844582d5\"\n}"}],"_postman_id":"627c5abe-2681-4b03-b8a7-a9d15e0e9fc0"},{"name":"Listar categorias","id":"5f6d1fca-9010-481a-934e-3bfbfd48156f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/categorias","description":"

Método utilizado para listar as categorias existentes. Os parâmetros abaixo são opcionais, caso nenhum seja informado será retornado todas as categorias. Os parâmetros não fazem busca exata e sim retornam registros que contenham o texto informado. Por exemplo, caso seja filtrado a descrição \"carne\" será retornado todas as categorias que contenham a palavra \"carne\" em sua descrição. O filtro de código possui o mesmo comportamento.

Retorno

O retorno deste método será sempre um array com os objetos das categorias filtradas.

\n","urlObject":{"path":["api","categorias"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"description":{"content":"

Nome da categoria a ser filtrada

\n","type":"text/plain"},"key":"nome","value":"{{nomeCategoria}}"},{"disabled":true,"description":{"content":"

Código da categoria a ser filtrada

\n","type":"text/plain"},"key":"codigo","value":"{{codigoCategoria}}"}],"variable":[]}},"response":[{"id":"e502e72e-647d-450d-9a65-0d41ff941f49","name":"Listar categorias","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/categorias","host":["https://app.vendizap.com"],"path":["api","categorias"],"query":[{"key":"nome","value":"{{nomeCategoria}}","description":"Nome da categoria a ser filtrada","disabled":true},{"key":"codigo","value":"{{codigoCategoria}}","description":"Código da categoria a ser filtrada","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": \"601d957bb6fa7c11ba209426\",\r\n \"nome\": \"Categoria teste\",\r\n \"codigo\": \"1\"\r\n }, \r\n {\r\n \"id\": \"6048f2b4b6fa7c28844582d5\",\r\n \"nome\": \"Teste API2\",\r\n \"codigo\": \"12234\",\r\n \"imagem\": \"https://minio.vendizap.com/vendizap-categorias/550a0eb3812c3e44071a03ea13cb0170.jpg\"\r\n }\r\n]"}],"_postman_id":"5f6d1fca-9010-481a-934e-3bfbfd48156f"},{"name":"Buscar categoria","id":"7a2dbb09-110f-4759-b321-02733e3435c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/categorias/3437d8bb6df10513fb742d56","description":"

Método utilizado para buscar uma categoria em específico através do seu ID ou Código.

Retorno

Em caso de sucesso esse método retorna um objeto em JSON com os campos e valores da categoria.

\n","urlObject":{"path":["api","categorias","3437d8bb6df10513fb742d56"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"dde37e92-2b69-456d-a04b-030cfcb0ca46","name":"Buscar categoria","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/categorias/3437d8bb6df10513fb742d56"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"6048f2b4b6fa7c28844582d5\",\r\n \"nome\": \"Utensílios\",\r\n \"codigo\": \"12234\",\r\n \"imagem\": \"https://minio.vendizap.com/vendizap-categorias/550a0eb3812c3e44071a03ea13cb0170.jpg\"\r\n}"}],"_postman_id":"7a2dbb09-110f-4759-b321-02733e3435c9"}],"id":"0a453aaf-96fe-44f4-9f41-f94471868855","description":"

Métodos utilizados para manutenção das categorias utilizadas nos produtos.

Categoria

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
nome	string	Sim	Nome da categoria (deve ser único)
imagem	base64/Url	Não	Imagem da categoria. Pode ser enviada em base64 ou via Url
codigo	string	Não	Código da categoria. Pode ser usado para buscar, listar ou atualizar categorias no lugar da Id.

","_postman_id":"0a453aaf-96fe-44f4-9f41-f94471868855"},{"name":"Variações","item":[{"name":"Cadastrar variação","id":"80c58159-44ae-462d-83e5-32012dd61fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Variação Teste\",\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"Variável 1\"\r\n },\r\n {\r\n \"nome\": \"Variável 2\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes","description":"

Método utilizado para cadastrar variação. Deve ser informado pelo menos uma variável neste método conforme exemplo abaixo, caso contrário não será possível cadastrar a variação.

\n","urlObject":{"path":["api","variacoes"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"c6a892b4-c5de-4354-96cf-101cc061993b","name":"Cadastrar variação","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Variação Teste\",\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"Variável 1\"\r\n },\r\n {\r\n \"nome\": \"Variável 2\",\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"60490e61b6fa7c2826105b43\",\r\n \"nome\": \"Variação Teste\", \r\n \"variaveis\": [\r\n {\r\n \"nome\": \"Variável 1\",\r\n \"id\": \"60490e61b6fa7c2826105b44\"\r\n },\r\n {\r\n \"nome\": \"Variável 2\",\r\n \"id\": \"60490e61b6fa7c2826105b45\"\r\n }\r\n ] \r\n}"}],"_postman_id":"80c58159-44ae-462d-83e5-32012dd61fbc"},{"name":"Atualizar variação","id":"cb918859-5fd1-4c7d-a86b-eb19862c8d4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\" : \"Sabores\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes/6037d8bb6df10513fb742d37","description":"

Método utilizado para atualizar uma variação. Caso seja informado variáveis nesse método, todas as variáveis atualmente existentes na variação serão substituídas pelas variáveis informadas nesse método. Caso queira apenas inserir uma nova variável verifique o método PATCH abaixo ou o método POST das variáveis. Os demais campos serão atualizados normalmente.

ATENÇÃO: Em caso de envio de variáveis nesse método, mesmo que as descrições sejam iguais as atualmente existentes, todas as existentes serão excluídas e cadastradas novamente gerando um novo ID para cada uma.

\n","urlObject":{"path":["api","variacoes","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"7efae238-3b8f-4ecd-8511-2e5ec70d1beb","name":"Atualizar variação","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"variável x\"\r\n },\r\n {\r\n \"nome\": \"variável y\"\r\n } \r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes/6037d8bb6df10513fb742d37"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"60490e61b6fa7c2826105b43\",\r\n \"nome\": \"Variação Teste\", \r\n \"variaveis\": [\r\n {\r\n \"nome\": \"variável x\",\r\n \"id\": \"604776f1b6fa7c87726f43e3\"\r\n },\r\n {\r\n \"nome\": \"variável y\",\r\n \"id\": \"6048ae8fb6fa7c29972c882b\"\r\n }\r\n ] \r\n}"}],"_postman_id":"cb918859-5fd1-4c7d-a86b-eb19862c8d4d"},{"name":"Atualizar variação (parcial)","id":"7215b7c4-2c88-42f4-93df-a87515dd4762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\" : \"Sabores\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes/6037d8bb6df10513fb742d37","description":"

Método utilizado para atualizar uma variação de maneira parcial em relação as variáveis. Ou seja, caso seja informado variáveis nesse método, ao contrário do método PUT, as variáveis informadas serão apenas acrescentadas na variação. Caso queira alterar as variáveis excluindo as existentes e incluindo novas veja o método PUT acima. Os demais campos informados serão atualizados normalmente igual ao método PUT.

\n","urlObject":{"path":["api","variacoes","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"5dee6b96-0db7-4ea8-8a49-4e3e28a29ba5","name":"Atualizar variação (parcial)","originalRequest":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"variável 3\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variacoes/6037d8bb6df10513fb742d37"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"60490e61b6fa7c2826105b43\",\n \"nome\": \"Variação Teste\",\n \"variaveis\": [\n {\n \"nome\": \"variável x\",\n \"id\": \"604776f1b6fa7c87726f43e3\"\n },\n {\n \"nome\": \"variável y\",\n \"id\": \"6048ae8fb6fa7c29972c882b\"\n },\n {\n \"nome\": \"variável 3\",\n \"id\": \"6048ae91b6fa7c29991d33e6\"\n }\n ]\n}"}],"_postman_id":"7215b7c4-2c88-42f4-93df-a87515dd4762"},{"name":"Listar variações","id":"b5b9a949-16b2-4cdf-a471-46a4dc3d12b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/variacoes?nome=Variação","description":"

Método utilizado para listar as variações existentes do usuário. Os parâmetros abaixo são opcionais, caso nenhum seja informado serão retornadas todas as variações. O parâmetro de nome faz uma busca de texto, ou seja, retorna as variações que contenham parte do texto informado. Já os demais campos fazem a busca exata pelo valor informado.

Retorno

O retorno deste método será um array com os objetos das variações filtradas e o array de objetos das variáveis.

\n","urlObject":{"path":["api","variacoes"],"host":["https://app.vendizap.com"],"query":[{"key":"nome","value":"Variação"}],"variable":[]}},"response":[{"id":"18f15144-8451-4550-839f-7402ccf97958","name":"Listar variações","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765179","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJnUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/variacoes","host":["https://app.vendizap.com"],"path":["api","variacoes"],"query":[{"key":"nome","value":"Variação","disabled":true},{"key":"codigo","value":"Teste","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": \"604613f7b6fa7c832e5a0314\",\r\n \"nome\": \"Variação API\",\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"variável 1\",\r\n \"id\": \"604613f7b6fa7c832e5a0313\"\r\n },\r\n {\r\n \"nome\": \"variável 2\",\r\n \"id\": \"6048ae8ab6fa7c28844582d1\"\r\n }\r\n ]\r\n }, \r\n {\r\n \"id\": \"60490e61b6fa7c2826105b43\",\r\n \"nome\": \"Variação Teste\",\r\n \"variaveis\": [\r\n {\r\n \"nome\": \"variável x\",\r\n \"id\": \"604776f1b6fa7c87726f43e3\"\r\n },\r\n {\r\n \"nome\": \"variável y\",\r\n \"id\": \"6048ae8fb6fa7c29972c882b\"\r\n },\r\n {\r\n \"nome\": \"variável 3\",\r\n \"id\": \"6048ae91b6fa7c29991d33e6\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"b5b9a949-16b2-4cdf-a471-46a4dc3d12b4"},{"name":"Buscar variação","id":"8bc3e76d-ed38-4659-b4de-f3c35427b37a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/variacoes/6037d8bb6df10513fb742d37","description":"

Método utilizado para buscar uma variação em específico através do seu ID, informado através da URL como mostra abaixo.

Retorno

Em caso de sucesso esse método retorna um objeto em JSON com os campos e valores da variação e suas respectivas variáveis.

Métodos utilizados para manutenção das variações utilizadas nos produtos. Uma variação pode ser entendida como um grupo que contém características que alteram o produto de acordo com essa classificação. Alguns exemplos de variações: Tamanho, Cor, Sabor, Cobertura, Adicional.

Variação

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
nome	string	Sim	Nome da variação (deve ser único)
variáveis	Array de Objetos	Sim	Variáveis que compõem a variação. Uma variação deve ter pelo menos uma variável.
utilizaCor	boolean	Não	Indica se as variáveis dessa variação utilizam cores.

","_postman_id":"c43491cb-3886-4a4a-a149-251f286d8749"},{"name":"Variáveis","item":[{"name":"Cadastrar variável","id":"9a6f4ce0-a5d6-4af7-b869-c1d54d821337","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Variável 5\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37","description":"

Método utilizado para cadastrar variável dentro de uma variação.

\n","urlObject":{"path":["api","variaveis","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"febdb187-7256-496e-b5be-78e68c599ec1","name":"Cadastrar variável","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Variável 5\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"604912a9b6fa7c28836ced05\",\r\n \"nome\": \"Variável 5\"\r\n}"}],"_postman_id":"9a6f4ce0-a5d6-4af7-b869-c1d54d821337"},{"name":"Atualizar variável","id":"94f384eb-1f89-4e06-841d-7e8b12957ca3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"Azul\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88","description":"

Método utilizado para atualizar uma variável de uma variação. Deve ser informado na URL o ID da variação e em seguida o da respectiva variável que deseja alterar.

\n","urlObject":{"path":["api","variaveis","6037d8bb6df10513fb742d37","4437d8bb6df10513fb742d88"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"ad4f601d-058b-4c9a-9263-27db1a69bda3","name":"Atualizar variável","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nome\": \"5 Variável\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"604912a9b6fa7c28836ced05\",\r\n \"nome\": \"5 Variável\"\r\n}"}],"_postman_id":"94f384eb-1f89-4e06-841d-7e8b12957ca3"},{"name":"Listar variáveis","id":"e1b74c43-df30-4bc0-9ec9-cba697eec130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37","description":"

Método utilizado para listar as variáveis existentes dentro de uma determinada variação. Os parâmetros abaixo são opcionais, caso nenhum seja informado será retornado todas as variáveis dentro da variação especificada. O parâmetro de nome faz uma busca de texto, ou seja, retorna as variáveis que contenham parte do texto informado. Já os demais campos fazem a busca exata pelo valor informado.

Retorno

O retorno deste método será um array com os objetos das variáveis filtradas dentro da variação informada.

\n","urlObject":{"path":["api","variaveis","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"key":"nome","value":"variavel"}],"variable":[]}},"response":[{"id":"beac80a5-9c42-4ab3-ae01-6799eef7ca7f","name":"Listar variáveis","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37","host":["https://app.vendizap.com"],"path":["api","variaveis","6037d8bb6df10513fb742d37"],"query":[{"key":"nome","value":"variavel","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"nome\": \"variável x\",\n \"id\": \"604776f1b6fa7c87726f43e3\"\n },\n {\n \"nome\": \"variável y\",\n \"id\": \"6048ae8fb6fa7c29972c882b\"\n },\n {\n \"nome\": \"variável 3\",\n \"id\": \"6048ae91b6fa7c29991d33e6\"\n }\n ]"}],"_postman_id":"e1b74c43-df30-4bc0-9ec9-cba697eec130"},{"name":"Buscar variável","id":"60498b5e-c3b1-432d-a02d-8a4e96a2d3da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/variaveis/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88","description":"

Método utilizado para buscar uma variável em específico através do seu ID e do ID de sua variação, ambos informados através da URL como pode ser visualizado abaixo.

Retorno

Em caso de sucesso esse método retorna um objeto em JSON com os campos e valores da variável.

Métodos utilizados para manutenção das variáveis pertencentes as variações. Uma variável pode ser entendida como uma característica que altera o produto ou um adicional, e pode ser vendido separadamente de acordo com essa característica. Essa variável deve pertencer a um uma variação, que é o que agrupa essas variáveis de acordo com a sua classificação. Exemplo de variáveis pertencentes a variação \"Tamanho\": PP, P, M, G, GG.

Todos os métodos abaixo devem ser acompanhados do ID da variação à qual a respectiva variável pertence.

Variável

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
nome	string	Sim	Nome da variação (deve ser único dentro da mesma variação)
cor	string	Não	Indica quais serão a cor ou cores da variável. Necessita que a variação esteja com o atributo 'utilizaCor' como true. Aceita cores em formato hex nestes formatos: '#000000' ou '#000000

","_postman_id":"22d40127-6c29-4f6a-bbf7-71e0dc7f07de"},{"name":"Produtos","item":[{"name":"Cadastrar produto","id":"9ac7911e-162a-4ed2-85b2-0a47606ed07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descricao\": \"Produto API\", \r\n \"preco\": 9.99,\r\n \"dimensoes\": {\r\n \"altura\": 10,\r\n \"largura\": 10,\r\n \"comprimento\": 10,\r\n \"peso\": 1\r\n },\r\n \"variacoes\": [\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d40\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d42\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n },\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d43\",\r\n \"preco\": 0,\r\n \"imagem\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d44\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d46\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n }\r\n ]\r\n }\r\n ],\r\n \"combinacoes\": [\r\n {\r\n \"codigo\": \"SKU_P_AZUL\",\r\n \"preco\": 12,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d40\",\r\n \"variavel\": \"6037d8bb6df10513fb742d43\"\r\n },\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d44\",\r\n \"variavel\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n ]\r\n },\r\n {\r\n \"codigo\": \"SKU_M_AZUL\",\r\n \"preco\": 12,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d40\",\r\n \"variavel\": \"6037d8bb6df10513fb742d42\"\r\n },\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d44\",\r\n \"variavel\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"imagens\": [\"https://www.vendizap.com/imagens/produto1.jpg\", \"https://www.vendizap.com/imagens/produto2.jpg\"], \r\n \"detalhes\": \"Detalhes do produto de exemplo\",\r\n \"categorias\": [],\r\n \"unidadeVenda\": \"Unidade\",\r\n \"unidadePreco\": \"Unidade\",\r\n \"codigo\": \"10\",\r\n \"qtdeMinima\": 0,\r\n \"qtdeMaxima\": 0,\r\n \"exibir\": true,\r\n \"destaque\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos","description":"

Método utilizado para cadastrar novos produtos. Segue um exemplo abaixo, vale ressaltar que apenas com a descrição já é possível inserir um produto:

\n","urlObject":{"path":["api","produtos"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"9b1287ab-e6c1-4465-b8b3-f84d42d7d6c3","name":"Cadastrar produto (retorno com erros)","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descricao\": \"Produto exemplo\", \r\n \"preco\": 9.99,\r\n \"variacoes\": [\r\n {\r\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037f540b6fa7c03441457b6\",\r\n \"preco\": 1.99,\r\n \"imagem\": 2\r\n }\r\n ]\r\n }\r\n ],\r\n \"promocao\": {\r\n \"dataHoraInicio\": \"2021-02-17 08:00:00\",\r\n \"dataHoraFim\": \"2021-03-01 23:59:59\",\r\n \"percentual\": 10\r\n },\r\n \"imagens\": [\"https://www.vendizap.com/wp-content/themes/startit/assets/img/logo.png\", \"https://play-lh.googleusercontent.com/sVm17jdr0Zp96sKyL8wiXoV_oBsvX92wK-4UN4Fu3quA7GHNUEqkVT1xkcmAolY9O8k\"], \r\n \"detalhes\": \"Detalhes do produto de exemplo\",\r\n \"categorias\": [\"601d957bb6fa7c11ba209426\", \"601d933eb6fa7c06f86bc18c\"],\r\n \"unidadeVenda\": \"Unidade\",\r\n \"unidadePreco\": \"Unidade\",\r\n \"codigo\": \"10\",\r\n \"qtdeMinima\": 0,\r\n \"qtdeMaxima\": 0,\r\n \"exibir\": true,\r\n \"destaque\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"604284466df1054914132443\",\n \"erros\": [\"Não foi possível vincular a imagem de índice 2 para a variável 6037f540b6fa7c03441457b6 da variação 6037f3e2b6fa7c00064e2cb2\"]\n}"},{"id":"b54235a4-7232-47d0-99ff-0c6db19fba93","name":"Cadastrar produto","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"descricao\": \"Produto exemplo\", \r\n \"preco\": 9.99,\r\n \"variacoes\": [\r\n {\r\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037f540b6fa7c03441457b6\",\r\n \"preco\": 1.99,\r\n \"imagem\": 0\r\n }\r\n ]\r\n }\r\n ],\r\n \"promocao\": {\r\n \"dataHoraInicio\": \"2021-02-17 08:00:00\",\r\n \"dataHoraFim\": \"2021-03-01 23:59:59\",\r\n \"percentual\": 10\r\n },\r\n \"imagens\": [\"https://www.vendizap.com/wp-content/themes/startit/assets/img/logo.png\", \"https://play-lh.googleusercontent.com/sVm17jdr0Zp96sKyL8wiXoV_oBsvX92wK-4UN4Fu3quA7GHNUEqkVT1xkcmAolY9O8k\"], \r\n \"detalhes\": \"Detalhes do produto de exemplo\",\r\n \"categorias\": [\"601d957bb6fa7c11ba209426\", \"601d933eb6fa7c06f86bc18c\"],\r\n \"unidadeVenda\": \"Unidade\",\r\n \"unidadePreco\": \"Unidade\",\r\n \"codigo\": \"10\",\r\n \"qtdeMinima\": 0,\r\n \"qtdeMaxima\": 0,\r\n \"exibir\": true,\r\n \"destaque\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"604284466df1054914132443\"\r\n}"}],"_postman_id":"9ac7911e-162a-4ed2-85b2-0a47606ed07f"},{"name":"Atualizar produto","id":"e497e35a-08a3-4d8f-9735-36264232c78a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"combinacoes\": [\r\n {\r\n \"codigo\": \"api\",\r\n \"preco\": 12,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"Tamanho\",\r\n \"variavel\": \"P\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos/6682f7b065be87123fd4d157","description":"

Este método é utilizado para atualizar um produto existente. Todos os campos que forem informados na requisição serão atualizados. Ou seja, inclusive no caso de variações, imagens e categorias que são arrays, caso sejam enviados, serão substituídos as variações/imagens/categorias atuais pelas informadas (caso deseje atualizar parcial veja o método PATCH abaixo).

OBS: Para excluir uma promoção de um produto basta enviar o campo \"promocao\" como null.

ATENÇÃO: No caso de enviar variações neste método, como elas substituirão as atuais, caso o estoque do produto seja controlado pela variação o mesmo será zerado.

\n","urlObject":{"path":["api","produtos","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"ef9439d8-63e1-43a2-9566-bce186765ebe","name":"Atualizar produto","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"categorias\": [\"601d957bb6fa7c11ba209426\"],\r\n \"codigo\": \"123\",\r\n \"exibir\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"604284466df1054914132443\"\r\n}"}],"_postman_id":"e497e35a-08a3-4d8f-9735-36264232c78a"},{"name":"Atualizar produto (parcial)","id":"70cf17a9-44fe-44bf-806a-28c64cb36299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"variacoes\": [\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d40\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d42\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n },\r\n {\r\n \"id\": \"6037d8bb6df10513fb742d43\",\r\n \"preco\": 0,\r\n \"imagem\": 1\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtos/6682f7b065be87123fd4d157","description":"

Este método é utilizado para atualizar um produto existente. É similar ao método PUT, porém, a principal diferença é que campos que são arrays como as variações, imagens e as categorias, quando informados através deste método serão apenas acrescentados e não substituídos como acontece no PUT.

Exemplo: caso seja enviado um array com 1 imagem nesse método para um produto que contenha 2 imagens, essa imagem será acrescentada no produto, ficando ele com 3 imagens. O mesmo acontece para as variações e categorias. Apenas lembrando em relação as variações que caso o controle de estoque seja impactado com a inclusão de uma variação o mesmo será zerado.

Os demais campos são possíveis atualizar normalmente conforme o método PUT;

OBS: Para excluir uma promoção de um produto basta enviar o campo \"promocao\" como null.

Método utilizado para fazer uma busca dos produtos sendo possível utilizar os campos do produto como filtro. O retorno deste método será um array de objetos de produtos. Os produtos serão retornados de maneira resumida, caso queira o produto completo deve ser buscado com o ID conforme método de Buscar produto abaixo.

Com exceção dos campos de variacoes, imagens e de promocao, todos os demais podem ser utilizados como filtro. Todos os campos podem ser filtrados com o seu respectivo nome, com exceção do campo \"categorias\" que deve ser filtrado como \"categoria\".

Os campos descricao, codigo e detalhes fazem a busca parcial, ou seja, qualquer produto que contenha parte do texto informado será retornado. Os demais campos fazem busca exata (equivalente ao operador =).

Além disso, é possível utilizar alguns recursos para paginação, já que o limite de produtos a ser retornado nesse método é de 100 produtos. Caso não seja informado nenhum deles será acatado o padrão:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Tipo	Padrão	Descrição
skip	integer	0	Quantidade de registros iniciais que deve ser \"ignorado\"
limit	integer	100	Quantidade máxima de registros que deve ser retornado (Se for maior que 100 será ignorado)
sort	string	id	Campo que deve ser ordenado os registros
sortType	string	ASC	Tipo de ordenação dos registros com base no campo de ordenação (Valores aceitos: ASC ou DESC)

Segue abaixo um exemplo com alguns parâmetros:

\n","urlObject":{"path":["api","produtos"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"key":"descricao","value":"Teste Metro"},{"disabled":true,"key":"skip","value":"0"},{"disabled":true,"key":"limit","value":"1000"},{"disabled":true,"key":"sort","value":"descricao"},{"disabled":true,"key":"sortType","value":"ASC"},{"disabled":true,"key":"categoria","value":"3437d8bb6df10513fb742d56"}],"variable":[]}},"response":[{"id":"35ec2fc8-d846-4f38-8e98-474fbdbae758","name":"Listar produtos","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/produtos","host":["https://app.vendizap.com"],"path":["api","produtos"],"query":[{"key":"descricao","value":"Produto API","disabled":true},{"key":"categoria","value":"3437d8bb6df10513fb742d56","disabled":true},{"key":"skip","value":"0","disabled":true},{"key":"limit","value":"100","disabled":true},{"key":"sort","value":"descricao","disabled":true},{"key":"sortType","value":"ASC","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"descricao\": \"Produto exemplo\",\r\n \"preco\": 9.99,\r\n \"unidadeVenda\": \"Unidade\",\r\n \"destaque\": false,\r\n \"codigo\": \"10\",\r\n \"exibir\": true,\r\n \"dt_cadastro\": \"2021-02-11 13:22:36\",\r\n \"dt_alteracao\": \"2021-03-01 11:23:21\",\r\n \"id\": \"60254bbcb6fa7c731139e763\"\r\n },\r\n {\r\n \"descricao\": \"Produto teste API\",\r\n \"preco\": 20,\r\n \"unidadeVenda\": \"Unidade\",\r\n \"destaque\": false,\r\n \"codigo\": \"1054\",\r\n \"exibir\": true,\r\n \"dt_cadastro\": \"2021-02-26 19:30:41\",\r\n \"dt_alteracao\": \"2021-03-10 12:36:15\", \r\n \"id\": \"60397691b6fa7c849962a025\"\r\n }\r\n]"}],"_postman_id":"0502e82d-9ae9-4e52-bc7b-ffbfcd518521"},{"name":"Buscar produto","id":"d4bf599e-6c3f-4945-a68e-67ac73780881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtos/6682f7b065be87123fd4d157","description":"

Método utilizado para buscar um produto em específico através do seu ID. Este método retornará um objeto com o produto completo contendo todos os seus campos.

\n","urlObject":{"path":["api","produtos","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"2612d794-a37e-4475-b8d1-53ec02a9fdc0","name":"Buscar produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtos/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"60254bbcb6fa7c731139e763\",\r\n \"descricao\": \"Produto exemplo\",\r\n \"detalhes\": \"Detalhes do produto de exemplo\",\r\n \"preco\": 9.99,\r\n \"unidadeVenda\": \"Unidade\",\r\n \"unidadePreco\": \"Unidade\",\r\n \"categorias\": [\r\n {\r\n \"id\": \"601d957bb6fa7c11ba209426\",\r\n \"nome\": \"Utensílios\"\r\n }\r\n ],\r\n \"variacoes\": [\r\n {\r\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\r\n \"nome\": \"Variacao Teste\",\r\n \"variaveis\": [\r\n {\r\n \"id\": \"604776f1b6fa7c87726f43e3\",\r\n \"nome\": \"Variável 1\",\r\n \"preco\": 0,\r\n \"codigo\": \"\",\r\n \"imagem\": \"https://minio.vendizap.com/produtos/8b5c26aaa4539ef48ca42bbfb98cc47c.jpg\"\r\n },\r\n {\r\n \"id\": \"6048ae8fb6fa7c29972c882b\",\r\n \"nome\": \"Variável 2\",\r\n \"preco\": 0,\r\n \"codigo\": \"\",\r\n \"imagem\": null\r\n },\r\n {\r\n \"id\": \"6048ae91b6fa7c29991d33e6\",\r\n \"nome\": \"Variável 3\",\r\n \"preco\": 0,\r\n \"codigo\": \"\",\r\n \"imagem\": null\r\n }\r\n ],\r\n \"multipla_selecao\": false,\r\n \"obrigatoria\": true,\r\n \"adicional\": false,\r\n \"qtdeMinima\": null,\r\n \"qtdeMaxima\": null\r\n }\r\n ],\r\n \"promocao\": {\r\n \"inicio\": \"2021-02-14 22:00:00\",\r\n \"fim\": \"2021-02-24 20:59:59\",\r\n \"percentual\": 9.999999999999996,\r\n \"precoPromocional\": 26.991\r\n },\r\n \"destaque\": true,\r\n \"codigo\": \"10\",\r\n \"qtdeMinima\": 0,\r\n \"qtdeMaxima\": 0,\r\n \"exibir\": true,\r\n \"dt_cadastro\": \"2021-02-11 13:22:36\",\r\n \"dt_alteracao\": \"2021-03-01 11:23:21\",\r\n \"imagens\": [\r\n \"https://minio.vendizap.com/produtos/8b5c26aaa4539ef48ca42bbfb98cc47c.jpg\",\r\n \"https://minio.vendizap.com/produtos/af9d54f62ac290dc083d2b8b8e58697a.jpg\"\r\n ] \r\n}"}],"_postman_id":"d4bf599e-6c3f-4945-a68e-67ac73780881"}],"id":"695a2a8a-afe1-4060-9096-a76d74d22019","description":"

Métodos utilizados para manutenção dos produtos.

Produto

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
descricao	string	Sim	Descrição do produto
preco	number	Não	Valor do produto
promocao	Object	Não	Informações de promoção para o produto. Objeto de promoção abaixo.
imagens	Array de base64/Url	Não	Array contendo todas as imagens do produto, com limite de acordo com o plano do usuário. As imagens poderão ser recebidas em uma string com a Url ou base64 e serão inseridas na ordem enviada, a primeira será a capa do produto
detalhes	string	Não	Detalhes adicionais do produto, descrição completa
categorias	Array de IDs	Não	Array com strings contendo os IDs de todas as categorias que o produto pertence
variacoes	Array de Variações	Não	Array contendo os objetos das variações do produto. Segue abaixo o modelo deste objeto.
unidadeVenda	string	Não	Unidade a ser utilizada na venda do produto. Deve ser uma das seguintes unidades: [\"Unidade\", \"Caixa\", \"Pacote\", \"Peça\", \"Quilo\", \"Porção\", \"Pedaço\", \"Metro\", \"Par\", \"Jogo\"]. Caso nenhuma seja informada ou seja diferente de uma dessas será cadastrada com a padrão \"Unidade\"
unidadePreco	string	Não	Unidade a ser utilizada no preço do produto. Ex: Produto com preço por Kg mas que é vendido por Peça. Deve ser uma das seguintes unidades: [\"Unidade\", \"Caixa\", \"Pacote\", \"Peça\", \"Quilo\", \"Porção\", \"Pedaço\", \"Metro\", \"Par\", \"Jogo\"]. Caso nenhuma seja informada ou seja diferente de uma dessas será cadastrada com a padrão \"Unidade\"
codigo	string	Não	Código correspondente ao produto no ERP
qtdeMinima	number	Não	Quantidade mínima do produto na venda
qtdeMaxima	number	Não	Quantidade máxima do produto na venda
exibir	bool	Não	Exibe ou não o produto na vitrine (corresponde a ativo/inativo). Padrão: true
destaque	bool	Não	Indica se o produto será exibido nos destaques da vitrine. Padrão: false

Variação

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
ID	string	Sim	ID da variação que deve ser vinculada ao produto
obrigatoria	bool	Não	Define se a variação é obrigatória na venda de um produto, ou seja, deve ser selecionado uma opção. Padrão: true
multipla_selecao	bool	Não	Define se a variação é múltipla, ou seja, permite informar mais de uma para um mesmo produto. Padrão: false
adicional	bool	Não	Define se a variação é um adicional do produto. Padrão: false
qtdeMinima	number	Não	Define a quantidade mínima que deve ser informado na venda para adicionar ao produto. Padrão: 0
qtdeMáxima	number	Não	Define a quantidade máxima que pode ser selecionado da variação na venda para o produto. Padrão: 0
variaveis	Array de Variáveis	Sim	Array de objetos das variáveis pertencentes a variação que serão vinculadas para esse produto. Segue objeto de variável abaixo

Variável

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
ID	string	Sim	ID da variável que deve ser vinculada a variação para o produto.
preco	number	Não	Valor adicional que pode ser informado para a variável. Este valor será somado ao valor do produto caso seja selecionado essa variável. Padrão: 0
imagem	Integer	Não	Índice referente a imagem do produto para esta variável. Ou seja, será mostrado uma das imagens do produto quando selecionado essa variável, portanto o número informado neste campo deve se referir a posição de uma das imagens do produto na ordem que está cadastrado (inicia em 0). Exemplo: caso queira vincular a primeira foto do produto a variação deve ser informado 0.

Combinações (Opcional)

Uma combinação é a junção de todas as variações do produto, relacionando todas as variáveis entre si, utilizado para definir código (sku) ou preço para um relacionamento de variações e variáveis, como por exemplo, Tamanho P e Cor Azul.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
combinacao	array	Sim	Array de objetos, contendo as variações e variáveis e compõem a combinação
variacao	string	Sim	Será enviado dentro do array de combinação e deve receber o ID ou o Nome da variação
variavel	string	Sim	Será enviado dentro do array de combinação e deve receber o ID ou o Nome da variável
codigo	string	Não (se houver preço)	Campo de código de identificação da combinação em outro sistema.
preco	string	Não (se houver código)	Caso a combinação tenha um preço diferente das demais, pode ser informado o preço espeficico para ela. OBS: Funcionalidade ainda não disponível na loja.

Promoção

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Nome	Tipo	Required	Descrição
dataHoraInicio	DateTime	Não	String com a data e hora de início da promoção (Formato: YYYY-mm-dd HH:MM:SS)
dataHoraFim	DateTime	Não	String com a data e hora de encerramento da promoção (Formato: YYYY-mm-dd HH:MM:SS)
percentual	number	Sim	Percentual da promoção aplicado sobre o preço do produto (caso seja informado o precoPromocional este campo não é obrigatório)
precoPromocional	number	Não	Valor promocional do produto.

","_postman_id":"695a2a8a-afe1-4060-9096-a76d74d22019"},{"name":"Estoque","item":[{"name":"Atualizar estoque - Sem variação","id":"edb04321-6ca6-42af-88c8-cb7836b54198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quantidade\": 11\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157","description":"

Através deste método é possível atualizar o estoque de um único produto.

Deve ser utilizado apenas para produtos Sem variação.

Enviar objeto informando a quantidade atual de estoque do produto.

{\n    \"quantidade\": 11\n}\n\n

Exemplo de um produto simples (sem variação) atualizando o estoque para 11

\n","urlObject":{"path":["api","estoque","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"97b42fdd-224a-4a62-9d60-680f3a11bbe9","name":"Atualizar estoque","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quantidade\": 11\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"edb04321-6ca6-42af-88c8-cb7836b54198"},{"name":"Atualizar estoque - Id Variação/Variável","id":"803c33b5-97bc-4cd9-b4b7-40224bb4c708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"quantidade\": 15,\r\n \"combinacao\": {\r\n \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d39\",\r\n \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d47\"\r\n }\r\n },\r\n {\r\n \"quantidade\": 5,\r\n \"combinacao\": {\r\n \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d38\",\r\n \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157","description":"

Através deste método é possível atualizar o estoque de diversas combinações do produto ao mesmo tempo.

Deve ser utilizado apenas para produtos que possuam variações.

Enviar um array contendo objetos informando a quantidade atual de estoque da combinação e também os ids das variações e variáveis que compõem a combinação.

[\n    {\n        \"quantidade\": 15,\n        \"combinacao\": {\n            \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d39\",\n            \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d47\"\n        }\n    },\n    {\n        \"quantidade\": 5,\n        \"combinacao\": {\n            \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d38\",\n            \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d46\"\n        }\n    }\n]\n\n

Exemplo de uma combinação de um produto com estoque controlado por duas variações:

Variação \"Tamanho\" com a variável \"P\" e variação \"Cor\" com a variável \"Preto\" possui 15 quantidades em estoque e Variação \"Tamanho\" com a variável \"P\" e variação \"Cor\" com a variável \"Azul\" possui 5 quantidades em estoque.

\n","urlObject":{"path":["api","estoque","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"66ac0157-2bda-4614-9e81-f5c20be9c78c","name":"Atualizar estoque","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"quantidade\": 15,\r\n \"combinacao\": {\r\n \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d39\",\r\n \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d47\"\r\n }\r\n },\r\n {\r\n \"quantidade\": 5,\r\n \"combinacao\": {\r\n \"6037d8bb6df10513fb742d5a\": \"6037d8bb6df10513fb742d38\",\r\n \"6037d8bb6df10513fb742d44\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"803c33b5-97bc-4cd9-b4b7-40224bb4c708"},{"name":"Atualizar estoque - Código SKU (Combinação)","id":"3d4610fa-2680-4dc1-84d6-4f919892b545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"quantidade\": 15,\r\n \"combinacaoSKU\": \"SKU_P_AZUL\"\r\n },\r\n {\r\n \"quantidade\": 5,\r\n \"combinacaoSKU\": \"SKU_M_AZUL\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157","description":"

Através deste método é possível atualizar o estoque de diversas combinações do produto ao mesmo tempo.

Deve ser utilizado apenas para produtos que possuam variações.

Enviar um array contendo objetos informando a quantidade atual de estoque da combinação e também os códigos SKU da combinação.

[\n    {\n        \"quantidade\": 15,\n        \"combinacaoSKU\": \"SKU_P_AZUL\"\n    },\n    {\n        \"quantidade\": 5,\n        \"combinacaoSKU\": \"SKU_M_AZUL\"\n    }\n]\n\n

Exemplo de uma combinação de um produto com estoque controlado por duas variações:

\n","urlObject":{"path":["api","estoque","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"a3262c9c-6d65-47d9-9004-90bcb3d6fe7f","name":"Atualizar estoque","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"quantidade\": 15,\r\n \"combinacaoSKU\": \"SKU_P_AZUL\"\r\n },\r\n {\r\n \"quantidade\": 5,\r\n \"combinacaoSKU\": \"SKU_M_AZUL\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"3d4610fa-2680-4dc1-84d6-4f919892b545"},{"name":"Atualizar estoque - Id (Combinação)","id":"1607204b-c605-4447-ba16-4e0531893ecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"quantidade\": 15,\r\n \"combinacaoId\": \"66831670fbf70d6ba1726972\"\r\n },\r\n {\r\n \"quantidade\": 5,\r\n \"combinacaoId\": \"66571e84d590f749515092e4\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/estoque/6682f7b065be87123fd4d157","description":"

Através deste método é possível atualizar o estoque de diversas combinações do produto ao mesmo tempo.

Deve ser utilizado apenas para produtos que possuam variações.

Enviar um array contendo objetos informando a quantidade atual de estoque da combinação e também os ids da combinação.

[\n    {\n        \"quantidade\": 15,\n        \"combinacaoId\": \"66831670fbf70d6ba1726972\"\n    },\n    {\n        \"quantidade\": 5,\n        \"combinacaoId\": \"66571e84d590f749515092e4\"\n    }\n]\n\n

Exemplo de uma combinação de um produto com estoque controlado por duas variações:

Métodos utilizados para atualização de estoque do produto.

\n","_postman_id":"2a49edeb-0dbd-42a2-918d-a65e6072bd6b"},{"name":"Pedidos","item":[{"name":"Buscar pedido","id":"deac1998-3236-4185-bd06-aed293cc9d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":"https://app.vendizap.com/api/pedidos/457d8bb6df10513fb742d32","description":"

Esse método é responsável por retornar o pedido completo em formato JSON, contendo todos os dados do cliente, itens (produtos) e suas variações, como mostra os exemplos ao lado.

\n","urlObject":{"path":["api","pedidos","457d8bb6df10513fb742d32"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"e21450f8-71ff-47a4-8752-8c5bcae63390","name":"Buscar pedido","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":"https://app.vendizap.com/api/pedidos/457d8bb6df10513fb742d32"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6040ee0eb6fa7c21341c2617\",\n \"data\": \"2021-03-04 11:26:21\",\n \"itens\": [\n {\n \"id_produto\": \"5e9613a41c23e16216777a62\",\n \"descricao\": \"Produto teste\",\n \"detalhes\": \"\",\n \"preco\": 1,\n \"controle_estoque\": true,\n \"unidadeVenda\": \"Unidade\",\n \"unidadePreco\": \"Unidade\",\n \"categorias\": [\n \"Bebidas\"\n ],\n \"precoPromocional\": null,\n \"quantidade\": 1,\n \"observacaoProduto\": \"\",\n \"relacaoVariacao\": [\n {\n \"nome\": \"Tamanho\",\n \"variaveis\": [\n {\n \"nome\": \"900ml\",\n \"quantidade\": 1,\n \"valorAdicional\": 0,\n \"id\": \"604613f7b6fa7c832e5a0314\"\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": 1,\n \"qtdeMaxima\": null,\n \"quantidadeSelecionada\": 0,\n \"valorAdicionais\": 0,\n \"id\": \"6035138cb6fa7c30a933452a\"\n }\n ],\n \"dimensoes\": null,\n \"embalagemTransporte\": null\n }\n ],\n \"entrega\": true,\n \"dataHoraRetirada\": null,\n \"observacao\": \"\",\n \"pagamento\": {\n \"descricao\": \"Dinheiro\",\n \"utilizaTroco\": true,\n \"utilizaBandeira\": false,\n \"bandeiraSelecionada\": null,\n \"parcelas\": null,\n \"id\": \"5ecfefb393eab21d8d4b3acf\",\n \"dt_alteracao\": null\n },\n \"taxaEntrega\": 0,\n \"qrcode\": null,\n \"valorPedido\": 1,\n \"valorAproximado\": false,\n \"numero\": 162,\n \"importacaoErp\": 0,\n \"vendedor\": null,\n \"cliente\": {\n \"nome\": \"José\",\n \"documento\": \"999.999.999-99\",\n \"telefone\": \"(44) 99999-9999\",\n \"endereco\": {\n \"cep\": \"99999-999\",\n \"logradouro\": \"Avenida Brasil\",\n \"numero\": \"9999\",\n \"bairro\": \"Centro\",\n \"pais\": \"Brasil\",\n \"estado\": \"PR\",\n \"cidade\": \"Maringá\",\n \"complemento\": \"apartamento 19\"\n }\n }\n}"}],"_postman_id":"deac1998-3236-4185-bd06-aed293cc9d8a"},{"name":"Buscar pedidos","id":"bb7ad591-2b94-4e18-b538-146477cd2247","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":"https://app.vendizap.com/api/pedidos?tipoData=criacao&dataInicial=05/01/2023 00:00:00&dataFinal=05/09/2023 23:59:59&cancelados=false&somenteNovos=false&consultarVendedores=true&skip=0","urlObject":{"path":["api","pedidos"],"host":["https://app.vendizap.com"],"query":[{"key":"tipoData","value":"criacao"},{"key":"dataInicial","value":"05/01/2023 00:00:00"},{"key":"dataFinal","value":"05/09/2023 23:59:59"},{"key":"cancelados","value":"false"},{"key":"somenteNovos","value":"false"},{"key":"consultarVendedores","value":"true"},{"key":"skip","value":"0"}],"variable":[]}},"response":[{"id":"d06a777f-e4af-4f31-bbe5-9002821f33d1","name":"Buscar pedidos","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":{"raw":"https://app.vendizap.com/api/pedidos?tipoData=criacao&dataInicial=05/01/2023 00:00:00&dataFinal=05/09/2023 23:59:59&cancelados=false&somenteNovos=false&consultarVendedores=false","protocol":"https","host":["app","vendizap","com"],"path":["api","pedidos"],"query":[{"key":"tipoData","value":"criacao","type":"text"},{"key":"dataInicial","value":"05/01/2023 00:00:00"},{"key":"dataFinal","value":"05/09/2023 23:59:59"},{"key":"cancelados","value":"false"},{"key":"somenteNovos","value":"false"},{"key":"consultarVendedores","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6040ee0eb6fa7c21341c2617\",\n \"data\": \"2021-03-04 11:26:21\",\n \"itens\": [\n {\n \"id_produto\": \"5e9613a41c23e16216777a62\",\n \"descricao\": \"Produto teste\",\n \"detalhes\": \"\",\n \"preco\": 1,\n \"controle_estoque\": true,\n \"unidadeVenda\": \"Unidade\",\n \"unidadePreco\": \"Unidade\",\n \"categorias\": [\n \"Bebidas\"\n ],\n \"precoPromocional\": null,\n \"quantidade\": 1,\n \"observacaoProduto\": \"\",\n \"relacaoVariacao\": [\n {\n \"nome\": \"Tamanho\",\n \"variaveis\": [\n {\n \"nome\": \"900ml\",\n \"quantidade\": 1,\n \"valorAdicional\": 0,\n \"codigo\": \"m\",\n \"id\": \"604613f7b6fa7c832e5a0314\"\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": 1,\n \"qtdeMaxima\": null,\n \"quantidadeSelecionada\": 0,\n \"valorAdicionais\": 0,\n \"codigo\": \"1\",\n \"id\": \"6035138cb6fa7c30a933452a\"\n }\n ],\n \"codigo\": \"teste\",\n \"dimensoes\": null,\n \"embalagemTransporte\": null\n }\n ],\n \"entrega\": true,\n \"dataHoraRetirada\": null,\n \"observacao\": \"\",\n \"pagamento\": {\n \"descricao\": \"Dinheiro\",\n \"utilizaTroco\": true,\n \"utilizaBandeira\": false,\n \"bandeiraSelecionada\": null,\n \"parcelas\": null,\n \"id\": \"5ecfefb393eab21d8d4b3acf\",\n \"dt_alteracao\": null\n },\n \"taxaEntrega\": 0,\n \"qrcode\": null,\n \"valorPedido\": 1,\n \"valorAproximado\": false,\n \"numero\": 162,\n \"importacaoErp\": 0,\n \"vendedor\": null,\n \"cliente\": {\n \"nome\": \"José\",\n \"documento\": \"999.999.999-99\",\n \"telefone\": \"(44) 99999-9999\",\n \"endereco\": {\n \"cep\": \"99999-999\",\n \"logradouro\": \"Avenida Brasil\",\n \"numero\": \"9999\",\n \"bairro\": \"Centro\",\n \"pais\": \"Brasil\",\n \"estado\": \"PR\",\n \"cidade\": \"Maringá\",\n \"complemento\": \"apartamento 19\"\n }\n }\n}"},{"id":"ecefe591-142d-416d-aa8f-0c57580877f8","name":"Buscar pedidos - Vendedor","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":{"raw":"https://app.vendizap.com/api/pedidos?tipoData=criacao&dataInicial=05/01/2023 00:00:00&dataFinal=05/09/2023 23:59:59&cancelados=false&somenteNovos=false&consultarVendedores=true","protocol":"https","host":["app","vendizap","com"],"path":["api","pedidos"],"query":[{"key":"tipoData","value":"criacao","type":"text"},{"key":"dataInicial","value":"05/01/2023 00:00:00"},{"key":"dataFinal","value":"05/09/2023 23:59:59"},{"key":"cancelados","value":"false"},{"key":"somenteNovos","value":"false"},{"key":"consultarVendedores","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6040ee0eb6fa7c21341c2617\",\n \"data\": \"2021-03-04 11:26:21\",\n \"itens\": [\n {\n \"id_produto\": \"5e9613a41c23e16216777a62\",\n \"descricao\": \"Produto teste\",\n \"detalhes\": \"\",\n \"preco\": 1,\n \"controle_estoque\": true,\n \"unidadeVenda\": \"Unidade\",\n \"unidadePreco\": \"Unidade\",\n \"categorias\": [\n \"Bebidas\"\n ],\n \"precoPromocional\": null,\n \"quantidade\": 1,\n \"observacaoProduto\": \"\",\n \"relacaoVariacao\": [\n {\n \"nome\": \"Tamanho\",\n \"variaveis\": [\n {\n \"nome\": \"900ml\",\n \"quantidade\": 1,\n \"valorAdicional\": 0,\n \"codigo\": \"m\",\n \"id\": \"604613f7b6fa7c832e5a0314\"\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": 1,\n \"qtdeMaxima\": null,\n \"quantidadeSelecionada\": 0,\n \"valorAdicionais\": 0,\n \"codigo\": \"1\",\n \"id\": \"6035138cb6fa7c30a933452a\"\n }\n ],\n \"codigo\": \"teste\",\n \"dimensoes\": null,\n \"embalagemTransporte\": null\n }\n ],\n \"entrega\": true,\n \"dataHoraRetirada\": null,\n \"observacao\": \"\",\n \"pagamento\": {\n \"descricao\": \"Dinheiro\",\n \"utilizaTroco\": true,\n \"utilizaBandeira\": false,\n \"bandeiraSelecionada\": null,\n \"parcelas\": null,\n \"id\": \"5ecfefb393eab21d8d4b3acf\",\n \"dt_alteracao\": null\n },\n \"taxaEntrega\": 0,\n \"qrcode\": null,\n \"valorPedido\": 1,\n \"valorAproximado\": false,\n \"numero\": 162,\n \"importacaoErp\": 0,\n \"vendedor\": {\n \"id\": \"6035137cb6fa7c30a933452a\",\n \"nome\": \"Nome - Vendedor\"\n },\n \"cliente\": {\n \"nome\": \"José\",\n \"documento\": \"999.999.999-99\",\n \"telefone\": \"(44) 99999-9999\",\n \"endereco\": {\n \"cep\": \"99999-999\",\n \"logradouro\": \"Avenida Brasil\",\n \"numero\": \"9999\",\n \"bairro\": \"Centro\",\n \"pais\": \"Brasil\",\n \"estado\": \"PR\",\n \"cidade\": \"Maringá\",\n \"complemento\": \"apartamento 19\"\n }\n }\n}"}],"_postman_id":"bb7ad591-2b94-4e18-b538-146477cd2247"},{"name":"Buscar pedidos - Data","id":"eaa5c33c-3124-469c-99a0-f6f32876bb93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":"https://app.vendizap.com/api/pedidos?tipoData=criacao&data=14/06/2023&cancelados=false&consultarVendedores=true&skip=0","urlObject":{"path":["api","pedidos"],"host":["https://app.vendizap.com"],"query":[{"key":"tipoData","value":"criacao"},{"key":"data","value":"14/06/2023"},{"key":"cancelados","value":"false"},{"disabled":true,"key":"somenteNovos","value":"false"},{"key":"consultarVendedores","value":"true"},{"key":"skip","value":"0"}],"variable":[]}},"response":[{"id":"e28fc71f-4704-4cee-adf8-81d067cc11bf","name":"Buscar pedidos - Data","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"}],"url":{"raw":"https://app.vendizap.com/api/pedidos?tipoData=criacao&data=14/06/2023&cancelados=false&consultarVendedores=true","protocol":"https","host":["app","vendizap","com"],"path":["api","pedidos"],"query":[{"key":"tipoData","value":"criacao","type":"text"},{"key":"data","value":"14/06/2023"},{"key":"cancelados","value":"false"},{"key":"consultarVendedores","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6040ee0eb6fa7c21341c2617\",\n \"data\": \"2021-03-04 11:26:21\",\n \"itens\": [\n {\n \"id_produto\": \"5e9613a41c23e16216777a62\",\n \"descricao\": \"Produto teste\",\n \"detalhes\": \"\",\n \"preco\": 1,\n \"controle_estoque\": true,\n \"unidadeVenda\": \"Unidade\",\n \"unidadePreco\": \"Unidade\",\n \"categorias\": [\n \"Bebidas\"\n ],\n \"precoPromocional\": null,\n \"quantidade\": 1,\n \"observacaoProduto\": \"\",\n \"relacaoVariacao\": [\n {\n \"nome\": \"Tamanho\",\n \"variaveis\": [\n {\n \"nome\": \"900ml\",\n \"quantidade\": 1,\n \"valorAdicional\": 0,\n \"id\": \"604613f7b6fa7c832e5a0314\"\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": 1,\n \"qtdeMaxima\": null,\n \"quantidadeSelecionada\": 0,\n \"valorAdicionais\": 0,\n \"id\": \"6035138cb6fa7c30a933452a\"\n }\n ],\n \"dimensoes\": null,\n \"embalagemTransporte\": null\n }\n ],\n \"entrega\": true,\n \"dataHoraRetirada\": null,\n \"observacao\": \"\",\n \"pagamento\": {\n \"descricao\": \"Dinheiro\",\n \"utilizaTroco\": true,\n \"utilizaBandeira\": false,\n \"bandeiraSelecionada\": null,\n \"parcelas\": null,\n \"id\": \"5ecfefb393eab21d8d4b3acf\",\n \"dt_alteracao\": null\n },\n \"taxaEntrega\": 0,\n \"qrcode\": null,\n \"valorPedido\": 1,\n \"valorAproximado\": false,\n \"numero\": 162,\n \"importacaoErp\": 0,\n \"vendedor\": null,\n \"cliente\": {\n \"nome\": \"José\",\n \"documento\": \"999.999.999-99\",\n \"telefone\": \"(44) 99999-9999\",\n \"endereco\": {\n \"cep\": \"99999-999\",\n \"logradouro\": \"Avenida Brasil\",\n \"numero\": \"9999\",\n \"bairro\": \"Centro\",\n \"pais\": \"Brasil\",\n \"estado\": \"PR\",\n \"cidade\": \"Maringá\",\n \"complemento\": \"apartamento 19\"\n }\n }\n}"}],"_postman_id":"eaa5c33c-3124-469c-99a0-f6f32876bb93"}],"id":"d5a24d01-09b8-4482-a104-d70322de5490","description":"

Os pedidos gerados através do Vendizap serão notificados através da URL de Webhook cadastrada na integração através da plataforma. Desta forma, só será possível buscar o pedido completo através do ID do mesmo, que constará nessa notificação. A notificação será disparada nas seguintes ocorrências do pedido:

Operações da notificação de pedido

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operação	Descrição
criado	Quando um novo pedido for criado na plataforma
pagamento_confirmado	Quando o pagamento do pedido for confirmado.
pagamento_cancelado	Quando o pagamento do pedido for cancelado.
cancelado	Quando o pedido for cancelado.
recuperado	Quando um pedido que estava cancelado foi reaberto (recuperado).

Os dados da notificação são enviadas para o webhook em POST no formato JSON. Segue um exemplo dos dados que são enviados na chamada da URL cadastrada no webhook:

{\n       \"client_id\": \"451234\",\n       \"objeto\": \"pedidos\",\n       \"operacao\": \"criado\",\n       \"dataHoraOperacao\": \"2021-03-08 17:01:45\",\n       \"id\": \"60467e6380e5ef19bc2da1d3\",\n       \"resource\": \"https://app.vendizap.com/api/pedidos/60467e6380e5ef19bc2da1d3\"\n}\n\n

O client_id refere-se ao identificador da integração que identifica o cliente. O id refere-se ao id do pedido neste caso, que pode ser acessado através do link no resource, que é o método que está descrito abaixo no qual é possível obter o pedido completo.

Parâmetros de consulta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operação	Descrição
tipoData	\"criacao\" (padrão) → Filtra os pedidos pela data em que foram criados. \"atualizacao\" → Filtra os pedidos pela data da última modificação.
dataInicial	Enviar data e hora no formato DD/MM/YYYY HH:MM:SS
dataFinal	Enviar data e hora no formato DD/MM/YYYY HH:MM:SS
cancelados	Booleano, indica se deve ou não retornar pedidos cancelados
consultarVendedores	Indica se deve ou não retornar pedidos das contas de vendedores vinculados.
skip	Quantidade de registros a serem ignorados (paginação)

","_postman_id":"d5a24d01-09b8-4482-a104-d70322de5490"},{"name":"Produto Variações","item":[{"name":"Vincular variação no produto","id":"5c11a194-819f-40a2-a482-5e59583a0459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"6053bb9b6df1055978541352\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"qtdeMinima\": null,\r\n \"qtdeMaxima\": null,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6053bb9b6df1055978541358\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157","description":"

Método utilizado para vincular uma nova variação ao produto. A variação informada neste método será vinculada no produto. Deve ser informado com as respectivas variáveis.

\n","urlObject":{"path":["api","produtoVariacoes","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"735b55bc-f8a0-4e18-ae7f-7d623ca265e6","name":"Vincular variação no produto","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"qtdeMinima\": null,\r\n \"qtdeMaxima\": null,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037f540b6fa7c03441457b6\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\r\n \"nome\": \"Variação teste\",\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037f540b6fa7c03441457b6\",\r\n \"nome\": \"Variável 1\",\r\n \"preco\": 0,\r\n \"imagem\": null\r\n }\r\n ],\r\n \"multipla_selecao\": false,\r\n \"obrigatoria\": true,\r\n \"adicional\": false,\r\n \"qtdeMinima\": null,\r\n \"qtdeMaxima\": null\r\n}"}],"_postman_id":"5c11a194-819f-40a2-a482-5e59583a0459"},{"name":"Atualizar variação do produto","id":"9a11d7b8-e61e-45d8-b0ed-aa8c42e34917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para atualizar uma variação já vinculada em um produto. Dependendo da alteração de indicadores o estoque pode ser afetado. As variáveis informadas neste método substituem as atuais existentes, dessa forma, o estoque das variáveis existentes serão zerados. Caso queira apenas adicionar uma nova variável utilize o método PATCH abaixo ou o método POST de Produto Variáveis.

\n","urlObject":{"path":["api","produtoVariacoes","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"bb95f048-a9d6-4e3e-98c3-806ec72847cd","name":"Atualizar variação do produto Copy","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"obrigatoria\": false,\r\n \"multipla_selecao\": true,\r\n \"adicional\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\n \"nome\": \"Variação teste\",\n \"variaveis\": [\n {\n \"id\": \"6037f540b6fa7c03441457b6\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n }\n ],\n \"multipla_selecao\": true,\n \"obrigatoria\": false,\n \"adicional\": true,\n \"qtdeMinima\": null,\n \"qtdeMaxima\": null\n}"}],"_postman_id":"9a11d7b8-e61e-45d8-b0ed-aa8c42e34917"},{"name":"Atualizar variação do produto (PARCIAL)","id":"6e854af2-f1da-4ce2-b8f6-50a7d8726b23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6037f540b6fa7c03441457b6\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para atualizar uma variação já vinculada em um produto. Funciona similar ao método PUT acima, porém com a diferença de que as variáveis informadas serão apenas adicionadas no produto e não substituídas.

\n","urlObject":{"path":["api","produtoVariacoes","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"84b29152-3239-43bf-82ed-4bf1672977c6","name":"Atualizar variação do produto (PARCIAL)","originalRequest":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"obrigatoria\": true,\r\n \"multipla_selecao\": false,\r\n \"adicional\": false,\r\n \"variaveis\": [\r\n {\r\n \"id\": \"6048aea5b6fa7c299835f50c\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\n \"nome\": \"Variação teste\",\n \"variaveis\": [\n {\n \"id\": \"6037f540b6fa7c03441457b6\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n },\n {\n \"id\": \"6048aea5b6fa7c299835f50c\",\n \"nome\": \"Variável 2\",\n \"preco\": 0,\n \"imagem\": null\n } \n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": null,\n \"qtdeMaxima\": null\n}"}],"_postman_id":"6e854af2-f1da-4ce2-b8f6-50a7d8726b23"},{"name":"Listar variações de um produto","id":"c6757367-111d-4ade-825d-37695500e4d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157","description":"

Método utilizado para listar todas as variações e respectivas variáveis que um produto possui. Com exceção das variáveis, todos os demais campos da variação podem ser utilizados como filtro no Params pela Url, com a única particularidade que o campo nome não fará a busca exata e sim trará a variação que contém parte daquele texto no nome.

\n","urlObject":{"path":["api","produtoVariacoes","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"key":"nome","value":"Variacao"},{"disabled":true,"key":"obrigatoria","value":"true"}],"variable":[]}},"response":[{"id":"6259de78-9928-4cc3-87fb-e90e2490e68b","name":"Listar variações de um produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157","host":["https://app.vendizap.com"],"path":["api","produtoVariacoes","6682f7b065be87123fd4d157"],"query":[{"key":"nome","value":"Variacao","disabled":true},{"key":"obrigatoria","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"60461196b6fa7c83fa48ecee\",\n \"nome\": \"Variacao Teste\",\n \"variaveis\": [\n {\n \"id\": \"60461196b6fa7c83fa48ecef\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n },\n {\n \"id\": \"60461196b6fa7c83fa48ecf0\",\n \"nome\": \"Variável 2\",\n \"preco\": 0,\n \"imagem\": null\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": null,\n \"qtdeMaxima\": null,\n },\n {\n \"id\": \"6037f3e2b6fa7c00064e2cb2\",\n \"nome\": \"Variação API\",\n \"variaveis\": [\n {\n \"id\": \"6037f540b6fa7c03441457b6\",\n \"nome\": \"Variável x\",\n \"preco\": 0,\n \"imagem\": null\n },\n {\n \"id\": \"6037f540b6fa7c03441457b7\",\n \"nome\": \"Variável y\",\n \"preco\": 0,\n \"codigo\": \"v2\"\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": null,\n \"qtdeMaxima\": null\n }\n]"}],"_postman_id":"c6757367-111d-4ade-825d-37695500e4d5"},{"name":"Buscar variação de um produto","id":"dc1524be-1da9-4281-90e2-2663cb1bf299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para retornar uma variação específica de um determinado produto e suas respectivas variáveis.

\n","urlObject":{"path":["api","produtoVariacoes","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"2cef8f39-25cd-402c-8938-4456d0798b33","name":"Buscar variação de um produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"60461196b6fa7c83fa48ecee\",\n \"nome\": \"Variacao Teste\",\n \"variaveis\": [\n {\n \"id\": \"60461196b6fa7c83fa48ecef\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n },\n {\n \"id\": \"60461196b6fa7c83fa48ecf0\",\n \"nome\": \"Variável 2\",\n \"preco\": 0,\n \"imagem\": null\n }\n ],\n \"multipla_selecao\": false,\n \"obrigatoria\": true,\n \"adicional\": false,\n \"qtdeMinima\": null,\n \"qtdeMaxima\": null,\n \"codigo\": \"Teste\"\n}"}],"_postman_id":"dc1524be-1da9-4281-90e2-2663cb1bf299"},{"name":"Desvincular variação do produto","id":"8a7da3e0-c2e8-45e3-8867-a149f158545c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariacoes/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para excluir (desvincular) uma variação de um produto. Ao executar este método a variação informada e suas respectivas variáveis serão \"desmarcadas\" para o produto informado. Nos casos em que esta variação fazia parte do controle de estoque do produto, todo o estoque dele será zerado.

Métodos utilizados para dar manutenção nas variações vinculadas a um determinado produto. Veja a seção de Produtos para ver a descrição dos campos do objeto de variação do produto, pois deverá ser informado da mesma maneira aqui.

Todos os métodos dessa seção devem obrigatoriamente informar o produtoId na URL, pois são utilizados para um produto em específico.

Validações:

Uma variação opcional (obrigatoria = false) e múltipla seleção (multipla_selecao = true) deve obrigatoriamente ser um adicional (adicional = true). Ou seja, neste caso, caso seja informado o \"adicional\" como false ou não seja informado, será automaticamente cadastrado como adicional (adicional = true).
Uma variação obrigatória (obrigatoria = true) e múltipla seleção (multipla_selecao = true) deve ter uma quantidade mínima maior ou igual a 1. Ou seja, neste caso, caso não seja informado uma quantidade mínima maior ou igual a 1 será automaticamente cadastrada com a quantidade mínima 1.

ATENÇÃO: A alteração de variações do produto pode impactar diretamente no estoque, portanto, caso seja feito alguma alteração que mude a forma como é controlado o estoque, todo o estoque do produto será zerado.

\n","_postman_id":"0bfa5b45-d93f-4756-8526-98d6af274f72"},{"name":"Produto Variáveis","item":[{"name":"Vincular variável na variação do produto","id":"f0c39c87-fad0-43f0-82fd-4199f358a99d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"60dfb46dc4f8da63d518c1d2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para vincular uma nova variável a uma variação do produto.

\n","urlObject":{"path":["api","produtoVariaveis","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"fddbcab3-2318-4cc5-adae-cca5e5d0c1d7","name":"Vincular variável na variação do produto","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"6037f540b6fa7c03441457b6\",\r\n \"preco\": 0,\r\n \"imagem\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6037f540b6fa7c03441457b6\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": \"https://minio.vendizap.com/produtos/75ffe8875716db9e8da84ec77322c38d.jpg\"\n}"}],"_postman_id":"f0c39c87-fad0-43f0-82fd-4199f358a99d"},{"name":"Atualizar variável do produto","id":"12308d5e-2eba-43b1-bb6d-b1561747bd4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"preco\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88","description":"

Método utilizado para alterar uma variável existente em uma variação no produto.

\n","urlObject":{"path":["api","produtoVariaveis","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37","4437d8bb6df10513fb742d88"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"4cecc0d9-b1a4-445e-a755-363ee7117165","name":"Atualizar variável do produto","originalRequest":{"method":"PUT","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"preco\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6037f540b6fa7c03441457b6\",\n \"nome\": \"Variável 1\",\n \"preco\": 2,\n \"imagem\": \"https://minio.vendizap.com/produtos/75ffe8875716db9e8da84ec77322c38d.jpg\"\n}"}],"_postman_id":"12308d5e-2eba-43b1-bb6d-b1561747bd4c"},{"name":"Listar variáveis de uma variação do produto","id":"7b23d23f-dfcc-42af-b84b-01e673c2b27b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","description":"

Método utilizado para listar todas as variáveis que estão vinculados a uma variação do produto. Retorna um array de objetos com as variáveis e pode ser utilizado os campos nos Params para filtrar (opcionais). O campo nome localiza todas as variáveis que contenham parte do texto informado.

\n","urlObject":{"path":["api","produtoVariaveis","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"key":"nome","value":"variavel"},{"disabled":true,"key":"preco","value":"2"}],"variable":[]}},"response":[{"id":"ae060647-0b21-495e-b415-88d5cc941c7a","name":"Listar variáveis de uma variação do produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37","host":["https://app.vendizap.com"],"path":["api","produtoVariaveis","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37"],"query":[{"key":"nome","value":"variavel","disabled":true},{"key":"preco","value":"2","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"60461196b6fa7c83fa48ecef\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n },\n {\n \"id\": \"60461196b6fa7c83fa48ecf0\",\n \"nome\": \"Variável 2\",\n \"preco\": 1.99,\n \"imagem\": null\n }\n]"}],"_postman_id":"7b23d23f-dfcc-42af-b84b-01e673c2b27b"},{"name":"Buscar variável de uma variação do produto","id":"b973db5d-c73f-4cb6-b6b5-275280d2d194","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88","description":"

Método utilizado para buscar uma variável específica vinculada a variação de um produto. Retorna um objeto com os dados da variável.

\n","urlObject":{"path":["api","produtoVariaveis","6682f7b065be87123fd4d157","6037d8bb6df10513fb742d37","4437d8bb6df10513fb742d88"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"7b00b255-9c4f-4624-b338-cf17151115e1","name":"Buscar variável de uma variação do produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"60461196b6fa7c83fa48ecef\",\n \"nome\": \"Variável 1\",\n \"preco\": 0,\n \"imagem\": null\n}"}],"_postman_id":"b973db5d-c73f-4cb6-b6b5-275280d2d194"},{"name":"Desvincular variável do produto","id":"27fea0ec-a4b1-4dca-9f1a-7063ed947a83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoVariaveis/6682f7b065be87123fd4d157/6037d8bb6df10513fb742d37/4437d8bb6df10513fb742d88","description":"

Método utilizado para desvincular (excluir) uma variável de uma variação do produto.

ATENÇÃO: Caso o produto controle estoque por essa variação e essa variável possua saldo em estoque, o mesmo será zerado.

Métodos utilizados para dar manutenção nas variáveis vinculadas a uma variação de um determinado produto. Veja a seção de Produtos para ver a descrição dos campos do objeto de variável da variação, pois deverá ser informado da mesma maneira aqui.

Todos os métodos dessa seção devem obrigatoriamente informar o produtoId e a variacaoId na URL, pois são utilizados para uma variação de um produto em específico.

\n","_postman_id":"c4b9928a-2523-4281-b400-42f1844bcb1e"},{"name":"Produto Combinações","item":[{"name":"Vincular combinações no produto","id":"7afe5796-3cf0-425b-b252-70a2f0ed4cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"combinacoes\": [\r\n {\r\n \"codigo\": \"SKU_API_NOME\",\r\n \"preco\": 0,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"Tamanho\",\r\n \"variavel\": \"P\"\r\n },\r\n {\r\n \"variacao\": \"Cor\",\r\n \"variavel\": \"Azul\"\r\n }\r\n ]\r\n },\r\n {\r\n \"codigo\": \"SKU_API_ID\",\r\n \"preco\": 10,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d40\",\r\n \"variavel\": \"655e3fe59a41cd020c30ff19\"\r\n },\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d44\",\r\n \"variavel\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157","description":"

Método utilizado para adicionar combinações no produto, é possível adicionar código (sku) e/ou preço em cada combinação.

O método aceita um array de combinações. As variações e variáveis podem ser enviadas usando o nome ou id.

O array \"combinacao\" deve conter os pares de variação e variável, esses pares devem ser os mesmos já vinculados no produto e todas as variações e variáveis também devem estar ativadas no produto.

Caso o sistema encontre alguma divergência na combinação, ela não será vinculada ao produto e retornará mais informações no objeto \"erros\".

\n","urlObject":{"path":["api","produtoCombinacoes","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"6e76539e-0d7b-437c-9b70-a4aa4badbb1a","name":"Vincular combinações no produto","originalRequest":{"method":"POST","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"combinacoes\": [\r\n {\r\n \"codigo\": \"SKU_API_NOME\",\r\n \"preco\": 0,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"Tamanho\",\r\n \"variavel\": \"P\"\r\n },\r\n {\r\n \"variacao\": \"Cor\",\r\n \"variavel\": \"Azul\"\r\n }\r\n ]\r\n },\r\n {\r\n \"codigo\": \"SKU_API_ID\",\r\n \"preco\": 10,\r\n \"combinacao\": [\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d40\",\r\n \"variavel\": \"655e3fe59a41cd020c30ff19\"\r\n },\r\n {\r\n \"variacao\": \"6037d8bb6df10513fb742d44\",\r\n \"variavel\": \"6037d8bb6df10513fb742d46\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Dec 2023 12:23:13 GMT"},{"key":"Server","value":"Apache/2.4.49 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.4.24"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, PATCH, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, App-Version, X-Auth-Id,X-Auth-Secret"},{"key":"Content-Length","value":"428"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"alteradas\": [\n {\n \"codigo\": \"SKU_API_NOME\",\n \"preco\": 0,\n \"combinacao\": {\n \"Tamanho\": \"P\",\n \"Cor\": \"Azul\"\n },\n \"id\": {\n \"$oid\": \"6571b932e3dd80645758f442\"\n }\n }\n ],\n \"erros\": [\n {\n \"codigo\": \"SKU_API_ID\",\n \"preco\": 10,\n \"combinacao\": [\n {\n \"variacao\": \"6037d8bb6df10513fb742d40\",\n \"variavel\": \"655e3fe59a41cd020c30ff19\"\n },\n {\n \"variacao\": \"6037d8bb6df10513fb742d44\",\n \"variavel\": \"6037d8bb6df10513fb742d46\"\n }\n ],\n \"erros\": [\n \"Variável Tamanho/PP não está vinculada ao produto\"\n ]\n }\n ]\n}"}],"_postman_id":"7afe5796-3cf0-425b-b252-70a2f0ed4cc0"},{"name":"Listar combinações do produto","id":"3557dc23-cf7e-4d0c-b732-759b9b759236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157?codigo=SKU_API_NOME","description":"

Método utilizado para listar todas as combinações que estão vinculadas ao produto. Retorna um array de objetos com as combinações. Podem ser utilizados os campos \"id\" e \"codigo\" para filtrar (opcional).

\n","urlObject":{"path":["api","produtoCombinacoes","6682f7b065be87123fd4d157"],"host":["https://app.vendizap.com"],"query":[{"disabled":true,"key":"id","value":"6570ce8c532eea32de0808b2"},{"key":"codigo","value":"SKU_API_NOME"}],"variable":[]}},"response":[{"id":"6b0878df-50d3-46ac-9901-7a770bf7e50e","name":"Listar combinações do produto","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":{"raw":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157?codigo=SKU_API_NOME","host":["https://app.vendizap.com"],"path":["api","produtoCombinacoes","6682f7b065be87123fd4d157"],"query":[{"key":"id","value":"6570ce8c532eea32de0808b2","disabled":true},{"key":"codigo","value":"SKU_API_NOME"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Dec 2023 12:18:57 GMT"},{"key":"Server","value":"Apache/2.4.49 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.4.24"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, PATCH, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, App-Version, X-Auth-Id,X-Auth-Secret"},{"key":"Content-Length","value":"108"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": {\n \"$oid\": \"6570ce46f9fdf13b7f6713d7\"\n },\n \"combinacao\": {\n \"Tamanho\": \"P\"\n },\n \"codigo\": \"SKU_API_NOME\",\n \"preco\": 10\n }\n]"}],"_postman_id":"3557dc23-cf7e-4d0c-b732-759b9b759236"},{"name":"Alterar combinação","id":"4ddcbe09-0a7d-4a93-a284-b3daf99926dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\n \"codigo\": \"SKU_API_ID\",\n \"preco\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157/{{combinacaoId_Codigo}}","description":"

Permite alterar código (sku) e/ou preço de uma combinação específica. Para localizar a combinação a ser alterada, pode ser usado o id ou o código (sku).

Example Response

{\n    \"sucesso\": [\n        {\n            \"id\": {\n                \"$oid\": \"6570ce8c532eea32de0808b2\"\n            },\n            \"codigo\": \"SKU_API_ID\",\n            \"preco\": 50\n        }\n    ],\n    \"erros\": []\n}\n\n

\n","urlObject":{"path":["api","produtoCombinacoes","6682f7b065be87123fd4d157","{{combinacaoId_Codigo}}"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"f8ec6beb-bd87-4738-abe6-878b52dd4882","name":"Alterar combinação","originalRequest":{"method":"PATCH","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"body":{"mode":"raw","raw":"{\n \"codigo\": \"SKU_API_ID\",\n \"preco\": 50\n}","options":{"raw":{"language":"json"}}},"url":"https://app.vendizap.com/api/produtoCombinacoes/6682f7b065be87123fd4d157/idOuCodigo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Dec 2023 12:01:34 GMT"},{"key":"Server","value":"Apache/2.4.49 (Unix)"},{"key":"X-Powered-By","value":"PHP/7.4.24"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, PATCH, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, App-Version, X-Auth-Id,X-Auth-Secret"},{"key":"Content-Length","value":"100"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"sucesso\": [\n {\n \"id\": {\n \"$oid\": \"6570ce8c532eea32de0808b2\"\n },\n \"codigo\": \"SKU_API_ID\",\n \"preco\": 50\n }\n ],\n \"erros\": []\n}"}],"_postman_id":"4ddcbe09-0a7d-4a93-a284-b3daf99926dc"}],"id":"ab1f8dc7-bc1a-4986-811d-1188ecfa713a","description":"

Métodos utilizados para dar manutenção nas combinações do produto.

Uma combinação é a junção de todas as variações do produto, relacionando todas as variáveis entre si.

Exemplo: Um produto que possua variações [Tamanho, Cor], variáveis [P, G] e [Azul , Branco] gera as seguintes combinações:

P / Azul
P / Branco
G / Azul
G / Branco

Através das combinações é possível personalizar código (SKU) e preço de todos os relacionamentos possíveis do produto.

\n","_postman_id":"ab1f8dc7-bc1a-4986-811d-1188ecfa713a"},{"name":"Usuário","item":[{"name":"Obter informações do usuário autenticado","id":"5f66f061-13db-4bed-991b-3f4741b9929f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/usuario","description":"

O endpoint GET /api/usuario retorna as informações detalhadas do usuário autenticado. Os dados retornados incluem o nome do usuário, o nome da empresa, o CPF/CNPJ, o e-mail, o número de celular e o endereço completo (com CEP, logradouro, número, complemento, bairro, cidade e estado). Além disso, são listados os subdomínios associados ao usuário.

\n","urlObject":{"path":["api","usuario"],"host":["https://app.vendizap.com"],"query":[],"variable":[]}},"response":[{"id":"0052830e-d9ea-41de-8ea7-4b2e86e05190","name":"Obter informações do usuário autenticado","originalRequest":{"method":"GET","header":[{"key":"X-Auth-Id","value":"765178","type":"text"},{"key":"X-Auth-Secret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S","type":"text"}],"url":"https://app.vendizap.com/api/cliente"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"nome_usuario\": \"Nome do usuário\",\r\n \"nome_empresa\": \"Nome da empresa\",\r\n \"cpfCnpj\": \"999.999.999-99\",\r\n \"email\": \"emailusuario@vendizap.com\",\r\n \"celular\": \"+55 11 99999 9999\",\r\n \"endereco\": {\r\n \"cep\": \"80000-100\",\r\n \"logradouro\": \"Logradouro usuário\",\r\n \"numero\": \"100\",\r\n \"complemento\": \"Loja 42\",\r\n \"bairro\": \"Bairro\",\r\n \"cidade\": \"Cidade\",\r\n \"estado\": \"ES\"\r\n },\r\n \"subdominios\": [\r\n \"subdominiodaloja\",\r\n \"lojasubdominio\"\r\n ]\r\n}"}],"_postman_id":"5f66f061-13db-4bed-991b-3f4741b9929f"}],"id":"6314c1eb-b5a1-4823-907b-06e129990154","description":"

Este endpoint retorna as informações do usuário autenticado.

\n","_postman_id":"6314c1eb-b5a1-4823-907b-06e129990154"}],"event":[{"listen":"prerequest","script":{"id":"d1c6a1e3-9d57-4c5d-858f-436cbd5a5b6d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"adde78a1-acdd-4984-837b-e48abe511183","type":"text/javascript","exec":[""]}}],"variable":[{"key":"clientId","value":"765178"},{"key":"clientSecret","value":"5p2mzhOxH%IWrJvUNbVcGPiy6aRTsj8S"},{"key":"url","value":"https://app.vendizap.com","type":"string"},{"key":"variacaoId","value":"6037d8bb6df10513fb742d37"},{"key":"categoriaId","value":"3437d8bb6df10513fb742d56"},{"key":"variavelId","value":"4437d8bb6df10513fb742d88"},{"key":"produtoId","value":"6682f7b065be87123fd4d157"},{"key":"campoSort","value":"descricao"},{"key":"descricaoProduto","value":"Produto API"},{"key":"pedidoId","value":"457d8bb6df10513fb742d32"},{"key":"combinacaoIdOuCodigo","value":"idOuCodigo"}]}