\n
![\"Exemplo](\"http://wiki.vipcommerce.com.br/images/a/a3/Img-score-pedido.png\")
A API VIP Commerce permite a criação, gerenciamento e consulta de diversas funcionalidades do sistema.
\nA API pode ser consumida por sistemas externos como CRMs (\"Costumer Relationship Management\", ou \"Gestão de Relacionamento com o Cliente\"). \n
\nO acesso se dá mediante um token que deve ser gerado através da aplicação do lojista.
Descrição do cabeçalho headers da requisição.
Será retornado o código de status 422 Unprocessable Entity com a mensagem \"O Cabeçalho Accept deve ser incluído na requisição\", quando o campo Accept do cabeçalho não for enviado na requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"code\": 422,\n \"message\": \"O Cabeçalho Accept deve ser incluído na requisição'\"\n}\nSerá retornado o código de status 500 Internal Server Error com a mensagem \"DomainKey is not defined\", quando o campo DomainKey do cabeçalho não for enviado na requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Ocorreu um erro interno.\",\n \"url\": \"/importacao/clientes?created_inicial=2020-06-23&created_final=2020-12-23\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"Cake\\\\Core\\\\Exception\\\\Exception\",\n \"code\": 500,\n \"message\": \"DomainKey is not defined\"\n }\n }\n}\nusername:password). \nvipcommerce@teste.com.br e sua chave de acesso seja: 673ab009bd2b611816415a3ab2f9b2ffbede60b28c90512991a1addcc7fa216c\ndmlwY29tbWVyY2VAdGVzdGUuY29tLmJyOjY3M2FiMDA5YmQyYjYxMTgxNjQxNWEzYWIyZjliMmZmYmVkZTYwYjI4YzkwNTEyOTkxYTFhZGRjYzdmYTIxNmM=\n\n403 Forbidden com a mensagem: \"Você não está autorizado a acessar esse local.\". Verifique se o seu usuário está habilitado a utilizar esta ação na API. Para facilitar a utilização da API de ofertas do VIP Commerce, disponibilizamos um ambiente para realização de testes.
\nPara utilizar o Sandbox é necessário configurar no cabeçalho header da requisição, o ambiente a ser utilizado.
URL: https://api-integracao.sandbox.vipcommerce.com.br
\nDomainKey: sandbox.vipcommerce.com.br
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}
URL: https://api.vipcommerce.com.br
\nDomainKey: {{DOMAIN_KEY}}
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}
URL: https://api.vipcommerce.com.br
\nOrganizationID: 1
\nAccept: application/json
\nAuthorization: Basic {{TOKEN}}
Algumas requisições retornam resultados com páginação. É possível informar a pagina e o limite de itens por página como parâmetros da requisiçao.
\nRequisições que retornam o objeto pagination é possível informar o número da pagina. O limite é possível informar em qualquer requisição.
\"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n\n\nExemplo informando número da página como parametro:
\nURL/importacao/produtos/?page=2\n\n
Exemplo informando limite de itens por pagina:
\nURL/importacao/produtos/?limit=10\n\n
Exemplo informando número da pagina e limite de itens:
\nURL/importacao/produtos/?page=2&limit=10\n\n
O Postman é um API Client que permite aos desenvolvedores criar, compartilhar, testar APIs. Permitindo aos usuários criar, salvar e efetuar requisições HTTPs. Disponibilizamos uma coleção que pode ser importada via Postman, conforme o tutorial abaixo:
\n![\"importando](\"http://wiki.vipcommerce.com.br/images/thumb/3/34/VIPCOMMERCE_API_1.png/799px-VIPCOMMERCE_API_1.png\")
\n\n![](\"http://wiki.vipcommerce.com.br/images/thumb/c/c0/VIPCOMMERCE_API_2.png/800px-VIPCOMMERCE_API_2.png\")
\n\nA coleção será importada no Postman.
\nApós importar a coleção para o Postman será necessário definir as variáveis, conforme forem utilizadas: DOMAIN_KEY, BASIC, URL, ID_OFERTA, ID_PRODUTO, ID_LISTA, ID_ITEM
\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar uma oferta por centro de distribuição.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção ao criar ofertas com \"produtos pai\", seus respectivos clones serão adicionados automaticamente na oferta.
\nAtenção para cadastrar uma oferta exclusiva por documentos, deverá ser informado a propriedade \"categoria\": \"D\" e a propriedade oferta_documentos
Atenção para cadastrar uma oferta exclusiva por perfis, deverá ser informado a propriedade \"categoria\": \"P\" e a propriedade perfis
Atenção não é possível cadastrar uma oferta vinculada a perfis e vinculada a documentos na mesma oferta.
\nAtenção a API limita um total de 50 (cinquenta) ofertas gerais e 50 (cinquenta) ofertas por CD vigentes. O limite não se aplica a ofertas exclusivas.
\nAtenção Há um limite de vitrines cadastradas. Esse limite hoje é de 10.000 itens vigentes e/ou 100 vitrines vigentes.
\nPara cadastrar uma oferta por CD é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | Sim |
centro_distribuicao_id | ID do centro de distribuição. Atenção deverá ser informado o ID do CD utilizando apenas números. Conforme o exemplo: 1.Atenção ao não enviar o campo centro_distribuicao_id na requisição, a oferta criada será valida para todos os CDs. | Não |
tipo_oferta_id | Tipo da oferta a ser criada.
| Sim |
nome | Título da oferta, exibido no site. Observação: este título será exibido na tag de ofertas: Produto com desconto. | Sim |
descricao | Breve explicação sobre a oferta | Sim |
data_inicial | Data e Hora inicial da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01Atenção: a data inicial não pode ser igual ou inferior a data e hora atual. Recomenda-se definir a hora de vigência com, pelo menos, 2 minutos superiores a hora atual. | Sim |
data_final | Data e Hora final da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | Sim |
criar_vitrine | Caso \"true\" cria automaticamente uma vitrine com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
criar_colecao | Caso \"true\" cria automaticamente uma coleção com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
tema | Template exibido no site em ofertas: Produto com desconto.
| Não |
oferta_produtos | Array de produtos vinculados à oferta. | Sim |
categoria | Categoria vinculada a oferta.
Atenção ao definir a categoria será necessario enviar a propriedade \"perfis\" ou \"oferta_documentos\". | Não |
oferta_documentos | Array de documentos vinculados à oferta. A oferta será exibida apenas para os documentos vinculados. Atenção deverá ser informado o CPF/CNPJ sem formatação. Conforme o exemplo: 11450944080Exemplo: \"oferta_documentos\": [{ documento: 15630585452 },{ documento: 68313757648306 }] | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"D\". |
perfis | Array de IDs de perfis vinculados à oferta. A oferta será exibida apenas para os clientes vinculados ao perfil. Exemplo: \"perfis\": { \"_ids\": [1,2,7]} | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"P\". |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
codigo_erp | Código ERP do produto | Sim |
preco | O preço padrão do produto, fora da oferta. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
valor | No caso de oferta Produto com desconto, é diferente do preço padrão, representando o preço promocional. No caso da oferta Leve e pague, deve ser igual ao preço padrão. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
quantidade_minima |
| Sim |
quantidade_maxima | Representa a quantidade máxima possível de ser incluída no carrinho pelo cliente durante a vigência da oferta. | Sim |
quantidade_pagar | Representa a quantidade do produto a ser paga pelo cliente em ofertas do tipo Leve e pague. Ou seja, o \"Y\" em \"Leve X, pague Y\". Atenção este parâmetro é obrigatório para o ofertas do tipo Leve e pague. | Não |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
documento | Documento do cliente, CPF ou CNPJ. Atenção deverá ser informado sem formatação. (ver exemplo de body abaixo) | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
perfis | Array de IDs de perfis vinculados a oferta. (ver exemplo de body abaixo) | Sim |
{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 5,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"centro_distribuicao_id\": 1,\n \"data_inicial\": \"2018-09-28 09:30:10\",\n \"data_final\": \"2018-09-29 09:40:00\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 32019,\n \"preco\": 8.49,\n \"valor\": 8.49,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1\n },\n {\n \"codigo_erp\": 32014,\n \"preco\": 3.49,\n \"valor\": 3.49,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1\n }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"centro_distribuicao_id\": 1,\n \"data_inicial\": \"2018-09-28 09:30:10\",\n \"data_final\": \"2018-09-29 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 32019,\n \"preco\": 8.49,\n \"valor\": 7.99,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7\n },\n {\n \"codigo_erp\": 32014,\n \"preco\": 3.49,\n \"valor\": 2.99,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7\n }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 5,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"familia\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"D\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5812345321,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"oferta_documentos\": [\n { \"documento\": \"15630585452\" },\n { \"documento\": \"68313757648306\" }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 5,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"familia\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"P\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5871,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"perfis\" : {\n \"_ids\": [1,2,7]\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"215\"\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a oferta será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais produtos.
{\n \"success\": true,\n \"data\": {\n \"id\": 223\n },\n \"warnings\": {\n \"67634\": {\n \"oferta_id\": {\n \"_produtoEmOutraOferta\": \"Produto já cadastrado em outra oferta\" }\n },\n \"12345\": \"Record not found in table \\\"produtos\\\"\",\n \"32014\": \"O desconto aplicado para o produto é igual ou superior a 40.00%\",\n \"45695\": {\n \"produto_id\": {\n \"_produtoDesativado\": \"Produto desativado.\"\n }\n }\n }\n}\n\n| Parâmetro | Erro | Descrição |
|---|---|---|
warnings.codigo_erp | Record not found in table \\\"produtos\\\" | O produto informado não foi encontrado. |
warnings.codigo_erp | O desconto aplicado para o produto é igual ou superior a 50.00% | O desconto aplicado ao produto é igual ou superior ao \"Percentual valor promocional\" parametrizado em Preferências no admin. |
warnings.codigo_erp | Produto já cadastrado em outra oferta. | Informa que o produto já está cadastrado em outra oferta com data conflitante. |
warnings.codigo_erp.produto_id. _produtoDesativado | Produto desativado. | O produto informado está desativado. |
warnings.codigo_erp | Não foi possível adicionar o produto na vitrine. Limite máximo atingido. | Não foi possível adicionar o produto na vitrine, pois na data de inicio da oferta haverá 100 vitrines vigentes ou 10000 produtos em vitrines vigentes. |
Será retornado o código de status 422 Unprocessable Entity quando um ou mais campos obrigatórios no body da requisição não forem informados, um produto não for encontrado, tema inválido (veja mais detalhes na tabela de \"Erros de validação no cadastro\"). É exibido na resposta, a quantidade de erros de validação em message e os erros ocorridos em errors, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"7 erros de validação ocorridos\",\n \"errorCount\": 7,\n \"errors\": {\n \"12345\": \"Record not found in table \\\"produtos\\\"\",\n \"30836\": {\n \"valor\": {\n \"_comparaQuantidade\": \"A quantidade minima do produto em oferta deve ser menor que a quantidade máxima permitida.\"\n }\n },\n \"30858\": {\n \"valor\": {\n \"_required\": \"Este campo é obrigatório\"\n }\n },\n \"32014\": {\n \"quantidade_pagar\": {\n \"checkLevePague\": \"A quantidade mínima (leve) deve ser maior que a quantidade à pagar (pague)\"\n }\n },\n \"32027\": {\n \"preco\": {\n \"decimal\": \"O valor fornecido é inválido\"\n }\n },\n \"45695\": {\n \"produto_id\": {\n \"_produtoDesativado\": \"Produto desativado.\"\n }\n },\n \"48154\": {\n \"oferta_id\": {\n \"_produtoEmOutraOferta\": \"Produto já cadastrado em outra oferta\"\n }\n }\n }\n }\n}\n\n| Parâmetro | Erro | Descrição |
|---|---|---|
data.message | 9 erros de validação ocorridos | Informa o total de erros. |
data.errorCount | 9 | Quantidade de erros. |
erros.codigo_erp | Record not found in table \\\"produtos\\\" | O produto informado não está cadastrado. |
erros.tipo_oferta_id | Tipo de oferta inválido | O tipo de oferta informado não está válido. |
erros.tema | Tema invalido | O tema informado não está válido. |
errors.codigo_erp.oferta_id. _produtoEmOutraOferta | Produto já cadastrado em outra oferta | O produto informado já está cadastrado em uma oferta com datas conflitantes |
errors.codigo_erp.produto_id. _produtoDesativado | Produto desativado. | O produto informado está desativado. |
erros.data_inicial | A data inicial deve ser maior que hoje | Informa que a data inicial deve ser maior que a data de criação da oferta |
erros.data_final | A data final deve ser maior que a data inicial | Informa que a data final deve ser maior que a data inicial. |
erros.filial_id | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.tipo_oferta_id | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.nome | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.descricao | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.data_inicial | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.data_final | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.codigo_erp.quantidade_minima. _required | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.codigo_erp.quantidade_maxima. _required | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.codigo_erp.preco._required | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.codigo_erp.valor._required | Este campo é obrigatório | Informa que este campo é obrigatório. |
erros.codigo_erp.quantidade_minima. numeric | O valor fornecido é inválido | O valor fornecido deverá ser um número. |
erros.codigo_erp.valor. _comparaValor | Preço do produto na oferta deve ser menor que o preço atual | Informa que o preço do produto na oferta deverá ser menor que o preço atual do produto. |
erros.codigo_erp.valor. _comparaQuantidade | A quantidade minima do produto em oferta deve ser menor que a quantidade máxima permitida. | Informa que a quantidade minima deverá ser menor que a quantidade máxima permitida. |
Será retornado o código de status 422 Unprocessable Entity com a mensagem: \"Para cadastrar oferta do tipo Exclusiva é necessário informar a lista de documentos e categoria D\", quando a propriedade \"categoria\" não estiver definida com \"D\" ou a propriedade \"oferta_documentos\" não estiver definida. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Para cadastrar oferta do tipo Exclusiva é necessário informar a lista de documentos e categoria D\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Para cadastrar oferta do tipo Perfil é necessário informar a lista de ids e categoria P\", quando a propriedade \"categoria\" não estiver definida com \"P\" ou a propriedade \"perfis\" não estiver definida. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Para cadastrar oferta do tipo Perfil é necessário informar a lista de ids e categoria P\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Categoria inválida\", quando a propriedade \"categoria\" não for valida. As opções aceitas são: \"D\" para documentos exclusivos e \"P\" para perfis. Atenção opção aceita somente em maiúsculo. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Categoria inválida\"\n }\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar uma oferta combo por centro de distribuição.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas
\nPara cadastrar uma oferta combo é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Atenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção em ofertas combo é obrigatório enviar no minimo 2 (dois) produtos e no maximo 4 (quatro) produtos.
\nAtenção a API limita um total de 50 (cinquenta) ofertas gerais e 50 (cinquenta) ofertas por CD vigentes. O limite não se aplica a ofertas exclusivas.
\nAtenção há um limite de vitrines cadastradas. Esse limite hoje é de 10.000 itens vigentes e/ou 100 vitrines vigentes.
\nDescrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | Sim |
centro_distribuicao_id | ID do centro de distribuição. Atenção deverá ser informado o ID do CD utilizando apenas números. Conforme o exemplo: 1.Atenção ao não enviar o campo centro_distribuicao_id na requisição, a oferta criada será valida para todos os CDs. | Não |
tipo_oferta_id | Tipo da oferta a ser criada. Atenção: deverá ser informado id: 4 (quatro) | Sim |
nome | Título da oferta, exibido no site. Observação: este título será exibido na tag de ofertas: Produto com desconto. | Sim |
descricao | Breve explicação sobre a oferta | Sim |
data_inicial | Data e Hora inicial da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01Atenção: a data inicial não pode ser igual ou inferior a data e hora atual. Recomenda-se definir a hora de vigência com, pelo menos, 2 minutos superiores a hora atual. | Sim |
data_final | Data e Hora final da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | Sim |
criar_vitrine | Caso \"true\" cria automaticamente uma vitrine com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
criar_colecao | Caso \"true\" cria automaticamente uma coleção com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
quantidade_maxima | Define a quantidade maxima de combos por compra. Quantidade maxima de 20 (vinte) combos por compra. Valor default: 1 (um) | Não |
oferta_produtos | Array de produtos vinculados à oferta | Sim |
categoria | Categoria vinculada a oferta.
Atenção ao definir a categoria será necessario enviar a propriedade \"perfis\" ou \"oferta_documentos\". | Não |
oferta_documentos | Array de documentos vinculados à oferta. A oferta será exibida apenas para os documentos vinculados. Atenção deverá ser informado o CPF/CNPJ sem formatação. Conforme o exemplo: 11450944080Exemplo: \"oferta_documentos\": [{ documento: 15630585452 },{ documento: 68313757648306 }] | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"D\". |
perfis | Array de IDs de perfis vinculados à oferta. A oferta será exibida apenas para os clientes vinculados ao perfil. Exemplo: \"perfis\": { \"_ids\": [1,2,7]} | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"P\". |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
codigo_erp | Código ERP do produto | Sim |
preco | O preço padrão do produto, fora da oferta. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
valor | O preço promocional do produto. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
quantidade_minima | Representa a quantidade de itens no combo. | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
documento | Documento do cliente, CPF ou CNPJ. Atenção deverá ser informado sem formatação. (ver exemplo de body abaixo) | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
perfis | Array de IDs de perfis vinculados a oferta. (ver exemplo de body abaixo) | Sim |
{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 4,\n \"nome\": \"Combo via API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"data_inicial\": \"2021-09-28 09:30:10\",\n \"data_final\": \"2021-09-29 09:32:01\",\n \"quantidade_maxima\": 15,\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 187,\n \"preco\": 2.97,\n \"valor\": 2.96,\n \"quantidade_minima\": 10\n },\n {\n \"codigo_erp\": 264,\n \"preco\": 2.97,\n \"valor\": 2.50,\n \"quantidade_minima\": 2\n }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 4,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"D\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5812345321,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"oferta_documentos\": [\n { \"documento\": \"15630585452\" },\n { \"documento\": \"68313757648306\" }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 4,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"familia\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"P\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5871,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"perfis\" : {\n \"_ids\": [1,2,7]\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 68\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a oferta será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais produtos.
{\n \"success\": true,\n \"data\": {\n \"id\": 223\n },\n \"warnings\": {\n \"67634\": {\n \"oferta_id\": {\n \"_produtoEmOutraOferta\": \"Produto já cadastrado em outra oferta\" }\n },\n \"12345\": \"Record not found in table \\\"produtos\\\"\",\n \"32014\": \"O desconto aplicado para o produto é igual ou superior a 40.00%\",\n \"45695\": {\n \"produto_id\": {\n \"_produtoDesativado\": \"Produto desativado.\"\n }\n }\n }\n}\n\n| Parâmetro | Erro | Descrição |
|---|---|---|
warnings.codigo_erp | Record not found in table \\\"produtos\\\" | O produto informado não foi encontrado. |
warnings.codigo_erp | O desconto aplicado para o produto é igual ou superior a 50.00% | O desconto aplicado ao produto é igual ou superior ao \"Percentual valor promocional\" parametrizado em Preferências no admin. |
warnings.codigo_erp | Produto já cadastrado em outra oferta. | Informa que o produto já está cadastrado em outra oferta com data conflitante. |
warnings.codigo_erp.produto_id. _produtoDesativado | Produto desativado. | O produto informado está desativado. |
warnings.codigo_erp | Não foi possível adicionar o produto na vitrine. Limite máximo atingido. | Não foi possível adicionar o produto na vitrine, pois na data de inicio da oferta haverá 100 vitrines vigentes ou 10000 produtos em vitrines vigentes. |
Será retornado o código de status 422 Unprocessable Entity com a mensagem \"Produto já cadastrado em outra oferta\", quando o produto estiver cadastrado em outra oferta vigente, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"22912\": {\n \"oferta_id\": {\n \"_produtoEmOutraOferta\": \"Produto já cadastrado em outra oferta\"\n }\n },\n \"1454\": \"O desconto aplicado para o produto é igual ou superior a 50.00%\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A quantidade de produtos para oferta combo deve ser no mínimo 2\", quando não forem enviado o minimo de produtos para criação do combo, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"oferta_produtos\": \"A quantidade de produtos para oferta combo deve ser no mínimo 2\"\n }\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar uma oferta por família.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção ao criar ofertas com \"produtos pai\", seus respectivos clones serão adicionados automaticamente na oferta.
\nAtenção a quantidade mínima de produtos na oferta família deve ser igual ou superior a 2.
\nAtenção para cadastrar uma oferta família, os produtos devem possuir os mesmos valores de 'preco', 'valor', 'quantidade_minima', 'quantidade_maxima'. Em caso de divergência um erro será retornado (ver erro - Condições promocionais divergentes entre os produtos).
\nAtenção para cadastrar uma oferta exclusiva por documentos, deverá ser informado a propriedade \"categoria\": \"D\" e a propriedade oferta_documentos
Atenção para cadastrar uma oferta exclusiva por perfis, deverá ser informado a propriedade \"categoria\": \"P\" e a propriedade perfis
Atenção não é possível cadastrar uma oferta vinculada a perfis e vinculada a documentos na mesma oferta.
\nAtenção a API limita um total de 50 (cinquenta) ofertas gerais e 50 (cinquenta) ofertas por CD vigentes. O limite não se aplica a ofertas exclusivas.
\nOfertas família permitem maior concessão de vantagens ao cliente, permitindo que comprem variações de um mesmo produto e receba desconto.
\nPara cadastrar uma oferta por família é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | Sim |
centro_distribuicao_id | ID do centro de distribuição. Atenção deverá ser informado o ID do CD utilizando apenas números. Conforme o exemplo: 1.Atenção ao não enviar o campo centro_distribuicao_id na requisição, a oferta criada será valida para todos os CDs. | Não |
tipo_oferta_id | Tipo da oferta a ser criada.
| Sim |
nome | Título da oferta, exibido no site. Observação: este título será exibido na tag de ofertas: Produto com desconto. | Sim |
descricao | Breve explicação sobre a oferta | Sim |
data_inicial | Data e Hora inicial da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01Atenção: a data inicial não pode ser igual ou inferior a data e hora atual. Recomenda-se definir a hora de vigência com, pelo menos, 2 minutos superiores a hora atual. | Sim |
data_final | Data e Hora final da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | Sim |
criar_vitrine | Caso \"true\" cria automaticamente uma vitrine com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
criar_colecao | Caso \"true\" cria automaticamente uma coleção com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
tema | Template exibido no site em ofertas: Produto com desconto.
| Não |
familia | Define se a oferta será do tipo familia. Em ofertas do tipo familia deverá ser enviado: true. Atenção: ao não enviar true, a oferta não será do tipo família. | Não |
oferta_produtos | Array de produtos vinculados à oferta. | Sim |
categoria | Categoria vinculada a oferta.
Atenção ao definir a categoria será necessario enviar a propriedade \"perfis\" ou \"oferta_documentos\". | Não |
oferta_documentos | Array de documentos vinculados à oferta. A oferta será exibida apenas para os documentos vinculados. Atenção deverá ser informado o CPF/CNPJ sem formatação. Conforme o exemplo: 11450944080Exemplo: \"oferta_documentos\": [{ documento: 15630585452 },{ documento: 68313757648306 }] | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"D\". |
perfis | Array de IDs de perfis vinculados à oferta. A oferta será exibida apenas para os clientes vinculados ao perfil. Exemplo: \"perfis\": { \"_ids\": [1,2,7]} | Não. Atenção será obrigatório enviar este parametro caso a propriedade \"categoria\" esta definida como \"P\". |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
codigo_erp | Código ERP do produto. | Sim |
preco | O preço padrão do produto, fora da oferta. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
valor | No caso de oferta Produto com desconto, é diferente do preço padrão, representando o preço promocional. No caso da oferta Leve e pague, deve ser igual ao preço padrão. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
quantidade_minima |
| Sim |
quantidade_maxima | Representa a quantidade máxima possível de ser incluída no carrinho pelo cliente durante a vigência da oferta. | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
documento | Documento do cliente, CPF ou CNPJ. Atenção deverá ser informado sem formatação. (ver exemplo de body abaixo) | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
perfis | Array de IDs de perfis vinculados a oferta. (ver exemplo de body abaixo) | Sim |
{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"centro_distribuicao_id\": 1,\n \"familia\": true,\n \"data_inicial\": \"2018-09-28 09:30:10\",\n \"data_final\": \"2018-09-29 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 32019,\n \"preco\": 8.49,\n \"valor\": 7.99,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7\n },\n {\n \"codigo_erp\": 32014,\n \"preco\": 8.49,\n \"valor\": 7.99,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7\n }\n ]}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 5,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"familia\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"D\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5812345321,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"oferta_documentos\": [\n { \"documento\": \"15630585452\" },\n { \"documento\": \"68313757648306\" }\n ]\n}\n\n{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 5,\n \"nome\": \"Ofertas especiais\",\n \"descricao\": \"Ofertas\",\n \"tema\": \"oferta-preto\",\n \"criar_vitrine\": true,\n \"criar_colecao\": true,\n \"familia\": true,\n \"centro_distribuicao_id\": 1,\n \"categoria\": \"P\",\n \"data_inicial\": \"2020-03-19 14:47:10\",\n \"data_final\": \"2025-04-30 09:32:01\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 56,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 57,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n },\n {\n \"codigo_erp\": 5871,\n \"preco\": 9.99,\n \"valor\": 9.99,\n \"quantidade_minima\": 3,\n \"quantidade_maxima\": 10,\n \"quantidade_pagar\": 2\n }\n ],\n \"perfis\" : {\n \"_ids\": [1,2,7]\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"215\"\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a oferta será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais produtos. A seguir é exibido um exemplo, de desconto aplicado para o produto igual ou acima do \"Percentual valor promocional\" parametrizado em Preferências no admin.
{\n \"success\": true,\n \"data\": {\n \"id\": 2152\n },\n \"warnings\": {\n \"56\": \"O desconto aplicado para o produto é igual ou superior a 50.00%\",\n \"57\": \"O desconto aplicado para o produto é igual ou superior a 50.00%\"\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Produto não cadastrado.\", quando um ou mais produtos não estiverem cadastrados.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"53126\": \"Produto não cadastrado.\",\n \"5312317\": \"Produto não cadastrado.\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Condições promocionais divergentes entre os produtos\", quando um ou mais produto possuir divergência em condições promocionais. Atenção deverá ser informado os mesmo valores nos campos: 'preco', 'valor', 'quantidade_minima', 'quantidade_maxima'.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"oferta_produtos\": \"Condições promocionais divergentes entre os produtos\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Ofertas por família deve ter no mínimo 2 produtos.\", quando os produtos da oferta família não tiverem o mínimo de 2 (dois) produtos.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"oferta_produtos\": \"Ofertas por família deve ter no mínimo 2 produtos.\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Para cadastrar oferta do tipo Exclusiva é necessário informar a lista de documentos e categoria D\", quando a propriedade \"categoria\" não estiver definida com \"D\" ou a propriedade \"oferta_documentos\" não estiver definida. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Para cadastrar oferta do tipo Exclusiva é necessário informar a lista de documentos e categoria D\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Para cadastrar oferta do tipo Perfil é necessário informar a lista de ids e categoria P\", quando a propriedade \"categoria\" não estiver definida com \"P\" ou a propriedade \"perfis\" não estiver definida. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Para cadastrar oferta do tipo Perfil é necessário informar a lista de ids e categoria P\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Categoria inválida\", quando a propriedade \"categoria\" não for valida. As opções aceitas são: \"D\" para documentos exclusivos e \"P\" para perfis. Atenção opção aceita somente em maiúsculo. A seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"categoria\": \"Categoria inválida\"\n }\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar uma oferta atacarejo.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção a API limita um total de 50 (cinquenta) ofertas gerais e 50 (cinquenta) ofertas por CD vigentes. O limite não se aplica a ofertas exclusivas.
\nAtenção há um limite de vitrines cadastradas. Esse limite hoje é de 10.000 itens vigentes e/ou 100 vitrines vigentes.
\nPara cadastrar uma oferta atacarejo é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | Sim |
tipo_oferta_id | Tipo da oferta a ser criada. Atenção: para ofertas atacarejo deverá ser enviado ID 7 (sete) | Sim |
nome | Título da oferta. | Sim |
descricao | Breve explicação sobre a oferta. | Sim |
data_inicial | Data e Hora inicial da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01Atenção: a data inicial não pode ser igual ou inferior a data e hora atual. Recomenda-se definir a hora de vigência com, pelo menos, 2 minutos superiores a hora atual. | Sim |
data_final | Data e Hora final da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | Sim |
criar_vitrine | Caso \"true\" cria automaticamente uma vitrine com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
criar_colecao | Caso \"true\" cria automaticamente uma coleção com os produtos e duração da oferta. O padrão, caso não informado, é \"false\".
| Não |
oferta_produtos | Array de produtos vinculados à oferta | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
codigo_erp | Código ERP do produto. | Sim |
preco | O preço padrão do produto, fora da oferta. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
valor | Representa o preço a ser exibido no site e incluso no carrinho, quando o produto é adicionado fora da faixa cadastrada. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
quantidade_minima | Representa a quantidade mínima de itens. | Sim |
quantidade_maxima | Representa a quantidade máxima possível de ser incluída no carrinho pelo cliente durante a vigência da oferta. | Sim |
oferta_produto_faixas | Representa a faixas de quantidade(s) e preço(s) a serem vinculados ao produto, sendo necessário enviar no minimo 1 (uma) faixa e no maximo 3 (três) faixas. Atenção: o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75. | Sim |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
quantidade | Quantidade de itens a serem inclusos no carrinho, para aplicação do valor informado. | Sim |
valor | Valor do produto, quando a quantidade informada for adicionada no carrinho. | Sim |
{\n \"filial_id\": 1,\n \"tipo_oferta_id\": 7,\n \"nome\": \"Super oferta atacarejo\",\n \"descricao\": \"Oferta Atacarejo\",\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"data_inicial\": \"2020-03-25 00:00:00\",\n \"data_final\": \"2020-03-25 23:59:59\",\n \"oferta_produtos\": [\n {\n \"codigo_erp\": 32019,\n \"preco\": 9.00,\n \"valor\": 8.95,\n \"quantidade_minima\": 1,\n \"quantidade_maxima\": 100,\n \"oferta_produto_faixas\" : [\n {\n \"quantidade\": 3,\n \"valor\": 7.85\n },\n {\n \"quantidade\": 6,\n \"valor\": 7.65\n },\n {\n \"quantidade\": 12,\n \"valor\": 7.45\n }\n ]\n },\n {\n \"codigo_erp\": 31501,\n \"preco\": 9.00,\n \"valor\": 8.95,\n \"quantidade_minima\": 1,\n \"quantidade_maxima\": 999,\n \"oferta_produto_faixas\" : [\n {\n \"quantidade\": 3,\n \"valor\": 7.85\n },\n {\n \"quantidade\": 6,\n \"valor\": 7.65\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"215\"\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a oferta será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais produtos.
{\n \"success\": true,\n \"data\": {\n \"id\": 16\n },\n \"warnings\": {\n \"32019\": {\n \"oferta_id\": {\n \"_produtoEmOutraOferta\": \"Produto já cadastrado em outra oferta\"\n }\n },\n \"41061\": \"Record not found in table \\\"produtos\\\"\"\n }\n}\n\n| Parâmetro | Erro | Descrição |
|---|---|---|
warnings.codigo_erp | Record not found in table \\\"produtos\\\" | O produto informado não foi encontrado. |
warnings.codigo_erp | O desconto aplicado para o produto é igual ou superior a 50.00% | O desconto aplicado ao produto é igual ou superior ao \"Percentual valor promocional\" parametrizado em Preferências no admin. |
warnings.codigo_erp.produto_id. _produtoDesativado | Produto desativado. | O produto informado está desativado. |
warnings.codigo_erp.oferta_id. _produtoEmOutraOferta | Produto já cadastrado em outra oferta. | Informa que o produto já está cadastrado em outra oferta com data conflitante. |
warnings.codigo_erp | Não foi possível adicionar o produto na vitrine. Limite máximo atingido. | Não foi possível adicionar o produto na vitrine, pois na data de inicio da oferta haverá 100 vitrines vigentes ou 10000 produtos em vitrines vigentes. |
Será retornado o código de status 500 Internal Server Error quando for enviada uma quantidade de faixas para um produto acima quantidade permitida. Atenção: a quantidade maxima permite é de 3 (três) faixas, sendo necessario informar no minimo 1 (uma) faixa. A seguir é exibido a mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Limite de faixas de preço excedido, máximo de 3 faixas por produto ERP: 32019.\",\n \"url\": \"/importacao/ofertas\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"Exception\",\n \"code\": 0,\n \"message\": \"Limite de faixas de preço excedido, máximo de 3 faixas por produto ERP: 32019.\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity quando o ID da oferta informado no body não for válido. Atenção: para ofertas atacarejo deverá ser enviado o ID 7 (sete).
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_oferta_id\": \"Tipo de oferta inválido\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo \"filial_id\" com a mensagem \"Este campo é obrigatório\", quando o ID da filial não for informado no body da requisição.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"filial_id\": \"Este campo é obrigatório\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo \"nome\" com a mensagem \"Este campo é obrigatório\", quando o nome da oferta não for informado no body da requisição.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/ofertas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"nome\": \"Este campo é obrigatório\"\n }\n }\n}\n\nToken de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text","description":"Identificador do dominio
\n"},{"key":"Accept","value":"application/json","type":"text","description":"Tipo de dado que será retornado
\n"}],"body":{"mode":"raw","raw":"{\n \"oferta_documentos\":[\n {\n \"documento\": \"87033594097\"\n },\n {\n \"documento\": \"31461868774304\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-documentos","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite adicionar documentos a uma oferta vigente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA/oferta-documentos
\nPara adicionar documentos a uma oferta exclusiva é necessário enviar uma requisição PUT informando o ID da oferta na URL e os documentos (cpf e cpnj) no corpo body da requisição.
Atenção: Somente será possível adicionar documentos em ofertas que estejam vigentes no momento do envio da requisição.
\nAtenção cada requisição deve conter no máximo 1000 documentos.
\nDescrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
oferta_documento | Array com com os documentos dos clientes. | Sim |
oferta_documento.documento | CPF ou CNPJ do cliente. Atenção deverá ser informado o CPF ou CNPJ do cliente contendo apenas números. | Sim |
Será retornado o código de status 200 OK, quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Documentos salvos com sucesso.\"\n }\n}\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso e uma mensagem de warning será informada quando um documento já estiver vinculado a oferta.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Documentos salvos com sucesso.\"\n },\n \"warning\": [\n \"O documento '31461868774304' já está vinculado nesta oferta.\"\n ]\n}\n\nSerá retornado o código de status 404 Not Found quando o ID da oferta informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Oferta não existe\"\n }\n}\n\nSerá retornado o código de status 406 Not Acceptable quando a oferta informado na URL não estiver vigente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"A Oferta está expirada\"\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma oferta.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA
\nPara consultar uma oferta é necessário enviar uma requisição GET informando o ID da oferta na URL.
Na URL da requisição é obrigatório informar o ID da oferta a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}Exemplo de ID_OFERTA:
\n105
{\n \"success\": true,\n \"data\": {\n \"id\": 139,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"data_inicial\": \"2021-09-28T09:30:10-03:00\",\n \"data_final\": \"2021-09-29T09:32:01-03:00\",\n \"quantidade_maxima\": 1,\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"classe\": null,\n \"desativado\": false,\n \"tema\": \"oferta-preto\",\n \"percentual\": null,\n \"created\": \"2020-05-19T18:29:51-03:00\",\n \"modified\": \"2020-05-19T18:29:51-03:00\",\n \"oferta_id\": 139\n }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID da oferta informada na URL não for encontrada, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/ofertas/1231',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found'\n }\n } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/ofertas","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de resultados,
\n\nPermite listar ofertas cadastradas.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas
\nOs parametros permitidos são:
\nPara listar as ofertas é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 138,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"data_inicial\": \"2021-09-28T09:30:10-03:00\",\n \"data_final\": \"2021-09-29T09:32:01-03:00\",\n \"quantidade_maxima\": 1,\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"classe\": null,\n \"desativado\": false,\n \"tema\": \"oferta-preto\",\n \"percentual\": null,\n \"created\": \"2020-05-19T18:29:51-03:00\",\n \"modified\": \"2020-05-19T18:29:51-03:00\",\n \"oferta_id\": 138\n },\n {\n \"id\": 139,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"data_inicial\": \"2021-09-28T09:30:10-03:00\",\n \"data_final\": \"2021-09-29T09:32:01-03:00\",\n \"quantidade_maxima\": 1,\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"classe\": null,\n \"desativado\": false,\n \"tema\": \"oferta-preto\",\n \"percentual\": null,\n \"created\": \"2020-05-19T18:29:51-03:00\",\n \"modified\": \"2020-05-19T18:29:51-03:00\",\n \"oferta_id\": 139\n },\n {\n \"id\": 140,\n \"centro_distribuicao_id\": 2,\n \"filial_id\": 1,\n \"tipo_oferta_id\": 1,\n \"nome\": \"Super Friday API\",\n \"descricao\": \"Ofertas Super Friday\",\n \"data_inicial\": \"2021-09-28T09:30:10-03:00\",\n \"data_final\": \"2021-09-29T09:32:01-03:00\",\n \"quantidade_maxima\": 1,\n \"criar_vitrine\": false,\n \"criar_colecao\": false,\n \"classe\": null,\n \"desativado\": false,\n \"tema\": \"oferta-preto\",\n \"percentual\": null,\n \"created\": \"2020-05-19T18:29:51-03:00\",\n \"modified\": \"2020-05-19T18:29:51-03:00\",\n \"oferta_id\": 140\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar todos os produtos de uma oferta cadastrada.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA/oferta-produtos
\nPara listar todos os produtos de uma oferta é necessário enviar uma requisição GET, informando o ID da oferta na URL..
Na URL da requisição é obrigatório informar o ID da oferta, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtosExemplo de ID_OFERTA:
\n105
Os parâmetros permitidos para consultar um produto da oferta especificada são:
\nExemplos:
\n\n\nID do produto:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos?produto_id=556Código ERP:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos?codigo_erp=123456
Atenção caso o produto especificado nos parâmetros não for encontrado, será retornado um array vazio.
\nAtenção ao não utilizar nenhum parâmetro, está requisição irá retornar todos os produtos da oferta consultada.
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"5bad3d50-1c5c-42be-93bc-0158ac1e0044\",\n \"oferta_id\": 206,\n \"produto_id\": 20,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1,\n \"desconto\": \"D\",\n \"preco\": 7,\n \"valor\": 7,\n \"modified\": \"2018-09-27T17:28:00-03:00\",\n \"created\": \"2018-09-27T17:28:00-03:00\"\n },\n {\n \"id\": \"5bad3d50-c710-4bbc-bdb3-0158ac1e0044\",\n \"oferta_id\": 206,\n \"produto_id\": 16,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1,\n \"desconto\": \"D\",\n \"preco\": 3.49,\n \"valor\": 3.49,\n \"modified\": \"2018-09-27T17:28:00-03:00\",\n \"created\": \"2018-09-27T17:28:00-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"0ac7dd98-03a3-48fd-b91d-441828ed0e1d\",\n \"oferta_id\": 208,\n \"produto_id\": 16,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1,\n \"desconto\": null,\n \"preco\": 3.49,\n \"valor\": 2.99,\n \"modified\": \"2018-09-27T12:23:57-03:00\",\n \"created\": \"2018-09-27T12:23:57-03:00\"\n },\n {\n \"id\": \"d913ffdc-8eb4-4b5e-a649-a02466fe16f7\",\n \"oferta_id\": 208,\n \"produto_id\": 20,\n \"quantidade_minima\": 2,\n \"quantidade_maxima\": 7,\n \"quantidade_pagar\": 1,\n \"desconto\": null,\n \"preco\": 8.49,\n \"valor\": 7.99,\n \"modified\": \"2018-09-27T12:23:57-03:00\",\n \"created\": \"2018-09-27T12:23:57-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os documentos vinculados a uma oferta.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA/oferta-documentos
\nPara consultar documentos vinculados a uma oferta é necessário enviar uma requisição GET informando o ID da oferta na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"06b45e51-746a-4c70-93d6-27409dd0af87\",\n \"oferta_id\": 674,\n \"cliente_id\": 34,\n \"documento\": \"61624255175\",\n \"created\": \"2021-04-12T13:50:37-03:00\"\n },\n {\n \"id\": \"56d94049-d96c-4fb3-94ea-54cc7a0dbbcb\",\n \"oferta_id\": 674,\n \"cliente_id\": null,\n \"documento\": \"41231412311\",\n \"created\": \"2021-04-12T13:50:37-03:00\"\n },\n {\n \"id\": \"5bb6ea81-c743-4401-bd08-e0d3b7c82e15\",\n \"oferta_id\": 674,\n \"cliente_id\": null,\n \"documento\": \"41231241413\",\n \"created\": \"2021-04-12T13:50:37-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso e a propriedade \"data\" vazio quando o ID da oferta informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos/{{OFERTA_PRODUTO_ID}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um produto da oferta.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA/oferta-produtos/OFERTA_PRODUTO_ID
\nPara excluir um produto da oferta é necessário enviar uma requisição DELETE informando o ID da oferta e o ID do produto na oferta.
Atenção poderão ser excluidos somente produtos cadastrados a partir do token informado em Authorization.
Na URL da requisição é obrigatório informar o ID da oferta e o ID do produto na oferta, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos/{{OFERTA_PRODUTO_ID}}Exemplo de ID_OFERTA: 196
\nExemplo de OFERTA_PRODUTO_ID:
\nfa92b83f-4641-4853-aa53-91727600451fQuantidade de caracteres OFERTA_PRODUTO_ID: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso.
Atenção caso a oferta possua apenas um produto, ao excluí-lo a oferta será excluída e um aviso será retornado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"warnings\": {\n \"oferta\": \"Oferta excluída por não possuir mais produtos associados\"\n }\n}\nSerá retornado o código de status 500 Internal Server Error quando o ID da oferta e/ou ID do produto não for encontrado ou o ID do produto não está vinculado ao ID da oferta, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"An Internal Error Has Occurred.\",\n \"url\": \"/importacao/ofertas/191/oferta-produtos/1b7918e9-5175-4782-8581-e66f758eedcb\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"Error\",\n \"code\": 0,\n \"message\": \"Class 'Cake\\\\Http\\\\Exception\\\\NotFoundException' not found\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite desativar uma oferta.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA
\nPara desativar uma oferta é necessário enviar uma requisição DELETE informando o ID da oferta na URL.
Atenção poderão ser desativadas apenas ofertas cadastradas a partir do token informado em Authorization.
Observação ao desativar uma oferta a vitrine e/ou coleção vinculados a oferta também serão excluídos.
\nNa URL da requisição é obrigatório informar o ID da oferta a ser desativada, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}Exemplo de ID:
\n192
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID da oferta informado na URL não for encontrado, conforme o exemplo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/ofertas/84',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' \n }\n } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"raw","raw":"{\n \"oferta_documentos\":[\n {\n \"documento\": \"87033594097\"\n },\n {\n \"documento\": \"31461868774304\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-documentos","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite deletar documentos de uma oferta vigente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/ofertas/ID_OFERTA/oferta-documentos
\nPara deletar documentos de uma oferta exclusiva é necessário enviar uma requisição DELETE informando o ID da oferta na URL e os documentos (cpf e cpnj) no corpo body da requisição.
Atenção: Somente será possível deletar documentos em ofertas que estejam vigentes no momento do envio da requisição.
\nAtenção cada requisição deve conter no máximo 1000 documentos.
\nDescrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
oferta_documento | Array com com os documentos dos clientes. | Sim |
oferta_documento.documento | CPF ou CNPJ do cliente. Atenção deverá ser informado o CPF ou CNPJ do cliente contendo apenas números. | Sim |
Será retornado o código de status 200 OK, quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Documentos removidos com sucesso.\"\n }\n}\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso e uma mensagem de warning será informada quando um documento informado no body da requisição não estiver vinculado a oferta.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Documentos removidos com sucesso.\"\n },\n \"warning\": [\n \"Documento '31461868774304' não existe nesta oferta.\"\n ]\n}\n\nSerá retornado o código de status 404 Not Found quando o ID da oferta informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Oferta não existe\"\n }\n}\n\nSerá retornado o código de status 406 Not Acceptable quando a oferta informado na URL não estiver vigente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"A Oferta está expirada\"\n }\n}\n\nA API de importacao de ofertas VIP Commerce visa disponibilizar o gerenciamento de ofertas do e-commerce com aplicativos externos como ERPs ou sistemas de BI, por exemplo.
\n","event":[{"listen":"prerequest","script":{"id":"2bb7fa9e-ca3a-4293-8b69-46a10fb5012e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fb760325-0af3-4ca4-87a4-cc033ba2f379","type":"text/javascript","exec":[""]}}],"_postman_id":"b7694475-3871-4905-8549-1450f3ef7129"},{"name":"Carrinho","item":[{"name":"Adicionar itens no carrinho pelo parceiro","id":"db278c96-6f54-4202-9bd9-8626c973b9c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{TOKEN_JWT}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cliente\": \"11111111111\",\n \"itens\": [\n {\n \"codigo_erp\": \"123\",\n \"quantidade\": 3\n },\n {\n \"codigo_erp\": \"321\",\n \"quantidade\": 5\n },\n {\n \"codigo_erp\": \"12345\",\n \"quantidade\": 8\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.{{DOMINIO_CLIENTE}}/v1/loja/parceiro/carrinhos/filial/{{ID_FILIAL}}/centro_distribuicao/{{ID_CD}}/atualizar_por_lista","description":"Permite adicionar itens no carrinho pelo parceiro.
\nURL:
\n\nPara adicionar itens no carrinho é necessário enviar uma requisição POST informando o DOMINIO DO CLIENTE na URL, ID_FILIAL e ID_CD . Por exemplo, caso o domínio do cliente seja 'vipcommerce.com.br', ID_FILIAL seja '1' e ID_CD seja '1', então a URL seria: https://api-integracao.vipcommerce.com.br/v1/loja/carrinhos/filial/1/centro_distribuicao/1/atualizar_por_lista
Atenção: será necessário informar o token jwt no header da requisição. Para mais informações sobre o token jwt
\n\nAtenção: caso seja enviada uma quantidade de itens superior a máxima permitida, será informado na resposta da requisição que a quantidade máxima foi ultrapassada, logo o produto não será adicionado no carrinho.
\nAtenção: caso o usuário seja menor de 18 anos, não será possível adicionar no carrinho produtos que estejam marcados como bebidas alcoólicas.
\nDescrição do corpo body da requisição:
| Propriedade | Descrição | Obrigatório |
|---|---|---|
cliente | CPF ou CNPJ do cliente cadastrado. Atenção: deverá ser informado sem formatação. Exemplo: 10303562632 | Sim |
itens | Array de itens a serem incluídos no carrinho. | Sim |
codigo_erp | Código ERP do produto. | Sim |
quantidade | Quantidade do produto que será adicionado no carrinho | Sim |
parceiro_id | Permite informar o identificador alfanumérico do parceiro para associação ao carrinho. | Não |
substituir_carrinho | Permite limpar o carrinho | Não |
{\n \"cliente\": \"11111111111\",\n \"parceiro_id\": \"05b35f9b-0fe9-44bf-bfff-9206c48a123\",\n \"substituir_carrinho\": false,\n \"itens\": [\n {\n \"codigo_erp\": \"123\",\n \"quantidade\": 3\n },\n {\n \"codigo_erp\": \"321\",\n \"quantidade\": 5\n },\n {\n \"codigo_erp\": \"12345\",\n \"quantidade\": 8\n }\n ]\n}\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, será retornado na propriedade data.itens_inseridos a quantidade de itens inseridos no carrinho, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"itens_inseridos\": 12\n }\n}\n\nSerá retornada a mensagem \"Entidade não encontrada\", quando o ID da filial informado na URL não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"error\": \"Entidade não encontrada\"\n}\n\nSerá retornada a mensagem \"Undefined index: campo\", quando um campo obrigatório não for enviado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"error\": \"Undefined index: cliente\"\n}\n\n{\n \"success\": false,\n \"error\": \"Undefined index: itens\"\n}\n\n{\n \"success\": false,\n \"error\": \"Undefined index: codigo_erp\"\n}\n\n{\n \"success\": false,\n \"error\": \"Undefined index: quantidade\"\n}\n\nSerá retornada a mensagem \"usuario não encontrado\", quando o CPF ou CNPJ informado no body da requisição não for encontrado, conforme o exemplo abaixo.
\n{\n success: false,\n error: \"usuario não encontrado\"\n}\n\nSerá retornada a mensagem \"Cliente já possui um carrinho para outro centro de distribuição\", quando tentar adicionar produtos no carrinho para um centro de distribuição e o cliente tiver carrinho em outro centro distribuição, conforme o exemplo abaixo.
\n{\n \"success\": false,\n \"error\": \"Cliente já possui um carrinho para outro centro de distribuição\"\n}\n\nSerá retornada a mensagem \"Cliente não encontrado.\", quando o CPF ou CNPF informado no campo cliente do body da requisição não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"error\": \"Cliente não encontrado.\"\n}\n\nSerá retornada a mensagem \"Quantidade superior ao máximo permitido\", quando a quantidade de um produto informado no body da requisição for maior que a quantidade máxima permitida, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"itens_inseridos\": 0,\n \"itens_nao_inseridos\": [\n {\n \"codigo_erp\": \"22788\",\n \"message\": \"Quantidade superior ao máximo permitido\"\n }\n ]\n }\n}\n\nSerá retornada a mensagem \"Produto de venda proibida para menores de 18 anos\", quando o produto informado no body da requisição for bebida alcoólica e o cliente tiver idade menor que 18 anos, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"itens_inseridos\": 0,\n \"itens_nao_inseridos\": [\n {\n \"codigo_erp\": \"74955\",\n \"message\": \"Produto de venda proibida para menores de 18 anos\"\n }\n ]\n }\n}\n\nSerá retornado a mensagem \"Produto indisponivel\" quando o item vinculado ao código ERP estiver indisponível, ou seja, quando o produto estiver desativado, bloqueado, sem estoque ou não existir, conforme o exemplo abaixo.
\n{\n \"success\": true,\n \"data\": {\n \"itens_inseridos\": 2,\n \"itens_nao_inseridos\": [\n {\n \"codigo_erp\": \"333\",\n \"message\": \"Produto indisponivel\"\n }\n ]\n }\n}\n\nSerá retornada a mensagem \"Identificador não identificado.\" quando o parceiro não for reconhecido. Isso ocorre nos casos em que o parceiro não está cadastrado ou não possui permissão, resultando em erro conforme o exemplo abaixo.
\n{\n \"success\": false,\n \"error\": \"Identificador não identificado.\"\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"nome","value":"carrinho-facil","description":"Exemplo de nome da lista
\n","type":"text"}]},"url":"{{URL}}/importacao/carrinho-facil-listas","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar uma lista.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/carrinho-facil-listas
\nPara cadastrar uma lista é necessário enviar uma requisição POST, informando o nome da lista no corpo body da requisição ou enviar a requisição com body vazio. Ao cadastrar uma lista enviando o body vazio o nome padrão é null.
Observação: ao enviar a propriedade nome no body será obrigatorio informar o nome.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| nome | \nNome da lista. | \nNão | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"601726d2-3e6a-4c2d-8a5c-a88f7c23a8a5\"\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando a propriedade nome da lista for enviado na requisição vazio, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"nome\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"produto_id\": 34,\n \"erp\": 22, \n \"quantidade\": 50\n}"},"url":"{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite adicionar um item na lista.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/carrinho-facil-listas/ID_LISTA/carrinho-facil-items
\nPara adicionar um item a lista é necessário enviar uma requisição POST, informando o ID da lista na URL. No corpo body da requisição é necessário enviar o ID do produto e/ou codigo erp e opcionalmente a quantidade de itens do produto.
Atenção: é obrigatório informar um ID de produto ou Código ERP, quando ambos não forem informados será retornado a mensagem \"produto_id\": \"Este campo é obrigatório\", conforme o exemplo demonstrado no código de status: 422 Unprocessable Entity
Atenção: ao informar valores do Produto ID e Código ERP, o Produto ID será prioritário. Logo, caso sejam informados valores correspondentes a produtos diferentes, será adicionado o produto correspondente ao produto_ID.
\nDescrição do corpo body da requisição.
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| produto_id | \nID do produto. | \nNão. É necessário enviar produto_id ou erp | \n
| erp | \nCódigo ERP do produto. | \nNão. É necessário enviar produto_id ou erp | \n
| quantidade | \nQuantidade de itens do produto. | \nNão. | \n
Na URL da requisição é obrigatório informar o ID da lista, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-itemsExemplo de ID_LISTA:
\n5b389e4b-be00-4a67-9654-df86168c1975Quantidade de caracteres: 36 caracteres.
\n
\n{\n \"produto_id\": 34,\n \"erp\": 22, \n \"quantidade\": 50\n}\n\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"601726d2-3e6a-4c2d-8a5c-a88f7c23a8a5\"\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Lista não encontrada\", quando o ID da lista for inexistente.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181rrrrre0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"carrinho_facil_lista_id\": \"Lista não encontrada\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Produto já incluso na lista\", quando o produto informado já estiver incluso na lista.
Atenção: a validação será realizada independentemente de o produto ter sido incluído pelo seu ID ou código ERP.
\nExemplo: o produto \"Neston Cereais 400g - ID=32 e código ERP=30242\", foi adicionado a lista informando o ID.
\nAo tentar adicionar o produto com o código ERP 30242, o sistema retornará o erro \"Produto já incluso na lista\", conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Produto já incluso na lista\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando o produto_id informado no body da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Nenhum produto foi localizado com o código informado\", quando o erp informado no body da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"erp\": \"Nenhum produto foi localizado com o código informado\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando as propriedades \"produto_id\" ou \"erp\" não forem informadas. É obrigatório fornecer ao menos um dos parametros, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este campo é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\", quando a propriedade \"produto_id\" e/ou \"erp\" forem enviadas como string vazias, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"produto_id\": 34,\n \"erp\": 22, \n \"quantidade\": 50\n}"},"url":"{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items/{{ID_ITEM}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um item da lista.
\n\nPara editar um item da lista é necessário enviar uma requisição PUT informando na URL o ID da lista e o ID do item na lista. No corpo body da requisição será preciso informar a quantidade, Id do produto ou Código ERP do produto no corpo .
Atenção: Poderão ser editadas apenas listas cadastradas a partir do token informado em Authorization.
Atenção: Ao informar valores de ID e Código ERP, o ID será prioritário. Logo, caso sejam informados valores correspondentes a produtos diferentes, será adicionado o produto correspondente ao ID do produto.
\nDescrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| produto_id | \nID do produto. | \nNão. | \n
| erp | \nCódigo ERP do produto. | \nNão. | \n
| quantidade | \nQuantidade de itens do produto. | \nNão. | \n
Na URL da requisição é obrigatório informar o ID da lista e o ID do item a ser editado, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items/{{ID_ITEM}}Exemplo de ID_LISTA:
\n5b389e4b-be00-4a67-9654-df86168c1975Exemplo de ID_ITEM:
\n952eb77c-de6b-49d5-ad0a-224af9485262Quantidade de caracteres: 36 caracteres.
\n
\n{\n \"produto_id\": 34,\n \"erp\": 22, \n \"quantidade\": 50\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Lista não encontrada\", quando o ID da lista for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eeaffff6-4420-868d-648688fd7c0f/carrinho-facil-items/23e0dcf9-fb89-4398-8cf5-dbc53590701d\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"carrinho_facil_lista_id\": \"Lista não encontrada\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando a propriedade \"produto_id\" informada no body da requisição não for encontrada, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items/23e0dcf9-fb89-4398-8cf5-dbc53590701d\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Nenhum produto foi localizado com o código informado\", quando a propriedade \"erp\" informada no body da requisição não for encontrada, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items/23e0dcf9-fb89-4398-8cf5-dbc53590701d\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"erp\": \"Nenhum produto foi localizado com o código informado\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\", quando a propriedade produto_id for informada como string vazia, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/carrinho-facil-listas/99b4d08d-8ec8-493a-bee3-606edf880b4a/carrinho-facil-items\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do item da lista informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/carrinho-facil-listas/7d7181e0-eea6-4420-868d-648688fd7c0f/carrinho-facil-items/23e0dcf9-fb89-4398-8cf5-dbc535907444\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma lista.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/carrinho-facil-listas/ID_LISTA
\nPara consultar uma lista é necessário enviar uma requisição GET informando o ID da lista na URL.
Atenção: serão retornadas na consulta apenas listas cadastradas a partir do token informado em Authorization.
\nNa URL da requisição é obrigatório informar o ID da lista a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}Exemplo de ID:
\n5b389e4b-be00-4a67-9654-df86168c1975Quantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"5b389e4b-be00-4a67-9654-df86168c1975\",\n \"nome\": \"carrinho-facil\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID da lista informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/carrinho-facil-listas/42ee74a2-0b02-4a02-b454-43b8b047be4aa\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Controller\\\\Exception\\\\MissingActionException\",\n \"code\": 404,\n \"message\": \"Action CarrinhoFacilListasController::42ee74a20b024a02B45443b8b047be4aa() could not be found, or is not accessible.\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os itens vinculados a uma lista.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/ID_LISTA/carrinho-facil-items
\nPara listar os itens de uma lista é necessário enviar uma requisição GET informando o ID da lista na URL.
Atenção: serão retornadas apenas listas cadastradas a partir do token informado em Authorization.
Na URL da requisição é obrigatório informar o ID da lista a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-itemsExemplo de ID:
\n0160d198-fd78-4926-8615-052e8b156fcaQuantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"1125a79a-66c0-4491-b086-5ad2f79bcd35\",\n \"produto_id\": 19,\n \"quantidade\": 1\n },\n {\n \"id\": \"396e3acb-878d-4507-acfe-85f38eb4d5cb\",\n \"produto_id\": 115,\n \"quantidade\": 1\n },\n {\n \"id\": \"8345cd27-61ce-452a-a149-2ad0b9790c6a\",\n \"produto_id\": 12345,\n \"quantidade\": 1\n },\n {\n \"id\": \"8a268951-d0d0-4b75-9757-6fbb7ddd25e5\",\n \"produto_id\": 55,\n \"quantidade\": 1\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 4,\n \"limit\": null\n }\n}\nSera retornado o data vazio quando a lista não possuir itens vinculados ou o ID da lista informado na URL for inexistente, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items/{{ID_ITEM}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um item da lista.
\n\nPara excluir um item da lista é necessário enviar uma requisição DELETE informando o ID da lista e o ID do item na lista.
Atenção poderão ser excluidos somente itens cadastrados a partir do token informado em Authorization.
Na URL da requisição é obrigatório informar o ID da lista e o ID do item na lista, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/carrinho-facil-listas/{{ID_LISTA}}/carrinho-facil-items/{{ID_ITEM}}Exemplo de ID_LISTA: 42ee74a2-0b02-4a02-b454-43b8b047be4a
\nExemplo de ID_ITEM: c719b8f0-53e1-4b10-9092-04aea1818653
\nQuantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID da lista e/ou ID do item na lista não forem encontrados, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/carrinho-facil-listas/0160d198-fd78-4926-8615-052e8b156fca/carrinho-facil-items/3caffa07-326b-40c3-bc39-008b83f02245a\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Controller\\\\Exception\\\\MissingActionException\",\n \"code\": 404,\n \"message\": \"Action CarrinhoFacilListasController::0160d198Fd7849268615052e8b156fca() could not be found, or is not accessible.\"\n }\n }\n}\nA API Carrinho Fácil permite que sistemas externos ao VIP Commerce enviem listas de produtos para inclusão no carrinho do cliente na loja web. Isso proporciona flexibilidade para divulgação de campanhas promocionais em diversas plataformas diferentes, direcionando o cliente para o ambiente de compra, com alto potencial de conversão.
\n","event":[{"listen":"prerequest","script":{"id":"5edd933c-9798-4cf2-98ca-01bbf7c5cd4d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff63c66a-64ab-4194-b277-4aabea419fce","type":"text/javascript","exec":[""]}}],"_postman_id":"d319f585-6499-4167-bddd-4f0dc0fe7508"},{"name":"CarrinhoFacil - Loja","item":[],"id":"47c5af7b-37fe-4c5a-9c3f-192d01e827bf","description":"Para incluir os itens da lista ao carrinho, é necessario acessar a loja informando o ID da lista.
\nSandbox da loja
\nhttps://www.sandbox.vipcommerce.com.br/minhas-listas/carrinho-facil/ID_LISTA
\nAtenção: para adicionar a lista ao carrinho é preciso estar cadastrado no site. É possível realizar o cadastro na loja sandbox com o CEP a seguir: 30881-610
\nAo acessar a loja será exibido um modal solicitando o login
\nApós realizar o login ou cadastro a lista será adicionada ao carrinho.
Observação: caso algum produto da lista ja esteja no carrinho, a quantidade de itens será substituida pela informada na lista.
Caso o usuário não possua nenhum produto no carrinho, será exibido o modal para escolha da forma de recebimento, conforme a imagem abaixo:
\n![](\"https://wiki.vipcommerce.com.br/images/d/db/CarrinhoFacil-ModalFormaDeRecebimento.png\")
\n\nApós escolher a forma de recebimento, os produtos disponíveis serão adicionados ao carrinho.
Observação: Caso o usuário já possua produtos no carrinho, o modal de escolha da forma de recebimento não será exibido.
![](\"https://wiki.vipcommerce.com.br/images/9/95/CarrinhoFacil-ProdutosAdicionadosNoCarrinho.png\")
\n\nCaso a lista possua itens indisponíveis, será exibida a opção de substituir ou não os produtos, conforme a imagem abaixo:
\n![](\"https://wiki.vipcommerce.com.br/images/0/0e/CarrinhoFacil-ModalAvisoProdutosIndisponiveis.png\")
\n\nAo clicar no botão 'Substituir produtos' será exibido um modal com cada produto indisponível, conforme a imagem abaixo:
\n![](\"https://wiki.vipcommerce.com.br/images/7/76/CarrinhoFacil-ModalProdutosIndisponiveis.png\")
\n\nObservação: Produtos desativados não serão exibidos no modal de substituição de produtos e também não serão adicionados ao carrinho.
\n","event":[{"listen":"prerequest","script":{"id":"38d0c2b9-0f19-498f-acb8-eec07c153315","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"001ee913-5769-4026-9446-f7e92833bccc","type":"text/javascript","exec":[""]}}],"_postman_id":"47c5af7b-37fe-4c5a-9c3f-192d01e827bf"},{"name":"Produtos","item":[{"name":"Classificacao-Mercadologica","item":[{"name":"Departamento","item":[{"name":"Adicionar departamento","id":"688dcda1-6599-45c4-87ac-9df06987d920","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"Nome do departamento","description":"Exemplo de nome do departamento
\n","type":"text"}]},"url":"{{URL}}/importacao/departamentos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos
\nPara cadastrar um departamento é necessário enviar uma requisição POST, informando o nome do departamento no corpo body da requisição.
Atenção ao cadastrar um slug já existe, o sistema irá adicionar no final do slug um número incremental de acordo com a quantidade de slugs iguais já existentem.
\nDescrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome do departamento. | \nSim | \n
| id_externo | \nID externo do departamento. Atenção: deverá ser enviado um valor númerico. | \nNão | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"225\"\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando a descrição do departamento enviada no body da requisição já for cadastrada. É exibido na resposta, a quantidade de erros de validação em message e os erros ocorridos em errors, conforme o exemplo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/departamentos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Esse valor já está em uso' } } \n}\n| Parâmetro | \nErro | \nDescrição | \n
|---|---|---|
| data.code | \n422 | \nCódigo do erro. | \n
| data.url | \n/importacao/departamentos | \nURL da requisição. | \n
| data.message | \nOcorreu um erro de validação | \nInforma uma mensagem com o total de erros. | \n
| data.errorCount | \n1 | \nTotal de erros. | \n
| data.errors.descricao | \nEsse valor já está em uso | \nInforma o nome do departamento já esta cadastrado. | \n
Será retornado o código de status 422 Unprocessable Entity com a mensagem: \"Este campo é obrigatório\", quando a descrição do departamento não for informada no body da requisição. Conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/departamentos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Este campo é obrigatório\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"descricao","value":"Nome do departamento","description":"Exemplo de nome do departamento
\n","type":"text"}]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO
\nPara editar um departamento é necessário enviar uma requisição PUT, informando o novo nome do departamento no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome do departamento. | \nSim | \n
| id_externo | \nID externo do departamento. Atenção: deverá ser enviado um valor númerico. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do departamento informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/departamentos/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar todos os departamentos cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos
\nPara listar todos departamentos é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 1,\n parent_id: null,\n slug: 'perfumaria-e-higiene',\n descricao: 'Perfumaria e higiene',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:53-03:00',\n modified: '2019-03-21T16:36:53-03:00',\n classificacao: 'Departamento' },\n { id: 3,\n parent_id: null,\n slug: 'hortifruti',\n descricao: 'Hortifruti',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:54-03:00',\n modified: '2019-03-21T16:36:54-03:00',\n classificacao: 'Departamento' },\n { id: 5,\n parent_id: null,\n slug: 'matinais-e-sobremesas',\n descricao: 'Matinais e sobremesas',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:55-03:00',\n modified: '2019-03-21T16:36:55-03:00',\n classificacao: 'Departamento' },\n { id: 9,\n parent_id: null,\n slug: 'bazar-e-utilidades',\n descricao: 'Bazar e utilidades',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:56-03:00',\n modified: '2019-03-21T16:36:56-03:00',\n classificacao: 'Departamento' },\n { id: 13,\n parent_id: null,\n slug: 'limpeza',\n descricao: 'Limpeza',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:57-03:00',\n modified: '2019-03-21T16:36:57-03:00',\n classificacao: 'Departamento' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 18,\n limit: null } }\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um departamento através do ID do departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO
\nPara consultar um departamento é necessário enviar uma requisição GET, sendo necessário informar o ID do departamento na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: { \n id: 222,\n parent_id: null,\n slug: 'bazar-e-utilidades',\n descricao: 'Bazar e utilidades',\n imagem: null,\n id_externo: null,\n created: '2019-03-25T11:05:21-03:00',\n modified: '2019-03-25T11:05:21-03:00',\n classificacao: 'Departamento' } \n}\nSerá retornado o código de status 404 Not Found quando o ID do departamento informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/departamentos/8',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos?q=biscoitos e chocolates","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite buscar departamento através da descrição.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos?q=biscoitos e chocolates
\nPara buscar um departamento é necessário enviar uma requisição GET, informando a descrição do departamento na URL.
Os parametros permitidos são
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 37,\n \"parent_id\": null,\n \"slug\": \"biscoitos-e-chocolates\",\n \"descricao\": \"Biscoitos e chocolates\",\n \"imagem\": null,\n \"id_externo\": null,\n \"created\": \"2019-03-21T16:37:03-03:00\",\n \"modified\": \"2019-03-21T16:37:03-03:00\",\n \"classificacao\": \"Departamento\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nExemplo de departamento
\n","type":"text/plain"},"key":"q","value":"biscoitos e chocolates"}],"variable":[]}},"response":[{"id":"a75711b1-04ed-41d6-9666-0d969fec860a","name":"200 OK - data vazio","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado"},{"key":"Authorization","value":"Basic aGV2ZXJ0b25jb3JyZWFAdmlwY29cbWVyY2UAY29tLmJyOmRmMDcyZjg1ZGY5YUY3ZGQ3MWI2ODExYzM0YmRiYWE0ZjIxOWQ5ODc3NWI1NmNmZjlkZmE1ZjhjYTFiZjg0Njk=","description":"Token de acesso - base64 do username e password"},{"key":"DomainKey","value":"vipcommerce.com.br","description":"Identificador do dominio"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}/importacao/departamentos?q=biscoitos e chocolates2","host":["{{URL}}"],"path":["importacao","departamentos"],"query":[{"key":"q","value":"biscoitos e chocolates2","description":"Exemplo de departamento"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"Authorization,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,App-Version,DomainKey","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 24 Apr 2019 14:22:45 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"data\":[],\"pagination\":{\"page_count\":1,\"current_page\":1,\"has_next_page\":false,\"has_prev_page\":false,\"count\":0,\"limit\":null}}"},{"id":"d204ae43-7c4a-4627-8936-0b0c3e5632ab","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado"},{"key":"Authorization","value":"Basic aGV2ZXJ0b25jb3JyZWFAdmlwY29cbWVyY2UAY29tLmJyOmRmMDcyZjg1ZGY5YUY3ZGQ3MWI2ODExYzM0YmRiYWE0ZjIxOWQ5ODc3NWI1NmNmZjlkZmE1ZjhjYTFiZjg0Njk=","description":"Token de acesso - base64 do username e password"},{"key":"DomainKey","value":"vipcommerce.com.br","description":"Identificador do dominio"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}/importacao/departamentos?q=biscoitos e chocolates","host":["{{URL}}"],"path":["importacao","departamentos"],"query":[{"key":"q","value":"biscoitos e chocolates","description":"Exemplo de departamento"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"Authorization,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,App-Version,DomainKey","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 24 Apr 2019 14:22:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"data\":[{\"id\":37,\"parent_id\":null,\"slug\":\"biscoitos-e-chocolates\",\"descricao\":\"Biscoitos e chocolates\",\"imagem\":null,\"created\":\"2019-03-21T16:37:03-03:00\",\"modified\":\"2019-03-21T16:37:03-03:00\",\"classificacao\":\"Departamento\"}],\"pagination\":{\"page_count\":1,\"current_page\":1,\"has_next_page\":false,\"has_prev_page\":false,\"count\":1,\"limit\":null}}"}],"_postman_id":"c4a8f40d-dab2-4288-85d1-b4923a0e2c26"},{"name":"Deletar departamento","id":"21bd82aa-5459-475d-a148-9b81277c4568","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO
\n Atenção não é possível excluir um departamento com relaciomanetos via API. Caso seja enviada uma tentativa de exclusão com um departamento que possui relaciomento uma erro será retornada, conforme o exemplo demonstrado Erro 500 - Internal Server Error.
Para excluir um departamento é necessário enviar uma requisição DELETE informando o ID do departamento na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 500 Internal Server Error quando ocorrer uma tentativa de exclusão de um departamento que possui relaciomento(s), conforme o exemplo.
{\n \"success\":false,\n \"data\": {\n \"message\":\"Ocorreu um erro interno.\",\n \"url\":\"/importacao/departamentos/191\",\n \"code\":500,\n \"exception\": {\n \"class\":\"PDOException\",\"code\":\"23000\",\"message\":\"SQLSTATE[23000]: Integrity constraint violation: 1451 Cannot delete or update a parent row: a foreign key constraint fails (`vipcommerce_dev`.`produtos`, CONSTRAINT `produtos_ibfk_1` FOREIGN KEY (`categoria_id`) REFERENCES `categorias` (`id`) ON DELETE NO ACTION ON UPDATE NO ACTION)\"}}\n}\nSerá retornado o código de status 404 Not found quando o ID do departamento informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/departamentos/8000\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nGerenciamento do nível mais alto do cadastro de produtos.
\n","event":[{"listen":"prerequest","script":{"id":"99c0e2d6-3b3e-4263-952e-2db02ce71766","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"52b80377-ec73-4d5a-9e60-8c5ffb7f7a13","type":"text/javascript","exec":[""]}}],"_postman_id":"211929a4-9f22-413a-a580-9df2153fa9a3"},{"name":"Secao","item":[{"name":"Adicionar secao","id":"41bc9a88-822f-4397-aa75-5d9baa80c784","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"Seção de teste","description":"Exemplo de nome de descrição
\n","type":"text"}]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar uma seção vinculada a um departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes
\nPara cadastrar uma seção é necessário enviar uma requisição POST, informando na URL o ID do departamento ao qual a seção será vinculada e o nome da seção no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome da seção. | \nSim | \n
| id_externo | \nID externo da seção. Atenção: deverá ser enviado um valor númerico. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 227 }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\" quando o ID do departamento informado na URL não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/departamentos/981/secoes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { parent_id: 'Este valor não existe' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Esse valor já está em uso\", quando a descrição da seção informada no body já estiver cadastrada, conforme o exemplo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/departamentos/9/secoes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Esse valor já está em uso' } }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"descricao","value":"Nome da seção","description":"Exemplo de nome da seção
\n","type":"text"}]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes/{{ID_SECAO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar uma seção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes/ID_SECAO
\nPara editar uma seção é necessário enviar uma requisição PUT, informando na URL o ID do departamento , ID da seção e o novo nome da seção no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome da seção. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do departamento e/ou ID da seção informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/departamentos/10/secoes/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar todas as seções vinculadas a um departamento.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes
\nPara listar todas as seções vinculadas a um departamento é necessário enviar uma requisição GET, sendo necessário informar o ID do departamento como paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ success: true,\n data:\n [ { id: 10,\n parent_id: 9,\n slug: 'utensilio',\n descricao: 'Utensilio',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:56-03:00',\n modified: '2019-03-21T16:36:56-03:00',\n classificacao: 'Secao' },\n { id: 59,\n parent_id: 9,\n slug: 'automotivo',\n descricao: 'Automotivo',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:37:09-03:00',\n modified: '2019-03-21T16:37:09-03:00',\n classificacao: 'Secao' },\n { id: 62,\n parent_id: 9,\n slug: 'travessa-e-assadeira',\n descricao: 'Travessa e assadeira',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:37:10-03:00',\n modified: '2019-03-21T16:37:10-03:00',\n classificacao: 'Secao' },\n { id: 67,\n parent_id: 9,\n slug: 'louca-e-prato',\n id_externo: null,\n descricao: 'Louca e prato',\n imagem: null,\n created: '2019-03-21T16:37:11-03:00',\n modified: '2019-03-21T16:37:11-03:00',\n classificacao: 'Secao' } ],\n pagination:\n { page_count: 2,\n current_page: 1,\n has_next_page: true,\n has_prev_page: false,\n count: 24,\n limit: null } }\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes/{{ID_SECAO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma seção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes/ID_SECAO
\nPara consultar uma seção é necessário enviar uma requisição GET, sendo necessário informar o ID do departamento e ID da seção.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: {\n id: 21,\n parent_id: 5,\n slug: 'achocolatado-em-po',\n descricao: 'Achocolatado em po',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:36:59-03:00',\n modified: '2019-03-21T16:36:59-03:00',\n classificacao: 'Secao' } \n}\nSerá retornado o código de status 404 Not Found quando o ID do departamento e/ou ID da seção informado na URL for inexistente ou ID da seção não estiver vinculada ao ID do departamento, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/departamentos/8/secoes/21',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes?q=automotivo","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite buscar uma seção através da descrição.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes?q=automotivo
\nPara buscar uma seção é necessário enviar uma requisição GET, informando o ID do departamento e a Descrição da seção na URL.
Os parametros permitidos são
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 59,\n parent_id: 9,\n slug: 'automotivo',\n descricao: 'Automotivo',\n imagem: null,\n id_externo: null,\n created: '2019-03-21T16:37:09-03:00',\n modified: '2019-03-21T16:37:09-03:00',\n classificacao: 'Secao' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 3,\n limit: null } }\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o ID do departamento e/ou descrição da seção informado na URL não forem encontrados, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nExemplo de seção
\n","type":"text/plain"},"key":"q","value":"automotivo"}],"variable":[]}},"response":[],"_postman_id":"01bc475d-cd05-4e72-9d03-7fadf55549d2"},{"name":"Deletar secao","id":"d7286970-35cb-4049-8deb-a609ad4b134a","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/departamentos/{{ID_DEPARTAMENTO}}/secoes/{{ID_SECAO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma seção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/departamentos/ID_DEPARTAMENTO/secoes/ID_SECAO
\nPara excluir uma seção é necessário enviar uma requisição DELETE, informando o ID do departamento e o ID da seção na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do departamento e/ou ID da seção informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/departamentos/8000/secoes/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nGerenciamento do segundo nível do cadastro de produtos.
\n","event":[{"listen":"prerequest","script":{"id":"dee5e5f6-9116-48bd-ac19-b49b36cb84a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"276b7ac7-73e6-4ba6-bc5a-f92dcf543169","type":"text/javascript","exec":[""]}}],"_postman_id":"e14656ae-a617-47f5-a386-06867a97601d"}],"id":"9f64170d-11d0-4a28-a29f-71164f64b42f","_postman_id":"9f64170d-11d0-4a28-a29f-71164f64b42f","description":""},{"name":"Unidade","item":[{"name":"Adicionar unidade","id":"c49aa1ea-4f8e-43d6-896a-ff459c6f1378","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"UN","description":"Exemplo de descrição da unidade
\n","type":"text"},{"key":"sigla","value":"UN","description":"Exemplo de sigla da unidade
\n","type":"text"}]},"url":"{{URL}}/importacao/unidades","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite adicionar uma unidade.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/unidades
\nPara adicionar uma unidade é necessário enviar uma requisição POST. No corpo body da requisição será necessario informar a descrição e a sigla da unidade.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da unidade. | \nSim | \n
| sigla | \nSigla da unidade. | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo descrição com a mensagem \"Esse valor já está em uso\", quando a descrição informada já estiver cadastrada, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/unidades',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Esse valor já está em uso' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo sigla com a mensagem \"Esse valor já está em uso\", quando a sigla informada já estiver cadastrada, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/unidades',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { sigla: 'Esse valor já está em uso' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo sigla com a mensagem \"Permitido somente letras e números\", quando a sigla informada contiver caracteres especiais, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/unidades\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"sigla\": \"Permitido somente letras e números\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity nos campos descrição ou sigla com a mensagem \"Este campo não pode ser deixado vazio\", quando a descrição e/ou sigla não for informado no body da requisição, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/unidades',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors:\n { descricao: 'Este campo não pode ser deixado vazio',\n sigla: 'Este campo não pode ser deixado vazio' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"descricao","value":"KG","description":"Exemplo de descrição da unidade
\n","type":"text"},{"key":"sigla","value":"KG","description":"Exemplo de sigla da unidade
\n","type":"text"}]},"url":"{{URL}}/importacao/unidades/{{ID_UNIDADE}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar uma unidade.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/unidades/ID_UNIDADE
\nPara editar uma unidade é necessário enviar uma requisição PUT. No corpo body da requisição será necessario informar a descrição e a sigla da unidade.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da unidade. | \nSim | \n
| sigla | \nSigla da unidade. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID da unidade informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/unidades/100\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo sigla com a mensagem \"Permitido somente letras e números\", quando a sigla informada contiver caracteres especiais, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/unidades\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"sigla\": \"Permitido somente letras e números\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/unidades","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar as unidades.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/unidades/?q=un
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por descrição:
\n{{URL}}/importacao/unidades/?descricao=unBusca por parametro q:
\n{{URL}}/importacao/unidades/?q=un
Para listar as unidades cadastradas é necessário enviar uma requisição GET .
Atenção ao não informar nenhum parametro na URL será retornado todas as unidades cadastradas.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ { \n id: 1,\n descricao: 'UN',\n sigla: 'UN',\n created: '2019-03-21T16:36:54-03:00',\n modified: '2019-03-21T16:36:54-03:00' },\n { id: 2,\n descricao: 'KG',\n sigla: 'KG',\n created: '2019-03-21T16:36:55-03:00',\n modified: '2019-03-21T16:36:55-03:00' },\n { id: 3,\n descricao: 'BJ',\n sigla: 'BJ',\n created: '2019-03-21T16:37:04-03:00',\n modified: '2019-03-21T16:37:04-03:00' },\n { id: 4,\n descricao: 'CX',\n sigla: 'CX',\n created: '2019-03-21T16:37:12-03:00',\n modified: '2019-03-21T16:37:12-03:00' } ],\n pagination: {\n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 10,\n limit: null } \n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/unidades/{{ID_UNIDADE}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma unidade através do ID da unidade.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/unidades/ID_UNIDADE
\nPara consultar uma unidade é necessário enviar uma requisição GET, sendo necessário informar o ID da unidade na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: { \n id: 1,\n descricao: 'UN',\n sigla: 'UN',\n created: '2019-03-21T16:36:54-03:00',\n modified: '2019-03-21T16:36:54-03:00' } \n}\nSerá retornado o código de status 404 Not Found quando o ID da unidade informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/unidades/10',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/unidades/{{ID_UNIDADE}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma unidade.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/unidades/ID_UNIDADE
\nPara excluir uma unidade é necessário enviar uma requisição DELETE informando o ID da unidade na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID da unidade informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/unidades/10',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento dos tipos de unidade dos produtos com os quais a loja trabalha. Ex: Un, KG, CX, etc.
\n","event":[{"listen":"prerequest","script":{"id":"b7624bea-9d4c-470c-b38c-887b1c19a2e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef38b4f0-b7c8-4366-b148-1c271cb8ede6","type":"text/javascript","exec":[""]}}],"_postman_id":"d87c526f-6de3-4b80-af8f-933985865710"},{"name":"Produto","item":[{"name":"Adicionar produto","id":"81d4f3a6-a497-4842-a999-7f0159bdf3f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"categoria_id","value":"216","type":"text"},{"key":"unidade_id","value":"10","type":"text"},{"key":"codigo_barras","value":"7896269691423","type":"text"},{"key":"codigo_embalagem","value":"2090024000016","type":"text"},{"key":"codigo_erp","value":"415267","type":"text"},{"key":"descricao","value":"Achocolatado Nescau 2.0 Refil 800g","type":"text"},{"key":"subtitulo","value":"Achocolatado Nescau 2.0 Refil 800g Teste","type":"text"},{"key":"informacoes","value":"Achocolatado Nescau 2.0","type":"text"},{"key":"preco","value":"1.09","type":"text"},{"key":"acrescimo","value":"10","type":"text"},{"key":"estoque_loja","value":"250","type":"text"},{"key":"estoque_seguranca","value":"10","type":"text"},{"key":"maximo_cliente","value":"5","type":"text"},{"key":"sem_validacao_estoque","value":"0","type":"text"},{"key":"unidade_diferente","value":"false","type":"text"},{"key":"quantidade_unidade_diferente","value":"1","type":"text"},{"key":"peso_liquido","value":"0.450","type":"text"},{"key":"peso_bruto","value":"0.500","type":"text"},{"key":"tipo_estoque","value":"P","type":"text"},{"key":"bebida_alcoolica","value":"false","type":"text"},{"key":"desativado","value":"false","type":"text"},{"key":"pesavel","value":"N","type":"text"},{"key":"variacao_unidade_diferente","value":"15","type":"text"}]},"url":"{{URL}}/importacao/produtos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos
\nAtenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75
\nAtenção ao se optar por não enviar um atributo opcional, ao invés de enviar o valor \"null\" na requisição, é preferível não enviar o atributo.
\nAtenção para cadastrar informações referentes ao estoque da loja, estoque de segurança, preço dos produtos, acrescimo no valor do produto, quantidade maxima de itens por cliente será necessário efetuar a requisição de estoque e preço clique aqui. Atenção esses dados são por CD, será necessário registros de estoque_preco para cada centro de distribuição cadastrado.
\nAtenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso.
\nAtenção não é possível excluir um produto via API. Para desabilitar um produto, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nPara cadastrar um produto é necessário enviar uma requisição POST. No corpo body da requisição será necessário informar as informações vinculadas ao produto (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| categoria_id | \nID da seção ao qual o produto esta vinculado. | \nSim | \n
| unidade_id | \nID da unidade | \nSim | \n
| enderecamento_id | \nID do endereçamento. O atributo é necessário caso seja utilizada separação por endereçamentos, como num WMS. | \nNão | \n
| marca_id | \nID da marca. | \nNão | \n
| codigo_barras | \nCódigo de barras do produto. Tamanho máximo de 15 caracteres. | \n Sim | \n
| codigo_embalagem | \nCódigo de Embalagem (Código da Balança) do produto. Obs: Normalmente enviado apenas em produtos pesáveis. Tamanho mínimo 7 caracteres, máximo 15 caracteres. | \n Não | \n
| codigo_produto_similar | \nCódigo de produto similar | \nNão | \n
| quantidade_embalagem | \nQuantidade da embalagem. | \nNão | \n
| codigo_erp | \nCódigo ERP do produto. Atenção tamanho máximo de 10 (dez) números. | \n Sim | \n
| descricao | \nDescrição do produto. | \nSim | \n
| subtitulo | \nSubtitulo do produto. Tamanho máximo de 150 caracteres. | \n Não | \n
| informacoes | \nInformações do produto. | \nSim | \n
| sem_validacao_estoque | \nDefine se o produto será definido com ou sem validação de estoque. Atenção produtos sem validação do estoque não ficam indisponíveis. Opções aceitas:
| \n Sim | \n
| unidade_diferente | \nDefine se o produto será definido com ou sem unidade diferente. Utilizado para ajuste da unidade do produto para venda na loja online em relação ao cadastro do ERP. Opções aceitas:
| \n Sim | \n
| quantidade_unidade_diferente | \nQuantidade da unidade diferente. Atenção deverá ser utilizado somente ponto como separador decimal. Atenção o atributo \"unidade_diferente\" deverá estar ou ser definido como true. | \n Não | \n
| variacao_unidade_diferente | \nTolerância de variação do peso do produto na separação. Atenção o produto deverá ser de unidade diferente. | \n Não | \n
| peso_liquido | \nPeso liquido do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| permitir_observacao_na_compra | \nPermite inserção de observação no produto na compra pelo cliente. Opções aceitas:
Default: false | \n Não | \n
| peso_bruto | \nPeso bruto do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| tipo_estoque | \nDefine o tipo de estoque do produto. Atenção opção aceita somente em maiusculo. Opções aceitas:
| \n Não | \n
| bebida_alcoolica | \nDefine se o produto é ou não uma bebica alcoolica. Atenção produtos definidos como bebica alcoolica não poderão ser adicionado no carrinho por cliente que não possuem maioridade. Opções aceitas:
Valor default: false | \n Sim | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
| pesavel | \nDefine se o produto é ou não pesavel. Atenção opções aceitas somente em maiúsculo. Opções aceitas:
Valor default: N | \n Não | \n
| quantidade_unidade_produto | \nQuantidade da unidade vinculada ao produto | \nNão | \n
| unidade_medida_id | \nID referente a unidade. Este ID poderá ser consultado na requisição de 'Unidades' | \nNão | \n
| quantidade_fracao | \nQuantidade da fração vinculada ao produto. | \nNão | \n
\n{\n categoria_id: 2,\n unidade_id: 10,\n enderecamento_id: '',\n marca_id: '',\n codigo_barras: 7312040017034,\n codigo_embalagem: 2090024000016,\n codigo_produto_similar: '',\n quantidade_embalagem: '',\n codigo_erp: 50446,\n descricao: 'Vodka Absolut 1l',\n subtitulo: 'Produto próximo do vencimento',\n informacoes: 'Ingredientes: Destilado De Cereais E Álcool',\n preco: 78.50,\n acrescimo: 10,\n estoque_loja: 650,\n estoque_seguranca: 10,\n maximo_cliente: 0,\n sem_validacao_estoque: false,\n unidade_diferente: false,\n quantidade_unidade_diferente: 1,\n peso_liquido: 0.450,\n peso_bruto: 0.500,\n tipo_estoque: 'P',\n bebida_alcoolica: false,\n desativado: false,\n pesavel: 'N'\n}\n\n\n![\"Descrição](\"http://wiki.vipcommerce.com.br/images/f/fd/Descricao-campos-produto.png\")
\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo categoria_id com a mensagem \"Informe uma seção válida.\", quando o ID da sessão não estiver cadastrada, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { categoria_id: 'Informe uma seção válida.' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo unidade_id com a mensagem \"Este valor não existe\", quando o ID da unidade não estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { unidade_id: 'Este valor não existe' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando um campo obrigatório não for enviado no body da requisição, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos',\n message: '12 erros de validação ocorridos',\n errorCount: 12,\n errors: {\n categoria_id: 'O campo categoria é obrigatório',\n codigo_barras: 'Este campo é obrigatório',\n codigo_erp: 'Este campo é obrigatório',\n descricao: 'Este campo é obrigatório',\n informacoes: 'Este campo é obrigatório',\n preco: 'Este campo é obrigatório',\n estoque_loja: 'Este campo é obrigatório',\n estoque_seguranca: 'Este campo é obrigatório',\n maximo_cliente: 'Este campo é obrigatório',\n sem_validacao_estoque: 'Este campo é obrigatório',\n unidade_diferente: 'Este campo é obrigatório',\n bebida_alcoolica: 'Este campo é obrigatório' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Esse valor já está em uso\", quando o valor do campo já estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { codigo_erp: 'Esse valor já está em uso' } } \n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":" {\n \"codigo_embalagem\": 284616,\n \"descricao\": \"Produto clone\",\n \"informacoes\": \"Informação produto clone\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 0.300,\n \"bebida_alcoolica\": false\n }","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO_PAI}}/clones","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um produto clone.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/{{ID_PRODUTO_PAI}}/clones
\nAtenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75
\nAtenção ao se optar por não enviar um atributo opcional, ao invés de enviar o valor \"null\" na requisição, é preferível não enviar o atributo.
\nPara cadastrar um produto clone é necessário enviar uma requisição POST informando o ID do produto pai . No corpo body da requisição será necessário informar as informações vinculadas ao produto (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_embalagem | \nCódigo de Embalagem (Código da Balança) do produto. Obs: Normalmente enviado apenas em produtos pesáveis. Tamanho mínimo 7 caracteres, máximo 15 caracteres. | \n Sim | \n
| descricao | \nDescrição do produto. | \nSim | \n
| informacoes | \nInformações do produto. | \nSim | \n
| sem_validacao_estoque | \nDefine se o produto será definido com ou sem validação de estoque. Atenção produtos sem validação do estoque não ficam indisponíveis. Opções aceitas:
| \n Sim | \n
| unidade_diferente | \nDefine se o produto será definido com ou sem unidade diferente. Utilizado para ajuste da unidade do produto para venda na loja online em relação ao cadastro do ERP. Opções aceitas:
| \n Sim | \n
| quantidade_unidade_diferente | \nQuantidade da unidade diferente. Atenção deverá ser utilizado somente ponto como separador decimal. Atenção o atributo \"unidade_diferente\" deverá estar ou ser definido como true. Atenção se não informado esse campo ele assume valor 1.000 | \n Não | \n
| bebida_alcoolica | \nDefine se o produto é ou não uma bebica alcoolica. Atenção produtos definidos como bebica alcoolica não poderão ser adicionado no carrinho por cliente que não possuem maioridade. Opções aceitas:
Valor default: false | \n Sim | \n
\n {\n \"codigo_embalagem\": 284616,\n \"descricao\": \"Produto clone\",\n \"informacoes\": \"Informação produto clone\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 0.300,\n \"bebida_alcoolica\": false\n }\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"message\": null,\n \"errors\": [],\n \"data\": {\n \"result\": 51550\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity nos campos obrigatórios com a mensagem \"Este campo é obrigatório.\", quando um campo obrigatório não for informado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/1/clones\",\n \"message\": \"5 erros de validação ocorridos:\",\n \"errorCount\": 5,\n \"errors\": {\n \"descricao\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"informacoes\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"sem_validacao_estoque\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"unidade_diferente\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"bebida_alcoolica\": {\n \"_required\": \"Este campo é obrigatório\"\n }\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"5 erros de validação ocorridos:\"\n }\n }\n }\nSerá retornado o código de status 422 Unprocessable Entity no campo errors com a mensagem \"Já existe um produto com o mesmo codigo de embalagem\", quando o código de embagem informado no body já estiver cadastrado para outro produto, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/1/clones\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": \"Já existe um produto com o mesmo codigo de embalagem\",\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n }\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Formato do corpo da requisição inválido\", quando o body da requisição possuir algum erro de formatação, conforme o exemplo abaixo.
\n{\n \"success\": false,\n \"data\": {\n \"message\": \"Formato do corpo da requisição inválido. Verifique se o corpo da requisição está vazio ou com caracteres inválidos\",\n \"url\": \"/importacao/produtos/17/clones\",\n \"code\": 422,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\BodyFormatValidationException\",\n \"code\": 422,\n \"message\": \"Formato do corpo da requisição inválido. Verifique se o corpo da requisição está vazio ou com caracteres inválidos\"\n }\n }\n }\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"[\n {\n \"categoria_id\": 2,\n \"unidade_id\": 10,\n \"enderecamento_id\": \"\",\n \"marca_id\": \"\",\n \"codigo_barras\": 7312040017034,\n \"codigo_embalagem\": \"0483748374\",\n \"codigo_produto_similar\": \"\",\n \"quantidade_embalagem\": 15,\n \"codigo_erp\": \"169961814\",\n \"descricao\": \"Vodka Absolut 1l\",\n \"subtitulo\": \"Produto próximo do vencimento\",\n \"informacoes\": \"Ingredientes: Destilado De Cereais E Álcool\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 7.40,\n \"peso_liquido\": \"0.450\",\n \"peso_bruto\": \"0.500\",\n \"tipo_estoque\": \"P\",\n \"prazo_validade\": 19,\n \"bebida_alcoolica\": false,\n \"desativado\": false,\n \"pesavel\": \"S\",\n \"variacao_unidade_diferente\": 10\n }, \n {\n \"categoria_id\": 1,\n \"codigo_barras\": \"1239\",\n \"codigo_erp\": \"22956548\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\":1\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/produtos/addAll","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar produtos em lote.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/addAll
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75
\nAtenção ao se optar por não enviar um atributo opcional, ao invés de enviar o valor \"null\" na requisição, é preferível não enviar o atributo.
\nAtenção para cadastrar informações referentes ao estoque da loja, estoque de segurança, preço dos produtos, acrescimo no valor do produto, quantidade maxima de itens por cliente será necessário efetuar a requisição de estoque e preço clique aqui. Atenção esses dados são por CD, será necessário registros de estoque_preco para cada centro de distribuição cadastrado.
\nAtenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso.
\nAtenção não é possível excluir um produto via API. Para desabilitar um produto, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nPara cadastrar produtos em lote é necessário enviar uma requisição POST. No corpo body da requisição será necessário informar as informações vinculadas ao produto (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| categoria_id | \nID da seção ao qual o produto esta vinculado. | \nSim | \n
| unidade_id | \nID da unidade | \nSim | \n
| marca_id | \nID da marca. | \nNão | \n
| codigo_barras | \nCódigo de barras do produto. Tamanho máximo de 15 caracteres. | \n Sim | \n
| codigo_embalagem | \nCódigo de Embalagem (Código da Balança) do produto. Obs: Normalmente enviado apenas em produtos pesáveis. Tamanho mínimo 7 caracteres, máximo 15 caracteres. | \n Não | \n
| codigo_produto_similar | \nCódigo de produto similar | \nNão | \n
| quantidade_embalagem | \nQuantidade da embalagem. | \nNão | \n
| codigo_erp | \nCódigo ERP do produto. Atenção tamanho máximo de 10 (dez) números. | \n Sim | \n
| descricao | \nDescrição do produto. | \nSim | \n
| subtitulo | \nSubtitulo do produto. Tamanho máximo de 150 caracteres. | \n Não | \n
| informacoes | \nInformações do produto. | \nSim | \n
| sem_validacao_estoque | \nDefine se o produto será definido com ou sem validação de estoque. Atenção produtos sem validação do estoque não ficam indisponíveis. Opções aceitas: \"False\" para \"Não\" e \"True\" para \"Sim\". | \n Sim | \n
| unidade_diferente | \nDefine se o produto será definido com ou sem unidade diferente. Utilizado para ajuste da unidade do produto para venda na loja online em relação ao cadastro do ERP. Opções aceitas:\" \"False\" para \"Não\" e \"True\" para \"Sim\". | \n Sim | \n
| quantidade_unidade_diferente | \nQuantidade da unidade diferente. Atenção deverá ser utilizado somente ponto como separador decimal. Atenção o atributo \"unidade_diferente\" deverá estar ou ser definido como \"true\". | \n Não | \n
| variacao_unidade_diferente | \nTolerância de variação do peso do produto na separação. | \nNão | \n
| peso_liquido | \nPeso liquido do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| peso_bruto | \nPeso bruto do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| tipo_estoque | \nDefine o tipo de estoque do produto. Atenção opção aceita somente em maiusculo. Opções aceitas:\"P\" para padrão | \n Não | \n
| bebida_alcoolica | \nDefine se o produto é ou não uma bebica alcoolica. Atenção produtos definidos como bebica alcoolica não poderão ser adicionado no carrinho por cliente que não possuem maioridade. Opções aceitas: \"False\" para \"Não\" e \"True\" para \"Sim\". Valor default: false | \n Sim | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas: \"False\" para \"Não\" e \"True\" para \"Sim\". Valor default: false | \n Não | \n
| pesavel | \nDefine se o produto é ou não pesável. Atenção opções aceitas somente em maiúsculo. Opções aceitas: \"False\" para \"Não\" e \"True\" para \"Sim\". Valor default: false | \n Não | \n
| quantidade_unidade_produto | \nQuantidade da unidade vinculada ao produto | \nNão | \n
| unidade_medida_id | \nID referente a unidade. Este ID poderá ser consultado na requisição de 'Unidades' | \nNão | \n
| quantidade_fracao | \nQuantidade da fração vinculada ao produto. | \nNão | \n
[\n {\n \"categoria_id\": 2,\n \"unidade_id\": 10,\n \"codigo_barras\": 784985565564,\n \"codigo_erp\": \"185815102\",\n \"descricao\": \"Vodka Absolut 1L\",\n \"subtitulo\": \"Vodka importada Absolut 1L destilada 5x\",\n \"informacoes\": \"Ingredientes: Destilado De Cereais E Álcool\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"peso_liquido\": \"0.450\",\n \"peso_bruto\": \"0.500\",\n \"tipo_estoque\": \"P\",\n \"bebida_alcoolica\": true,\n \"desativado\": false,\n \"pesavel\": \"S\"\n },\n {\n \"categoria_id\": 1,\n \"codigo_barras\": \"75884846913\",\n \"codigo_erp\": \"11205151\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\":1\n }\n]\nSerá retornado o código de status 200 OK e a propriedade data.result contendo informações dos produtos cadastrados. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"message\": \"Informação: 0 não processados. Total processado: 1\",\n \"data\": {\n \"result\": [\n {\n \"id\": 51548,\n \"codigo_erp\": 122956548\n }\n ],\n \"not_processed\": []\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Informe uma seção válida.\" na propriedade data.not_processed.messages.message, quando o ID da seção informado no body não estiver cadastrada. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"categoria_id\": 12123,\n \"codigo_barras\": \"1239123142\",\n \"codigo_erp\": \"22956548\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\": 1\n },\n \"messages\": [\n {\n \"message\": \"Informe uma seção válida.\",\n \"field\": \"categoria_id\",\n \"rule\": \"custom\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Esse valor já está em uso\" na propriedade data.not_processed.messages.message, quando o Código de ERP informado no body já estiver vinculado a outro produto. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"categoria_id\": 12,\n \"codigo_barras\": \"1239123142\",\n \"codigo_erp\": \"22956548\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\": 1\n },\n \"messages\": [\n {\n \"message\": \"Esse valor já está em uso\",\n \"field\": \"codigo_erp\",\n \"rule\": \"_isUnique\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Esse valor já está em uso\" na propriedade data.not_processed.messages.message, quando o Código de barras informado no body já estiver vinculado a outro produto. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"categoria_id\": 12,\n \"codigo_barras\": \"1239\",\n \"codigo_erp\": \"22956544128\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\": 1\n },\n \"messages\": [\n {\n \"message\": \"Esse valor já está em uso\",\n \"field\": \"codigo_barras\",\n \"rule\": \"_isUnique\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"O valor fornecido é inválido\" na propriedade data.not_processed.messages.message, quando o Código de barras informado no body não for válido. Atenção tamanho máximo de 15 (). A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"categoria_id\": 12,\n \"codigo_barras\": \"1239123124123123\",\n \"codigo_erp\": \"412341253221\",\n \"descricao\": \"Leite Desnatado Cemil\",\n \"informacoes\": \"Leite Desnatado Cemil 1L\",\n \"sem_validacao_estoque\": true,\n \"unidade_diferente\": false,\n \"bebida_alcoolica\": false,\n \"unidade_id\": 1\n },\n \"messages\": [\n {\n \"message\": \"O valor fornecido é inválido\",\n \"field\": \"codigo_barras\",\n \"rule\": \"maxLength\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Este campo é obrigatório\" na propriedade data.not_processed.messages.message,\nquando um ou mais campos obrigatórios não forem informandos no body da requisição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": [],\n \"messages\": [\n {\n \"message\": \"O campo categoria é obrigatório\",\n \"field\": \"categoria_id\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"codigo_barras\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"codigo_erp\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"descricao\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"informacoes\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"sem_validacao_estoque\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"unidade_diferente\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"bebida_alcoolica\",\n \"rule\": \"_required\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity e a mensagem \"Formato do corpo da requisição inválido. Verifique se o corpo da requisição está vazio ou com caracteres inválidos\"\nna propriedade data.message, quando o Formato do body enviado não for valido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Formato do corpo da requisição inválido. Verifique se o corpo da requisição está vazio ou com caracteres inválidos\",\n \"url\": \"/importacao/produtos/addAll\",\n \"code\": 422,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\BodyFormatValidationException\",\n \"code\": 422,\n \"message\": \"Formato do corpo da requisição inválido. Verifique se o corpo da requisição está vazio ou com caracteres inválidos\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"categoria_id","value":"211","type":"text"},{"key":"unidade_id","value":"","type":"text"},{"key":"enderecamento_id","value":"","type":"text"},{"key":"marca_id","value":"4","type":"text"},{"key":"codigo_barras","value":"7896269691362","type":"text"},{"key":"codigo_embalagem","value":"2090024000016","type":"text"},{"key":"codigo_produto_similar","value":"","type":"text"},{"key":"quantidade_embalagem","value":"","type":"text"},{"key":"codigo_erp","value":"36805","type":"text"},{"key":"descricao","value":"Achocolatado Nescau 2.0 Refil 800g","type":"text"},{"key":"subtitulo","value":"Achocolatado Nescau 2.0 Refil 800g Teste","type":"text"},{"key":"informacoes","value":"Achocolatado Nescau 2.0","type":"text"},{"key":"preco","value":"1.09","type":"text"},{"key":"acrescimo","value":"","type":"text"},{"key":"estoque_loja","value":"190","type":"text"},{"key":"estoque_seguranca","value":"10","type":"text"},{"key":"maximo_cliente","value":"20","type":"text"},{"key":"sem_validacao_estoque","value":"false","type":"text"},{"key":"unidade_diferente","value":"false","type":"text"},{"key":"quantidade_unidade_diferente","value":"","type":"text"},{"key":"peso_liquido","value":"1.500","type":"text"},{"key":"peso_bruto","value":"1.500","type":"text"},{"key":"tipo_estoque","value":"P","type":"text"},{"key":"prazo_validade","value":"","type":"text"},{"key":"bebida_alcoolica","value":"false","type":"text"},{"key":"desativado","value":"false","type":"text"},{"key":"pesavel","value":"N","type":"text"},{"key":"variacao_unidade_diferente","value":"10","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO
\nAtenção: ao realizar a requisição via POSTMAN os valores true (verdadeiro) e false (falso) deverão ser substituidos pelos respectivos valores 1 (verdadeiro) ou 0 (falso).
\nAtenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto
\n Atenção não é possível excluir um produto, para desativar um produto será necessário editar o produto enviando a propriedade desativado igual a \"true\".
Atenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso.
\nAtenção para editar informações referentes ao estoque da loja, estoque de segurança, preço dos produtos, acrescimo no valor do produto, quantidade maxima de itens por cliente será necessário efetuar a requisição de estoque e preço clique aqui. Atenção esses dados são por CD, será necessário registros de estoque_preco para cada centro de distribuição cadastrado.
\nOs parâmetros para atualizações de produto mais frequentes na importação parcial são:
\nPara editar um produto é necessário enviar uma requisição PUT, será necessário informar o ID do produto na URL e no corpo body da requisição será necessário informar os dados do produto (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| categoria_id | \nID da seção ao qual o produto esta vinculado. | \nNão | \n
| unidade_id | \nID da unidade. | \nNão | \n
| enderecamento_id | \nID do endereçamento. O atributo é necessário caso seja utilizada separação por endereçamentos, como num WMS. | \nNão | \n
| marca_id | \nID da marca. | \nNão | \n
| codigo_barras | \nCódigo de barras do produto. | \nNão | \n
| codigo_embalagem | \nCódigo de Embalagem (Código da Balança) do produto. Obs: Normalmente enviado apenas em produtos pesáveis. Tamanho mínimo 7 caracteres, máximo 15 caracteres. | \n Não | \n
| codigo_produto_similar | \nCódigo de produto similar | \nNão | \n
| quantidade_embalagem | \nQuantidade da embalagem. | \nNão | \n
| codigo_erp | \nCódigo ERP do produto. | \nNão | \n
| descricao | \nDescrição do produto. | \nNão | \n
| subtitulo | \nSubtitulo do produto. | \nNão | \n
| informacoes | \nInformações do produto. | \nNão | \n
| sem_validacao_estoque | \nDefine se o produto será definido com ou sem validação de estoque. Atenção produtos sem validação do estoque não ficam indisponíveis. Opções aceitas:
| \n Não | \n
| permitir_observacao_na_compra | \nPermite inserção de observação no produto na compra pelo cliente. Opções aceitas:
| \n Não | \n
| unidade_diferente | \nDefine se o produto será definido com ou sem unidade diferente. Opções aceitas:
Valor default: false | \n Não | \n
| quantidade_unidade_diferente | \nQuantidade da unidade diferente. Atenção deverá ser utilizado somente ponto como separador decimal. | \n Não | \n
| variacao_unidade_diferente | \nTolerância de variação do peso do produto na separação. | \nNão | \n
| peso_liquido | \nPeso liquido do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| peso_bruto | \nPeso bruto do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| tipo_estoque | \nDefine o tipo de estoque do produto. Atenção opção aceita somente em maiusculo. Opções aceitas:
| \n Não | \n
| prazo_validade | \nPrazo de validade. Deverá ser informado um valor númerico positivo, conforme o exemplo: 15 | \nNão | \n
| bebida_alcoolica | \nDefine se o produto é ou não uma bebica alcoolica. Atenção produtos definidos como bebica alcoolica não poderão ser adicionado no carrinho por cliente que não possuem maioridade. Opções aceitas:
Valor default: false | \n Não | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
| pesavel | \nDefine se o produto é ou não pesavel. Atenção opções aceitas somente em maiúsculo. Opções aceitas:
Valor default: N | \n Não | \n
| quantidade_unidade_produto | \nQuantidade da unidade vinculada ao produto | \nNão | \n
| unidade_medida_id | \nID referente a unidade. Este ID poderá ser consultado na requisição de 'Unidades' | \nNão | \n
| quantidade_fracao | \nQuantidade da fração vinculada ao produto. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do produto informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/3121',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } }\n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 41,\n \"categoria_id\":7,\n \"unidade_id\":2,\n\t\t\"codigo_barras\":111111111111111,\n \"codigo_embalagem\":\"Embalagem1\",\n \"codigo_erp\":99999998,\n \"descricao\":\"Descriçao do produto\",\n \"subtitulo\":\"subtitulo\",\n \"informacoes\":\"Informaçoes\",\n \"sem_validacao_estoque\":1,\n \"unidade_diferente\":1,\n \"quantidade_unidade_diferente\":\"1.10\",\n \"peso_liquido\":\"1.2\",\n \"peso_bruto\":\"1.3\",\n \"tipo_estoque\":\"H\",\n \"bebida_alcoolica\":1,\n \"desativado\":1,\n \"pesavel\":1\n },\n {\n \"id\": 17,\n \"categoria_id\":7,\n \"unidade_id\":2,\n\t\t\"codigo_barras\":\"111111111111112\",\n \"codigo_embalagem\":\"Embalagem2\",\n \"codigo_erp\":99999999 \n }\n]","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/produtos/editAll","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar vários produtos.
\nURL Sandbox: https://api.sandbox.vipcommerce.com.br/importacao/produtos/editAll
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\nAtenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75
\nAtenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso.
\nAtenção para editar informações referentes ao estoque da loja, estoque de segurança, preço dos produtos, acrescimo no valor do produto, quantidade maxima de itens por cliente será necessário efetuar a requisição de estoque e preço clique aqui. Atenção esses dados são por CD, será necessário registros de estoque_preco para cada centro de distribuição cadastrado.
\nAtenção os campos categoria_id, unidade_id, codigo_barras, codigo_erp, descricao, informacoes, sem_validacao_estoque, unidade_diferente e bebida_alcoolica não podem ser editados para valores vazios.
\nPara editar o(os) produtos é necessário enviar uma requisição PUT, será necessário informar o(os) ID do produto na URL e no corpo body da requisição será necessário informar os dados do(os) produto (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| id | \nID do produto | \nSim | \n
| categoria_id | \nID da seção ao qual o produto esta vinculado. | \nNão | \n
| unidade_id | \nID da unidade. | \nNão | \n
| enderecamento_id | \nID do endereçamento. O atributo é necessário caso seja utilizada separação por endereçamentos, como num WMS. | \nNão | \n
| marca_id | \nID da marca. | \nNão | \n
| codigo_barras | \nCódigo de barras do produto. | \nNão | \n
| codigo_embalagem | \nCódigo de Embalagem (Código da Balança) do produto. Obs: Normalmente enviado apenas em produtos pesáveis. Tamanho mínimo 7 caracteres, máximo 15 caracteres. | \n Não | \n
| codigo_produto_similar | \nCódigo de produto similar | \nNão | \n
| quantidade_embalagem | \nQuantidade da embalagem. | \nNão | \n
| codigo_erp | \nCódigo ERP do produto. | \nNão | \n
| descricao | \nDescrição do produto. | \nNão | \n
| subtitulo | \nSubtitulo do produto. | \nNão | \n
| informacoes | \nInformações do produto. | \nNão | \n
| sem_validacao_estoque | \nDefine se o produto será definido com ou sem validação de estoque. Atenção produtos sem validação do estoque não ficam indisponíveis. Opções aceitas:
| \n Não | \n
| unidade_diferente | \nDefine se o produto será definido com ou sem unidade diferente. Opções aceitas:
Valor default: false | \n Não | \n
| quantidade_unidade_diferente | \nQuantidade da unidade diferente. Atenção deverá ser utilizado somente ponto como separador decimal. | \n Não | \n
| peso_liquido | \nPeso liquido do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| peso_bruto | \nPeso bruto do produto. Atenção deverá ser informado um valor decimal conforme o exemplo: 1.500 | \n Não | \n
| tipo_estoque | \nDefine o tipo de estoque do produto. Atenção opção aceita somente em maiusculo. Opções aceitas:
| \n Não | \n
| prazo_validade | \nPrazo de validade. Deverá ser informado um valor númerico positivo, conforme o exemplo: 15 | \nNão | \n
| bebida_alcoolica | \nDefine se o produto é ou não uma bebica alcoolica. Atenção produtos definidos como bebica alcoolica não poderão ser adicionado no carrinho por cliente que não possuem maioridade. Opções aceitas:
Valor default: false | \n Não | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
| pesavel | \nDefine se o produto é ou não pesavel. Atenção opções aceitas somente em maiúsculo. Opções aceitas:
Valor default: N | \n Não | \n
| quantidade_unidade_produto | \nQuantidade da unidade vinculada ao produto | \nNão | \n
| unidade_medida_id | \nID referente a unidade. Este ID poderá ser consultado na requisição de 'Unidades' | \nNão | \n
| quantidade_fracao | \nQuantidade da fração vinculada ao produto. | \nNão | \n
\n[\n {\n \"id\": 41,\n \"categoria_id\":7,\n \"unidade_id\":2,\n \"codigo_barras\":111111111111111,\n \"codigo_embalagem\":\"Embalagem1\",\n \"codigo_erp\":99999998,\n \"descricao\":\"Descriçao do produto\",\n \"subtitulo\":\"subtitulo\",\n \"informacoes\":\"Informaçoes\",\n \"sem_validacao_estoque\":1,\n \"unidade_diferente\":1,\n \"quantidade_unidade_diferente\":\"1.10\",\n \"peso_liquido\":\"1.2\",\n \"peso_bruto\":\"1.3\",\n \"tipo_estoque\":\"H\",\n \"bebida_alcoolica\":1,\n \"desativado\":1,\n \"pesavel\":1\n },\n {\n \"id\": 17,\n \"categoria_id\":7,\n \"unidade_id\":2,\n \"codigo_barras\":\"111111111111112\",\n \"codigo_embalagem\":\"Embalagem2\",\n \"codigo_erp\":99999999 \n }\n]\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Produtos alterados com sucesso\",\n \"errors\": []\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"ID do produto é obrigatório\", quando o ID do produto não for informado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"ID do produto é obrigatório\"\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Record not found in table \"produtos\", quando o ID do produto não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Record not found in table \\\"produtos\\\"\"\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Código de barras já cadastrado como código de volume\", quando o código de barras do produto informado já estiver cadastrado em um código de volume, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível atualizar alguns produtos\",\n \"errorCount\": 1,\n \"errors\": {\n \"1\": {\n \"codigo_barras\": {\n \"custom\": \"Código de barras já cadastrado como código de volume\"\n }\n }\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Este campo não pode ser deixado vazio\", quando os campos informados não puder ter valores vaziosódigo de barras do produto informado já estiver cadastrado em um código de volume, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível atualizar alguns produtos\",\n \"errorCount\": 1,\n \"errors\": {\n \"11\": {\n \"codigo_barras\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"codigo_erp\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"descricao\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"informacoes\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"sem_validacao_estoque\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"unidade_diferente\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"bebida_alcoolica\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n }\n }\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de itens por página,
\n\nPermite listar produtos cadastrados.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/?codigo_erp=123456
\nOs parametros permitidos são
\nExemplos:
\n\n\nCódigo de barras:
\n
Código ERP:
Código de embalagem:
Produtos bloqueados:
Produtos desativados:
Multiplos parametros:
Atenção ao não utilizar nenhum parametro, está requisição irá retornar todos os produtos cadastrados.
\nPara listar os produtos é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"sku\": \"0F-00001\",\n \"categoria_id\": 2,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": null,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7896292050150\",\n \"codigo_embalagem\": null,\n \"codigo_erp\": 25,\n \"descricao\": \"Refresco Em Pó Magro 8g Zero Morango - Teste 02\",\n \"subtitulo\": \"\",\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": true,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:02-03:00\",\n \"modified\": \"2021-12-05T18:27:19-03:00\",\n \"volumes\": [],\n \"produto_estoque_precos\": [\n {\n \"id\": 1,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 1,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.25,\n \"maximo_cliente\": 0,\n \"estoque\": 141,\n \"estoque_seguranca\": 6,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:21:02-03:00\",\n \"estoque_disponivel\": 135,\n \"preco_venda\": 1.25\n },\n {\n \"id\": 66390,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 1,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.25,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 4,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T18:30:54-03:00\",\n \"modified\": \"2020-05-07T09:43:02-03:00\",\n \"estoque_disponivel\": -4,\n \"preco_venda\": 1.25\n },\n {\n \"id\": 66391,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 1,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.29,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 1,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T18:30:56-03:00\",\n \"modified\": \"2020-05-03T18:30:56-03:00\",\n \"estoque_disponivel\": -1,\n \"preco_venda\": 1.29\n }\n ],\n \"link\": \"1-refresco-em-po-magro-8g-zero-morango-teste-02\",\n \"imagemUrls\": []\n },\n {\n \"id\": 2,\n \"sku\": \"0F-00002\",\n \"categoria_id\": 2,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": null,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7896292050068\",\n \"codigo_embalagem\": null,\n \"codigo_erp\": 27,\n \"descricao\": \"Refresco Em Pó Magro 8g Zero Abacaxi....abcdabcd...\",\n \"subtitulo\": null,\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": true,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:02-03:00\",\n \"modified\": \"2019-03-01T16:15:57-03:00\",\n \"volumes\": [\n {\n \"id\": 7,\n \"codigo\": \"84985908533\",\n \"produto_id\": 2,\n \"quantidade\": 12,\n \"created\": \"2021-10-14T15:36:17-03:00\",\n \"modified\": \"2021-10-14T15:36:17-03:00\"\n },\n {\n \"id\": 8,\n \"codigo\": \"849859085332\",\n \"produto_id\": 2,\n \"quantidade\": 121,\n \"created\": \"2021-10-14T15:39:52-03:00\",\n \"modified\": \"2021-10-14T15:39:52-03:00\"\n }\n ],\n \"produto_estoque_precos\": [\n {\n \"id\": 2,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 2,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.45,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 4,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:14:12-03:00\",\n \"estoque_disponivel\": 145,\n \"preco_venda\": 1.45\n },\n {\n \"id\": 66380,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 2,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.45,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 2,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T18:30:35-03:00\",\n \"modified\": \"2020-05-07T09:43:03-03:00\",\n \"estoque_disponivel\": -2,\n \"preco_venda\": 1.45\n },\n {\n \"id\": 66381,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 2,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.35,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 1,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T18:30:37-03:00\",\n \"modified\": \"2020-05-03T18:30:37-03:00\",\n \"estoque_disponivel\": -1,\n \"preco_venda\": 1.35\n }\n ],\n \"link\": \"2-refresco-em-po-magro-8g-zero-abacaxi-abcdabcd\",\n \"imagemUrls\": []\n },\n {\n \"id\": 3,\n \"sku\": \"0F-00003\",\n \"categoria_id\": 2,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": null,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7891095017720\",\n \"codigo_embalagem\": null,\n \"codigo_erp\": 47,\n \"descricao\": \"Refresco Em Pó Yoki 30g Morango....abcdabcd...\",\n \"subtitulo\": null,\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": true,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:02-03:00\",\n \"modified\": \"2019-03-01T16:15:57-03:00\",\n \"volumes\": [],\n \"produto_estoque_precos\": [\n {\n \"id\": 3,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 3,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 5,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:14:20-03:00\",\n \"estoque_disponivel\": 144,\n \"preco_venda\": 1.09\n },\n {\n \"id\": 66416,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 3,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.05,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 2,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T19:39:22-03:00\",\n \"modified\": \"2020-05-09T03:24:20-03:00\",\n \"estoque_disponivel\": -2,\n \"preco_venda\": 1.05\n },\n {\n \"id\": 90939,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 3,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 3,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-07T09:12:42-03:00\",\n \"modified\": \"2020-05-07T09:43:07-03:00\",\n \"estoque_disponivel\": -3,\n \"preco_venda\": 1.09\n }\n ],\n \"link\": \"3-refresco-em-po-yoki-30g-morango-abcdabcd\",\n \"imagemUrls\": []\n },\n {\n \"id\": 4,\n \"sku\": \"0F-00004\",\n \"categoria_id\": 2,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": null,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7891095017683\",\n \"codigo_embalagem\": null,\n \"codigo_erp\": 50,\n \"descricao\": \"Refresco Em Pó Yoki 30g Uva....abcdabcd...\",\n \"subtitulo\": null,\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": true,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:02-03:00\",\n \"modified\": \"2019-03-01T16:15:57-03:00\",\n \"volumes\": [],\n \"produto_estoque_precos\": [\n {\n \"id\": 4,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 4,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 6,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:23:48-03:00\",\n \"estoque_disponivel\": 143,\n \"preco_venda\": 1.09\n },\n {\n \"id\": 66559,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 4,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.05,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 2,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T20:00:42-03:00\",\n \"modified\": \"2020-05-09T04:25:36-03:00\",\n \"estoque_disponivel\": -2,\n \"preco_venda\": 1.05\n },\n {\n \"id\": 66560,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 4,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 0,\n \"estoque_seguranca\": 4,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-05-03T20:00:46-03:00\",\n \"modified\": \"2020-05-07T09:43:10-03:00\",\n \"estoque_disponivel\": -4,\n \"preco_venda\": 1.09\n }\n ],\n \"link\": \"4-refresco-em-po-yoki-30g-uva-abcdabcd\",\n \"imagemUrls\": []\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 5,\n \"limit\": null\n }\n}\n\n| Campo | Descrição |
|---|---|
data.id | ID do produto |
data.sku | ID único para o produto (Stock Keeping Unit). |
data.categoria_id | ID da categoria. |
data.unidade_id | ID da unidade. |
data.enderecamento_id | ID do endereçamento. |
data.marca_id | ID da marca. |
data.parent_id | ID da seção do departamento do produto. |
data.codigo_barras | Código de barras do produto. |
data.codigo_embalagem | Código de embalagem do produto. |
data.codigo_erp | Código ERP do produto. |
data.descricao | Descrição do produto. |
data.subtitulo | Subtítulo vinculado ao produto. |
data.informacoes | Informações vinculadas ao produto. |
data.quantidade_unidade_produto | Quantidade da unidade do produto. |
data.unidade_medida_id | ID da unidade vinculado ao produto. |
data.quantidade_fracao | Quantidade da fração vinculado ao produto. |
data.sem_validacao_estoque | Exibe se o produto possui ou não validade de estoque.\"True\" para \"sim\" e \"False\" para \"não\". |
data.unidade_diferente | Define se o possui produto unidade diferente. \"True\" para \"sim\" e \"False\" para \"não\".. |
data.quantidade_unidade_diferente | Quantidade da unidade diferente. |
data.variacao_unidade_diferente | Tolerância de variação do peso na separação. |
data.bebida_alcoolica | Defina se o produto é ou não bebida alcoólica. \"True\" para \"sim\" e \"False\" para \"não\". |
data.peso_liquido | Peso líquido do produto. |
data.peso_bruto | Peso bruto do produto. |
data.tipo_estoque | Tipo de estoque do produto. \"P\" para o padrão. |
data.desativado | Informa se o produto está ou não desativado. \"True\" para \"sim\" e \"False\" para \"não\". |
data.permitir_observacao_na_compra | Permite inserção de observação no produto na compra pelo cliente. |
data.bloqueado | Informa se o produto está ou não bloqueado. \"True\" para \"sim\" e \"False\" para \"não\". |
data.pesavel | Defina se o produto é ou não pesável. |
data.localizacao | Localização do produto.. |
data.created | Data de criação do registro. |
data.modified | Data de modificação do registro. |
data.link | Link do produto. ID do produto e separados por hífen. |
data.imagemUrls.tamanho | Tamanho da imagem do produto em pixels |
data.imagemUrls.localizacao | URL da localização da imagem do produto. |
pagination.page_count | Número de páginas. |
pagination.current_page | Página corrente. |
pagination.has_next_page | Existe próxima página. |
pagination.has_prev_page | Existe página anterior. |
pagination.count | Total de registros retornados. |
pagination.limit | Limite da paginação. |
Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite consultar um produto através do ID do produto.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO
\nAtenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso.
\nPara consultar um produto é necessário enviar uma requisição GET, sendo necessário informar o ID do produto ou SKU (Stock Keeping Unit) na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 830,\n \"sku\": \"0F-0033E\",\n \"categoria_id\": 24,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": 0,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7894000010014\",\n \"codigo_embalagem\": \"\",\n \"codigo_erp\": 2721,\n \"descricao\": \"Amido De Milho Maizena 200g\",\n \"subtitulo\": \"\",\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 0.5,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": false,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:05-03:00\",\n \"modified\": \"2022-11-23T15:25:23-03:00\",\n \"volumes\": [],\n \"produto_estoque_precos\": [\n {\n \"id\": 830,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 700,\n \"estoque_seguranca\": 0.1,\n \"estoque_reserva\": 1,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 698.9,\n \"preco_venda\": 2.7,\n \"estoque_disponivel_unidade_diferente\": 1397.8\n },\n {\n \"id\": 69592,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 600,\n \"estoque_seguranca\": 0,\n \"estoque_reserva\": 3,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-05-04T01:42:28-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 597,\n \"preco_venda\": 2.7,\n \"estoque_disponivel_unidade_diferente\": 1194\n },\n {\n \"id\": 91706,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 500,\n \"estoque_seguranca\": 0,\n \"estoque_reserva\": 1,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-05-07T09:56:34-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 499,\n \"preco_venda\": 2.7,\n \"estoque_disponivel_unidade_diferente\": 998\n }\n ],\n \"link\": \"830-amido-de-milho-maizena-200g\",\n \"imagemUrls\": []\n }\n}\n\nSerá retornado o código de status 404 Not found quando o ID do produto informado na URL não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/9901',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\n\n| Campo | Descrição |
|---|---|
| data.id | ID do produto |
| data.sku | ID único para o produto (Stock Keeping Unit). |
| data.categoria_id | ID da categoria. |
| data.unidade_id | ID da unidade. |
| data.enderecamento_id | ID do endereçamento. |
| data.marca_id | ID da marca. |
| data.quantidade_unidade_produto | Quantidade da unidade do produto. |
| data.unidade_medida_id | ID da unidade vinculado ao produto. |
| data.quantidade_fracao | Quantidade da fração vinculado ao produto. |
| data.parent_id | ID da seção do departamento do produto. |
| data.codigo_barras | Código de barras do produto. |
| data.codigo_embalagem | Código de embalagem do produto. |
| data.codigo_erp | Código ERP do produto. |
| data.descricao | Descrição do produto. |
| data.subtitulo | Subtítulo vinculado ao produto. |
| data.informacoes | Informações vinculadas ao produto. |
| data.permitir_observacao_na_compra | Permite inserção de observação no produto na compra pelo cliente.\"True\" para \"sim\" e \"False\" para \"não\". |
| data.sem_validacao_estoque | Exibe se o produto possui ou não validade de estoque.\"True\" para \"sim\" e \"False\" para \"não\". |
| data.unidade_diferente | Define se o possui produto unidade diferente. \"True\" para \"sim\" e \"False\" para \"não\".. |
| data.quantidade_unidade_diferente | Quantidade da unidade diferente. |
| data.variacao_unidade_diferente | Tolerância de variação do peso na separação. |
| data.bebida_alcoolica | Defina se o produto é ou não bebida alcoólica. \"True\" para \"sim\" e \"False\" para \"não\". |
| data.peso_liquido | Peso líquido do produto. |
| data.peso_bruto | Peso bruto do produto. |
| data.tipo_estoque | Tipo de estoque do produto. \"P\" para o padrão. |
| data.desativado | Informa se o produto está ou não desativado. \"True\" para \"sim\" e \"False\" para \"não\". |
| data.bloqueado | Informa se o produto está ou não bloqueado. \"True\" para \"sim\" e \"False\" para \"não\". |
| data.pesavel | Defina se o produto é ou não pesável. |
| data.localizacao | Localização do produto.. |
| data.created | Data de criação do registro. |
| data.modified | Data de modificação do registro. |
| data.link | Link do produto. ID do produto e separados por hífen. |
| data.imagemUrls.tamanho | Tamanho da imagem do produto em pixels |
| data.imagemUrls.localizacao | URL da localização da imagem do produto. |
Tipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO_PAI}}/clones","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar produtos clones apartir do produto pai.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO_PAI/clones
\nPara consultar os produtos clones de um produto é necessário enviar uma requisição GET, informando na URL o ID do produto pai.
Atenção o ID informado na URL pode conter o ID do produto ou SKU do produto
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 51542,\n \"codigo_barras\": \"7896292050150\",\n \"codigo_embalagem\": \"223123\",\n \"descricao\": \"Produto clone 2\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 0.3,\n \"desativado\": false\n },\n {\n \"id\": 51543,\n \"codigo_barras\": \"7896292050150\",\n \"codigo_embalagem\": \"2454523\",\n \"descricao\": \"Produto clone 1\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": true,\n \"quantidade_unidade_diferente\": 1,\n \"desativado\": false\n }\n ]\n}\n\nSerá retornado o código de status 200 OK quando com a mensagem \"O produto 1515 não possui clones\" quando o produto informado na URL não possuir clones, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n \"O produto 88888888 não possui clones\"\n ]\n}\n\nSerá retornado o código de status 200 OK quando com a mensagem \"O produto 51542 já é um produto clone\" quando o produto informado na URL já for um clone, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n \"O produto 51542 já é um produto clone\"\n ]\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/filial/{{ID_FILIAL}}/centro_distribuicao/{{ID_CD}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar informações de uma oferta sobre um produto através do ID do produto, ID do Centro de Distribuição e do ID da filial.
\nURL Sandbox:
\n\nAtenção essa funcionalidade informa apenas Ofertas do Tipo Produto com Desconto
\nPara consultar informações de oferta através de um produto, é necessário enviar uma requisição GET, sendo necessário informar o ID do produto, ID da filial e ID do Centro de Distribuição na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 8176,\n \"sku\": \"02-01FF0\",\n \"categoria_id\": 106,\n \"unidade_id\": 1,\n \"quantidade_unidade_produto\": null,\n \"quantidade_fracao\": 1,\n \"unidade_medida_id\": null,\n \"enderecamento_id\": null,\n \"marca_id\": null,\n \"parent_id\": null,\n \"codigo_barras\": \"7891515429454\",\n \"codigo_embalagem\": null,\n \"codigo_erp\": 19121,\n \"descricao\": \"Sobrecoxa Perdigão 800g\",\n \"subtitulo\": null,\n \"informacoes\": \".\",\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"variacao_unidade_diferente\": 0,\n \"bebida_alcoolica\": false,\n \"peso_liquido\": 0,\n \"peso_bruto\": 0,\n \"tipo_estoque\": \"P\",\n \"desativado\": false,\n \"bloqueado\": false,\n \"pesavel\": \"N\",\n \"permite_compartilhar_volumes\": false,\n \"localizacao\": \"\",\n \"permitir_observacao_na_compra\": false,\n \"created\": \"2018-08-20T19:06:49-03:00\",\n \"modified\": \"2020-05-03T00:16:52-03:00\",\n \"volumes\": [],\n \"produto_estoque_precos\": [\n {\n \"id\": 8176,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 8176,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 11.79,\n \"maximo_cliente\": 0,\n \"estoque\": 11,\n \"estoque_seguranca\": 2,\n \"estoque_reserva\": 8,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-06-14T04:52:15-03:00\",\n \"estoque_disponivel\": 1,\n \"preco_venda\": 11.79,\n \"estoque_disponivel_unidade_diferente\": 1\n }\n ],\n \"oferta\": {\n \"id\": \"0ea5da65-60d5-4def-a098-d0ffb9cd5c13\",\n \"oferta_id\": 184,\n \"oferta_item_id\": \"0ea5da65-60d5-4def-a098-d0ffb9cd5c13\",\n \"produto_id\": 8176,\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 1,\n \"tipo_oferta_id\": 1,\n \"categoria\": \"G\",\n \"familia\": false,\n \"nome\": \"Preço VIP\",\n \"preco_antigo\": 11.79,\n \"preco_oferta\": 10,\n \"menor_preco\": 10,\n \"quantidade_minima\": 1,\n \"quantidade_maxima\": 30,\n \"quantidade_pagar\": 1,\n \"quantidade_oferta\": 1,\n \"tema\": \"preco-vip\",\n \"tipo\": null,\n \"classe_oferta\": \"preco-vip\",\n \"tag\": \"preco-vip\",\n \"data_inicial\": \"2023-05-24T10:03:00-03:00\",\n \"data_final\": \"2024-05-01T09:57:00-03:00\",\n \"exibe_preco_original\": 0,\n \"preco_original\": 0\n },\n \"link\": \"8176-sobrecoxa-perdigao-800g\",\n \"imagemUrls\": [],\n \"imagem_placeholder\": \"https://s3.amazonaws.com/produtos.vipcommerce.com.br/placeholders/500.png\"\n }\n}\n\nSerá retornado o código de status 404 Not found quando o ID do produto informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/produtos/813376/filial/1/centro_distribuicao/1\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\n\n| Campo | Descrição |
|---|---|
| data.oferta.id | ID vipcommerce da oferta. |
| data.oferta.oferta_id | ID da oferta. |
| data.oferta.oferta_item_id | ID do item da oferta. |
| data.oferta.produto_id | ID do produto. |
| data.oferta.filial_id | ID da filial. |
| data.oferta.centro_distribuicao_id | ID do centro de distribuição. |
| data.oferta.tipo_oferta_id | ID do tipo de oferta. |
| data.oferta.categoria | Categoria da oferta. |
| data.oferta.familia | Define se a oferta considera família. |
| data.oferta.nome | Descrição da oferta. |
| data.oferta.preco_antigo | Preço do produto fora da oferta. |
| data.oferta.preco_oferta | Preço do produto na oferta. |
| data.oferta.quantidade_minima | Quantidade mínima de itens do produto para aplicação da oferta. |
| data.oferta.quantidade_maxima | Quantidade máxima de itens do produto permitida por compra durante a validade da oferta. |
| data.oferta.quantidade_pagar | Define se o possui produto unidade diferente. \"True\" para \"sim\" e \"False\" para \"não\".. |
| data.oferta.tema | Tema da oferta utilizado para apresentação na loja e no aplicativo. |
| data.oferta.tipo | Tipo da oferta. |
| data.oferta.tag | Nome da tag da oferta. |
| data.oferta.data_inicial | Data de início da vigência da oferta. |
| data.oferta.data_final | Data de término da vigência da oferta. |
| data.oferta.exibe_preco_original | Informa se preço original será exibido. |
| data.oferta.preco_original | Valor do preço original. |
Gerenciamento de cadastro dos produtos da loja online.
\nAtenção não é possível excluir um produto via API. Para desabilitar um produto, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true. Ao realizar esta ação o produto não será exibido na loja.
\nAtenção: ao realizar a requisição via POSTMAN os valores true (verdadeiro) e false (falso) deverão ser substituidos pelos respectivos valores 1 (verdadeiro) ou 0 (falso).
\nAtenção na versão CD as informações de estoque e preço deverão ser consultada na requisição de estoque e preço. Clique aqui
\nAtenção em decorrência da Lei Federal nº 14.181/2021, publicada no Diário Oficial da União em 01/07/2021, a qual alterou o Código de Defesa do Consumidor, especificamente em seu art. 6º, inciso XIII, agora será possível informar no cadastro dos produtos o preço por unidade de medida, exibindo assim, na loja online, uma tag informando acerca dos preços dos produtos por unidade de medida, tal como por quilo, por litro, por metro ou por outra unidade, conforme o caso. No cadastro e edição de produtos foram adicionados 3 (três) novos campos, sendo eles: \"quantidade_unidade_produto\", \"unidade_medida_id\" e \"quantidade_fracao\" (suas respectivas descrições estão inclusas na tabela de descrição dos campos).
\n","event":[{"listen":"prerequest","script":{"id":"ac127023-3446-4157-863b-57414fd8647a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c1ae6e39-0b2e-46ea-a4a0-243a46c8936b","type":"text/javascript","exec":[""]}}],"_postman_id":"234a9b2a-ced8-47f7-9e7e-70445bf6286e"},{"name":"Estoque e Preco","item":[{"name":"Adicionar estoque e preco","id":"dd54f5d7-517d-43d7-8d09-01e68c88802d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"centro_distribuicao_id","value":"2","type":"text"},{"key":"percentual_ajuste","value":"10","type":"text"},{"key":"preco_base","value":"5.59","type":"text"},{"key":"maximo_cliente","value":"100","type":"text"},{"key":"estoque","value":"400","type":"text"},{"key":"estoque_seguranca","value":"15","type":"text"},{"key":"desativado","value":"0","type":"text"},{"key":"enderecamento_id","value":"19","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/produto-estoque-precos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar informações de produto como: estoque, preço, ajuste, maximo por cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/produto-estoque-precos
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto.
\nAtenção não é possível excluir um produto via API. Para desabilitar um produto, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nPara cadastrar estoque é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| centro_distribuicao_id | \nID do centro de distribuição. Atenção: deverá ser informado um número inteiro positivo. | \n Sim | \n
| percentual_ajuste | \nAcréscimo ao preço do produto. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| preco_base | \nPreço do produto. Atenção deverá ser informado número positivo, utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| maximo_cliente | \nQuantidade máxima por cliente. Esta quantidade define quantos itens um cliente pode incluir no carrinho por compra. Atenção: deverá ser informado um número inteiro positivo. Ao enviar o valor 0 (zero) o produto não terá maximo. | \n Sim | \n
| estoque | \nEstoque da loja. Atenção deverá ser informado número positivo, utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| estoque_seguranca | \nEstoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Atenção deverá ser informado número positivo, utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| enderecamento_id | \nID do apartamento, caso o admin esteja configurado para trabalhar com grupo de separação por endereçamento. | \nNão | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
\n centro_distribuicao_id: 2,\n percentual_ajuste: 0,\n preco_base: 12.98,\n maximo_cliente: 0,\n estoque: 100,\n estoque_seguranca: 10\n\n\n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
\n{\n \"success\": true,\n \"data\": {\n \"id\": 33729\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"produto_id\" com a mensagem \"Este valor não existe\", quando o ID do produto informado na URL não for encontrado, abaixo é exibida um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/100/produto-estoque-precos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"produto_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"preco_base\" com a mensagem \"Precificação já realizada para este centro de distribuição\", quando ocorrer uma tentativa de cadastro de estoque e preço em um CD que já possui um registro cadastrado para o CD enviado na requisição, abaixo é exibida um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/1/produto-estoque-precos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"preco_base\": \"Precificação já realizada para este centro de distribuição\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"centro_distribuicao_id\" com a mensagem \"Este valor não existe\", quando o ID do centro de distribuicao informado no corpo da requisição não for encontrado, abaixo é exibida um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/1/produto-estoque-precos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"centro_distribuicao_id\": \"Este valor não existe\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar estoque-preços dos produtos em lote.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produto-estoque-precos/addAll
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\n Atenção não é possível excluir um estoque-preco via API. Para desabilitar um estoque-preco, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
Atenção ao se optar por não cadastrar algum atributo opcional, ao invés de enviar o valor \"null\" na requisição, é preferível não enviar o atributo.
\nPara cadastrar estoque-preço em lote é necessário enviar uma requisição POST. No corpo body da requisição será necessário informar as informações vinculadas ao estoque e preço (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| produto_id | \nID do produto cadastrado. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | \n Sim | \n
| centro_distribuicao_id | \nID do centro de distribuição. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | \n Sim | \n
| percentual_ajuste | \nAcréscimo ao preço do produto. Atenção deverá ser enviado um número inteiro, conforme o exemplo para 15%: 15 | \n Não | \n
| preco_base | \nPreço do produto. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| maximo_cliente | \nQuantidade máxima por cliente. Esta quantidade define quantos itens um cliente pode incluir no carrinho por compra. Atenção: deverá ser informado um número inteiro positivo. Valor default: 0 | \n Não | \n
| estoque | \nEstoque da loja. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| estoque_seguranca | \nEstoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Sim | \n
| enderecamento_id | \nID do apartamento, caso o admin esteja configurado para trabalhar com grupo de separação por endereçamento. | \nNão | \n
| bloqueado | \nDefine se o estoque e preço estará bloqueado. Opções aceitas:
Valor default: false | \n Não | \n
| desativado | \nDefine se o estoque e preço estará desativado. Atenção: caso o estoque e preço esteja desativado, o produto vinculado ao estoque e preço não será exibido na loja. Opções aceitas:
| \n Não | \n
\n[\n {\n \"produto_id\":51537,\n \"centro_distribuicao_id\":1,\n \"percentual_ajuste\":20,\n \"preco_base\":2.22,\n \"estoque\":222,\n \"estoque_seguranca\":2,\n \"bloqueado\": false,\n \"desativado\": false\n },\n {\n \"produto_id\":51537,\n \"centro_distribuicao_id\":3,\n \"percentual_ajuste\":30,\n \"preco_base\":3.33,\n \"estoque\":333,\n \"estoque_seguranca\":3,\n \"bloqueado\":false,\n \"desativado\": true\n },\n {\n \"produto_id\":51538,\n \"centro_distribuicao_id\":2,\n \"preco_base\":3.33,\n \"estoque\":333,\n \"estoque_seguranca\":3\n }\n]\n\n\nSerá retornado o código de status 200 OK e a propriedade data.result contendo informações dos produtos cadastrados. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"message\": \"Informação: 0 não processados. Total processado: 1\",\n \"data\": {\n \"result\": [\n {\n \"id\": 128766,\n \"produto_id\": 14,\n \"codigo_erp\": 27827,\n \"centro_distribuicao_id\": 2\n }\n ],\n \"not_processed\": []\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a propriedade data.result contendo informações dos estoque-precos cadastrados e data.not_processed\ncontendo informações dos estoque-precos não cadastrados. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 1\",\n \"data\": {\n \"result\": [\n {\n \"id\": 128767,\n \"produto_id\": 500,\n \"codigo_erp\": 1194\n }\n ],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 1,\n \"percentual_ajuste\": 20,\n \"preco_base\": -192.1,\n \"estoque\": 7.5\n },\n \"messages\": [\n {\n \"message\": \"O valor fornecido é inválido\",\n \"field\": \"preco_base\",\n \"rule\": \"greaterThanOrEqual\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"estoque_seguranca\",\n \"rule\": \"_required\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity e a mensagem \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\"\nna propriedade data.message, quando o Formato do body enviado não for valido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\",\n \"url\": \"/importacao/produto-estoque-precos/addAll\",\n \"code\": 422,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\BodyFormatValidationException\",\n \"code\": 422,\n \"message\": \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\"\n }\n }\n}\nSerá retornado o código de status 200 OK e a mensagem \"Este valor não existe\" na propriedade data.not_processed.messages.message, quando o ID do produto informado no body não estiver cadastrado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 143123121,\n \"centro_distribuicao_id\": 8,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50\n },\n \"messages\": [\n {\n \"message\": \"Este valor não existe\",\n \"field\": \"produto_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Este valor não existe\" na propriedade data.not_processed.messages.message,\nquando o ID do centro de distribuição informado no body não estiver cadastrado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 831231,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50\n },\n \"messages\": [\n {\n \"message\": \"Este valor não existe\",\n \"field\": \"centro_distribuicao_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Precificação já realizada para este centro de distribuição\" na propriedade data.not_processed.messages.message,\nquando o produto já conter precificação para o centro de distribuição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 1,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50,\n \"bloqueado\": false,\n \"desativado\": false,\n \"maximo_cliente\": 500\n },\n \"messages\": [\n {\n \"message\": \"Precificação já realizada para este centro de distribuição\",\n \"field\": \"preco_base\",\n \"rule\": \"uniquePrice\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"O valor fornecido é inválido\" na propriedade data.not_processed.messages.message,\nquando um ou mais valores informado(s) no body for invalido. A seguir é exibido um exemplo da mensagem, onde valor de preço base é informado negativo.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 7,\n \"percentual_ajuste\": 20,\n \"preco_base\": -1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50,\n \"bloqueado\": false,\n \"desativado\": false,\n \"maximo_cliente\": 500\n },\n \"messages\": [\n {\n \"message\": \"O valor fornecido é inválido\",\n \"field\": \"preco_base\",\n \"rule\": \"greaterThanOrEqual\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Record not found in table \"enderecamentos\" with primary key [NULL]\" na propriedade\ndata.not_processed.messages.message, quando o ID do apartamento informado no body não estiver vinculado ao ID do centro de distribuição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 1,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"enderecamento_id\": 1\n },\n \"messages\": [\n {\n \"message\": \"Record not found in table \\\"enderecamentos\\\" with primary key [NULL]\",\n \"field\": \"produto_id\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Este campo é obrigatório\" na propriedade data.not_processed.messages.message,\nquando um ou mais campos obrigatórios não forem informandos no body da requisição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12\n },\n \"messages\": [\n {\n \"message\": \"É necessário informar o ID ou CNPJ do centro de distribuição\",\n \"field\": \"centro_distribuicao_id\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"preco_base\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"estoque\",\n \"rule\": \"_required\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"estoque_seguranca\",\n \"rule\": \"_required\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar as informações de um produto
\n\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto.
\nAtenção não é possível excluir um produto via API. Para desabilitar um produto, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nPara editar as informações de um produto é necessário enviar uma requisição PUT, informando os dados a serem editados no body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| centro_distribuicao_id | \nID do centro de distribuição. Atenção: deverá ser informado um número inteiro positivo. | \n Não | \n
| percentual_ajuste | \nAcréscimo ao preço do produto. Atenção deverá ser enviado um número inteiro, conforme o exemplo: 10 | \n Não | \n
| preco_base | \nPreço do produto. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| maximo_cliente | \nQuantidade máxima por cliente. Esta quantidade define quantos itens um cliente pode incluir no carrinho por compra. Atenção: deverá ser informado um número inteiro positivo. | \n Não | \n
| estoque | \nEstoque da loja. Atenção deverá ser informado número positivo, utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| estoque_seguranca | \n>Estoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Atenção deverá ser informado número positivo, utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| enderecamento_id | \nID do apartamento, caso o admin esteja configurado para trabalhar com grupo de separação por endereçamento. | \nNão | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
| \n Não | \n
| bloqueado | \nDefine se o produto estará bloqueado para venda. Atenção produtos bloqueados são exibidos na loja como indisponível. Opções aceitas:
| \n Não | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do produto ou ID do estoque-preco informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/produto-estoque-precos/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar estoque-preços dos produtos em lote.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produto-estoque-precos/editAll
\nAtenção cada requisição deve conter no máximo 1000 produtos.
\n Atenção não é possível excluir um estoque-preco via API. Para desabilitar um estoque-preco, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
Atenção ao se optar por não editar algum atributo opcional, ao invés de enviar o valor \"null\" na requisição, é preferível não enviar o atributo.
\nPara editar estoque-preço em lote é necessário enviar uma requisição PUT. No corpo body da requisição será necessário informar as informações vinculadas ao estoque e preço (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| produto_id | \nID do produto cadastrado. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | \n Sim | \n
| id | \nID do estoque-preco. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | \n Sim | \n
| percentual_ajuste | \nAcréscimo ao preço do produto. Atenção deverá ser enviado um número inteiro ou negativo, conforme o exemplo para 15%: 15 | \n Não | \n
| preco_base | \nPreço do produto. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| maximo_cliente | \nQuantidade máxima por cliente. Esta quantidade define quantos itens um cliente pode incluir no carrinho por compra. Atenção: deverá ser informado um número inteiro positivo. | \n Não | \n
| estoque | \nEstoque da loja. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| estoque_seguranca | \nEstoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Atenção deverá ser utilizado somente ponto como separador decimal, conforme o exemplo: 10.75 | \n Não | \n
| enderecamento_id | \nID do apartamento, caso o admin esteja configurado para trabalhar com grupo de separação por endereçamento. | \nNão | \n
| bloqueado | \nDefine se o estoque e preço estará bloqueado. Opções aceitas:
| \n Não | \n
| desativado | \nDefine se o estoque e preço estará desativado. Atenção: caso o estoque e preço esteja desativado, o produto vinculado ao estoque e preço não será exibido na loja. Opções aceitas:
| \n Não | \n
\n[\n {\n \"produto_id\":51537,\n \"id\":1,\n \"bloqueado\": true\n },\n {\n \"produto_id\":51537,\n \"id\":3,\n \"percentual_ajuste\":30,\n \"preco_base\":3.33\n },\n {\n \"produto_id\":51538,\n \"id\":2,\n \"preco_base\":3.33,\n \"estoque\":333,\n \"estoque_seguranca\":3\n }\n]\n\n\nSerá retornado o código de status 200 OK e a propriedade data.result contendo informações dos produtos cadastrados. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"message\": \"Informação: 0 não processados. Total processado: 1\",\n \"data\": {\n \"result\": [\n {\n \"id\": 128766,\n \"produto_id\": 14,\n \"codigo_erp\": 27827\n }\n ],\n \"not_processed\": []\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a propriedade data.result contendo informações dos estoque-precos cadastrados e data.not_processed\ncontendo informações dos estoque-precos não cadastrados. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 1\",\n \"data\": {\n \"result\": [\n {\n \"id\": 128766,\n \"produto_id\": 14,\n \"codigo_erp\": 27827\n }\n ],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 14\n },\n \"messages\": [\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"id\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity e a mensagem \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\"\nna propriedade data.message, quando o Formato do body enviado não for valido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\",\n \"url\": \"/importacao/produto-estoque-precos/addAll\",\n \"code\": 422,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\BodyFormatValidationException\",\n \"code\": 422,\n \"message\": \"Formato do corpo da requisição inválido. Deve ser informado pelo menos um ProdutoEstoquePreco\"\n }\n }\n}\nSerá retornado o código de status 200 OK e a mensagem \"Produto não encontrado\" na propriedade data.not_processed.messages.message,\nquando o ID do produto informado no body não existir ou não estiver vinculado ao ID do estoque-preco. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 143123121,\n \"centro_distribuicao_id\": 8,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50\n },\n \"messages\": [\n {\n \"message\": \"Produto não encontrado\",\n \"field\": \"produto_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"ProdutoEstoquePreco não encontrado\" na propriedade data.not_processed.messages.message,\nquando o ID do estoque-preco informado no body não estiver cadastrado ou não estiver vinculado ao ID do produto. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"id\": 831231,\n \"percentual_ajuste\": 20,\n \"preco_base\": 1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50\n },\n \"messages\": [\n {\n \"message\": \"ProdutoEstoquePreco não encontrado\",\n \"field\": \"id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"O valor fornecido é inválido\" na propriedade data.not_processed.messages.message,\nquando um ou mais valores informado(s) no body for invalido. A seguir é exibido um exemplo da mensagem, onde valor de preço base é informado negativo.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 12,\n \"centro_distribuicao_id\": 7,\n \"percentual_ajuste\": 20,\n \"preco_base\": -1232.09,\n \"estoque\": 15.2,\n \"estoque_seguranca\": 50,\n \"bloqueado\": false,\n \"desativado\": false,\n \"maximo_cliente\": 500\n },\n \"messages\": [\n {\n \"message\": \"O valor fornecido é inválido\",\n \"field\": \"preco_base\",\n \"rule\": \"greaterThanOrEqual\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Endereçamento informado não pertece ao CD do produto\" na propriedade\ndata.not_processed.messages.message, quando o ID do apartamento informado no body não estiver vinculado ao ID do centro de distribuição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"produto_id\": 14,\n \"id\": 128766,\n \"preco_base\": 3.33,\n \"estoque\": 333,\n \"estoque_seguranca\": 3,\n \"enderecamento_id\": 4\n },\n \"messages\": [\n {\n \"message\": \"Endereçamento informado não pertece ao CD do produto\",\n \"field\": \"enderecamento_id\",\n \"rule\": \"customPath\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nSerá retornado o código de status 200 OK e a mensagem \"Este campo é obrigatório\" na propriedade data.not_processed.messages.message,\nquando um ou mais campos obrigatórios não forem informandos no body da requisição. A seguir é exibido um exemplo da mensagem.
{\n \"success\": true,\n \"message\": \"Informação: 1 não processados. Total processado: 0\",\n \"data\": {\n \"result\": [],\n \"not_processed\": [\n {\n \"entity\": {\n \"preco_base\": 3.33,\n \"estoque\": 333,\n \"estoque_seguranca\": 3\n },\n \"messages\": [\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"id\"\n },\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"produto_id\"\n }\n ]\n }\n ]\n },\n \"errors\": []\n}\nPara detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de itens por página,
\n\nPermite Busca informações de um produto.
\nURL Sandbox:
\n\nPara buscar as informações de um produto é necessário enviar uma requisição GET, informando o ID do produto e o ID centro de distribuição na URL.
Os parametros permitidos são:
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 830,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 700,\n \"estoque_seguranca\": 0.1,\n \"estoque_reserva\": 1,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 698.9,\n \"preco_venda\": 2.7\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\n\nID do centro de distribuição
\n","type":"text/plain"},"key":"centro_distribuicao_id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"3703aa10-c886-4fba-9275-f29d92ddf64f"},{"name":"Listar estoque e preco","id":"5944a23b-8d69-40e8-a85c-aa9800679cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/produto-estoque-precos","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de itens por página,
\n\nPermite listar informações do produto cadastrado.
\nURL Sandbox:
\n\nPara listar as informações de um produto é necessário enviar uma requisição GET, informando o ID do produto na URL.
Os parametros permitidos são:
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 830,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 700,\n \"estoque_seguranca\": 0.1,\n \"estoque_reserva\": 1,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 698.9,\n \"preco_venda\": 2.7\n },\n {\n \"id\": 69592,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 600,\n \"estoque_seguranca\": 0,\n \"estoque_reserva\": 3,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-05-04T01:42:28-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 597,\n \"preco_venda\": 2.7\n },\n {\n \"id\": 91706,\n \"centro_distribuicao_id\": 3,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 500,\n \"estoque_seguranca\": 0,\n \"estoque_reserva\": 1,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-05-07T09:56:34-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 499,\n \"preco_venda\": 2.7\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de itens por página,
\n\nPermite listar todos os estoque-precos sem informar um ID de produto.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/produto-estoque-precos
\nPara listar as informações de estoques e preços é necessário enviar uma requisição GET.
Os parametros permitidos são:
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 1,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.25,\n \"maximo_cliente\": 0,\n \"estoque\": 141,\n \"estoque_seguranca\": 6,\n \"estoque_reserva\": 0,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:21:02-03:00\",\n \"estoque_disponivel\": 135,\n \"preco_venda\": 1.25\n },\n {\n \"id\": 2,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 2,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.45,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 4,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:14:12-03:00\",\n \"estoque_disponivel\": 145,\n \"preco_venda\": 1.45\n },\n {\n \"id\": 3,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 3,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 5,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:14:20-03:00\",\n \"estoque_disponivel\": 144,\n \"preco_venda\": 1.09\n },\n {\n \"id\": 4,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 4,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.09,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 6,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:23:48-03:00\",\n \"estoque_disponivel\": 143,\n \"preco_venda\": 1.09\n },\n {\n \"id\": 5,\n \"centro_distribuicao_id\": 1,\n \"produto_id\": 5,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 1.35,\n \"maximo_cliente\": 0,\n \"estoque\": 150,\n \"estoque_seguranca\": 4,\n \"estoque_reserva\": 1,\n \"desativado\": true,\n \"bloqueado\": false,\n \"created\": \"2020-03-22T20:45:07-03:00\",\n \"modified\": \"2020-10-09T08:26:38-03:00\",\n \"estoque_disponivel\": 145,\n \"preco_venda\": 1.35\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 50,\n \"limit\": null\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite consultar o estoque e preço de um produto.
\nURL Sandbox:
\n\nPara consultar o estoque e preço de um produto é necessário enviar uma requisição GET informando o ID do produto e ID do estoque e preço da oferta na URL.
{\n \"success\": true,\n \"data\": {\n \"id\": 69592,\n \"centro_distribuicao_id\": 2,\n \"produto_id\": 830,\n \"produto_parent_id\": null,\n \"enderecamento_id\": null,\n \"localizacao\": null,\n \"percentual_ajuste\": 0,\n \"preco_base\": 5.39,\n \"maximo_cliente\": 0,\n \"estoque\": 600,\n \"estoque_seguranca\": 0,\n \"estoque_reserva\": 3,\n \"desativado\": false,\n \"bloqueado\": false,\n \"created\": \"2020-05-04T01:42:28-03:00\",\n \"modified\": \"2022-11-23T15:25:24-03:00\",\n \"estoque_disponivel\": 597,\n \"preco_venda\": 2.7\n }\n}\n\nSerá possível a partir dessa versão, a utilização de múltiplos Centros de Distribuição (CD) no sistema. Cada CD funciona como uma unidade logística independente (operando no mesmo Back-Office), onde cada Centro poderá ter funcionários, compras, tipos de entrega, produtos, estoques e preços e diferentes.
\nContudo, inicialmente as campanhas de vendas e meios de comunicação (como ofertas, banners, descontos, notificações, newsletter, etc), serão únicas, sendo válidas em todos os Centros de Distribuição simultaneamente.
\nCom a alteração, todos os ambientes passarão a ter automaticamente um Centro de Distribuição.
\n","event":[{"listen":"prerequest","script":{"id":"afbaeed9-030a-482b-8783-9dc2996e41eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c6ef06f9-fcec-4838-ba3a-c73c2ca9e881","type":"text/javascript","exec":[""]}}],"_postman_id":"b804218b-d94b-4c9f-a4ea-2959a2a6f282"},{"name":"Volume","item":[{"name":"Adicionar volume","id":"4e40a84b-bab2-4b1d-a7f5-96c8299660ef","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"codigo","value":"84985908533","description":"Exemplo de código do volume
\n","type":"text"},{"key":"quantidade","value":"12","description":"Exemplo de quantidade do volume
\n","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/volumes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um volume.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/volumes
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto
\nAtenção no parametro: \"código de volume\" deverá ser enviado um valor númerico positivo, contendo um mínímo de 7 (sete) digitos.
\nPara cadastrar um volume é necessário enviar uma requisição POST, informando na URL o ID do produto ao qual o volume será vinculado. No corpo body da requisição será necessario informar o código e a quantidade do volume.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo | \nCódigo do volume. Atenção deverá ser informado um valor númerico positivo, sem utilização de casas decimais, conforme o exemplo: 41231413121 | \n Sim | \n
| quantidade | \nQuantidade do volume. | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo produto_id com a mensagem \"Este valor não existe\", quando o ID do produto informado na URL não for encontrado, conforme o exemplo abaixo.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos/4367/volumes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { produto_id: 'Este valor não existe' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo codigo com a mensagem \"Esse valor já está em uso\", quando o código do volume informado no body da requisição já estiver cadastrado, conforme o exemplo abaixo.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos/4367/volumes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { codigo: 'Esse valor já está em uso' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo codigo com a mensagem \"Este campo não pode ser deixado vazio\", quando o código do volume não for informado, conforme o exemplo abaixo.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos/4367/volumes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { codigo: 'Este campo não pode ser deixado vazio' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"codigo","value":"87981906743","description":"Exemplo de código do volume
\n","type":"text"},{"key":"quantidade","value":"13","description":"Exemplo de quantidade do volume
\n","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/volumes/{{ID_VOLUME}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um volume.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/volumes/ID_VOLUME
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto
\nPara editar um volume é necessário enviar uma requisição PUT, informando na URL o ID do produto e ID do volume ao qual o novo volume será vinculado. No corpo body da requisição será necessario informar o código e a quantidade do volume.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo | \nCódigo do volume. | \nSim | \n
| quantidade | \nQuantidade do volume. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: []\n}\nSerá retornado o código de status 404 Not found com a mensagem \"Not found\", quando o ID do produto e/ou ID do volume informados na URL não forem encontrado(s), conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/23/volumes/70',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/volumes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar todos os volumes vinculados a um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/volumes/?codigo=12345678
\nOs parametros permitidos são
\nExemplos:
\n\n\nBusca por id:
\n{{URL}}/importacao/produtos/ID_PRODUTO/volumes/?id=123Busca por código:
\n{{URL}}/importacao/produtos/ID_PRODUTO/volumes/?codigo=1234567
Para listar os volumes vinculados a um produto é necessário enviar uma requisição GET , sendo necessário informar o ID do produto como paramêtro na URL.
Atenção ao informar apenas o ID do produto na URL será retornado todos os volumes vinculados ao produto.
\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 5,\n codigo: '14985908533',\n quantidade: 6,\n created: '2019-03-27T12:17:21-03:00',\n modified: '2019-03-27T12:22:27-03:00' },\n { id: 6,\n codigo: '14985808533',\n quantidade: 6,\n created: '2019-03-28T15:21:12-03:00',\n modified: '2019-03-28T15:29:03-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 2,\n limit: null } \n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/volumes","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite listar todos os volumes cadastrados.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/volumes
\nOs parametros permitidos são
\nExemplos:
\n\n\nBusca por id:
\n{{URL}}/importacao/volumes?id=123
Para listar os volumes é necessário enviar uma requisição GET .
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"codigo\": \"7251747239930\",\n \"quantidade\": 2,\n \"produto_id\": 1,\n \"created\": \"2020-10-07T15:52:42-03:00\",\n \"modified\": \"2020-10-07T15:52:42-03:00\"\n },\n {\n \"id\": 2,\n \"codigo\": \"123445667\",\n \"quantidade\": 3,\n \"produto_id\": 1,\n \"created\": \"2020-10-15T08:32:55-03:00\",\n \"modified\": \"2020-10-15T08:32:55-03:00\"\n },\n {\n \"id\": 7,\n \"codigo\": \"199999999\",\n \"quantidade\": 22,\n \"produto_id\": 1,\n \"created\": \"2020-10-27T12:07:33-03:00\",\n \"modified\": \"2020-10-27T12:08:08-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 7,\n \"limit\": null\n }\n}\n\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/volumes/{{ID_VOLUME}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um volume.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/volumes/ID_VOLUME
\nPara consultar um volume é necessário enviar uma requisição GET, sendo necessário informar o ID do produto e o ID do volume na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: {\n id: 6,\n codigo: '14985808533',\n quantidade: 6,\n created: '2019-03-28T15:21:12-03:00',\n modified: '2019-03-28T15:29:03-03:00' } \n}\nSerá retornado o código de status 404 Not Found quando o ID do produto ou ID do volume informado na URL for inexistente ou ID do volume não estiver vinculado ao ID do produto, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/100/volumes/6',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/volumes/{{ID_VOLUME}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um volume.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/volumes/ID_VOLUME
\nPara excluir um volume é necessário enviar uma requisição DELETE, informando o ID do produto e o ID do volume na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do produto e/ou ID do volume informado na URL for inexistente ou ID do volume não for vinculado ao ID do produto, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/100/volumes/2',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento do cadastro de volumes de produtos específicos.
\nUm volume pode ser uma embalagem diferente na qual pode conter unidades diferentes de um produto.
\nO cadastro de volumes visa facilitar o processo de separação e controle de estoque.
\n","event":[{"listen":"prerequest","script":{"id":"f5c748bf-be52-4bfd-ad54-d143726bdc37","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4fe6c9b3-913b-437e-8ed5-1ee0b85c9374","type":"text/javascript","exec":[""]}}],"_postman_id":"6b443918-2ec7-49ac-9598-2ca557b8a583"},{"name":"Tabela-Nutricional","item":[{"name":"Adicionar tabela","id":"187766be-63ef-425f-bd9f-f13b2b3cc734","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"porcao","value":"15","type":"text"},{"key":"unidade","value":"UN","type":"text"},{"key":"valor_calorico","value":"0.00","type":"text"},{"key":"valor_calorico_porcentagem","value":"0.00","type":"text"},{"key":"carboidratos","value":"0.00","type":"text"},{"key":"carboidratos_porcentagem","value":"0.00","type":"text"},{"key":"proteinas","value":"0.00","type":"text"},{"key":"proteinas_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_totais","value":"0.00","type":"text"},{"key":"gorduras_totais_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_saturadas","value":"0.00","type":"text"},{"key":"gorduras_saturadas_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_trans","value":"0.00","type":"text"},{"key":"gorduras_trans_porcentagem","value":"0.00","type":"text"},{"key":"colesterol","value":"0.00","type":"text"},{"key":"colesterol_porcentagem","value":"0.00","type":"text"},{"key":"fibra_alimentar","value":"0.00","type":"text"},{"key":"fibra_alimentar_porcentagem","value":"0.00","type":"text"},{"key":"calcio","value":"0.00","type":"text"},{"key":"calcio_porcentagem","value":"0.00","type":"text"},{"key":"ferro","value":"0.00","type":"text"},{"key":"ferro_porcentagem","value":"0.00","type":"text"},{"key":"sodio","value":"0.00","type":"text"},{"key":"sodio_porcentagem","value":"0.00","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/tabela-nutricionais","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite adicionar uma tabela nutricional a um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/tabela-nutricionais
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto.
\nAtenção deverá ser informado um valor decimal, conforme o exemplo: 1.500
Para adicionar uma tabela nutricional a um produto é necessário enviar uma requisição POST, informando na URL o ID do produto . No corpo body da requisição será necessário informar os campos conforme a tabela abaixo (ver tabela).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| porcao | \nPorção do produto. | \nNão | \n
| unidade | \nUnidade do produto. Opções aceitas em maiúsculo ou minúsculo Opções aceitas:
| \n Sim | \n
| valor_calorico | \nValor calorico do produto. | \nNão | \n
| valor_calorico_porcentagem | \nPorcentagem do valor calorico. | \nNão | \n
| carboidratos | \nCarboidratos do produto. | \nNão | \n
| carboidratos_porcentagem | \nPorcentagem de carboidratos. | \nNão | \n
| proteinas | \nProteinas do produto. | \nNão | \n
| proteinas_porcentagem | \nPorcentagem de proteinas. | \nNão | \n
| gorduras_totais | \nGorduras totais do produtos. | \nNão | \n
| gorduras_totais_porcentagem | \nPorcentagem de gorduras totais. | \nNão | \n
| gorduras_saturadas | \nGorduras saturadas do produto. | \nNão | \n
| gorduras_saturadas_porcentagem | \nPorcentagem de gorduras saturadas. | \nNão | \n
| gorduras_trans | \nGorduras trans do produto. | \nNão | \n
| gorduras_trans_porcentagem | \nPorcetagem de gorduras trans do produto. | \nNão | \n
| colesterol | \nColesterol do produto. | \nNão | \n
| colesterol_porcentagem | \nPorcentagem do colesterol. | \nNão | \n
| fibra_alimentar | \nFibra alimentar do produto. | \nNão | \n
| fibra_alimentar_porcentagem | \nPorcentagem de fibra alimentar. | \nNão | \n
| calcio | \nCalcio do produto. | \nNão | \n
| calcio_porcentagem | \nPorcentagem de calcio do produto. | \nNão | \n
| ferro | \nFerro do produto. | \nNão | \n
| ferro_porcentagem | \nPorcentagem de ferro do produto. | \nNão | \n
| sodio | \nSodio do produto. | \nNão | \n
| sodio_porcentagem | \nPorcentagem de sodio. | \nNão | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 227 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo produto_id com a mensagem \"Este valor não existe\", quando o ID do produto informado na URL não for encontrado, conforme o exemplo abaixo.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/produtos/4367/volumes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { produto_id: 'Este valor não existe' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"porcao","value":"15","type":"text"},{"key":"unidade","value":"UN","type":"text"},{"key":"valor_calorico","value":"0.00","type":"text"},{"key":"valor_calorico_porcentagem","value":"0.00","type":"text"},{"key":"carboidratos","value":"0.00","type":"text"},{"key":"carboidratos_porcentagem","value":"0.00","type":"text"},{"key":"proteinas","value":"0.00","type":"text"},{"key":"proteinas_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_totais","value":"0.00","type":"text"},{"key":"gorduras_totais_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_saturadas","value":"0.00","type":"text"},{"key":"gorduras_saturadas_porcentagem","value":"0.00","type":"text"},{"key":"gorduras_trans","value":"0.00","type":"text"},{"key":"gorduras_trans_porcentagem","value":"0.00","type":"text"},{"key":"colesterol","value":"0.00","type":"text"},{"key":"colesterol_porcentagem","value":"0.00","type":"text"},{"key":"fibra_alimentar","value":"0.00","type":"text"},{"key":"fibra_alimentar_porcentagem","value":"0.00","type":"text"},{"key":"calcio","value":"0.00","type":"text"},{"key":"calcio_porcentagem","value":"0.00","type":"text"},{"key":"ferro","value":"0.00","type":"text"},{"key":"ferro_porcentagem","value":"0.00","type":"text"},{"key":"sodio","value":"0.00","type":"text"},{"key":"sodio_porcentagem","value":"0.00","type":"text"}]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/tabela-nutricionais/{{ID_TABELA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar uma tabela nutricional vinculada a um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/tabela-nutricionais/ID_TABELA
\nAtenção o ID informado na URL pode conter o ID do produto ou SKU do produto.
\nAtenção deverá ser informado um valor decimal, conforme o exemplo: 1.500
Para editar uma tabela nutricional vinculada a um produto é necessário enviar uma requisição PUT, informando na URL o ID do produto e o ID da tabela . No corpo body da requisição será necessário informar os campos conforme a tabela abaixo (ver tabela).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| porcao | \nPorção do produto. | \nNão | \n
| unidade | \nUnidade do produto. Opções aceitas em maiúsculo ou minúsculo Opções aceitas:
| \n Sim | \n
| valor_calorico | \nValor calorico do produto. | \nNão | \n
| valor_calorico_porcentagem | \nPorcentagem do valor calorico. | \nNão | \n
| carboidratos | \nCarboidratos do produto. | \nNão | \n
| carboidratos_porcentagem | \nPorcentagem de carboidratos. | \nNão | \n
| proteinas | \nProteinas do produto. | \nNão | \n
| proteinas_porcentagem | \nPorcentagem de proteinas. | \nNão | \n
| gorduras_totais | \nGorduras totais do produtos. | \nNão | \n
| gorduras_totais_porcentagem | \nPorcentagem de gorduras totais. | \nNão | \n
| gorduras_saturadas | \nGorduras saturadas do produto. | \nNão | \n
| gorduras_saturadas_porcentagem | \nPorcentagem de gorduras saturadas. | \nNão | \n
| gorduras_trans | \nGorduras trans do produto. | \nNão | \n
| gorduras_trans_porcentagem | \nPorcetagem de gorduras trans do produto. | \nNão | \n
| colesterol | \nColesterol do produto. | \nNão | \n
| colesterol_porcentagem | \nPorcentagem do colesterol. | \nNão | \n
| fibra_alimentar | \nFibra alimentar do produto. | \nNão | \n
| fibra_alimentar_porcentagem | \nPorcentagem de fibra alimentar. | \nNão | \n
| calcio | \nCalcio do produto. | \nNão | \n
| calcio_porcentagem | \nPorcentagem de calcio do produto. | \nNão | \n
| ferro | \nFerro do produto. | \nNão | \n
| ferro_porcentagem | \nPorcentagem de ferro do produto. | \nNão | \n
| sodio | \nSodio do produto. | \nNão | \n
| sodio_porcentagem | \nPorcentagem de sodio. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/tabela-nutricionais","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar a tabela nutricional vinculada a um produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/tabela-nutricionais
\nPara listar a tabela nutricional vinculada a um produto é necessário enviar uma requisição GET, sendo necessário informar o ID do produto na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ {\n id: 2,\n porcao: 15,\n unidade: 'G',\n valor_calorico: 0,\n valor_calorico_porcentagem: 0,\n carboidratos: 0,\n carboidratos_porcentagem: 0,\n proteinas: 0,\n proteinas_porcentagem: 0,\n gorduras_totais: 0,\n gorduras_totais_porcentagem: 0,\n gorduras_saturadas: 0,\n gorduras_saturadas_porcentagem: 0,\n gorduras_trans: 0,\n gorduras_trans_porcentagem: 0,\n colesterol: 0,\n colesterol_porcentagem: 0,\n fibra_alimentar: 0,\n fibra_alimentar_porcentagem: 0,\n calcio: 0,\n calcio_porcentagem: 0,\n ferro: 0,\n ferro_porcentagem: 0,\n sodio: 10,\n sodio_porcentagem: 0,\n created: '2019-04-05T15:13:13-03:00',\n modified: '2019-04-05T15:45:38-03:00' } ],\n pagination: { \n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/tabela-nutricionais/?id=7","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite buscar uma tabela nutricional vinculada a um produto através do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/tabela-nutricionais/?id=7
\nPara buscar uma tabela nutricional é necessário enviar uma requisição GET, informando o ID do produto e o ID da tabela na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 7,\n porcao: null,\n unidade: 'UN',\n valor_calorico: null,\n valor_calorico_porcentagem: null,\n carboidratos: null,\n carboidratos_porcentagem: null,\n proteinas: null,\n proteinas_porcentagem: null,\n gorduras_totais: null,\n gorduras_totais_porcentagem: null,\n gorduras_saturadas: null,\n gorduras_saturadas_porcentagem: null,\n gorduras_trans: null,\n gorduras_trans_porcentagem: null,\n colesterol: null,\n colesterol_porcentagem: null,\n fibra_alimentar: null,\n fibra_alimentar_porcentagem: null,\n calcio: null,\n calcio_porcentagem: null,\n ferro: null,\n ferro_porcentagem: null,\n sodio: null,\n sodio_porcentagem: null,\n created: '2019-04-29T17:02:00-03:00',\n modified: '2019-04-29T17:04:42-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 3,\n limit: null } }\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/produtos/{{ID_PRODUTO}}/tabela-nutricionais/{{ID_TABELA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma tabela nutricional.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/ID_PRODUTO/tabela-nutricionais/ID_TABELA
\nPara excluir uma tabela nutricional é necessário enviar uma requisição DELETE, informando o ID do produto e o ID da tabela nutricional na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do produto ou o ID da tabela nutricional não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/produtos/31246/tabela-nutricionais/31246',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento do cadastro de tabela nutricional de um produto específico.
\n","event":[{"listen":"prerequest","script":{"id":"905a5f59-f39c-4304-a824-fc3f488351ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"90a9bbb4-162b-4c01-b294-de48e4eaf6f7","type":"text/javascript","exec":[""]}}],"_postman_id":"d30ce266-19c6-4cb3-8de6-c811b6891d52"},{"name":"Marca","item":[{"name":"Adicionar marca","id":"ee06155c-5dd3-4f79-a25b-e4c75affab42","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"Marca 01","type":"text"}]},"url":"{{URL}}/importacao/marcas","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar uma marca.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas
\nPara cadastrar uma marca é necessário enviar uma requisição POST. No corpo body da requisição será necessario informar a descrição da marca.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome da marca. | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando a descrição da marca não for informado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/marcas',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Este campo é obrigatório' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"descricao","value":"Marca 01","description":"Exemplo de descrição da marca
\n","type":"text"}]},"url":"{{URL}}/importacao/marcas/{{ID_MARCA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar uma marca.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas/ID_MARCA
\nPara editar uma marca é necessário enviar uma requisição PUT. No corpo body da requisição será necessario informar a descrição da marca.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome da marca. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID da marca informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/marcas/3124123',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/marcas","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar todas as marcas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas
\nPara listar todas as marcas é necessário enviar uma requisição GET, não sendo necessário informar nenhum parametro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ success: true,\n data:\n [ { id: 1,\n slug: 'dove',\n descricao: 'Dove',\n created: '2019-04-01T10:27:26-03:00',\n modified: '2019-04-03T17:22:49-03:00' },\n { id: 2,\n slug: 'lacta',\n descricao: 'Lacta',\n created: '2019-04-03T15:45:08-03:00',\n modified: '2019-04-03T17:23:22-03:00' },\n { id: 3,\n slug: 'aymore',\n descricao: 'Aymoré',\n created: '2019-04-03T16:08:41-03:00',\n modified: '2019-04-03T17:23:34-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 3,\n limit: null } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/marcas/?q=marca","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite buscar uma marca através da descrição.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas/?q=marca
\nPara buscar uma marca é necessário enviar uma requisição GET, informando a descrição da marca na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 6,\n slug: 'marca-teste-201',\n descricao: 'marca teste 201',\n created: '2019-04-03T18:00:47-03:00',\n modified: '2019-04-03T18:00:47-03:00' },\n { id: 8,\n slug: 'marca-teste-312',\n descricao: 'marca teste 312',\n created: '2019-04-05T18:07:37-03:00',\n modified: '2019-04-05T18:07:37-03:00' },\n { id: 9,\n slug: 'marca-01',\n descricao: 'Marca 01',\n created: '2019-04-24T12:08:17-03:00',\n modified: '2019-04-24T12:08:17-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 3,\n limit: null } }\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nExemplo de marca
\n","type":"text/plain"},"key":"q","value":"marca"}],"variable":[]}},"response":[{"id":"98d3452a-d660-4fe9-aa06-0399a347fe20","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado"},{"key":"Authorization","value":"Basic aGV2ZXJ0b25jb3JyzWFAdmlwY29tbWVyY2UuY29tLmJyOmRmMDcyZjg1ZGY5YmY3ZGQ3MWI2ODEx\nYzM0YmRiYWo0ZjIaOuQ5ODc3NWI1NmNmZjlkZmE1ZjhjYTFiZjg0Njk=","description":"Token de acesso - base64 do username e password"},{"key":"DomainKey","value":"vipcommerce.com.br","description":"Identificador do dominio"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}/importacao/marcas/?q=marca","host":["{{URL}}"],"path":["importacao","marcas",""],"query":[{"key":"q","value":"marca","description":"Exemplo de marca"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"Authorization,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,App-Version,DomainKey","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=UTF-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 29 Apr 2019 18:01:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"data\":[{\"id\":3,\"slug\":\"aymore\",\"descricao\":\"Aymor\\u00e9\",\"created\":\"2019-04-03T16:08:41-03:00\",\"modified\":\"2019-04-03T17:23:34-03:00\"}],\"pagination\":{\"page_count\":1,\"current_page\":1,\"has_next_page\":false,\"has_prev_page\":false,\"count\":1,\"limit\":null}}"}],"_postman_id":"8f7ba53e-8d9c-4bbe-b15e-896d5134cdcc"},{"name":"Consultar marca","id":"5c1bb0d6-dc86-4022-83b1-9d725bce5a80","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/marcas/{{ID_MARCA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma marca.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas/ID_MARCA
\nPara consultar uma marca é necessário enviar uma requisição GET, sendo necessário informar o ID da marca na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: {\n id: 1,\n slug: 'dove',\n descricao: 'Dove',\n created: '2019-04-01T10:27:26-03:00',\n modified: '2019-04-03T17:22:49-03:00' } \n}\nSerá retornado o código de status 404 Not Found quando o ID da marca informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/marcas/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/marcas/{{ID_MARCA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma marca.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/marcas/ID_MARCA
\nPara excluir uma marca é necessário enviar uma requisição DELETE, informando o ID da marca na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID da marca informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/marcas/31212',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento do cadastro de marcas de produtos.
\nAtualmente, a associação de marcas possui o objetivo de agrupar produtos para realização de buscas avançadas na loja.
\n","event":[{"listen":"prerequest","script":{"id":"362bca6c-84c6-4a71-a67d-c89e881b7ed1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"877ebf7e-fa65-4d42-800c-0c2932bdc201","type":"text/javascript","exec":[""]}}],"_postman_id":"4ecefc93-0795-4e59-8196-8fc65a64b672"},{"name":"Enderecamento","item":[{"name":"Modulo","item":[{"name":"Adicionar modulo","id":"05e7d47f-dc61-435a-9b30-8c9148f9e102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"05","description":"Descricao do modulo
\n","type":"text"},{"key":"centro_distribuicao_id","value":"1","description":"ID do centro de distribuicao
\n","type":"text"}]},"url":"{{URL}}/importacao/modulos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o cadastro de modulo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos
\nPara realizar o cadastro de um modulo é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do modulo | \nSim | \n
| centro_distribuicao_id | \nID do centro de distribuição. | \nSim | \n
{\n \"success\": true,\n \"data\": {\n \"id\": 9\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity será retornado o campo \"descrição\" com a mensagem \"Já existe um módulo com esta descrição\", quando o modulo informado já estiver cadastrado para o ID do centro de distribuição enviado no body da requisição, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Já existe um módulo com esta descrição\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo: \"centro_distribuicao_id\", com a mensagem: \"É necessário informar o ID ou CNPJ do centro de distribuição\" quando o centro_distribuicao_id não for informado no body da requisição, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"centro_distribuicao_id\": \"É necessário informar o ID ou CNPJ do centro de distribuição\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo: \"centro_distribuicao_id\", com a mensagem: \"Este valor não existe\" quando o centro_distribuicao_id não for encontrado, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"centro_distribuicao_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo: \"descricao\", com a mensagem: \"Este campo é obrigatório\" quando a descrição do modulo não for informado, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Este campo é obrigatório\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite atualizar um modulo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO
\nPara editar as informações de um modulo é necessário enviar uma requisição PUT, informando os dados a serem editados no body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do modulo | \nNão | \n
| centro_distribuicao_id | \nID do centro de distribuição. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity será retornado o campo \"descrição\" com a mensagem \"Já existe um módulo com esta descrição\", quando o modulo informado já estiver cadastrado para o ID do centro de distribuição enviado no body da requisição, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos/9\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Já existe um módulo com esta descrição\"\n }\n }\n}\nSerá retornado o código de status 404 Not found quando o ID do modulo informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar informações um modulo através do ID do modulo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO
\nPara consultar informações de um modulo é necessário enviar uma requisição GET informando o ID do modulo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 3,\n \"centro_distribuicao_id\": 1,\n \"level\": 0,\n \"descricao\": \"0001\",\n \"created\": \"2017-10-10T10:45:07-03:00\",\n \"modified\": \"2020-06-05T17:53:40-03:00\",\n \"localizacao\": \"0001\",\n \"classificacao\": \"Modulo\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/100\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de itens por página, clique aqui
\nPermite listas modulos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por centro_distruibição_id:
\n{{URL}}/importacao/modulos/?centro_distruibição_id=1Busca por descricao:
\n{{URL}}/importacao/modulos/?descricao=005
Para listar modulos é necessário enviar uma requisição GET, quando não informado um parametro na URL todos os registro serão retornados.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 3,\n \"centro_distribuicao_id\": 1,\n \"level\": 0,\n \"descricao\": \"0001\",\n \"created\": \"2017-10-10T10:45:07-03:00\",\n \"modified\": \"2020-06-05T17:53:40-03:00\",\n \"localizacao\": \"0001\",\n \"classificacao\": \"Modulo\"\n },\n {\n \"id\": 5,\n \"centro_distribuicao_id\": 2,\n \"level\": 0,\n \"descricao\": \"0002\",\n \"created\": \"2018-10-15T09:20:37-03:00\",\n \"modified\": \"2020-06-05T18:04:15-03:00\",\n \"localizacao\": \"0002\",\n \"classificacao\": \"Modulo\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um modulo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO
\nPara excluir um modulo é necessário enviar uma requisição DELETE informando o ID do modulo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/100\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o cadastro de ruas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas
\nPara realizar o cadastro de uma rua é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da rua. | \nSim | \n
{\n \"success\": true,\n \"data\": {\n \"id\": 9\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity será retornado o campo \"descrição\" com a mensagem \"Já existe uma rua com esta descrição\", quando a rua já estiver cadastrada ao ID do modulo informado na URL, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos/9/ruas\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Já existe uma rua com esta descrição\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite atualizar uma rua.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA
\nPara editar as informações de uma rua é necessário enviar uma requisição PUT, informando os dados a serem editados no body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da rua | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar informações uma rua.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA
\nPara consultar informações de uma rua é necessário enviar uma requisição GET informando o ID do modulo e ID da rua na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"centro_distribuicao_id\": null,\n \"level\": 1,\n \"descricao\": \"0001\",\n \"created\": \"2020-06-06T12:15:03-03:00\",\n \"modified\": \"2020-06-06T12:15:03-03:00\",\n \"modulo_id\": 9,\n \"localizacao\": \"0006-0001\",\n \"classificacao\": \"Rua\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua informado na URL for inexistente ou ID do modulo não esta vinculado ao ID da rua, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/9/ruas/10\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de itens por página, clique aqui
\nPermite listas ruas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por q:
\n{{URL}}/importacao/modulos/ID_MODULO/ruas/?q=numero
Para listar ruas é necessário enviar uma requisição GET, quando não informado um parametro na URL todos os registro serão retornados.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"centro_distribuicao_id\": null,\n \"level\": 1,\n \"descricao\": \"0001-0001\",\n \"created\": \"2017-10-10T10:45:07-03:00\",\n \"modified\": \"2017-12-18T09:10:01-03:00\",\n \"modulo_id\": 1,\n \"localizacao\": \"0001-0001-0001\",\n \"classificacao\": \"Rua\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma rua.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA
\nPara excluir uma rua é necessário enviar uma requisição DELETE informando o ID do modulo e ID da rua na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua informado na URL for inexistente ou ID do modulo não esta vinculado ao ID da rua, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/100/ruas/150\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o cadastro de números.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros
\nPara realizar o cadastro de um número é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da número. | \nSim | \n
{\n \"success\": true,\n \"data\": {\n \"id\": 9\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity será retornado o campo \"descrição\" com a mensagem \"Já existe um número com esta descrição\", quando a número já estiver cadastrado ao ID do modulo e ID da rua informados na URL, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos/9/ruas/10/numeros\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Já existe um número com esta descrição\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite atualizar um número.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros/ID_NUMERO
\nPara editar as informações de um número é necessário enviar uma requisição PUT, informando os dados a serem editados no body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do número | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar informações de um número.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros/ID_NUMERO
\nPara consultar informações de um número é necessário enviar uma requisição GET informando o ID do modulo, ID da rua e ID da número na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 11,\n \"centro_distribuicao_id\": null,\n \"level\": 2,\n \"descricao\": \"0012\",\n \"created\": \"2020-06-06T12:49:55-03:00\",\n \"modified\": \"2020-06-06T12:49:55-03:00\",\n \"rua_id\": 10,\n \"localizacao\": \"0006-0001-0012\",\n \"classificacao\": \"Numero\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua ou ID do número informado na URL forem inexistente ou ID do modulo não esta vinculado ao ID da rua ou ID do número, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/9/ruas/10\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de itens por página, clique aqui
\nPermite listas números.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros/?q=numero
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por q:
\n{{URL}}/modulos/ID_MODULO/ruas/ID_RUA/numeros/?q=numero
Para listar números é necessário enviar uma requisição GET, quando não informado um parametro na URL todos os registro serão retornados.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 11,\n \"centro_distribuicao_id\": null,\n \"level\": 2,\n \"descricao\": \"0012\",\n \"created\": \"2020-06-06T12:49:55-03:00\",\n \"modified\": \"2020-06-06T12:49:55-03:00\",\n \"rua_id\": 10,\n \"localizacao\": \"0006-0001-0012\",\n \"classificacao\": \"Numero\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um número.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros/ID_NUMERO
\nPara excluir um número é necessário enviar uma requisição DELETE informando o ID do modulo, ID da rua e ID do número na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua informado na URL for inexistente ou ID do modulo,rua não estão estiverem vinculados ao ID do número, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/100/ruas/150\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o cadastro de apartamento.
\n\nPara realizar o cadastro de um apartamento é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição da apartamento. | \nSim | \n
{\n \"success\": true,\n \"data\": {\n \"id\": 9\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity será retornado o campo \"descrição\" com a mensagem \"Já existe um apartamento com esta descrição\", quando a apartamento já estiver cadastrado ao ID do modulo, rua e número informados na URL, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/modulos/9/ruas/10/numeros/1/apartamentos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Já existe um apartamento com esta descrição\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite atualizar um apartamento.
\n\nPara editar as informações de um apartamento é necessário enviar uma requisição PUT, informando os dados a serem editados no body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do apartamento | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar informações de um apartamento.
\n\nPara consultar informações de um apartamento é necessário enviar uma requisição GET informando o ID do modulo, ID da rua, ID da número e ID do apartamento na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 11,\n \"centro_distribuicao_id\": 1,\n \"level\": 3,\n \"descricao\": \"0012\",\n \"created\": \"2020-06-06T12:49:55-03:00\",\n \"modified\": \"2020-06-06T12:49:55-03:00\",\n \"numero_id\": 10,\n \"localizacao\": \"0006-0001-0012-005\",\n \"classificacao\": \"Apartamento\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua, ID do número ou ID do apartamento informado na URL forem inexistente ou ID do modulo não esta vinculado ao ID da rua, número ou apartamento, abaixo é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/9/ruas/10/apartamentos/150\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de itens por página, clique aqui
\nPermite listas apartamentos.
\n\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por q:
\n{{URL}}/importacao/modulos/ID_MODULO/ruas/ID_RUA/numeros/ID_NUMERO/apartamentos/?q=numero
Para listar apartamentos é necessário enviar uma requisição GET, quando não informado um parametro na URL todos os registro serão retornados.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [ {\n \"id\": 11,\n \"centro_distribuicao_id\": 1,\n \"level\": 3,\n \"descricao\": \"0012\",\n \"created\": \"2020-06-06T12:49:55-03:00\",\n \"modified\": \"2020-06-06T12:49:55-03:00\",\n \"numero_id\": 10,\n \"localizacao\": \"0006-0001-0012-005\",\n \"classificacao\": \"Apartamento\"\n }],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um apartamento.
\n\nPara excluir um apartamento é necessário enviar uma requisição DELETE informando o ID do modulo, ID da rua e ID do apartamento na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do modulo, ID da rua informado na URL for inexistente ou ID do modulo, rua ou número não estiverem vinculados ao ID do apartamento conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/modulos/100/ruas/150\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nA API de Produtos permite que sistemas externos ao VIP Commerce gerenciem os produtos e sua respectiva hierarquia no sistema.
\nÉ possível trabalhar com os seguintes CRUDs via API:\n
Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"dias","value":"10","description":"Exemplo de quantidade de dias
\n","type":"text"},{"key":"tipo","value":"F","description":"Exemplo de tipo de prazo
\n","type":"text"}]},"url":"{{URL}}/importacao/prazos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um prazo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/prazos
\nPara adicionar um prazo é necessário enviar uma requisição POST. No corpo body da requisição será necessario informar a quantidade de dias e o tipo do prazo.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| dias | \nQuantidade de dias do prazo. | \nSim | \n
| tipo | \nTipo do prazo. Opções aceitas:
| \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo dias com a mensagem \"Esse valor já está em uso\" quando a quantidade de dias informada no body da requisição já estiver cadastrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/prazos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"dias\": \"Esse valor já está em uso\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando a quantidade de dias ou o tipo do prazo não for informado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/prazos\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"dias\": \"Este campo é obrigatório\",\n \"tipo\": \"Este campo é obrigatório\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"dias","value":"9","type":"text"},{"key":"tipo","value":"F","type":"text"}]},"url":"{{URL}}/importacao/prazos/{{ID_PRAZO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um prazo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/prazos/ID_PRAZO
\nPara editar um prazo é necessário enviar uma requisição PUT. No corpo body da requisição será necessario informar a quantidade de dias e o tipo do prazo.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| dias | \nQuantidade de dias do prazo. | \nSim | \n
| tipo | \nTipo do prazo. Opções aceitas:
| \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do prazo informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/prazos/500\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/prazos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os prazos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/prazos/?id=5
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por id:
\n{{URL}}/importacao/prazos/?id=1Busca por dias:
\n{{URL}}/importacao/prazos/?dias=5
Para listar os prazos é necessário enviar uma requisição GET .
Atenção ao não informar nenhum parametro será retornado todos os prazos cadastrados.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ { \n id: 1,\n dias: 5,\n tipo: 'F',\n created: '2019-03-21T16:43:00-03:00',\n modified: '2019-03-21T16:43:00-03:00' \n },\n { \n id: 2,\n dias: 10,\n tipo: 'F',\n created: '2019-04-04T17:39:47-03:00',\n modified: '2019-04-04T17:39:47-03:00' \n },\n { \n id: 6,\n dias: 73,\n tipo: 'F',\n created: '2019-04-04T17:57:45-03:00',\n modified: '2019-04-04T17:57:45-03:00' \n },\n {\n id: 7,\n dias: 78,\n tipo: 'F',\n created: '2019-04-05T12:28:09-03:00',\n modified: '2019-04-05T12:28:09-03:00' } ],\n pagination: {\n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 5,\n limit: null } \n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/prazos/{{ID_PRAZO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um prazo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/prazos/ID_PRAZO
\nPara consultar um prazo é necessário enviar uma requisição GET, sendo necessário informar o ID do prazo.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: { \n id: 2,\n dias: 10,\n tipo: 'F',\n created: '2019-04-04T17:39:47-03:00',\n modified: '2019-04-04T17:39:47-03:00' } \n}\nSerá retornado o código de status 404 Not Found quando o ID do prazo informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/prazos/120',\n code: 404,\n exception: { \n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/prazos/{{ID_PRAZO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um prazo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/prazos/ID_PRAZO
\nPara excluir um prazo é necessário enviar uma requisição DELETE, informando o ID do prazo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do prazo informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/prazos/312312',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de dias de prazo de pagamento de boleto.
\n","event":[{"listen":"prerequest","script":{"id":"68f0c9b4-e666-402f-92c0-06d19119064b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"16c4aa7e-5e30-4049-8f2d-786de438e239","type":"text/javascript","exec":[""]}}],"_postman_id":"241c7463-a06c-4cf9-aa8e-8de6bd9eb6ea"},{"name":"Cliente","item":[{"name":"Adicionar cliente","id":"af118ae8-732b-436a-ab13-ffe3d29d59aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"filial_id","value":"1","description":"Filial do cliente
\n","type":"text"},{"key":"tipo_cliente","value":"PF","description":"Tipo de conta do cliente
\n","type":"text"},{"key":"nome","value":"VipCommerce","description":"Nome do cliente
\n","type":"text"},{"key":"sobrenome","value":"Sistemas","description":"Sobrenome do cliente
\n","type":"text"},{"key":"telefone_fixo","value":"3130160000","description":"Telefone fixo. (É necessario informar telefone fixo ou celular)
\n","type":"text"},{"key":"telefone_celular","value":"31996888300","description":"Telefone celular. (É necessario informar telefone fixo ou celular)
\n","type":"text"},{"key":"email","value":"vipcommerce@teste.com","description":"Email do cliente
\n","type":"text"},{"key":"email_confirm","value":"vipcommerce@teste.com","description":"Confirmação do email
\n","type":"text"},{"key":"data_nascimento","value":"18/02/1995","description":"Data de nascimento
\n","type":"text"},{"key":"cpf","value":"68371437005","description":"CPF do cliente
\n","type":"text"},{"key":"cnpj","value":"09124476000109","description":"CNPJ da empresa. Somente pessoa juridica
\n","type":"text"},{"key":"nome_fantasia","value":"VipCommerce Sistemas","description":"Nome fantasia da empresa. Somente pessoa juridica
\n","type":"text"},{"key":"razao_social","value":"Vipcommerce Sistemas","description":"Razão social. Somente pessoa juridica
\n","type":"text"},{"key":"inscricao_estadual","value":"Isento","description":"Inscrição estadual. Somente pessoa juridica
\n","type":"text"},{"key":"comunicacao_sms","value":"true","description":"Define se o cliente aceita receber comunicação por sms
\n","type":"text"},{"key":"comunicacao_email","value":"false","description":"Define se o cliente aceita receber comunicação por email
\n","type":"text"},{"key":"observacoes","value":"Observação de teste","description":"Observação do cliente
\n","type":"text"},{"key":"ip","value":"187.127.19.152","description":"Número IP de cadastro do cliente
\n","type":"text"}]},"url":"{{URL}}/importacao/clientes","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar um cliente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes
\nAtenção por medidas de seguranças a senha é gerada randomicamente, não sendo possível definir. Para que o cliente possa acessar sua conta, será necessário que o mesmo redefina sua senha atráves do \"Esqueci minha senha\" na loja online.
\nPara cadastrar um cliente é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do cliente (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Número identificador da filial à qual a conta do cliente estará vinculada. | Sim |
tipo_cliente | Tipo de cliente. Opções aceitas em maiúsculo ou minúsculo
| Sim |
sexo | Sexo do cliente.
Valor default: N => \"Não informado\" | Não |
nome | Nome do cliente | Sim |
sobrenome | Sobrenome do cliente | Sim |
telefone_fixo | Telefone fixo do cliente. Sem formatação, conforme o exemplo: 3193588000 | Não. É necessário informar telefone fixo ou celular |
telefone_celular | Telefone celular do cliente. Sem formatação, conforme o exemplo: 31993588000 | Não. É necessário informar telefone fixo ou celular |
email | Email do cliente. | Sim |
email_confirm | Confirmação do email. | Sim |
data_nascimento | Data de nascimento. Deverá ser informada no formato: DD-MM-YYYY, dia/mês/ano. Conforme o exemplo: 18/02/1995 | Sim |
cpf | CPF do cliente. Atenção deverá ser informado exatamente o CPF do cliente contendo 11 dígitos, utilizando apenas números. Conforme o exemplo: 10603554638 | Sim |
rg | RG do cliente. | Não |
emissor | Órgão expedidor do RG. | Não |
cnpj | CNPJ da empresa. Atenção deverá ser informado sem pontuação, contendo 14 dígitos. Conforme o exemplo: 23544256000165 | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
nome_fantasia | Nome fantasia da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
razao_social | Razão social da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
inscricao_estadual | Inscrição estadual da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
comunicacao_sms | Define se o cliente aceita receber comunicação por SMS.
| Não. Valor default: false |
comunicacao_email | Define se o cliente aceita receber comunicação por E-mail.
| Não. Valor default: false |
observacoes | Observações da conta do cliente. | Não |
ip | Número IP de cadastro do cliente.Atenção deverá ser enviado o número IP com formatação, conforme o exemplo: 187.127.16.151 | Não |
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem de campo obrigatório quando o campo não for informado no body da requisição, conforme o exemplo abaixo.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: '12 erros de validação ocorridos',\n errorCount: 12,\n errors:\n { tipo_cliente: 'O tipo de cadastro é obrigatório',\n nome: 'O campo nome é obrigatório',\n sobrenome: 'O campo sobrenome é obrigatório',\n data_nascimento: 'O campo data de nascimento é obrigatório',\n rg: 'O campo RG é obrigatório',\n emissor: 'O campo órgão emissor é obrigatório',\n cpf: 'O campo CPF é obrigatório',\n telefone_fixo: 'Favor informar um telefone fixo ou celular para contato',\n email: 'O campo email é obrigatório',\n email_confirm: 'O campo confirmação de e-mail é obrigatório',\n sexo: 'O campo sexo é obrigatório' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo tipo_cliente com a mensagem \"O valor fornecido é inválido\", quando o valor fornecido foi diferente de PF (Pessoa fisíca) ou PJ (Pessoa juridica). As opções aceitas são em minusculo ou maiusculo.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { tipo_cliente: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo data_nascimento com a mensagem \"A faixa da data de nascimento deve ser entre X e X anos\", quando a data fornecida estiver fora da permitida para cadastro. Atenção a faixa permitida é definida no admin (Configurações -> Filiais -> Listagem -> Dados básicos).
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { data_nascimento: 'A faixa da data de nascimento deve ser entre X e X anos' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo email com a mensagem \"Este e-mail já está em uso\", quando o e-mail fornecido já estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { email: 'Este e-mail já está em uso' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo cpf com a mensagem \"O CPF informado já cadastrado\", quando o CPF fornecido já estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cpf: 'O CPF informado já cadastrado' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo cnpj com a mensagem \"Este CNPJ já está em uso\", quando o valor fornecido já estiver cadastrado, conforme o exemplo.
{ success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { \n cnpj: 'Este CNPJ já está em uso' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo cnpj com a mensagem \"O CNPJ informado é inválido\", quando o valor fornecido for invalido. Atenção deverá ser informado sem pontuação, contendo 14 dígitos. Conforme o exemplo: 23544256000165.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cnpj: 'O CNPJ informado é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo sexo com a mensagem \"O valor fornecido é inválido\", quando o valor fornecido foi diferente \"M\" para masculino, \"F\" para feminino ou \"N\" para não informado.Atenção: opção aceita somente em maiúsculo, conforme o exemplo.
{ success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { sexo: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo email com a mensagem \"Esse não parece ser um e-mail válido\", quando o valor fornecido no campo email for invalido.
{ success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n {\n email: 'Esse não parece ser um e-mail válido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo email_confirm com a mensagem \"O e-mail e a confirmação devem ser iguais\", quando o valor fornecido em email_confirm for diferente do valor fornecido em email.
{ \n success: false,\n data:\n { code: 422,\n url: '/importacao/clientes',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { \n email_confirm: 'O e-mail e a confirmação devem ser iguais' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity nos campos telefone_fixo e telefone_celular com a mensagem \"Favor, informar ao menos um telefone\", quando nenhum dos telefones for informado.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/clientes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"telefone_fixo\": \"Favor, informar ao menos um telefone\",\n \"telefone_celular\": \"Favor, informar ao menos um telefone\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity nos campos telefone_fixo e telefone_celular com a mensagem \"Valor não aceito\", quando ambos os campos forem enviados com valores vazios.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/clientes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"telefone_fixo\": \"Valor não aceito\",\n \"telefone_celular\": \"Valor não aceito\"\n }\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"filial_id","value":"1","description":"ID da filial
\n","type":"text"},{"key":"filial_origem_id","value":"1","description":"Filial de origem
\n","type":"text"},{"key":"tipo_cliente","value":"PF","description":"Tipo de cliente
\n","type":"text"},{"key":"nome","value":"VipCommerce","description":"Nome do cliente
\n","type":"text"},{"key":"sobrenome","value":"Sistemas","description":"Sobrenome do cliente
\n","type":"text"},{"key":"telefone_fixo","value":"3130167900","description":"Telefone fixo. (É necessário informar telefone fixo ou celular)
\n","type":"text"},{"key":"telefone_celular","value":"31990808541","description":"Telefone celular. (É necessário informar telefone fixo ou celular)
\n","type":"text"},{"key":"email","value":"vipcommerce@teste.com","description":"Email do cliente
\n","type":"text"},{"key":"email_confirm","value":"vipcommerce@teste.com","description":"Confirmação do email do cliente
\n","type":"text"},{"key":"data_nascimento","value":"18/02/1995","description":"Data de nascimento
\n","type":"text"},{"key":"cpf","value":"33875179633","description":"CPF do cliente
\n","type":"text"},{"key":"comunicacao_sms","value":"true","description":"Define se o cliente deseja receber sms
\n","type":"text"},{"key":"comunicacao_email","value":"true","description":"Define se o cliente deseja receber email
\n","type":"text"},{"key":"bloquear_login","value":"false","description":"Define se o login do cliente será bloqueado
\n","type":"text"},{"key":"observacoes","value":"Observação de teste","description":"Campo para observações do cliente
\n","type":"text"},{"key":"ip","value":"187.127.16.159","description":"Número IP de cadastro do cliente
\n","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite editar um cliente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE
\nAtenção por medidas de seguranças a senha é gerada randomicamente na criação da conta, não sendo possível editar via API. Para que o cliente possa acessar sua conta, será necessário redefinir sua senha atráves do \"Esqueci minha senha\" disponível na loja.
\nPara editar um cliente é necessário enviar uma requisição PUT. No corpo body da requisição será necessário informar os dados do cliente (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Número identificador da filial à qual a conta do cliente estará vinculada. | Não |
tipo_cliente | Tipo de cliente. Opções aceitas em maiúsculo ou minúsculo
| Não |
nome | Nome do cliente | Não |
sobrenome | Sobrenome do cliente | Não |
telefone_fixo | Telefone fixo do cliente. Sem formatação, conforme o exemplo: 3193588000 | Não. É necessário informar telefone fixo ou celular |
telefone_celular | Telefone celular do cliente. Sem formatação, conforme o exemplo: 31993588000 | Não. É necessário informar telefone fixo ou celular |
email | Email do cliente. | Não |
email_confirm | Confirmação do email. | Não |
data_nascimento | Data de nascimento. Deverá ser informada no formato: DD-MM-YYYY, dia/mês/ano. Conforme o exemplo: 18/02/1995 | Não |
sexo | Sexo do cliente.
| Não |
cpf | CPF do cliente. Atenção deverá ser informado exatamente o CPF do cliente contendo 11 dígitos, utilizando apenas números. Conforme o exemplo: 10603554638 | Não |
rg | RG do cliente. | Não |
emissor | Órgão expedidor do RG. | Não |
cnpj | CNPJ da empresa. Atenção deverá ser informado sem pontuação, contendo 14 dígitos. Conforme o exemplo: 23544256000165 | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
nome_fantasia | Nome fantasia da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
razao_social | Razão social da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
inscricao_estadual | Inscrição estadual da empresa. | Sim. Atenção este campo é obrigatório somente em contas de pessoa jurídica |
comunicacao_sms | Define se o cliente aceita receber comunicação por SMS.
| Não. Valor default: false |
comunicacao_email | Define se o cliente aceita receber comunicação por E-mail.
| Não. Valor default: false |
observacoes | Observações da conta do cliente. | Não |
ip | Número IP de cadastro do cliente.Atenção deverá ser enviado o número IP com formatação, conforme o exemplo: 187.127.16.151 | Não |
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n \"success\": true,\n \"data\": []\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/?cpf=10203554698","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de resultados,
\n\nPermite listar clientes cadastrados.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/?email=vipcommerce@tst.com
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por CPF:
\n{{URL}}/importacao/clientes/?cpf=10403554638
Atenção ao não informar nenhum parametro, será retornado todos os clientes cadastrados.
\nPara listar o(s) cliente(s) é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"tipo_cliente\": \"PF\",\n \"nome\": \"Christoper\",\n \"sobrenome\": \"Jahnel\",\n \"telefone_fixo\": \"0437202216\",\n \"telefone_celular\": \"07490400228\",\n \"email\": \"christoper28@tst.com\",\n \"sexo\": \"M\",\n \"data_nascimento\": \"1994-05-20T00:00:00+00:00\",\n \"cpf\": \"04623875857\",\n \"rg\": \"123456\",\n \"emissor\": \"ssp mg\",\n \"nome_fantasia\": \"\",\n \"inscricao_estadual\": \"\",\n \"razao_social\": \"\",\n \"cnpj\": \"\",\n \"comunicacao_sms\": false,\n \"comunicacao_email\": false,\n \"aceite_cookie\": null,\n \"suspeita_fraude\": false,\n \"codigo\": \"CHRISTOPER1\",\n \"informacoes_cashback\": null,\n \"created\": \"2020-06-18T08:21:01-03:00\",\n \"modified\": \"2021-05-28T14:54:00-03:00\",\n \"nome_completo\": \"Christoper Jahnel,m,pf,um\",\n \"maioridade\": true,\n \"perfis\": [1,2],\n \"regioes\": {\n \"1\": \"1\"\n },\n \"compras_finalizadas\": 0,\n \"primeiro_status\": 9,\n \"primeiro_status_pre_pago\": 9,\n \"cpf_formatado\": \"046.238.758-57\",\n \"cnpj_formatado\": \"\",\n \"telefone_celular_formatado\": \"(07) 49040-0228\",\n \"telefone_fixo_formatado\": \"(04) 3720-2216\",\n \"url_codigo\": \"/i/CHRISTOPER1\",\n \"compra_em_processo\": false,\n \"tipo_documento\": \"CPF\",\n \"documento\": \"04623875857\",\n \"termos_uso\": [\n {\n \"id\": 1,\n \"aceite\": \"2020-10-08T15:26:14-03:00\",\n \"vigente\": \"nao\"\n },\n {\n \"id\": 2,\n \"aceite\": \"2022-04-29T14:40:05-03:00\",\n \"vigente\": \"sim\"\n }\n ]\n },\n {\n \"id\": 4,\n \"tipo_cliente\": \"PJ\",\n \"nome\": \"Crantz\",\n \"sobrenome\": \"Elidia\",\n \"telefone_fixo\": \"0215634114\",\n \"telefone_celular\": \"01945597252\",\n \"email\": \"crantz22@tst.com\",\n \"sexo\": \"F\",\n \"data_nascimento\": \"1978-07-15T00:00:00+00:00\",\n \"cpf\": \"53033876749\",\n \"rg\": \"132646\",\n \"emissor\": \"ssp mg\",\n \"nome_fantasia\": \"Elidia-F-PJ-um\",\n \"inscricao_estadual\": \"Isento\",\n \"razao_social\": \"Elidia-F-PJ-um\",\n \"cnpj\": \"24416163713262\",\n \"comunicacao_sms\": false,\n \"comunicacao_email\": false,\n \"aceite_cookie\": null,\n \"suspeita_fraude\": false,\n \"codigo\": \"TESTE4\",\n \"informacoes_cashback\": null,\n \"created\": \"2020-06-19T16:44:18-03:00\",\n \"modified\": \"2020-10-21T10:56:22-03:00\",\n \"nome_completo\": \"Crantz Elidia,F,PJ,um\",\n \"maioridade\": true,\n \"perfis\": [],\n \"regioes\": {\n \"4\": \"1\"\n },\n \"compras_finalizadas\": 0,\n \"primeiro_status\": 9,\n \"primeiro_status_pre_pago\": 9,\n \"cpf_formatado\": \"530.338.767-49\",\n \"cnpj_formatado\": \"24.416.163/7132-62\",\n \"telefone_celular_formatado\": \"(01) 94559-7252\",\n \"telefone_fixo_formatado\": \"(02) 1563-4114\",\n \"url_codigo\": \"/i/TESTE4\",\n \"compra_em_processo\": false,\n \"tipo_documento\": \"CNPJ\",\n \"documento\": \"24416163713262\",\n \"termos_uso\": [\n {\n \"id\": 1,\n \"aceite\": \"2020-10-08T15:26:14-03:00\",\n \"vigente\": \"nao\"\n },\n {\n \"id\": 2,\n \"aceite\": \"2022-04-29T14:40:05-03:00\",\n \"vigente\": \"sim\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"page_count\": 39,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 780,\n \"limit\": null\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite consultar um cliente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE
\nPara consultar um cliente é necessário enviar uma requisição GET, sendo necessário informar o ID do cliente na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:{\n \"id\": 1,\n \"tipo_cliente\": \"PF\",\n \"nome\": \"Christoper\",\n \"sobrenome\": \"Jahnel\",\n \"telefone_fixo\": \"0437202216\",\n \"telefone_celular\": \"07490400228\",\n \"email\": \"christoper28@tst.com\",\n \"sexo\": \"M\",\n \"data_nascimento\": \"1994-05-20T00:00:00+00:00\",\n \"cpf\": \"04623875857\",\n \"rg\": \"123456\",\n \"emissor\": \"ssp mg\",\n \"nome_fantasia\": \"\",\n \"inscricao_estadual\": \"\",\n \"razao_social\": \"\",\n \"cnpj\": \"\",\n \"comunicacao_sms\": false,\n \"comunicacao_email\": false,\n \"aceite_cookie\": null,\n \"suspeita_fraude\": false,\n \"codigo\": \"CHRISTOPER1\",\n \"informacoes_cashback\": null,\n \"created\": \"2020-06-18T08:21:01-03:00\",\n \"modified\": \"2021-05-28T14:54:00-03:00\",\n \"nome_completo\": \"Christoper Jahnel,m,pf,um\",\n \"maioridade\": true,\n \"perfis\": [1,2],\n \"regioes\": {\n \"1\": \"1\"\n },\n \"compras_finalizadas\": 0,\n \"primeiro_status\": 9,\n \"primeiro_status_pre_pago\": 9,\n \"cpf_formatado\": \"046.238.758-57\",\n \"cnpj_formatado\": \"\",\n \"telefone_celular_formatado\": \"(07) 49040-0228\",\n \"telefone_fixo_formatado\": \"(04) 3720-2216\",\n \"url_codigo\": \"/i/CHRISTOPER1\",\n \"compra_em_processo\": false,\n \"tipo_documento\": \"CPF\",\n \"documento\": \"04623875857\",\n \"termos_uso\": [\n {\n \"id\": 1,\n \"aceite\": \"2020-10-08T15:26:14-03:00\",\n \"vigente\": \"nao\"\n },\n {\n \"id\": 2,\n \"aceite\": \"2022-04-29T14:40:05-03:00\",\n \"vigente\": \"sim\"\n }\n ]\n }\n}\n\nSerá retornado o código de status 404 Not Found quando o ID do cliente informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\n\nGerenciamento de cadastro de clientes na loja online.
\nAtenção não é possível excluir um cliente via API. Para desativar o acesso de um cliente na loja, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nAtenção por medidas de seguranças a senha é gerada randomicamente, não sendo possível definir ou editar via API. Para que o cliente possa acessar sua conta, será necessário que o mesmo redefina sua senha atráves do \"Esqueci minha senha\" na loja online.
\n","event":[{"listen":"prerequest","script":{"id":"2ff218f6-d0d3-4edf-8952-e8fd6e91c4cb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f096f369-1a33-4893-84b1-136221da45d7","type":"text/javascript","exec":[""]}}],"_postman_id":"b8e70df3-4ea5-4d52-8e99-bcd3fd45ae0c"},{"name":"Credito","item":[{"name":"Adicionar credito","id":"843ccc7e-0677-4c0e-b5b7-95914f707caa","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"prazo_id","value":"1","description":"Exemplo de ID do prazo
\n","type":"text"},{"key":"limite_credito","value":"500.00","description":"Exemplo de limite de credito
\n","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/creditos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite adicionar um crédito a um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/creditos
\nPara adicionar um crédito é necessário enviar uma requisição POST. Na URL será necessário informar o ID do cliente e no corpo body da requisição será necessario informar o ID do prazo e o limite de créditos.
Atenção é possível vincular apenas 1 (um) crédito ao cliente.
\nDescrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| prazo_id | \nID do prazo | \nSim | \n
| limite_credito | \nLimite de créditos. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 500.75 | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: { \n id: 1 }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem Este valor não existe quando o ID do prazo informado no corpo body da requisição não for encontrado, conforme o exemplo.
{ \n success: false,\n data: { \n code: 422,\n url: '/importacao/clientes/22/creditos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { prazo_id: 'Este valor não existe' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem Este valor não existe quando o ID do cliente informado na URL da requisição não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31231231/creditos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cliente_id: 'Este valor não existe' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"prazo_id","value":"1","type":"text"},{"key":"limite_credito","value":"780.50","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/creditos/{{ID_CREDITO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar o crédito de um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/creditos/ID_CREDITO
\nPara editar um crédito é necessário enviar uma requisição PUT. Na URL será necessário informar o ID do cliente e o ID do crédito e no corpo body da requisição será necessário informar o ID do prazo e o limite de créditos.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| prazo_id | \nID do prazo | \nSim | \n
| limite_credito | \nLimite de créditos. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 800.75 | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/creditos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar o crédito de um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/creditos
\nPara listar o crédito vinculado a um cliente é necessário enviar uma requisição GET, sendo necessário informar o ID do cliente na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ { \n id: 3,\n cliente_id: 44,\n prazo_id: 1,\n limite_credito: 200,\n created: '2019-04-11T10:34:00-03:00',\n modified: '2019-04-11T10:34:00-03:00' } ],\n pagination: {\n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/creditos/{{ID_CREDITO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um crédito vinculado a um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/creditos/ID_CREDITO
\nPara consultar um crédito é necessário enviar uma requisição GET, informando o ID do cliente e o ID do crédito na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: { \n id: 2,\n cliente_id: 44,\n prazo_id: 1,\n limite_credito: 200,\n created: '2019-04-11T10:21:04-03:00',\n modified: '2019-04-11T10:21:04-03:00' }\n}\nSerá retornado o código de status 404 Not Found quando o ID do cliente e/ou ID do crédito informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/213/creditos/5',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/creditos/{{ID_CREDITO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um crédito vinculado a um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/creditos/ID_CREDITO
\nPara excluir um crédito é necessário enviar uma requisição DELETE, informando o ID do cliente e o ID do crédito na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do cliente e/ou ID do crédito informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/213/creditos/5',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento dos limites de crédito por cliente na loja online.
\nO limite de crédito define o valor máximo de compra para pagamento com boleto.
\n","event":[{"listen":"prerequest","script":{"id":"5bbc33cf-588d-4b58-9325-1f03aadf281b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb8ba714-ce82-45fa-94fb-4af9762bd973","type":"text/javascript","exec":[""]}}],"_postman_id":"57b132f8-c972-4d28-96b2-dd3dcb7dfb15"},{"name":"Endereco","item":[{"name":"Adicionar endereco","id":"ad29427c-f65c-4636-8c55-ba833f01f4b6","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"filial_origem_id","value":"1","description":"Filial de origem
\n","type":"text"},{"key":"cep","value":"33930-832","description":"CEP do cliente
\n","type":"text"},{"key":"titulo","value":"Apartamento","description":"Titulo a ser exibido para o endereço
\n","type":"text"},{"key":"logradouro","value":"Rua almeida melo","description":"Logradouro do endereço
\n","type":"text"},{"key":"numero","value":"10","description":"Número do endereço
\n","type":"text"},{"key":"complemento","value":"AP 10","description":"Complemento do endereço
\n","type":"text"},{"key":"bairro","value":"Nova Esperança","description":"Bairro do endereço
\n","type":"text"},{"key":"cidade","value":"Belo Horizonte","description":"Cidade
\n","type":"text"},{"key":"uf","value":"Minas Gerais","description":"UF
\n","type":"text"},{"key":"sigla","value":"MG","description":"Sigla da UF
\n","type":"text"},{"key":"telefone","value":"3130867509","description":"Telefone para contato
\n","type":"text"},{"key":"referencia","value":"Próximo ao supermercado VIP","description":"Ponto de referencia para o endereço
\n","type":"text"},{"key":"principal","value":"0","description":"Define se o endereço é o principal
\n","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/enderecos","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar um endereço de entrega a um cliente.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/enderecos
\nAtenção é possível cadastrar apenas 1 (um) endereço como principal.
\nAtenção não é possível excluir um endereço, para desabilitar um endereço, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nAtenção deverá ser informado o CEP formatado, contendo no total 9 (nove) digitos, conforme o exemplo: 33931-832.
\nPara cadastrar um endereço é necessário enviar uma requisição POST, informando na URL o ID do cliente ao qual o endereço será vinculado. No corpo body da requisição será necessário informar os campos conforme definidos abaixo (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_origem_id | ID da filial. | Sim |
cep | CEP do endereço.Atenção será necessário informar o CEP formatado contendo 9 (nove) dígitos. conforme o exemplo: 33930-832. Tamanho máximo de 9 (nove) caracteres. | Não |
titulo | Titulo do endereço. O título será exibido na loja. Ex: \"casa\", \"trabalho\" | Não |
logradouro | Logradouro do endereço. | Sim |
numero | Numero do endereço. Número inteiro positivo | Sim |
complemento | Complemento associado ao endereço. Ex: \"ap 303 bl 06\". | Não |
bairro | Bairro do endereço. | Sim |
cidade | Cidade do endereço. | Sim |
uf | Nome do estado por extenso. Ex: \"São Paulo\", \"Minas Gerais\". | Sim |
sigla | Sigla da UF do endereço. Ex: \"MG\", \"RJ\", \"SP\". Tamanho máximo de 2 (dois) caracteres. | Não |
telefone | Telefone para contato associado ao endereço. Sem caracteres especiais. | Não |
referencia | Ponto de referência para a entrega. | Sim |
principal | Identifica se o endereço do cliente é o principal. Apenas um endereço pode ser identificado como principal.
| Sim |
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo cep com a mensagem \"O valor fornecido é inválido\", quando o CEP fornecido for invalido (ver exemplo abaixo), deverá ser informado o CEP formato, conforme o exemplo: 33630-830 (contendo 9 digitos).
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cep: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo principal com a mensagem \"O valor fornecido é inválido\", quando o valor fornecido não for booleano, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors: { principal: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo sigla com a mensagem \"O valor fornecido é inválido\", quando a sigla fornecida for invalida (ver exemplo abaixo), deverá ser informada uma sigla utilizando 2 (dois) caracteres, podendo ser letras maiuscula ou minuscula.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { sigla: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo numero com a mensagem \"O valor fornecido é inválido\", quando o número do endereço a ser cadastrado for invalido (ver exemplo abaixo), deverá ser informado um número inteiro positivo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { numero: 'O valor fornecido é inválido' } } \n}\n\nSerá retornado o código de status 422 Unprocessable Entity no campo principal com a mensagem \"O cliente já possui um endereço principal cadastrado\", quando o endereço a ser cadastrado estiver definido como true e o cliente já possuir um endereço principal (ver exemplo abaixo). O endereço já definido como principal deverá ser editado, somente a após a edição será possivel definir um novo endereço como principal.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { principal: 'O cliente já possui um endereço principal cadastrado' } } \n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"raw","raw":"{\n \"filial_origem_id\": 1,\n \"cep\": \"33930-000\",\n \"titulo\":\"Apartamento\",\n \"logradouro\": \"Rua almeida melo\",\n \"numero\": 201,\n \"complemento\": \"AP 09\",\n \"bairro\": \"Maria Helena\",\n \"cidade\": \"Belo Horizonte\",\n \"uf\": \"Minas Gerais\",\n \"sigla\": \"MG\",\n \"telefone\": \"31231231231\",\n \"referencia\": \"Próximo ao supermercado VIP\",\n \"principal\": true,\n \"desativado\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/enderecos/{{ID_ENDERECO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um endereço de entrega de um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/enderecos/ID_ENDERECO
\nAtenção é possível cadastrar apenas 1 (um) endereço como principal.
\nAtenção não é possível excluir um endereço, para desabilitar um endereço, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true.
\nAtenção deverá ser informado o CEP formatado, contendo no total 9 (nove) digitos, conforme o exemplo: 33931-832.
\nPara editar um endereço é necessário enviar uma requisição PUT, informando na URL o ID do cliente e o ID do endereço. No corpo body da requisição será necessário informar os campos conforme definidos abaixo (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_origem_id | \nID da filial. | \nNão | \n
| cep | \nCEP do endereço.Atenção será necessário informar o CEP formatado contendo 9 (nove) digitos. conforme o exemplo: 33930-832 | \nNão | \n
| titulo | \nTitulo do endereço. O título será exibido na loja. Ex: \"casa\", \"trabalho\" | \nNão | \n
| logradouro | \nLogradouro do endereço. | \nNão | \n
| numero | \nNumero do endereço. Número inteiro positivo | \nNão | \n
| complemento | \nComplemento associado ao endereço. Ex: \"ap 303 bl 06\". | \nNão | \n
| bairro | \nBairro do endereço. | \nNão | \n
| cidade | \nCidade do endereço. | \nNão | \n
| uf | \nNome do estado por extenso. Ex: \"São Paulo\", \"Minas Gerais\". | \nNão | \n
| sigla | \nSigla da UF do endereço. Ex: \"MG\", \"RJ\", \"SP\" | \nNão | \n
| telefone | \nTelefone para contato associado ao endereço. Sem caracteres especiais. | \nNão | \n
| referencia | \nPonto de referência para a entrega. | \nNão | \n
| principal | \nIdentifica se o endereço do cliente é o principal. Apenas um endereço pode ser identificado como principal. Opções aceitas:
| \n Não | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo cep com a mensagem \"O valor fornecido é inválido\", quando o CEP fornecido for invalido (ver exemplo abaixo), deverá ser informado o CEP formato, conforme o exemplo: 33630-830 (contendo 9 digitos).
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cep: 'O valor fornecido é inválido' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo principal com a mensagem \"O valor fornecido é inválido\", quando o valor fornecido não for booleano, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors: { principal: 'O valor fornecido é inválido' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo sigla com a mensagem \"O valor fornecido é inválido\", quando a sigla fornecida for invalida (ver exemplo abaixo), deverá ser informada uma sigla utilizando 2 (dois) caracteres, podendo ser letras maiuscula ou minuscula.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { sigla: 'O valor fornecido é inválido' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo numero com a mensagem \"O valor fornecido é inválido\", quando o número do endereço a ser cadastrado for invalido (ver exemplo abaixo), deverá ser informado um número inteiro positivo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { numero: 'O valor fornecido é inválido' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo principal com a mensagem \"O cliente já possui um endereço principal cadastrado\", quando o endereço a ser cadastrado estiver definido como true e o cliente já possuir um endereço principal (ver exemplo abaixo). O endereço já definido como principal deverá ser editado, somente a após a edição será possivel definir um novo endereço como principal.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/31/enderecos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors:\n { principal: 'O cliente já possui um endereço principal cadastrado' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/enderecos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar os endereços de entrega de um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/enderecos/?cep=30881-640
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por cep:
\n{{URL}}/importacao/clientes/ID_CLIENTE/enderecos/?cep=30881-640Busca por numero:
\n{{URL}}/importacao/clientes/ID_CLIENTE/enderecos/?numero=21Busca por uf:
\n{{URL}}/importacao/clientes/ID_CLIENTE/enderecos/?uf=Minas Gerais
Atenção ao não informar nenhum parametro na URL será retornado todos os endereços de entrega do cliente.
\nPara listar os endereços de entrega de um cliente é necessário enviar uma requisição GET , sendo necessário informar o ID do cliente na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ { \n id: 30,\n cliente_id: 44,\n titulo: 'Apartamento',\n cep: '30881-640',\n logradouro:\n 'Rua General Clark - até 487/488 (trecho posterior pertence a(o) Contagem)',\n numero: 0,\n complemento: 'AP 01',\n bairro: 'São Salvador',\n cidade: 'Belo Horizonte',\n uf: 'Minas Gerais',\n sigla: 'MG',\n telefone: '',\n referencia: 'Supermercado vip',\n principal: true,\n created: '2019-04-11T10:03:49-03:00',\n modified: '2019-04-11T10:03:49-03:00',\n endereco_formatado:\n 'Rua General Clark - até 487/488 (trecho posterior pertence a(o) Contagem), nr.0 AP 01 - São Salvador - Belo Horizonte/MG',\n telefone_formatado: '' },\n { id: 31,\n cliente_id: 44,\n titulo: 'Trabalho',\n cep: '30881-100',\n logradouro: 'Rua Nove de Julho',\n numero: 3,\n complemento: '',\n bairro: 'Coqueiros',\n cidade: 'Belo Horizonte',\n uf: 'Minas Gerais',\n sigla: 'MG',\n telefone: '',\n referencia: 'Supermercado vip',\n principal: false, \n created: '2019-04-11T10:04:37-03:00',\n modified: '2019-04-11T10:04:37-03:00',\n endereco_formatado: 'Rua Nove de Julho, nr.3 - Coqueiros - Belo Horizonte/MG',\n telefone_formatado: '' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 2,\n limit: null } }\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/enderecos/{{ID_ENDERECO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um endereço.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/enderecos/ID_ENDERECO
\nPara consultar um endereço é necessário enviar uma requisição GET, sendo necessário informar o ID do cliente e o ID do endereço na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:{\n id: 22,\n cliente_id: 18,\n titulo: 'Titulo do endereco',\n cep: '33930-000',\n logradouro: 'Rua almeida melo',\n numero: 21,\n complemento: 'apto 202',\n bairro: 'Nova Esperança',\n cidade: 'Belo Horizonte',\n uf: 'Minas Gerais',\n sigla: 'MG',\n telefone: '3189795931',\n referencia: 'referencia',\n principal: true,\n created: '2019-04-04T10:11:41-03:00',\n modified: '2019-04-05T14:15:58-03:00',\n endereco_formatado:\n 'Rua almeida melo, nr.21 apto 202 - Nova Esperança - Belo Horizonte/MG',\n telefone_formatado: '(31) 8979-5931' } \n}\nSerá retornado o código de status 404 Not Found quando o ID do cliente e/ou ID do endereço informado na URL for inexistente ou o ID do endereço não for vinculado ao ID do cliente, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/10/enderecos/22',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de endereços de cada cliente.
\nAtenção é possível cadastrar apenas 1 (um) endereço como principal.
\nAtenção não é possível excluir um endereço, para desabilitar um endereço, será necessário enviar uma requisição PUT editando a propriedade \"desativado\" para true. Ao realizar esta ação o cliente não irá visualizar o endereço na loja.
\nAtenção deverá ser informado o CEP formatado, contendo no total 9 (nove) digitos, conforme o exemplo: 33931-832.
\n","event":[{"listen":"prerequest","script":{"id":"d59f7769-61d3-4239-b936-f3ddeed77896","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3c275609-1afb-4c9b-9f06-c6c66ea03ce0","type":"text/javascript","exec":[""]}}],"_postman_id":"44022490-6ad2-4fa9-87db-6c2302443194"},{"name":"Cliente-Filiais","item":[{"name":"Adicionar cliente-filial","id":"e8f07ebd-e186-400c-a351-88f80f6c1e58","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"filial_id","value":"2","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/clientes-filiais","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite vincular uma filial a um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/clientes-filiais
\nPara vincular um cliente a uma filial é necessário enviar uma requisição POST, informando na URL o ID do cliente . No corpo body da requisição será necessário informar o ID da filial a qual o cliente será vinculado.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 227 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo filial_id com a mensagem \"Este valor não existe\", quando o ID da filial não estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/1/clientes-filiais',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { filial_id: 'Este valor não existe' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo cliente_id com a mensagem \"Este valor não existe\", quando o ID do cliente informado na URL não estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/clientes/1/clientes-filiais',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cliente_id: 'Este valor não existe' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"filial_id","value":"1","description":"Exemplo de ID da filial
\n","type":"text"}]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/clientes-filiais/{{ID_CLIENTE_FILIAL}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite a vinculação de um cliente a uma filial.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/clientes-filiais/ID_CLIENTE_FILIAL
\nPara editar a vinculação de um cliente a filial é necessário enviar uma requisição PUT, informando na URL o ID do cliente e o ID do registro de vinculação do cliente a filial. No body da requisição será necessário informar o ID da filial.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do cliente e/ou ID do registro de clientes-filiais informados na URL não forem encontrados, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/500/clientes-filiais/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/clientes-filiais","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar as filiais que um cliente está vinculado.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/clientes-filiais
\nPara listar as filiais que um cliente está vinculado é necessário enviar uma requisição GET, informando o ID do cliente na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 18, filial_id: 1, cliente_id: 18 },\n { id: 68, filial_id: 2, cliente_id: 18 } ],\n pagination: {\n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 2,\n limit: null } \n}\nSerá retornado o código de status 200 OK com o data vazio, quando a requisição ocorrer com sucesso e o ID do cliente informado na URL não for encontrado, conforme o exemplo.
{ \n success: true,\n data: [],\n pagination: {\n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 0,\n limit: null } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/clientes-filiais/{{ID_CLIENTE_FILIAL}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar a filial vinculada a um cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/clientes-filiais/ID_CLIENTE_FILIAL
\nPara consultar a filial que um cliente está vinculado é necessário enviar uma requisição GET, informando o ID do cliente e o ID do registro de vinculação do cliente a filial na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: { id: 68, filial_id: 2, cliente_id: 18 } \n}\nSerá retornado o código de status 404 Not found quando o ID do cliente e/ou ID do registro de vinculação do cliente a filial informado na URL não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/18/clientes-filiais/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/clientes-filiais/{{ID_CLIENTE_FILIAL}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite desvincular um cliente a uma filial.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/clientes-filiais/ID_CLIENTE_FILIAL
\nPara desvincular um cliente de uma Filial é necessário enviar uma requisição DELETE, informando o ID do cliente e o ID do registro de vinculação do cliente a filial na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID do cliente e/ou ID do registro de vinculação do cliente a filial informado na URL não for encontrado, conforme o exemplo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/clientes/18/clientes-filiais/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de vinculação de clientes às filiais da loja online.
\n","event":[{"listen":"prerequest","script":{"id":"b7ef1501-979f-4f68-9795-8bec7c16f200","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"288f6090-734f-49a3-b39b-b16e79fa0fae","type":"text/javascript","exec":[""]}}],"_postman_id":"018526f7-5b03-46bb-b7e6-9c3fefee3008"},{"name":"Senha","item":[{"name":"Enviar email de alteração de senha","id":"bbc43ed4-cd4a-40dc-9e31-d7c360576872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"filial","value":"1","type":"text"},{"key":"cliente","value":"1","type":"text"}]},"url":"{{URL}}/importacao/clientes/recuperar-senha","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite acionar o envio do email de alteração de senha.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/recuperar-senha
\nPara acionar o envio do email de alteração de senha para o email padrão cadastrado de um cliente específico, é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do ID do cliente e da filial.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| cliente | \nID do cliente que receberá o email de recuperação de senha, no formato de número inteiro. | \nSim | \n
| filial | \nID da filial em que o cliente está cadastrado, no formato de número inteiro. | \nSim | \n
Tipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"password\": \"teste1423\",\n \"password_confirm\": \"teste1423\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/clientes/{{ID_CLIENTE}}/definir-senha","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite definir a senha de um cliente criado pela API.\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/clientes/ID_CLIENTE/definir-senha
\nAtenção A alteração de senha somente e válida para clientes cadastrados pela API.
\nAtenção A alteração de senha é possível somente 1 única vez.
\nAtenção A senha deve conter ao menos 6 caracteres.
\nPara definir a senha um cliente criado pela API é necessário enviar uma requisição PUT. No corpo body da requisição será necessário informar os dados da nova senha do cliente (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| password | \nInformar a nova senha do cliente | \nSim | \n
| password_confirm | \nInformar novamente a nova senha do cliente | \nSim | \n
\n\n{\n \"password\": \"teste1423\",\n \"password_confirm\": \"teste1423\"\n}\n\n\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando a requisição encontrar as situações abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/clientes/756/definir-senha\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 403 Forbidden quando a requisição encontrar as situações abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Você não está autorizado a acessar esse local.\",\n \"url\": \"/importacao/clientes/756/definir-senha\",\n \"code\": 403,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\ForbiddenException\",\n \"code\": 403,\n \"message\": \"Você não está autorizado a acessar esse local.\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity quando a requisição encontrar as situações abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/clientes/759/definir-senha\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"password_confirm\": \"A senha e a confirmaçao devem ser iguais\"\n }\n }\n}\nA API de Clientes permite que sistemas externos ao VIP Commerce gerenciem clientes na plataforma.
\nÉ possível trabalhar com os seguintes CRUDs via API:\n
Para detalhes sobre o cabeçalho da requisição,
\n\nPermite criar um pedido.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/add
\nAtenção quando o pedido for criado ele irá aparecer no Back-Office com a letra \"P\" no inicio do número do pedido. Exemplo do número do pedido: P-1000001
\nPara cadastrar um pedido é necessário enviar uma requisição POST. No corpo body da requisição será necessário informar os dados do pedido (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
filial_id | ID da filial. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
centro_distribuicao_id | ID do centro de distribuição. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
forma_pagamento_id | ID da forma de pagamento. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
tipo_entrega_id | ID do tipo de entrega. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
cnpj_gerador_pedido | CNPJ de quem está gerando o pedido. Atenção: Deverá ser informado um CNPJ válido. Com ou sem o formato de ponto e traço. | Sim |
cliente_id | ID do cliente. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
endereco_id | Endereço de entrega do pedido. O endereço de entrega tem que estar vinculado ao cliente. Atenção: deverá ser enviado um número inteiro positivo, conforme o exemplo: 1 | Sim |
data_entrega | Data que a entrega do pedido será realizada. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | Sim |
frete | Valor do frete do pedido. Atenção: Deverá ser informado um valor com duas casas decimais, por exemplo: 9.99 | Sim |
tipo_fiscal | Tipo fiscal do pedindo, podendo ser Cupom Fiscal ou Nota Fiscal.
| Sim |
observacoes_do_cliente | Observações feitas pelo cliente | Não |
peso_bruto | Peso bruto dos produtos do pedido. | Não |
peso_liquido | Peso liquido dos produtos do pedido. | Não |
pedido_produtos | Array de produtos vinculados ao pedido. | Sim |
descontos | Array de descontos vinculados ao pedido. | Não |
fonte_compra | Origem de onde a compra foi criada
| Não |
marketplace | Define se o pedido foi feito ou não por um marketplace, se o valor fonte_compra for M, será obrigatório selecionar um marketplace
| Não |
parceiro_id | Permite informar o identificador alfanumérico do parceiro para pedidos importados | Não |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
codigo_erp | Código ERP do produto | Sim |
quantidade | Quantidade de itens deste produto. | Sim |
preco | O preço do produto. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
preco_venda | O preço que o produto foi vendido. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim |
brinde | Define se o produto será ou não um brinde.
| Não |
enviar_prevenda | Define se o item será enviado para a prevenda. Valor default: true | Não |
| Propriedade | Descrição | Obrigatório |
|---|---|---|
valor | Valor do desconto que será aplicado na compra. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | Sim caso o array de descontos for informado |
observacoes | Observacoes referentes ao desconto. | Sim caso o array de descontos for informado |
{\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 1,\n \"forma_pagamento_id\": 2,\n \"tipo_entrega_id\": 1,\n \"cnpj_gerador_pedido\": \"08.880.403/0001-84\",\n \"cliente_id\": 718,\n \"endereco_id\": 721,\n \"data_entrega\": \"2020-12-23 13:00:00\",\n \"frete\": 10.72,\n \"tipo_fiscal\": \"CF\",\n \"observacoes_do_cliente\": \"observaoces do cliente\",\n \"peso_bruto\": 0.250,\n \"peso_liquido\": 0.250,\n \"parceiro_id\": \"05b35f9b-0fe9-44bf-bfff-9206c48a5b1b\",\n \"pedido_produtos\": [\n {\n \"codigo_erp\": 53333,\n \"quantidade\": 2,\n \"preco\": 10.32,\n \"preco_venda\": 9.44,\n \"brinde\": false,\n \"enviar_prevenda\": true\n },\n {\n \"codigo_erp\": 12222,\n \"quantidade\": 12,\n \"preco\": 0,\n \"preco_venda\": 0,\n \"brinde\": true,\n \"enviar_prevenda\": true\n }\n ],\n \"descontos\": [\n {\n \"valor\": 1.00,\n \"observacoes\": \"desconto 1\"\n },\n {\n \"valor\": 3.99,\n \"observacoes\": \"desconto teste\"\n }\n ]\n}\n\nSerá retornado o código de status 201 Created e a propriedade data.id com o ID do pedido criado, quando o pedido for criado com sucesso. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1009410\n }\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este campo é obrigatório\" quando algum dos campos obrigatórios do array de produtos não for informado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Ocorreram erros de pré-validação\",\n \"field\": \"compra_produtos\",\n \"errors\": [\n {\n \"entity\": {\n \"quantidade\": 2,\n \"preco\": 10,\n \"preco_venda\": 9\n },\n \"messages\": [\n {\n \"message\": \"É obrigatório informar o codigo_erp ou produto_id\",\n \"field\": \"codigo_erp\",\n \"rule\": \"required\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este campo é obrigatório\" quando algum dos campos obrigatórios do array de descontos não for informado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Ocorreram erros de validação: \",\n \"field\": \"compra_descontos\",\n \"errors\": [\n {\n \"entity\": {\n \"model\": \"DescontoParceiro\",\n \"foreign_key\": 101,\n \"observacoes\": \"teste 1\",\n \"valor\": null\n },\n \"messages\": [\n {\n \"message\": \"Este campo não pode ser deixado vazio\",\n \"field\": \"valor\",\n \"rule\": \"_empty\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este campo é obrigatório\" na propriedade data.errors.messages.message quando um campo obrigatório não for informado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"filial_id\",\n \"rule\": \"required\"\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Endereço não vinculado ao cliente\" na propriedade data.errors.messages.message, quando o endereço não estiver vinculado ao cliente. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Endereço não vinculado ao cliente\",\n \"field\": \"endereco_id\",\n \"rule\": \"endereco_nao_vinculado_cliente\"\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este valor não existe\" na propriedade data.errors.messages.message, quando o ID de algum dos campos não exister, informando qual o campo que apresentou problema na propriedade data.errors.messages.field. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Este valor não existe\",\n \"field\": \"centro_distribuicao_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n}\n\n➤ CAMPOS QUE ESTE ERRO PODE ACONTECER SE O ID INFORMADO FOR INVÁLIDO
\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este valor não existe\", quando o ID da forma de pagamento não existir. Também será apresentado um array \"erros\" mostrando qual entidade está apresentando erro. Conforme o exemplo a seguir.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Ocorreram erros de validação: \",\n \"field\": \"compra_pagamentos\",\n \"errors\": [\n {\n \"entity\": {\n \"parcelas\": 1,\n \"capturado\": true,\n \"confirmado\": true,\n \"valor\": 131.73,\n \"forma_pagamento_id\": 222222\n },\n \"messages\": [\n {\n \"message\": \"Este valor não existe\",\n \"field\": \"forma_pagamento_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"Centro de distribuicação não pertence a filial\" na propriedade data.errors.messages.message, quando o Centro de distribuição não estiver vinculado a filial. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Centro de distribuicação não pertence a filial.\",\n \"field\": \"centro_distribuicao_id\",\n \"rule\": \"_existsIn\"\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"O valor fornecido é inválido\" na propriedade data.errors.messages.message, quando o valor do tipo fical for inválido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O valor fornecido é inválido\",\n \"field\": \"tipo_fiscal\",\n \"rule\": \"inList\"\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 400 Bad Request e a mensagem \"O CNPJ informado é inválido\" na propriedade data.errors.messages.message, quando o CNPJ gerador do pedido for inválido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O CNPJ informado é inválido\",\n \"field\": \"cnpj_gerador_pedido\",\n \"rule\": \"document\"\n }\n ]\n }\n ]\n}\n\nSerá retornada a mensagem \"O preco_venda para produto brinde deve ser igual a 0\", quando a propriedade brinde estiver \"true\" e a propriedade preco_venda não estiver definida como 0 (zero). A seguir é exibido um exemplo da mensagem.
\n{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Ocorreram erros de validação: \",\n \"field\": \"pedido_produtos\",\n \"errors\": [\n {\n \"entity\": {\n \"produto_id\": 306,\n \"preco\": 10.32,\n \"preco_venda\": 0.1,\n \"compra_produto_status_id\": 1,\n \"unidade\": 1,\n \"brinde\": true,\n \"enviar_prevenda\": 1\n },\n \"messages\": [\n {\n \"message\": \"O preco_venda para produto brinde deve ser igual a 0\",\n \"field\": \"brinde\",\n \"rule\": \"_brinde\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}\n\nSerá retornado o status code 400 Bad Request e a mensagem \"Valor inválido. Informe um Id de Parceiro Válido\" na propriedade data.errors.messages.message, quando o parceiro_id do pedido for inválido. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Valor inválido. Informe um Id de Parceiro Válido\",\n \"field\": \"parceiro_id\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\n\nSerá retornado o código de status 201 Created e a mensagem \"Este produto encontra-se sem estoque cadastrado\", quando algum(ns) dos produtos informados não tiver estoque-preço no Centro de distribuição do pedido, assim o pedido será criado mas o produto não será adicionado. Conforme o exemplo a seguir.
{\n \"success\": true,\n \"data\": {\n \"id\": 19426\n },\n \"warnings\": [\n {\n \"entity\": {\n \"codigo_erp\": 54,\n \"quantidade\": 2,\n \"preco\": 10,\n \"preco_venda\": 9\n },\n \"messages\": [\n {\n \"message\": \"Este produto encontra-se sem estoque cadastrado\",\n \"field\": \"codigo_erp\",\n \"rule\": \"produto_estoque_preco_nao_cadastrado\"\n }\n ]\n }\n ]\n}\n\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/cancelar/ID_PEDIDO
\nPara cancelar o pedido é necessário enviar uma requisição POST, sendo necessário informar o ID do pedido.
Atenção poderão ser excluidos somente pedidos cadastrados a partir do token informado em Authorization.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando não for informado o ID do pedido na URL, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/cancelar/\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Controller\\\\Exception\\\\MissingActionException\",\n \"code\": 404,\n \"message\": \"Action PedidosController::cancelar() could not be found, or is not accessible.\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request quando o ID do pedido informado na URL for inexistente ou o pedido não pertence ao usuário que está solicitando o cancelamento, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Pedido não pertence ao usuário que está solicitando o cancelamento.\"\n }\n}\nSerá retornado o código de status 400 Bad Request quando o pedido informado na URL estiver em um status que não está autorizado a realizar o cancelamento , conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"A compra já passou do status permitido para cancelamento.\"\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"url":"{{URL}}/importacao/pedidos/?cliente_id=1","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de itens por página,
\n\nPermite listar pedidos através do parametro informado na URL.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/?cliente_id=1
\nOs parametros permitidos são
\nEx: ao realizar uma consulta informando o parametro \"compra_status_id\" igual a 9 (nove), será retornado todas as compras que estiverem \"AGUARDANDO ATENDIMENTO\".
\nID dos status da compra
\n| ID | Descrição | Status retornado |
|---|---|---|
1 | ATENDIMENTO | Atendimento |
2 | SEPARAÇÃO | Separação |
3 | EMPACOTAMENTO | Empacotamento |
4 | FATURAMENTO | Faturamento |
5 | LOGÍSTICA | Logística |
6 | CHECK-OUT | Expedição |
7 | CHECK-IN | Entrega |
8 | COMPRA | Finalizada |
9 | AGUARDANDO ATENDIMENTO | Em atendimento |
10 | EM ATENDIMENTO | Em atendimento |
11 | PENDENTE | Em atendimento |
12 | AGUARDANDO SEPARAÇÃO | Em separação |
13 | EM SEPARAÇÃO | Em separação |
14 | PENDENTE SEPARAÇÃO | Em separação |
15 | FINALIZADA | Finalizada |
16 | EM PROCESSO DE COMPRA | Em processo |
17 | CANCELADA | Cancelada |
18 | AGUARDANDO EMPACOTAMENTO | Em empacotamento |
19 | EM EMPACOTAMENTO | Em empacotamento |
20 | PENDENTE EMPACOTAMENTO | Em empacotamento |
21 | AGUARDANDO FATURAMENTO | Em faturamento |
22 | EM FATURAMENTO | Em faturamento |
23 | AGUARDANDO LOGÍSTICA | Em logística |
25 | EM LOGÍSTICA | Em logística |
26 | EM CHECK-OUT | Em logística |
27 | EM ENTREGA | Em entrega |
28 | AGUARDANDO CHECK-IN | Entregue |
29 | EM CHECK-IN | Entregue |
30 | AGUARDANDO CHECK-OUT | Em entrega |
31 | SOLICITAÇÃO DE CANCELAMENTO | Cancelamento Solicitado |
32 | CARREGAMENTO | Carregamento |
33 | AGUARDANDO CARREGAMENTO | Aguardando Carregamento |
34 | EM CARREGAMENTO | Em carregamento |
35 | ENTREGUE | Entregue |
36 | NÃO ENTREGUE | Entrega não realizada |
37 | RISCO DE FRAUDE | Em atendimento |
Para listar os pedidos através do parametro informado na URL é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1626,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"compra_status_id\": 9,\n \"tipo_entrega_id\": 1,\n \"cliente_id\": 210,\n \"endereco_id\": 210,\n \"usuario_id\": null,\n \"api_usuario_id\": \"5ef3a9b2-2964-4c00-b41e-5188ac3200a1\",\n \"cnpj_gerador_pedido\": \"08880403000184\",\n \"foreign_key\": null,\n \"parent_id\": null,\n \"data_entrega\": \"2020-12-23T13:00:00-03:00\",\n \"data_entregue\": null,\n \"data_faturamento\": null,\n \"faturamento\": false,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": null,\n \"prevenda\": false,\n \"numero_prevenda\": null,\n \"frete\": 10.72,\n \"taxa_de_servico\": null,\n \"valor_inicial\": 18.88,\n \"valor_desconto\": 4.99,\n \"observacoes_do_cliente\": \"observaoces do cliente\",\n \"observacoes_do_atendimento\": null,\n \"observacoes_na_entrega\": null,\n \"intervalo\": 0,\n \"qtd_itens\": 14,\n \"qtd_produtos\": 2,\n \"valor_produtos\": 18.88,\n \"retirada_loja\": false,\n \"notificacao_retirada\": 0,\n \"antifraude_session_id\": null,\n \"score_priorizacao\": null,\n \"informacoes_cashback\": null,\n \"desconto_aplicado\": false,\n \"created\": \"2021-05-21T10:23:45-03:00\",\n \"modified\": \"2021-05-21T10:23:45-03:00\",\n \"centro_distribuicao\": {\n \"id\": 1,\n \"vipcommerce_centro_distribuicao_id\": null,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"00000000000000\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"00000000\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\",\n \"relacionamento_telefone\": null,\n \"relacionamento_whatsapp\": null,\n \"relacionamento_link_whatsapp\": false,\n \"relacionamento_mensagem_whatsapp\": null,\n \"relacionamento_email\": null,\n \"tipo_exibicao_retirada\": 1,\n \"observacao_retirada\": \"\",\n \"remover_mascara_telefones\": false\n },\n \"codigo\": \"1626\",\n \"status\": \"Em atendimento\",\n \"valor_final\": 29.6,\n \"tipo_pedido\": \"Compra\",\n \"volumes_frios\": null,\n \"volumes_comuns\": null\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/pedidos/{{ID_PEDIDO}}","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite consultar informações de um pedido.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO
\nAo consultar pedidos em processo (compras ainda não finalizadas), informações dos produtos podem retornar valores desatualizados, pois as compras estão em constante atualização.
\nPara consultar os produtos de um pedido, recomendamos realizar a consulta especifica em
\n\nPara consultar um pedido é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: {\n id: 1000075,\n centro_distribuicao_id: 1,\n filial_id: 1,\n compra_status_id: 15,\n tipo_entrega_id: 1,\n cliente_id: 1,\n endereco_id: 1,\n usuario_id: null,\n cnpj_gerador_pedido: \"08880403000184\",\n parent_id: null,\n data_entrega: '2019-04-26T20:20:00-03:00',\n data_entregue: '2019-04-26T11:44:50-03:00',\n data_faturamento: '2019-04-26T08:19:38-03:00',\n faturamento: true,\n tipo_fiscal: 'CF',\n numero_fiscal: '56757',\n prevenda: true,\n numero_prevenda: '1000075.zip',\n frete: 7.5,\n taxa_de_servico: null,\n valor_inicial: 58.97,\n valor_desconto: 0,\n observacoes_do_cliente: null,\n observacoes_do_atendimento: null,\n observacoes_na_entrega: null,\n intervalo: 0,\n qtd_itens: 0,\n qtd_produtos: 0,\n valor_produtos: 0,\n retirada_loja: false,\n created: '2018-03-25T09:39:46-03:00',\n modified: '2019-04-26T11:48:12-03:00',\n centro_distribuicao: { \n id: 1,\n nome: 'CD Principal',\n cnpj: '00000000000000',\n inscricao_estadual: 'ISENTO',\n endereco_cep: '00000000',\n endereco_logradouro: 'Logradouro',\n endereco_numero: '100',\n endereco_complemento: null,\n endereco_bairro: 'Bairro',\n endereco_cidade: 'Cidade',\n endereco_estado: 'Estado',\n tipo_exibicao_retirada: 1,\n observacao_retirada: null\n },\n codigo: '1000075',\n status: 'Finalizada',\n tipo_pedido: 'Compra',\n valor_final: 53.38,\n fonte_compra: 'M',\n marketplace: 1 }\n}\n\nSerá retornado o código de status 404 Not Found quando o ID do pedido informado na URL for inexistente, conforme o exemplo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/pedidos/5000075',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\n\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite consultar detalhes de um pedido.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/detalhes
\nPara consultar detalhes de um pedido é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Atenção ao consultar pedidos em processo (compras ainda não finalizadas), as informações podem retornar valores desatualizados, pois os pedidos estão em constante atualização.
\nPara consultar os produtos de um pedido, recomendamos realizar a consulta especifica
\n\nPara consultar os detalhes de um pedido utilizando parametros, recomendamos realizar a consulta disponível na pasta Score
\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 329,\n \"compra_status_id\": 22,\n \"tipo_entrega_id\": 5,\n \"usuario_id\": null,\n \"cnpj_gerador_pedido\": \"08880403000184\",\n \"parent_id\": null,\n \"tipo_compra\": \"N\",\n \"data_original_entrega\": \"2020-06-24T18:35:00-03:00\",\n \"data_entrega\": \"2020-06-24T18:35:00-03:00\",\n \"data_entregue\": null,\n \"data_faturamento\": \"2020-09-07T11:35:51-03:00\",\n \"faturamento\": true,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": null,\n \"numero_fiscal_devolucao\": null,\n \"prevenda\": true,\n \"numero_prevenda\": \"329.xml\",\n \"frete\": 0,\n \"taxa_de_servico\": null,\n \"valor_inicial\": 431.99,\n \"valor_desconto\": 80.8,\n \"observacoes_do_cliente\": null,\n \"observacoes_do_atendimento\": null,\n \"observacoes_na_entrega\": null,\n \"observacoes_retorno_entrega\": null,\n \"intervalo\": 3,\n \"cancelamento\": false,\n \"data_status\": null,\n \"envio_automatico\": true,\n \"peso_bruto\": 0,\n \"peso_liquido\": 0,\n \"qtd_itens\": 50,\n \"qtd_produtos\": 50,\n \"valor_produtos\": 431.99,\n \"mobile\": 1,\n \"tipo_dispositivo\": \"S\",\n \"retirada_loja\": false,\n \"score_priorizacao\": -329,\n \"created\": \"2020-06-24T12:36:10-03:00\",\n \"modified\": \"2020-09-07T14:35:51-03:00\",\n \"empacotamentos\": [\n {\n \"id\": 43,\n \"volumes_frios\": 5,\n \"volumes_comuns\": 14,\n \"compra_id\": 329\n }\n ],\n \"endereco\": {\n \"id\": 100,\n \"cep\": \"32180-360\",\n \"titulo\": \"Cadastro via script - 14\",\n \"logradouro\": \"Rua Conde Bonfim\",\n \"numero\": 4,\n \"complemento\": \"\",\n \"bairro\": \"Tijuca\",\n \"cidade\": \"Contagem\",\n \"uf\": \"Minas Gerais\",\n \"telefone\": null,\n \"referencia\": \"teste - 48\",\n \"longitude\": \"-44.0217364\",\n \"latitude\": \"-19.8635804\",\n \"principal\": true,\n \"desativado\": false\n },\n \"cliente\": {\n \"id\": 100,\n \"tipo_cliente\": \"PJ\",\n \"nome_completo\": \"\",\n \"nome_fantasia\": \"Kelvin-M-PJ-um\",\n \"inscricao_estadual\": \"Isento\",\n \"razao_social\": \"Kelvin-M-PJ-um\",\n \"cnpj\": \"86415722138310\",\n \"telefone_fixo\": \"0542689850\",\n \"telefone_celular\": \"02876680171\",\n \"email\": \"stermer181@tst.com\",\n \"sexo\": \"M\",\n \"data_nascimento\": \"1956-02-14T00:00:00+00:00\",\n \"cpf\": \"85844812069\",\n \"rg\": \"132646\",\n \"emissor\": \"ssp mg\",\n \"comunicacao_sms\": null,\n \"comunicacao_email\": null,\n \"comunicacao_aplicativo\": null,\n \"termos_aceite\": true,\n \"bloquear_login\": false,\n \"confirmado\": true,\n \"status\": \"N\",\n \"suspeita_fraude\": false,\n \"observacoes\": null\n },\n \"tipo_entrega\": {\n \"id\": 5,\n \"descricao\": \"Retirada CD2\",\n \"resumo\": \"Retirada CD2\"\n },\n \"filial\": {\n \"id\": 1,\n \"nome\": \"Filial 1 Release\",\n \"site_url\": \"https://www.release.vipcommerce.com.br/\"\n },\n \"centro_distribuicao\": {\n \"id\": 2,\n \"nome\": \"CD dois\",\n \"cnpj\": \"56246832000147\"\n },\n \"pagamentos\": [\n {\n \"id\": 304,\n \"forma_pagamento_id\": 10,\n \"online\": true,\n \"parcelas\": 1,\n \"valor\": 351.19,\n \"valor_declarado\": 0,\n \"juros\": 0,\n \"capturado\": true,\n \"confirmado\": false,\n \"adicionado\": false,\n \"desativado\": false,\n \"created\": \"2020-06-24T12:36:12-03:00\",\n \"modified\": \"2020-06-24T12:36:12-03:00\",\n \"detalhe_pagamento\": {\n \"descricao\": \"VR Alimentação\",\n \"bandeira\": null,\n \"tid\": null,\n \"data\": \"2020-06-23T11:40:34-03:00\",\n \"chave\": null,\n \"componente\": null,\n \"observacoes\": null,\n \"nsu\": null,\n \"autorizacao\": null,\n \"nome\": null,\n \"cpf\": null,\n \"bin\": null,\n \"validade\": null,\n \"data_autorizacao\": \"2020-06-23T11:40:34-03:00\",\n \"data_captura\": \"2020-06-23T11:40:34-03:00\",\n \"cv\": \"76902620\"\n },\n \"parametro_faturamentos\": null,\n \"pagamento_entrega\": true\n }\n ],\n \"descontos\": [\n {\n \"id\": 1022,\n \"valor\": 1,\n \"tipo\": \"cupom-credito\",\n \"motivo\": \"Promoção\",\n \"codigo\": \"COD-PARCEIRO-1652\"\n },\n {\n \"id\": 1023,\n \"valor\": 2.59,\n \"tipo\": \"cupom-credito\",\n \"motivo\": \"Promoção\",\n \"codigo\": \"60a68218329e6\"\n }\n ],\n \"codigo\": \"329\",\n \"status\": \"Em faturamento\",\n \"valor_final\": 431.99,\n \"tipo_pedido\": \"Compra\",\n \"fonte_compra\": \"M\",\n \"marketplace\": 1\n }\n}\n\nSerá retornado o código de status 404 Not Found quando o ID do pedido informado na URL da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/pedidos/1002/detalhes\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\n\nSerá retornado o código de status 500 Internal Server Error quando o ID do pedido informado na URL da requisição for inválido (letras), conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Ocorreu um erro interno.\",\n \"url\": \"/importacao/pedidos/aas/detalhes\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"InvalidArgumentException\",\n \"code\": 0,\n \"message\": \"Cannot convert value of type `string` to integer\"\n }\n }\n}\n\nPermite consultar informações vinculadas a um pedido.
\nAtenção ao consultar pedidos em processo (compras ainda não finalizadas), informações dos produtos podem retornar valores desatualizados, pois as compras estão em constante atualização.
\nPara consultar os produtos de um pedido, recomendamos realizar a consulta especifica em
\n\n","event":[{"listen":"prerequest","script":{"id":"f5d8b9e4-9f2c-4951-bcca-05bb0269ae88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3b06ec3c-57e6-4e31-ac9e-84ccfdb605aa","type":"text/javascript","exec":[""]}}],"_postman_id":"fce241fa-cebf-4997-b662-b585a38a5277"},{"name":"Devolução","item":[{"name":"Criar devolução","id":"b18f2aa7-1cf4-4103-b121-966370e82867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"tipo_entrega_id\": 2,\n \"data_entrega\": \"2021-09-10 13:00:00\",\n \"tipo_reposicao\": \"C\",\n \"observacoes\": \"Desistencia desses produto\",\n \"compra_produtos\": [\n {\n \"codigo_erp\": 17364,\n \"quantidade\": 1,\n \"motivo_id\": 4\n },\n {\n \"codigo_erp\": 84821,\n \"quantidade\": 1,\n \"motivo_id\": 4\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/pedidos/{{ID_COMPRA}}/devolucoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite criar um devolução.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{ID_COMPRA}}/devolucoes
\nAtenção só será possível realizar a devolução de uma compra quando ela estiver dentro do prazo permitido. O prazo é configurado em Preferências no Back-Office.
\nAtenção quando a devolução for criada ele irá aparecer no Back-Office com a letra \"D\" no início do número do pedido. Exemplo do número do pedido: D-1000001
\nPara criar uma devolução é necessário enviar uma requisição POST informando o ID da Compra que se deseja para fazer a devolução na URL. No corpo body da requisição será necessário informar os dados da devolução (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| tipo_entrega_id | \nID do tipo de entrega. Atenção: Caso não informado será considerado o tipo de entrega da compra | \n Não | \n
| data_entrega | \nData de entrega da devolução. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| tipo_reposicao | \nInforma se a devolução será recebida como cupom de crédito ou o recebimento do dinheiro. Atenção: Caso optar por cupom de crédito enviar \"C\" caso contrário enviar \"D\". | \n Sim | \n
| observacoes | \nObservações referentes a devolução. | \nSim | \n
| compra_produtos | \nArray de produtos da devolução. | \nSim | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto | \nSim | \n
| quantidade | \nQuantidade de itens deste produto. | \nSim | \n
| motivo_id | \nMotivo da devolução desse produto. Valores possivéis: 4 - Desistência 5- Arrependimento 6 - Erro de compra_pagamentos | \n Sim | \n
\n {\n \"tipo_entrega_id\": 2,\n \"data_entrega\": \"2021-09-10 13:00:00\",\n \"tipo_reposicao\": \"C\",\n \"observacoes\": \"Desistencia desses produto\",\n \"compra_produtos\": [\n {\n \"codigo_erp\": 17364,\n \"quantidade\": 1,\n \"motivo_id\": 4\n },\n {\n \"codigo_erp\": 84821,\n \"quantidade\": 1,\n \"motivo_id\": 4\n }\n ]\n }\n\n\nSerá retornado o código de status 201 Created e a propriedade data.entity.id com o ID da devolução criada, quando a devolução for criada com sucesso. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Devolução efetuada com sucesso\",\n \"entity\": {\n \"parent_id\": 750,\n \"compra_status_id\": 9,\n \"cliente_id\": 287,\n \"endereco_id\": 287,\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 2,\n \"retirada_loja\": false,\n \"tipo_entrega_id\": 2,\n \"valor_inicial\": 36.58,\n \"observacoes_do_cliente\": \"Observações do cliente\",\n \"data_entrega\": \"2021-09-10T13:00:00-03:00\",\n \"api_usuario_id\": \"5f8dbc0e-8d90-46ff-bb99-503bac32005b\",\n \"tipo_reposicao\": \"Cupom\",\n \"faturamento\": 1,\n \"prevenda\": 1,\n \"tipo_fiscal\": \"CF\",\n \"qtd_itens\": 2,\n \"qtd_produtos\": 1,\n \"compra_produtos\": [\n {\n \"produto_id\": 8699,\n \"preco_venda\": 18.29,\n \"compra_produto_status_id\": 5,\n \"compra_id\": 1680,\n \"id\": 215655,\n \"codigo_barras\": \"7501001104191\",\n \"codigo_erp\": 17364,\n \"quantidade_informada\": 1,\n \"preco_total\": 18.29,\n \"quantidade\": 1\n }\n ],\n \"compra_pagamentos\": [\n {\n \"forma_pagamento_id\": 1,\n \"parcelas\": 1,\n \"valor\": 36.58,\n \"confirmado\": true,\n \"compra_id\": 1680,\n \"created\": \"2021-09-09T14:37:00-03:00\",\n \"modified\": \"2021-09-09T14:37:00-03:00\",\n \"id\": 1696,\n \"descricao\": \"Dinheiro\",\n \"number_bin_decrypt\": null,\n \"pagamento_entrega\": true\n }\n ],\n \"created\": \"2021-09-09T14:37:00-03:00\",\n \"modified\": \"2021-09-09T14:37:00-03:00\",\n \"id\": 1680,\n \"codigo\": \"D-1680\",\n \"status\": \"Em atendimento\",\n \"valor_final\": 36.58,\n \"tipo_pedido\": \"Devolução\",\n \"volumes_frios\": null,\n \"volumes_comuns\": null\n }\n }\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este campo é obrigatório\" quando algum dos campos obrigatórios não for informado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"data_entrega\",\n \"rule\": \"required\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A compra não foi finalizada, então não será possível fazer devolução\" quando a compra ainda não estiver finalizada. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A compra não foi finalizada, então não será possível fazer devolução\",\n \"field\": \"compra_id\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"O produto Código Erp não possui vinculo com essa compra.\" quando o produto informado para a devolução não estiver na compra. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O produto 112 não possui vinculo com essa compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n },\n {\n \"message\": \"O produto 14185 não possui vinculo com essa compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A compra passou do prazo de 10 dias para devolução.\" quando a compra não estiver dentro do período para devolução. Conforme o exemplo a seguir.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A compra passou do prazo de 10 dias para devolução.\",\n \"field\": \"data_entrega\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A quantidade informada para o produto Código ERP está maior que a da compra.\" quando a quantidade do produto informada for maior da quantidade da compra. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A quantidade informada para o produto 42922 está maior que a da compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"Já existe devolução para o produto 18447 que excede a quantidade desejada.\" quando já existe uma devolução para aquele produto e a quantidade informada for maior que a disponivél para a troca. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Já existe devolução para o produto 18447 que excede a quantidade desejada.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A data de entrega não pode ser anterior a atual\" quando a data de entrega for menor que a data atual. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A data de entrega não pode ser anterior a atual\",\n \"field\": \"data_entrega\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"O motivo 7 para o produto 4149 não é válido para devolução\" quando o ID do motivo informado for diretente de 4,5 ou 6. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O motivo 7 para o produto 4149 não é válido para devolução\",\n \"field\": \"motivo_id\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"url":"{{URL}}/importacao/pedidos/{{ID_COMPRA}}/devolucoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar as devoluções de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_COMPRA/devolucoes
\nPara consultar devoluções de uma compra é necessário enviar uma requisição GET informando o ID da compra na URL.
Na URL da requisição é obrigatório informar o ID da compra a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/pedidos/{{ID_COMPRA}}/devolucoesExemplo de ID_COMPRA:
\n105
Atenção: Caso a compra não tenha devolução será retornado vazio no campo data
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1667,\n \"centro_distribuicao_id\": 2,\n \"filial_id\": 1,\n \"compra_status_id\": 9,\n \"tipo_entrega_id\": 2,\n \"cliente_id\": 287,\n \"endereco_id\": 287,\n \"usuario_id\": null,\n \"api_usuario_id\": null,\n \"cnpj_gerador_pedido\": null,\n \"foreign_key\": null,\n \"parent_id\": 750,\n \"data_entrega\": \"2021-09-10T13:00:00-03:00\",\n \"data_entregue\": null,\n \"data_faturamento\": null,\n \"faturamento\": true,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": null,\n \"prevenda\": true,\n \"numero_prevenda\": null,\n \"frete\": 0,\n \"valor_inicial\": 19.59,\n \"valor_desconto\": 0,\n \"tipo_reposicao\": \"Cupom\",\n \"observacoes_do_cliente\": \"Campo de observações\",\n \"observacoes_do_atendimento\": null,\n \"observacoes_na_entrega\": null,\n \"intervalo\": 0,\n \"qtd_itens\": 1,\n \"qtd_produtos\": 1,\n \"valor_produtos\": 19.59,\n \"retirada_loja\": false,\n \"notificacao_retirada\": 0,\n \"antifraude_session_id\": null,\n \"score_priorizacao\": null,\n \"informacoes_cashback\": null,\n \"desconto_aplicado\": false,\n \"created\": \"2021-09-09T09:38:00-03:00\",\n \"modified\": \"2021-09-09T09:38:00-03:00\",\n \"centro_distribuicao\": {\n \"id\": 2,\n \"vipcommerce_centro_distribuicao_id\": 2,\n \"nome\": \"CD dois\",\n \"cnpj\": \"56246832000147\",\n \"inscricao_estadual\": \"464938228\",\n \"endereco_cep\": \"8833048\",\n \"endereco_logradouro\": \"Avenida Brasil\",\n \"endereco_numero\": \"123\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Centro\",\n \"endereco_cidade\": \"Balneário Camboriú\",\n \"endereco_estado\": \"SC\",\n \"relacionamento_telefone\": \"\",\n \"relacionamento_whatsapp\": \"\",\n \"relacionamento_link_whatsapp\": false,\n \"relacionamento_mensagem_whatsapp\": null,\n \"relacionamento_email\": \"\",\n \"limite_itens_carrinho\": null,\n \"tipo_exibicao_retirada\": 2,\n \"observacao_retirada\": \"Campo de Observação\",\n \"remover_mascara_telefones\": false\n },\n \"codigo\": \"D-1667\",\n \"status\": \"Em atendimento\",\n \"valor_final\": 19.59,\n \"tipo_pedido\": \"Devolução\",\n \"volumes_frios\": null,\n \"volumes_comuns\": null\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 11,\n \"limit\": null\n }\n}\nPermite consultar informações vinculadas a um pedido.
\nAtenção ao consultar pedidos em processo (compras ainda não finalizadas), informações dos produtos podem retornar valores desatualizados, pois as compras estão em constante atualização.
\nPara consultar os produtos de um pedido, recomendamos realizar a consulta especifica em produtos
\n","event":[{"listen":"prerequest","script":{"id":"fd3673af-2304-4a72-9c6a-8d441f8e16ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b739308e-9008-49da-9b18-e32b359fd6fe","type":"text/javascript","exec":[""]}}],"_postman_id":"40737979-3988-4b9e-a973-54616f52da17"},{"name":"Troca","item":[{"name":"Criar troca","id":"598f00ac-f946-443d-b1d6-d40ef62bdb6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"×\n\n {\n \"tipo_entrega_id\": 2,\n \"data_entrega\": \"2021-09-15 13:00:00\",\n \"compra_produtos\": [\n {\n \"codigo_erp\": 10298,\n \"quantidade\": 1,\n \"motivo_id\": 1\n },\n {\n \"codigo_erp\": 2868,\n \"quantidade\": 2,\n \"motivo_id\": 2\n }\n ]\n }","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/pedidos/{{ID_COMPRA}}/trocas","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite criar um troca.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{ID_COMPRA}}/trocas
\nAtenção só será possível realizar a troca de uma compra quando ela estiver dentro do prazo permitido. O prazo é configurado em Preferências no Back-Office.
\nAtenção quando a troca for criada ela irá aparecer no Back-Office com a letra \"T\" no início do número do pedido. Exemplo do número do pedido: T-1692
\nPara criar uma troca é necessário enviar uma requisição POST informando o ID da Compra que se deseja para fazer a troca na URL. No corpo body da requisição será necessário informar os dados da troca (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| tipo_entrega_id | \nID do tipo de entrega. Atenção: Caso não informado será considerado o tipo de entrega da compra | \n Não | \n
| data_entrega | \nData de entrega da troca. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2021-09-15 13:00:00 | \n Sim | \n
| compra_produtos | \nArray de produtos da troca. | \nSim | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto | \nSim | \n
| quantidade | \nQuantidade de itens deste produto. | \nSim | \n
| motivo_id | \nMotivo da troca desse produto. Valores possivéis: 1 - Produto danificado 2 - Produto Impróprio para consumo 3 - Produto com validade expirada | \n Sim | \n
\n {\n \"tipo_entrega_id\": 2,\n \"data_entrega\": \"2021-09-15 13:00:00\",\n \"compra_produtos\": [\n {\n \"codigo_erp\": 10298,\n \"quantidade\": 1,\n \"motivo_id\": 1\n },\n {\n \"codigo_erp\": 2868,\n \"quantidade\": 2,\n \"motivo_id\": 2\n }\n ]\n }\n\n\nSerá retornado o código de status 201 Created e a propriedade data.id com o ID da troca criada, quando a troca for criada com sucesso. A seguir é exibido um exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Troca efetuada com sucesso\",\n \"entity\": {\n \"parent_id\": 1691,\n \"compra_status_id\": 9,\n \"cliente_id\": 720,\n \"endereco_id\": 727,\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 1,\n \"retirada_loja\": true,\n \"tipo_entrega_id\": 2,\n \"valor_inicial\": 19.57,\n \"observacoes_do_cliente\": null,\n \"data_entrega\": \"2021-09-15T13:00:00-03:00\",\n \"api_usuario_id\": \"5f8dbc0e-8d90-46ff-bb99-503bac32005b\",\n \"tipo_fiscal\": \"CF\",\n \"qtd_itens\": 3,\n \"qtd_produtos\": 2,\n \"compra_produtos\": [\n {\n \"produto_id\": 6976,\n \"preco_venda\": 4.79,\n \"compra_produto_status_id\": 1,\n \"compra_id\": 1692,\n \"id\": 215731,\n \"codigo_barras\": \"7891025699873\",\n \"codigo_erp\": 10298,\n \"quantidade_informada\": 1,\n \"preco_total\": 4.79,\n \"quantidade\": 1\n },\n {\n \"produto_id\": 1001,\n \"preco_venda\": 7.39,\n \"compra_produto_status_id\": 1,\n \"compra_id\": 1692,\n \"id\": 215732,\n \"codigo_barras\": \"7896275960605\",\n \"codigo_erp\": 2868,\n \"quantidade_informada\": 1,\n \"preco_total\": 7.39,\n \"quantidade\": 1\n },\n {\n \"produto_id\": 1001,\n \"preco_venda\": 7.39,\n \"compra_produto_status_id\": 1,\n \"compra_id\": 1692,\n \"id\": 215733,\n \"codigo_barras\": \"7896275960605\",\n \"codigo_erp\": 2868,\n \"quantidade_informada\": 1,\n \"preco_total\": 7.39,\n \"quantidade\": 1\n }\n ],\n \"compra_pagamentos\": [\n {\n \"forma_pagamento_id\": 1,\n \"parcelas\": 1,\n \"valor\": 19.57,\n \"confirmado\": true,\n \"compra_id\": 1692,\n \"created\": \"2021-09-14T17:38:44-03:00\",\n \"modified\": \"2021-09-14T17:38:44-03:00\",\n \"id\": 1705,\n \"descricao\": \"Dinheiro\",\n \"number_bin_decrypt\": null,\n \"pagamento_entrega\": true\n }\n ],\n \"created\": \"2021-09-14T17:38:44-03:00\",\n \"modified\": \"2021-09-14T17:38:44-03:00\",\n \"id\": 1692,\n \"codigo\": \"T-1692\",\n \"status\": \"Em atendimento\",\n \"valor_final\": 19.57,\n \"tipo_pedido\": \"Troca\",\n \"volumes_frios\": null,\n \"volumes_comuns\": null\n },\n \"warnings\": []\n }\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"Este campo é obrigatório\" quando algum dos campos obrigatórios não for informado. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Este campo é obrigatório\",\n \"field\": \"data_entrega\",\n \"rule\": \"required\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A compra não foi finalizada, então não será possível fazer troca\" quando a compra ainda não estiver finalizada. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A compra não foi finalizada, então não será possível fazer troca\",\n \"field\": \"compra_id\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"O produto Código Erp não possui vinculo com essa compra.\" quando o produto informado para a troca não estiver na compra. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O produto 112 não possui vinculo com essa compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n },\n {\n \"message\": \"O produto 14185 não possui vinculo com essa compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A compra passou do prazo de 09 dias para troca.\" quando a compra não estiver dentro do período para troca. Conforme o exemplo a seguir.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A compra passou do prazo de 09 dias para troca.\",\n \"field\": \"data_entrega\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A quantidade informada para o produto Código ERP está maior que a da compra.\" quando a quantidade do produto informada for maior da quantidade da compra. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A quantidade informada para o produto 42922 está maior que a da compra.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"Já existe troca para o produto 18447 que excede a quantidade desejada.\" quando já existe uma troca para aquele produto e a quantidade informada for maior que a disponível para a troca. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"Já existe troca para o produto 18447 que excede a quantidade desejada.\",\n \"field\": \"compra_produtos\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"A data de entrega não pode ser anterior a atual\" quando a data de entrega for menor que a data atual. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"A data de entrega não pode ser anterior a atual\",\n \"field\": \"data_entrega\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nSerá retornado o código de status 400 Bad Request e a mensagem \"O motivo 7 para o produto 4149 não é válido para troca\" quando o ID do motivo informado for diretente de 1,2 ou 3. A seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"message\": \"Ocorreu um erro\",\n \"errors\": [\n {\n \"messages\": [\n {\n \"message\": \"O motivo 7 para o produto 4149 não é válido para troca\",\n \"field\": \"motivo_id\",\n \"rule\": \"invalid\"\n }\n ]\n }\n ]\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"url":"{{URL}}/importacao/pedidos/{{ID_COMPRA}}/trocas","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar as trocas de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{ID_COMPRA}}/trocas
\nPara consultar trocas de uma compra é necessário enviar uma requisição GET informando o ID da compra na URL.
Na URL da requisição é obrigatório informar o ID da compra a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/pedidos/{{ID_COMPRA}}/trocasExemplo de ID_COMPRA:
\n1691
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1692,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"compra_status_id\": 9,\n \"tipo_entrega_id\": 2,\n \"cliente_id\": 720,\n \"endereco_id\": 727,\n \"usuario_id\": null,\n \"api_usuario_id\": \"5f8dbc0e-8d90-46ff-bb99-503bac32005b\",\n \"cnpj_gerador_pedido\": null,\n \"foreign_key\": null,\n \"parent_id\": 1691,\n \"data_entrega\": \"2021-09-15T13:00:00-03:00\",\n \"data_entregue\": null,\n \"data_faturamento\": null,\n \"faturamento\": false,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": null,\n \"prevenda\": false,\n \"numero_prevenda\": null,\n \"frete\": 0,\n \"valor_inicial\": 19.57,\n \"valor_desconto\": 0,\n \"observacoes_do_cliente\": null,\n \"observacoes_do_atendimento\": null,\n \"observacoes_na_entrega\": null,\n \"intervalo\": 0,\n \"qtd_itens\": 3,\n \"qtd_produtos\": 2,\n \"valor_produtos\": 19.57,\n \"retirada_loja\": true,\n \"notificacao_retirada\": 0,\n \"antifraude_session_id\": null,\n \"score_priorizacao\": null,\n \"informacoes_cashback\": null,\n \"desconto_aplicado\": false,\n \"created\": \"2021-09-14T17:38:44-03:00\",\n \"modified\": \"2021-09-14T17:38:44-03:00\",\n \"centro_distribuicao\": {\n \"id\": 1,\n \"vipcommerce_centro_distribuicao_id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"00000000000000\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"00000000\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\",\n \"relacionamento_telefone\": \"\",\n \"relacionamento_whatsapp\": \"\",\n \"relacionamento_link_whatsapp\": false,\n \"relacionamento_mensagem_whatsapp\": \"\",\n \"relacionamento_email\": \"\",\n \"limite_itens_carrinho\": 11,\n \"tipo_exibicao_retirada\": 1,\n \"observacao_retirada\": \"\",\n \"remover_mascara_telefones\": false\n },\n \"codigo\": \"T-1692\",\n \"status\": \"Em atendimento\",\n \"valor_final\": 19.57,\n \"tipo_pedido\": \"Troca\",\n \"volumes_frios\": null,\n \"volumes_comuns\": null\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\nPermite consultar informações vinculadas a um pedido.
\nAtenção ao consultar pedidos em processo (compras ainda não finalizadas), informações dos produtos podem retornar valores desatualizados, pois as compras estão em constante atualização.
\nPara consultar os produtos de um pedido, recomendamos realizar a consulta especifica em produtos
\n","event":[{"listen":"prerequest","script":{"id":"0d5bcd26-9774-431c-8ab7-9554a86a5cf3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4bcceede-717c-4578-a540-babc925cc429","type":"text/javascript","exec":[""]}}],"_postman_id":"f0c1891e-4ddb-40cf-805e-08069a433485"},{"name":"Pedido-Produtos","item":[{"name":"Listar produtos do pedido","id":"4ba06c35-6998-4cd1-836a-c343a3285217","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/pedidos/{{ID_PEDIDO}}/pedido-produtos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os produtos vinculados a um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/pedido-produtos
\nPara consultar os produtos de um pedido é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL, podendo ou não informar parametros na URL.
Ao consultar compras que possuam produtos clone, o código ERP será retornado do produto \"pai\".
\nCaso os itens de um produto tenham sido separados na separação com pesagens diferenciadas, eles serão listados por grupos conforme o peso. Ou seja, caso haja pesos diferentes, haverá objetos diferentes mesmo que seja para o mesmo produto. Isso ocorre pois, quando o item possui um peso diferente lido na separação, o seu preço é recalculado.
\nOs parametros permitidos são
\nPara visualizar a descrição do ID retornado na propriedade \"compra_produto_status_id\", clique aqui
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ \n {\n \"id\": 3578271,\n \"produto_id\": 2274,\n \"compra_produto_status_id\": 13,\n \"preco_venda\": 1.39,\n \"preco_total\": 1.39,\n \"unidade\": 1,\n \"brinde\": false,\n \"enviar_prevenda\": true,\n \"quantidade\": 1,\n \"codigo_barras\": \"0000000000537\",\n \"codigo_erp\": 537,\n \"quantidade_informada\": 1,\n \"unidade_diferente\": 1,\n \"status\": \"Separado\"\n }\n ],\n pagination: { \n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 4,\n limit: null \n } \n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os produtos vinculados a um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/pedido-produtos/detalhes
\nPara consultar os produtos de um pedido é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Ao consultar compras que possuam produtos clone, o código ERP será retornado do produto \"pai\".
\nPara visualizar a descrição do ID retornado na propriedade \"compra_produto_status_id\", clique aqui
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: [ \n {\n \"id\": 3578271,\n \"produto_id\": 2274,\n \"compra_produto_status_id\": 13,\n \"preco_venda\": 1.39,\n \"preco_total\": 1.39,\n \"unidade\": 1,\n \"brinde\": false,\n \"enviar_prevenda\": true,\n \"quantidade\": 1,\n \"usuario_separacao_id\": 1,\n \"codigo_barras\": \"0000000000537\",\n \"codigo_erp\": 537,\n \"quantidade_informada\": 1,\n \"unidade_diferente\": 1,\n \"status\": \"Separado\"\n },\n {\n \"id\": 9538,\n \"produto_id\": 3841,\n \"compra_produto_status_id\": 1,\n \"preco_venda\": 11.85,\n \"preco_total\": 11.85,\n \"unidade\": 1,\n \"brinde\": false,\n \"enviar_prevenda\": true,\n \"quantidade\": 1,\n \"usuario_separacao_id\": 1,\n \"codigo_barras\": \"7896685200773\",\n \"codigo_erp\": 182041,\n \"quantidade_informada\": 1,\n \"unidade_diferente\": 1,\n \"status\": \"Normal\"\n }\n ],\n pagination: { \n page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 4,\n limit: null \n } \n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar produtos de um pedido por status do produto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/produtos-status/ID_STATUS
\nPara listar os produtos de um pedido por status é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido e o ID do status na URL.
Para visualizar a descrição do ID retornado na propriedade \"compra_produto_status_id\", clique aqui
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 24108,\n \"produto_id\": 46484,\n \"compra_produto_status_id\": 5,\n \"preco_venda\": 79.9,\n \"preco_total\": 79.9,\n \"unidade\": 1,\n \"brinde\": false,\n \"enviar_prevenda\": true,\n \"quantidade\": 1,\n \"codigo_barras\": \"7898924935057\",\n \"codigo_erp\": 71345,\n \"quantidade_informada\": 1,\n \"unidade_diferente\": 1,\n \"status\": \"Liberado\"\n },\n {\n \"id\": 24109,\n \"produto_id\": 47161,\n \"compra_produto_status_id\": 5,\n \"preco_venda\": 44.9,\n \"preco_total\": 44.9,\n \"unidade\": 1,\n \"brinde\": false,\n \"enviar_prevenda\": true,\n \"quantidade\": 1,\n \"codigo_barras\": \"7891149107797\",\n \"codigo_erp\": 74955,\n \"quantidade_informada\": 1,\n \"unidade_diferente\": 1,\n \"status\": \"Liberado\"\n }\n ]\n}\nSerá retornado o código de status 500 Internal Server Error quando o ID do status for inválido. A seguir é exibido a mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Ocorreu um erro interno.\",\n \"url\": \"/importacao/pedidos/476/produtos-status/800\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"Exception\",\n \"code\": 0,\n \"message\": \"Status inválido\"\n }\n }\n}\nMódulo de consulta dos produtos de um pedido específico.
\nRetornará uma listagem dos produtos da compra requisitada.
\nDescrição do ID retornado na propriedade \"compra_produto_status_id\":
\n| ID | \nDescrição | \n
|---|---|
| 1 | \nNormal - Estado inicial do produto. Padrão. | \n
| 2 | \nBloqueado - Um usuário iniciou a separação de uma compra com esse produto ou o item foi bipado no empacotamento | \n
| 3 | \nPendente - Item ausente na separação ou empacotamento, pendência relatada pelo operador | \n
| 4 | \nExcluído - Item removido da compra | \n
| 5 | \nLiberado - Item disponível para entrega. Empacotamento finalizado. | \n
| 6 | \nTroca / Devolução - Item será devolvido ou trocado. O pedido é uma troca/devolução. | \n
| 10 | \nChecado - Item separado e confirmado na separação. | \n
| 11 | \nValidado - Item separado e com data de validade correta na separação | \n
| 12 | \nPendência - Item ausente na separação ou empacotamento, pendência realatada pelo operador | \n
| 13 | \nSeparado - Item separado durante o processo de separação. | \n
Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/pedidos/{{ID_PEDIDO}}/pedido-pagamentos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os pagamentos vinculados a uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/pedido-pagamentos
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por desativados:
\n{{URL}}/importacao/pedidos/ID_PEDIDO/pedido-pagamentos/?desativado=0
Para consultar os pagamentos é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 16,\n \"compra_id\": 1000015,\n \"forma_pagamento_id\": 2,\n \"parcelas\": 1,\n \"valor\": 136.32,\n \"juros\": 0,\n \"capturado\": false,\n \"confirmado\": false,\n \"adicionado\": false,\n \"desativado\": false,\n \"created\": \"2020-05-23T11:46:48-03:00\",\n \"modified\": \"2020-05-23T11:46:48-03:00\",\n \"descricao\": \"Visa Crédito\",\n \"parametro_faturamentos\": [],\n \"detalhe_pagamento\": {\n \"descricao\": \"Visa Crédito\",\n \"bandeira\": \"visa\",\n \"tid\": \"0523114648555\",\n \"data\": \"2020-05-23T11:46:48-03:00\",\n \"chave\": \"9a117f26-8223-4094-b850-1e7b27cb0374\",\n \"componente\": \"CieloEcommerce\",\n \"observacoes\": \"4 - Operation Successful.\",\n \"nsu\": null,\n \"autorizacao\": null,\n \"nome\": \"teste\",\n \"cpf\": \"11111111111\",\n \"bin\": \"111111xxxxxx1111\",\n \"validade\": \"03 22\",\n \"data_autorizacao\": \"2020-05-23T11:46:48-03:00\",\n \"data_captura\": null,\n \"cv\": \"76902620\"\n },\n \"pagamento_entrega\": false\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite capturar pagamento pré-pago da compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/faturamento/captura
\nAtenção é permitido capturar apenas 1 (uma) vez o pagamento pré-pago de compras ainda não capturadas.
\nAtenção é permitido capturar apenas pagamento em compras nas etapas: 'Aguardando faturamento' e 'Em faturamento'. Caso a compra esteja em qualquer outra etapa o pagamento não será capturado.
\nAtenção caso o pagamento pré-pago seja removido da compra o pagamento não será capturado.
\nPara capturar um pagamento pré-pago é necessário enviar uma requisição POST, informando na URL o ID da compra .
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"O Pagamento foi capturado com sucesso\"\n }\n}\nSerá retornado o código de status 400 Bad request com a mensagem \"Pagamento não pode ser capturado\", quando a compra não estiver nas etapas: 'Aguardando faturamento' ou 'Em faturamento', quando o pagamento pré-pago já tiver sido capturado ou tiver sido removido da compra.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Pagamento não pode ser capturado\"\n }\n}\nMódulo de consulta do(s) pagamento(s) de um pedido específico.\nRetornará informações a respeito do(s) pagamento(s) vinculado(s) à compra.
\n","event":[{"listen":"prerequest","script":{"id":"8a581b71-bb53-4b35-990d-4ec450968b37","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d8947e66-85ac-4c2d-94bd-b3e07365a8a8","type":"text/javascript","exec":[""]}}],"_postman_id":"02f9a824-cda3-4e2b-8e81-eb76b270b638"},{"name":"Pedido-Documento fiscal","item":[{"name":"Consultar documento fiscal do pedido","id":"98c07c5f-057f-4c2e-adf6-5addf74f344c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/pedido-documentos/{{ID_PEDIDO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar o documento fiscal de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedido-documentos/ID_PEDIDO
\nPara consultar o documento fiscal é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1000015,\n \"centro_distribuicao_id\": 1,\n \"foreign_key\": null,\n \"data_entrega\": \"2020-05-23T16:45:00-03:00\",\n \"data_faturamento\": null,\n \"faturamento\": false,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": null,\n \"numero_fiscal_devolucao\": null,\n \"prevenda\": false,\n \"numero_prevenda\": null,\n \"frete\": 0,\n \"valor_inicial\": 138.9,\n \"valor_desconto\": 2.58,\n \"qtd_itens\": 2,\n \"qtd_produtos\": 2,\n \"valor_produtos\": 138.9,\n \"created\": \"2020-05-23T11:42:16-03:00\",\n \"modified\": \"2020-05-23T15:03:03-03:00\",\n \"centro_distribuicao\": {\n \"id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"00000000000000\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"00000000\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\",\n \"tipo_exibicao_retirada\": 3,\n \"observacao_retirada\": \"\"\n },\n \"valor_final\": 136.32,\n \"tipo_pedido\": \"Compra\"\n }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do pedido informando na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/pedido-documentos/1000481',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"numero_fiscal","value":"465320","description":"Exemplo de número fiscal
\n","type":"text"},{"key":"numero_fiscal_devolucao","value":"687620","description":"Exemplo de número fiscal de devolução
\n","type":"text"},{"key":"tipo_fiscal","value":"CF","description":"Tipo de documento fiscal
\n","type":"text"}]},"url":"{{URL}}/importacao/pedidos/{{ID_PEDIDO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite o documento fiscal de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO
\nPara editar o documento fiscal é necessário enviar uma requisição PUT, informando na URL o ID do pedido e o novo número do documento fiscal no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| numero_fiscal | \nNúmero fiscal | \nNão | \n
| numero_fiscal_devolucao | \nNúmero fiscal da devolução. | \nNão | \n
| tipo_fiscal | \nTipo de documento fiscal. Atenção opções aceitas somente em maiúsculo. Opções aceitas: \"CF\" para Cupom fiscal ou \"NF\" para Nota fiscal. | \n Não | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do pedido informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/pedidos/10000',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nMódulo de consulta de documento fiscal de um pedido específico.
\nRetornará informações do documento fiscal vinculado à compra.
\n","event":[{"listen":"prerequest","script":{"id":"516df50c-9e37-4baa-aba2-072222d7874d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3dd59f53-f2e4-4697-bb5e-c3a5fd0908cd","type":"text/javascript","exec":[""]}}],"_postman_id":"ee01197b-44a8-4200-8133-c00569f0ef72"},{"name":"Pedido- Atualizar valor item","item":[{"name":"Atualizar valor do item","id":"8cccf8e8-88ff-45e5-ac0e-97bf742f1ea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"codigo_erp\": 5749,\n \"valor_original\": 8.58,\n \"valor_atualizado\": 7\n },\n {\n \t \"codigo_erp\": 5749,\n \"valor_original\": 8.58,\n \"valor_atualizado\": 7\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/pedidos/{{ID_COMPRA}}/pedido-produtos/edit-all","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite atualizar o valor de itens na compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{ID_COMPRA}}/pedido-produtos/edit-all
\nAtenção caso o produto tenha pesos diferentes porem o mesmo valor na compra, ambos itens serão atualizados.
\nQuando um produto possui preços/pesos diferentes na compra, os itens diferentes são listados separadamente.
\nPara alterar o preço de itens de um produto que estão listados de forma separada, basta enviar o respectivo valor total do item (conforme listagem na API), no campo \"valor_original\".
\nA API reconhecerá o item diferente pelo valor total.\nObservação: Produtos separados com peso acima da unidade configurada ( unidade_diferente maior que unidade ), não possuem alteração de preço, apesar de serem listados separadamente na API. Ao editar, esses itens serão alterados junto à demais itens que possuem o preço original do produto na compra
\nAtenção para atualizar o valor de um item, é necessário que a compra esteja na etapa de faturamento, estar faturada (ter gerado a pré-venda) e não estar capturada, logo uma compra com captura automática não poderá ter o valor de seus itens alterados.
\nAtenção será necessário enviar a propriedade 'compra_produto_id' ou 'codigo_erp' no body da requisição. Ao enviar o ID do produto na compra, apenas o produto cotendo o ID terá o valor alterado. O ID poderá ser consultado nas requisições de listagem de produtos da compra, clique aqui
\nPara editar o valor de um ou mais itens na compra é necessário enviar uma requisição PUT, no corpo body da requisição será necessário informar os dados do item.
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto. | \nNão. Será necessário enviar codigo_erp ou compra_produto_id. | \n
| compra_produto_id | \nID do produto na compra. Consulte o ID nas requisições de listagem de produtos da compra, clique aqui | \nNão. Será necessário enviar codigo_erp ou compra_produto_id. | \n
| valor_original | \nValor total em reais dos itens do produto na compra. Atenção deverá ser utilizado somente ponto como separador decimal. Exemplo: 10.75 | \nSim | \n
| valor_atualizado | \nValor total em reais a ser atualizado para os itens na compra. Atenção deverá ser utilizado somente ponto como separador decimal. Exemplo: 10.75 | \nSim | \n
\n[\n {\n \"codigo_erp\": 3488,\n \"valor_original\": 39.79,\n \"valor_atualizado\": 38\n },\n {\n \"codigo_erp\": 34881,\n \"valor_original\": 45.79,\n \"valor_atualizado\": 38.55\n }\n]\n\n\n\n[\n {\n \"compra_produto_id\": 1488,\n \"valor_original\": 39.79,\n \"valor_atualizado\": 38\n },\n {\n \"compra_produto_id\": 14881,\n \"valor_original\": 45.79,\n \"valor_atualizado\": 38.55\n }\n]\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"codigo_erp\": 3488,\n \"preco_venda\": 38,\n \"preco_total\": 38,\n \"quantidade\": 1\n }\n ],\n \"warnings\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Alteração não permitida\", quando a compra não estiver no status correto. Atenção para atualizar o valor de um item, é necessário que a compra esteja na etapa de faturamento, estar faturada (ter gerado a pré-venda) e não estar capturada, logo uma compra com captura automática não poderá ter o valor de seus itens alterados, abaixo é exibida um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": [],\n \"warnings\": [\n \"Alteração não permitida\"\n ]\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar o score de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_COMPRA/score-priorizacao
\nAtenção Considera-se como maior prioridade os scores em ordem crescente, ou seja, do menor para o maior número. Por exemplo, compras que possuem o score -20 serão prioridades em relação a compras com score 10. Compras com score 10 serão prioridade em relação a compras que não possuem score.
\nAtenção deverá ser enviado no score um valor de -2147483648 até 2147483647.
\nAtenção Não será aceito números decimais ou outros caracteres como vírgulas, pontos e letras. Somente números inteiros poderão ser informados, podendo ser números positivos ou negativos, conforme o exemplo: 10 ou -30.
\nPara cadastrar um score é necessário enviar uma requisição POST informando como parâmetro o ID da compra. No corpo body da requisição será necessário informar o score desejado para a compra.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| score_priorizacao | \nDefine o valor do score para a compra. | \nSim | \n
\n{\n \"score_priorizacao\":300\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request no campo score_priorizacao com a mensagem \"O campo deve ser informado\", quando o score da compra for enviado com caracteres inválidos ou em branco, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"score_priorizacao\": \"O campo deve ser informado\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID \"ID Compra\" informado como parâmetro na URL da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/pedidos/11521456407/score-priorizacao\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar o score de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_COMPRA/score-priorizacao
\nAtenção Considera-se como maior prioridade os scores em ordem crescente, ou seja, do menor para o maior número. Por exemplo, compras que possuem o score -20 serão prioridades em relação a compras com score 10. Compras com score 10 serão prioridade em relação a compras que não possuem score.
\nAtenção deverá ser enviado no score um valor de -2147483648 até 2147483647.
\nAtenção Não será aceito números decimais ou outros caracteres como vírgulas, pontos e letras. Somente números inteiros poderão ser informados, podendo ser números positivos ou negativos, conforme o exemplo: 10 ou -30.
\nPara editar um score é necessário enviar uma requisição POST informando como parâmetro o ID da compra. No corpo body da requisição será necessário informar o score desejado para a compra.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| score_priorizacao | \nDefine o valor do score para a compra. | \nSim | \n
\n{\n \"score_priorizacao\":300\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request no campo score_priorizacao com a mensagem \"O campo deve ser informado\", quando o score da compra for enviado com caracteres inválidos ou em branco, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"score_priorizacao\": \"O campo deve ser informado\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID \"ID Compra\" informado como parâmetro na URL da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/pedidos/11521456407/score-priorizacao\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite remover o score de uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_COMPRA/score-priorizacao
\nPara remover o score da compra é necessário enviar uma requisição POST informando como parâmetro o ID da compra. No corpo body da requisição será necessário informar o score como vazio.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| score_priorizacao | \nDefine o valor do score para a compra. | \nSim | \n
\n{\n \"score_priorizacao\": \"\"\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request no campo score_priorizacao com a mensagem \"O campo deve ser informado\", quando o score da compra for enviado com caracteres inválidos ou em branco, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"score_priorizacao\": \"O campo deve ser informado\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID \"ID Compra\" informado como parâmetro na URL da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/pedidos/11521456407/score-priorizacao\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de itens por página, clique aqui
\nPermite listar e detalhar as compras.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/detalhes?possui_score_priorizacao=0
\nOs parametros permitidos são
\nExemplos:
\n\n\nPossui Score de Priorizacao:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1ID:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&id=1Tipo de Entrega:\n
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&tipo_entrega_id=4Tipo da Compra:
\n{{URL}}/importacaopedidos/detalhes?possui_score_priorizacao&tipo_compra=NData de entrega:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&data_entrega=2020-06-24Data de entrega inicial:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&data_entrega_incial=2020-06-24Data de entrega final:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&data_entrega_final=2020-06-24Data de entrega inicial e final:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao=1&data_entrega_inicial=2020-06-25&data_entrega_final=2020-06-30Score da Compra:
\n{{URL}}/importacao/pedidos/detalhes?possui_score_priorizacao&score_priorizacao=55
Atenção: Ao não utilizar nenhum parametro (que não seja obrigatório), esta requisição irá retornar todos as compras que possuem score caso o parâmetro possui_score_priorizacao for igual a 1. Irá retornar todas as compras que não possuem score caso o parâmetro possui_score_priorizacao for igual a 0.
\nPara listar os produtos é necessário enviar uma requisição GET, informando 0 ou 1 para o parâmetro possui_score_priorizacao.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção A resposta de sucesso será a mesma para compras com ou sem score. O que diferencia é que na tag score_priorizacao virá com valor diferente de NULL quando o parâmetro possui_score_priorizacao for igual a 1.
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1000079,\n \"compra_status_id\": 12,\n \"qtd_itens\": 4,\n \"endereco_id\": 2,\n \"created\": \"2020-09-15T11:15:49-03:00\",\n \"data_entrega\": \"2020-09-16T13:30:00-03:00\",\n \"score_priorizacao\": null,\n \"endereco\": {\n \"id\": 2,\n \"cep\": \"32235-000\",\n \"titulo\": \"Principal\",\n \"logradouro\": \"Avenida Coronel Benjamim Guimarães\",\n \"numero\": 332,\n \"complemento\": \"fundos\",\n \"bairro\": \"Industrial\",\n \"cidade\": \"Contagem\",\n \"uf\": \"Minas Gerais\",\n \"referencia\": \"pizzaria\"\n },\n \"pagamentos\": [\n {\n \"id\": 76,\n \"descricao\": \"Dinheiro\",\n \"tipo_pagamento\": \"Pos\",\n \"adicionado\": false\n }\n ],\n \"valor_final\": 53.56\n }\n],\n \"pagination\": {\n \"page_count\": 29,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 561,\n \"limit\": null\n }\n}\nSerá possível definir a priorização de compras a partir de um score. As compras poderão ter ou não score definido, na forma de números inteiros positivos ou negativos. A ordem de priorização se baseia na ordem crescente dos scores, sendo prioridades números negativos em relação a números positivos e números positivos em relação a compras sem score. Atenção deverá ser enviado no score um valor de -2147483648 até 2147483647.
\nAs compras com menor score serão consideradas prioridades, seguindo sempre a ordem crescente, conforme exemplo abaixo: \n
Score: -10\n
Score: 3
O score é exibido na visualização das informações do pedido, a seguir é exibido um exemplo de score:
\n
Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar descontos vinculados a uma compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/ID_PEDIDO/pedido-descontos
\nPara listar os descontos vinculados a uma compra é necessário enviar uma requisição GET, informando na URL o ID da compra.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 164,\n \"valor\": 16,\n \"tipo\": \"desconto\",\n \"motivo\": \"Desconto para cliente específico\",\n \"motivo_id\": 1,\n \"codigo\": null,\n \"desconto_id\": 1\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nA API de Pedidos é um módulo que permite consultar as compras realizados na loja online.
\nÉ possível consultar via API:\n
Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/filiais","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar todas as filiais cadastradas.
\nPara listar todas as filiais é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Atenção serão listadas apenas filiais cadastradas a partir do DomainKey informado.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"nome\": \"VIPCommerce\",\n \"site_url\": \"https://www.teste.vipcommerce.com.br\"\n },\n {\n \"id\": 2,\n \"nome\": \"Supermercado Online - 2B Teste\",\n \"site_url\": \"https://www.filial_2.vipcommerce.com.br\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\n\n\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"descricao","value":"Descontos via API","description":"Exemplo de motivo
\n","type":"text"}]},"url":"{{URL}}/importacao/cupom-motivos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um motivo de cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-motivos
\nPara cadastrar um motivo de cupom de crédito é necessário enviar uma requisição POST, informando a descrição do motivo no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nNome do motivo. | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Esse valor já está em uso\", quando a descrição do motivo do cupom de crédito já estiver cadastrada, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/cupom-motivos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Esse valor já está em uso' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando a descrição do motivo do cupom de crédito não for informada no corpo body da requisição, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/cupom-motivos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { descricao: 'Este campo é obrigatório' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"descricao","value":"Descontos via API","description":"Exemplo de descrição do motivo
\n","type":"text"}]},"url":"{{URL}}/importacao/cupom-motivos/{{ID_MOTIVO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um motivo de cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-motivos/ID_MOTIVO
\nPara editar um motivo de cupom de crédito é necessário enviar uma requisição PUT, informando a nova descrição do motivo no corpo body e o ID do motivo a ser editado na URL.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do motivo. | \nSim | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do motivo informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/cupom-motivos/51',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-motivos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os motivos de cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-motivos
\nPara listar os motivos é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 1,\n descricao: 'Promoção',\n slug: 'promocao',\n created: '2019-03-21T16:11:56-03:00',\n modified: '2019-03-21T16:11:56-03:00' },\n { id: 2,\n descricao: 'Ressarcimento',\n slug: 'ressarcimento',\n created: '2019-03-21T16:11:56-03:00',\n modified: '2019-03-21T16:11:56-03:00' },\n { id: 3,\n descricao: 'Troca/Devolução',\n slug: 'troca-devolucao',\n created: '2019-03-21T16:11:56-03:00',\n modified: '2019-03-21T16:11:56-03:00' },\n { id: 5,\n descricao: 'Descontos via API',\n slug: 'descontos-via-api',\n created: '2019-06-17T10:30:30-03:00',\n modified: '2019-06-17T10:30:30-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 4,\n limit: null } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-motivos/{{ID_MOTIVO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um motivo de cupom de crédito atraves do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-motivos/ID_MOTIVO
\nPara consultar o motivo é necessário enviar uma requisição GET, sendo necessário informar o ID do motivo na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 5,\n descricao: 'Descontos via API',\n slug: 'descontos-via-api',\n created: '2019-06-17T10:30:30-03:00',\n modified: '2019-06-17T10:30:30-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 4,\n limit: null } \n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do motivo informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/cupom-motivos/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-motivos/{{ID_MOTIVO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um motivo de cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-motivos/ID_MOTIVO
\nPara excluir um motivo é necessário enviar uma requisição DELETE, sendo necessário informar o ID do motivo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do motivo informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/cupom-motivos/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de motivos de cupons de créditos.
\n","event":[{"listen":"prerequest","script":{"id":"5a84d47b-00fd-42c9-95b5-e37b07e0e97c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d42c3c46-5f28-441f-884f-ee8ba3db19ec","type":"text/javascript","exec":[""]}}],"_postman_id":"c721784c-f448-467e-bfa6-383a316e90fc"},{"name":"Cupom de credito","item":[{"name":"Adicionar cupom de credito","id":"ca557e75-6e59-4357-94ab-f6f5549a6e33","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"cupom_motivo_id","value":"1","description":"Exemplo de ID de motivo
\n","type":"text"},{"key":"documento","value":"10403554832","description":"Exemplo de CPF
\n","type":"text"},{"key":"valor","value":"10.55","description":"Exemplo de valor do cupom
\n","type":"text"},{"key":"validade","value":"2018-12-22 00:00:01","description":"Exemplo de data de validade do cupom
\n","type":"text"},{"key":"observacoes","value":"Ressarcimento","description":"Exemplo de observação do cupom
\n","type":"text"}]},"url":"{{URL}}/importacao/cupom-creditos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-creditos
\nPara cadastrar um cupom de crédito é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do cupom (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| cupom_motivo_id | \nID do motivo do cupom de crédito. | \nSim | \n
| documento | \nDocumento (CPF ou CNPJ) a ser vinculado ao cupom de crédito. Atenção documento aceito com ou sem formatação. | \n Sim | \n
| valor | \nValor do cupom de crédito. Atenção deverá ser utilizado somente ponto como separador decimal. | \n Sim | \n
| validade | \nDefine a data limite de utilização do cupom de crédito. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| observacoes | \nObservações vinculada ao cupom de crédito. | \nNão | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 5 }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo cupom_motivo_id com a mensagem \"Este valor não existe\", quando o ID do motivo informado no corpo body da requisição não estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/cupom-creditos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { cupom_motivo_id: 'Este valor não existe' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity no campo validade com a mensagem \"O valor fornecido é inválido\", quando o formato da data informado no corpo body não estiver no padrão: YYYY-MM-DD HH:MM:SS . Exemplo: 2018-04-01 00:01:01, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/cupom-creditos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { validade: 'O valor fornecido é inválido' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando um ou mais campos obrigatorios não forem informados no requisição, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/cupom-creditos',\n message: '3 erros de validação ocorridos',\n errorCount: 3,\n errors:\n { cupom_motivo_id: 'Este campo é obrigatório',\n valor: 'Este campo é obrigatório',\n validade: 'Este campo é obrigatório' } }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"cupom_motivo_id\": 1,\n \"documento\": \"10403554835\",\n \"valor\": 10.90,\n \"validade\": \"2018-12-22 00:00:01\",\n \"observacoes\": \"Ressarcimento\"\n },\n {\n \t\"cupom_motivo_id\": 1,\n \"documento\": \"81621852245\",\n \"valor\": 10.90,\n \"validade\": \"2018-12-22 00:00:01\",\n \"observacoes\": \"Ressarcimento\"\n },\n {\n \t\"cupom_motivo_id\": 1,\n \"documento\": \"08364611000120\",\n \"valor\": 10.90,\n \"validade\": \"2018-12-22 00:00:01\",\n \"observacoes\": \"Ressarcimento\"\n }\n \n]\n\n"},"url":"{{URL}}/importacao/cupom-creditos/add-all","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-creditos/add-all
\nAtenção é permitido cadastrar um total de 1000 (mil) registros por requisição. Caso a quantidade ultrapasse esta quantidade recomendamos dividir as requisições cada uma contendo no máximo 1000 (mil) registros.
\nPara cadastrar um cupom de crédito é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do cupom (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| cupom_motivo_id | \nID do motivo do cupom de crédito. | \nSim | \n
| documento | \nDocumento (CPF ou CNPJ) a ser vinculado o cupom de crédito. Atenção documento aceito com ou sem formatação. | \n Sim | \n
| valor | \nValor do cupom de crédito. Atenção deverá ser utilizado somente ponto como separador decimal. | \n Sim | \n
| validade | \nDefine a data limite de utilização do cupom de crédito. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| observacoes | \nObservações vinculada ao cupom de crédito. | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { ids: [ 75, 76 ] }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-creditos/?documento=10403554237","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar cupons de créditos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupons-creditos/?documento=10503154638
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por documento:
\n{{URL}}/importacao/cupons-creditos/?documento=10503154638Busca por cliente_id:
\n{{URL}}/importacao/cupons-creditos/?cliente_id=16Busca por compra_id:
\n{{URL}}/importacao/cupons-creditos/?compra_id=1000589Busca por id:
\n{{URL}}/importacao/cupons-creditos/?id=21
Para listar os cupons de créditos é necessário enviar uma requisição GET.
{\n success: true,\n data:\n [ { id: 72,\n usuario_id: null,\n cupom_motivo_id: 1,\n cliente_id: null,\n compra_origem_id: null,\n compra_id: null,\n documento: '03828743000142',\n codigo: '5d0410603faa7',\n valor: 10.9,\n validade: '2018-12-22T00:00:01-02:00',\n observacoes: 'cupom de credito via script',\n utilizado: false,\n created: '2019-06-14T18:23:44-03:00',\n modified: '2019-06-14T18:23:44-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-creditos/{{ID_CUPOM}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um de cupom de crédito através do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-creditos/ID_CUPOM
\nPara consultar um cupom de crédito é necessário enviar uma requisição GET, sendo necessário informar o ID do cupom na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n { id: 23,\n usuario_id: null,\n cupom_motivo_id: 1,\n cliente_id: 103,\n compra_origem_id: null,\n compra_id: 1000338,\n documento: '51745708502',\n codigo: '5ce40b1ab3e18',\n valor: 1,\n validade: '2019-05-22T11:27:28-03:00',\n observacoes: 'Observação de cupom de credito 3',\n utilizado: true,\n created: '2019-05-21T11:28:42-03:00',\n modified: '2019-05-21T11:28:42-03:00' } \n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do motivo informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/cupom-motivos/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/cupom-creditos/{{ID_CUPOM}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um cupom de crédito.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/cupom-creditos/ID_CUPOM
\nPara excluir um cupom é necessário enviar uma requisição DELETE, sendo necessário informar o ID do cupom na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do cupom informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/cupom-creditos/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de cupons de créditos para clientes.
\n","event":[{"listen":"prerequest","script":{"id":"0df480bb-006a-439a-b354-8922795581bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d3f28bbf-1450-435e-bbbe-aa1bf92ecb93","type":"text/javascript","exec":[""]}}],"_postman_id":"05a8c248-e0dd-4451-bf9f-f97acfd1f19f"},{"name":"Codigo promocional","item":[{"name":"Adicionar código promocional","id":"d1484872-7cdc-4733-9e90-a63d45976f10","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[{"key":"filial_id","value":"1","description":"Exemplo de ID da filial
\n","type":"text"},{"key":"tipo_desconto_id","value":"7","description":"ID do tipo de desconto
\n","type":"text"},{"key":"tipo_dispositivo","value":"T","description":"Exemplo de tipo de dispositivo
\n","type":"text"},{"key":"codigo","value":"vipcommerce","description":"Exemplo de código promocional
\n","type":"text"},{"key":"quantidade_compras","value":"3","description":"Exemplo de limite de compras para um mesmo cliente
\n","type":"text"},{"key":"quantidade_geral_compras","value":"10","description":"Exemplo de quantidade limite de utilização do codigo
\n","type":"text"},{"key":"valor","value":"5.50","description":"Exemplo de valor do código promocional
\n","type":"text"},{"key":"data_inicial","value":"2019-08-10 13:35:00","description":"Exemplo de data inicial
\n","type":"text"},{"key":"data_final","value":"2019-08-10 18:35:00","description":"Exemplo de data final
\n","type":"text"},{"key":"tipo_cliente","value":"AM","description":"Exemplo de tipo de cliente
\n","type":"text"},{"key":"desconto","value":"V","description":"Exemplo de tipo de desconto. Valor ou Porcentagem
\n","type":"text"},{"key":"primeira_compra","value":"false","description":"Exemplo de definição de primeira compra
\n","type":"text"}]},"url":"{{URL}}/importacao/descontos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um código promocional.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos
\nAtenção: para cadastrar uma ação de código promocional será necessário enviar o parametro \"tipo_desconto_id\" com o valor 7 (sete).
\nPara cadastrar um código promocional é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do código (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Valor númerico positivo. | \nSim | \n
| tipo_desconto_id | \nID do tipo de desconto. Atenção deverá ser informado o ID: 7 (sete) | \n Sim | \n
| tipo_cliente | \nTipo de cliente ao qual será permitido a aplicação do código. Atenção opções aceitas em maiúsculo ou minusculo Opções aceitas: \"AM\" para Ambos, \"PF\" para Pessoa Fisica ou \"PJ\" para Pessoa Juridica. Valor default: Ambos | \n Não | \n
| tipo_dispositivo | \nDefine em qual tipo de dispositivo o desconto será aplicado. Aplicativo, Site ou Todos. Atenção opções aceitas somente em maiúsculo\n Opções aceitas: A para Aplicativo, S para Site ou T para Todos | \n Sim | \n
| codigo | \nCódigo promocional. Atenção: o código promocional deverá conter apenas letras e números. | \n Sim | \n
| quantidade_compras | \nLimite de vezes em compras diferentes que um mesmo cliente poderá utilizar o código. Valor númerico positivo. | \nNão | \n
| quantidade_geral_compras | \nLimite de compras que o código poderá ser utilizado. Valor númerico positivo. | \nNão | \n
| desconto | \nTipo de desconto a ser aplicado. Valor ou percentual. Atenção opções aceitas somente em maiúsculo \n Opções aceitas: V para Valor ou P para Porcentagem. Valor default: Porcetagem | \n Não | \n
| valor | \nValor do desconto a ser aplicado. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50 | \n Sim | \n
| primeira_compra | \nDefine o desconto será utilizado somente na primeira compra. Opções aceitas:
Valor default: false | \n Não | \n
| valor_minimo_compra | \nDefine o valor minimo da compra para aplicação do desconto. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50. Valor default: 0.00 | \n Não | \n
| data_inicial | \nData inicial de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| data_final | \nData final de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Código utilizado em outra ação de desconto\", quando o código informado no corpo body da requisição já estiver cadastrado em outra ação de desconto, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { codigo: 'Código utilizado em outra ação de desconto' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Tipo de desconto não disponível\", quando o ID do tipo de desconto for diferente de 7 (sete), conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { tipo_desconto_id: 'Tipo de desconto não disponível' } } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Permitido somente letras e números\", quando o código promocional conter caracteres especiais, abaixo é exibido um exemplo do erro.
{ success: false,\n data: \n { code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { codigo: 'Permitido somente letras e números' }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o tipo de dispositivo informado for diferente das opções aceitas. Opções aceitas: Opções aceitas: A para Aplicativo, S para Site ou T para Todos. Atenção: opções aceitas somente em maiusculo. A seguir é exibido um exemplo da mensagem de erro.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors: { tipo_dispositivo: 'O valor fornecido é inválido' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando o ID da filial informado não estiver cadastrado, conforme o exemplo abaixo.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { filial_id: 'Este valor não existe' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o formato da data for diferente do valido. Formato valido: YYYY-MM-DD HH:MM:SS \"2018-04-01 00:01:01\". A seguir é exibido um exemplo da mensagem de erro.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: '3 erros de validação ocorridos',\n errorCount: 3,\n errors: {\n data_inicial: 'O valor fornecido é inválido',\n data_final: 'O valor fornecido é inválido' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data inicial deve ser maior que hoje\", quando a data inicial de vigência for menor que a data atual. A seguir é exibido um exemplo da mensagem de erro.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { data_inicial: 'A data inicial deve ser maior que hoje' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data final deve ser maior que a data inicial\", a data final for igual ou menor que a data inicial. A seguir é exibido um exemplo da mensagem de erro.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: {\n data_final: 'A data final deve ser maior que a data inicial' } }\n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"filial_id\": 1,\n \"tipo_desconto_id\": 12,\n \"tipo_dispositivo\": \"T\",\n \"codigo\": \"CODIGO\",\n \"quantidade_compras\": 3,\n \"quantidade_geral_compras\": 10,\n \"valor\": 5.50,\n \"data_inicial\": \"2021-09-10 13:35:00\",\n \"data_final\": \"2021-09-15 18:35:00\",\n \"tipo_cliente\": \"AM\",\n \"desconto\": \"P\",\n \"primeira_compra\": false,\n \"valor_minimo_compra\": 48.00,\n \"desconto_produtos\": [\n {\n \"codigo_erp\": 6535,\n \"desconto\": 50,\n \"quantidade_maxima\": 2\n },\n {\n \"codigo_erp\": 1076,\n \"desconto\": 43,\n \"quantidade_maxima\": 3\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/descontos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um código promocional por produto(s).
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos
\nAtenção: para cadastrar uma ação de código promocional por produto será necessário enviar o parametro \"tipo_desconto_id\" com o valor 12 (doze).
\nPara cadastrar um código promocional por produto é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do código (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Valor númerico positivo. | \nSim | \n
| tipo_desconto_id | \nID do tipo de desconto. Atenção deverá ser informado o ID: 12 (Doze) | \n Sim | \n
| tipo_dispositivo | \nDefine em qual tipo de dispositivo o desconto será aplicado. Aplicativo, Site ou Todos. Atenção opções aceitas somente em maiúsculo\n Opções aceitas: A para Aplicativo, S para Site ou T para Todos | \n Sim | \n
| codigo | \nCódigo promocional. Atenção: o código promocional deverá conter apenas letras e números. | \n Sim | \n
| quantidade_compras | \nLimite de vezes em compras diferentes que um mesmo cliente poderá utilizar o código. Valor númerico positivo. | \nNão | \n
| quantidade_geral_compras | \nLimite de compras que o código poderá ser utilizado. Valor númerico positivo. | \nNão | \n
| valor | \nValor do desconto a ser aplicado. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50 | \n Sim | \n
| data_inicial | \nData inicial de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| data_final | \nData final de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| tipo_cliente | \nTipo de cliente ao qual será permitido a aplicação do código. Atenção opções aceitas em maiúsculo ou minusculo Opções aceitas: \"AM\" para Ambos, \"PF\" para Pessoa Fisica ou \"PJ\" para Pessoa Juridica. Valor default: Ambos | \n Não | \n
| desconto | \nTipo de desconto a ser aplicado. Valor ou percentual. Atenção opções aceitas somente em maiúsculo \n Opções aceitas: V para Valor ou P para Porcentagem. Valor default: Porcetagem | \n Não | \n
| primeira_compra | \nDefine o desconto será utilizado somente na primeira compra. Opções aceitas:
Valor default: false | \n Não | \n
| valor_minimo_compra | \nDefine o valor minimo da compra para aplicação do desconto. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50. Valor default: 0.00 | \n Não | \n
| desconto_produtos | \nArray de produtos para o código promocional. | \nNão | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto. | \nSim | \n
| desconto | \nValor do desconto. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50. | \n Sim | \n
| quantidade_maxima | \nQuantidade máxima do produto que poderá aplicar o desconto do código promocional. | \nSim | \n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 63\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Código utilizado em outra ação de desconto\", quando o código informado no corpo body da requisição já estiver cadastrado em outra ação de desconto, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"codigo\": \"Código utilizado em outra ação de desconto\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Tipo de desconto não disponível\", quando o ID do tipo de desconto for diferente de 7 (sete), conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_desconto_id\": \"Tipo de desconto não disponível\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Permitido somente letras e números\", quando o código promocional conter caracteres especiais, abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"codigo\": \"Permitido somente letras e números\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o tipo de dispositivo informado for diferente das opções aceitas. Opções aceitas: Opções aceitas: A para Aplicativo, S para Site ou T para Todos. Atenção: opções aceitas somente em maiusculo. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_dispositivo\": \"O valor fornecido é inválido\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando o ID da filial informado não estiver cadastrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"filial_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o formato da data for diferente do valido. Formato valido: YYYY-MM-DD HH:MM:SS \"2018-04-01 00:01:01\". A seguir é exibido um exemplo da mensagem de erro.
{\n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: '3 erros de validação ocorridos',\n errorCount: 3,\n errors: {\n data_inicial: 'O valor fornecido é inválido',\n data_final: 'O valor fornecido é inválido' \n } \n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data inicial deve ser maior que hoje\", quando a data inicial de vigência for menor que a data atual. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_inicial\": \"A data inicial deve ser maior que hoje\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data final deve ser maior que a data inicial\", a data final for igual ou menor que a data inicial. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_final\": \"A data final deve ser maior que a data inicial\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Não foi possível localizar o produto, verifique o campo 'codigo_erp'\", quando o codigo erp de algum produto informado não existir. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_final\": \"A data final deve ser maior que a data inicial\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Para descontos do tipo 12 (Desconto por código promocional por produtos) é necessário informar os produtos no campo 'desconto_produtos'\", quando o campo desconto_produtos não for enviado ou estiver vazio. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_desconto_id\": \"Para descontos do tipo 12 (Desconto por código promocional por produtos) é necessário informar os produtos no campo 'desconto_produtos' \"\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"filial_id","value":"1","description":"Exemplo de ID da filial
\n","type":"text"},{"key":"tipo_desconto_id","value":"7","description":"ID do tipo de desconto
\n","type":"text"},{"key":"tipo_cliente","value":"AM","description":"Exemplo de tipo de cliente
\n","type":"text"},{"key":"tipo_dispositivo","value":"T","description":"Exemplo de tipo de dispositivo
\n","type":"text"},{"key":"codigo","value":"VIPCOMMERCE1","description":"Exemplo de código
\n","type":"text"},{"key":"quantidade_compras","value":"3","description":"Exemplo de limite de utilização para um mesmo cliente
\n","type":"text"},{"key":"quantidade_geral_compras","value":"10","description":"Exemplo de limite maximo de utilização do codigo
\n","type":"text"},{"key":"desconto","value":"V","description":"Exemplo do tipo de desconto. Valor ou Porcentagem
\n","type":"text"},{"key":"valor","value":"15.50","description":"Exemplo de valor do desconto
\n","type":"text"},{"key":"primeira_compra","value":"false","description":"Define se o código será utilizado somente na primera compra
\n","type":"text"},{"key":"valor_minimo_compra","value":"85.00","description":"Exemplo de valor minimo de compra para utilização
\n","type":"text"},{"key":"data_inicial","value":"2018-04-01 00:01:01","description":"Exemplo de data inicial de vigencia
\n","type":"text"},{"key":"data_final","value":"2018-05-01 00:01:01","description":"Exemplo de data final de vigencia
\n","type":"text"}]},"url":"{{URL}}/importacao/descontos/{{ID_CODIGO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um código promocional.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO
\nAtenção: para editar um código promocional é necessário enviar o parametro \"tipo_desconto_id\" com o valor 7 (sete) na requisição.
\nPara editar um código promocional é necessário enviar uma requisição PUT, no corpo body da requisição será necessário informar os dados do código (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Valor númerico positivo. | \nNão | \n
| tipo_desconto_id | \nID do tipo de desconto. Atenção deverá ser informado o ID: 7 (sete) | \n Sim | \n
| tipo_cliente | \nTipo de cliente ao qual será permitido a aplicação do código. Atenção opções aceitas em maiúsculo ou minusculo Opções aceitas: \"AM\" para Ambos, \"PF\" para Pessoa Fisica ou \"PJ\" para Pessoa Juridica. | \n Não | \n
| tipo_dispositivo | \nDefine em qual tipo de dispositivo o desconto será aplicado. Aplicativo, Site ou Todos. Atenção opções aceitas somente em maiúsculo\n Opções aceitas: A para Aplicativo, S para Site ou T para Todos | \n Não | \n
| codigo | \nCódigo promocional. Atenção: o código promocional deverá conter apenas letras e números. | \n Não | \n
| quantidade_compras | \nLimite de vezes em compras diferentes que um mesmo cliente poderá utilizar o código. Valor númerico positivo. | \nNão | \n
| quantidade_geral_compras | \nLimite de compras que o código poderá ser utilizado. Valor númerico positivo. | \nNão | \n
| desconto | \nTipo de desconto a ser aplicado. Valor ou percentual. Atenção opções aceitas somente em maiúsculo Opções aceitas: V para Valor ou P para Porcentagem. | \n Não | \n
| valor | \nValor do desconto a ser aplicado. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50 | \n Não | \n
| primeira_compra | \nDefine o desconto será utilizado somente na primeira compra. Opções aceitas:
| \n Não | \n
| valor_minimo_compra | \nDefine o valor minimo da compra para aplicação do desconto. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50. | \n Não | \n
| data_inicial | \nData inicial de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Não | \n
| data_final | \nData final de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Não | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do código promocional informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/descontos/12',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/?codigo=vipcommerce","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPara detalhes sobre paginação e limite de resultados,
\n\nPermite listar códigos promocionais.
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/?codigo=vipcommerce
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por codigo:
\n{{URL}}/importacao/descontos/?codigo=vipcommerce
Para listar códigos promocionais é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 93,\n filial_id: 1,\n tipo_desconto_id: 10,\n tipo_cliente: null,\n tipo_dispositivo: 'S',\n codigo: 'VIPCOMMERCE',\n quantidade_compras: 12,\n quantidade_geral_compras: null,\n desconto: 'V',\n valor: 10.5,\n primeira_compra: false,\n valor_minimo_compra: 80,\n data_inicial: '2019-08-10T13:35:00-03:00',\n data_final: '2019-08-11T13:33:00-03:00',\n created: '2019-06-18T11:31:11-03:00',\n modified: '2019-06-18T11:31:11-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null } }\n\nID dos Tipos de Descontos
\n| ID | Descrição |
|---|---|
1 | Desconto para cliente específico |
2 | Desconto com base no perfil de cliente |
3 | Desconto na quantidade de itens por produtos |
4 | Desconto na quantidade de itens por compra |
5 | Desconto na quantidade de compras |
6 | Desconto na forma de pagamento |
7 | Desconto por código promocional |
8 | Desconto por categorias de produtos |
9 | Desconto por valor da compra |
10 | Desconto por código promocional via arquivo externo |
11 | Desconto na coleção por código promocional |
12 | Desconto por código promocional por produtos |
Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/{{ID_CODIGO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um código promocional atraves do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO
\nPara consultar um código promocional é necessário enviar uma requisição GET, sendo necessário informar o ID do código na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: {\n id: 93,\n filial_id: 1,\n tipo_desconto_id: 10,\n tipo_cliente: null,\n tipo_dispositivo: 'S',\n codigo: 'VIPCOMMERCE',\n quantidade_compras: 12,\n quantidade_geral_compras: null,\n desconto: 'V',\n valor: 10.5,\n primeira_compra: false,\n valor_minimo_compra: 80,\n data_inicial: '2019-08-10T13:35:00-03:00',\n data_final: '2019-08-11T13:33:00-03:00',\n created: '2019-06-18T11:31:11-03:00',\n modified: '2019-06-18T11:31:11-03:00' }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do código promocional informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/descontos/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n","key":"Accept","value":"application/json"},{"description":"Token de acesso - base64 do username e password
\n","key":"Authorization","value":"Basic {{TOKEN}}"},{"description":"Identificador do dominio
\n","key":"DomainKey","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/descontos/{{ID_CODIGO}}/desconto-produtos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar produtos de um código promocional por produtos através do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO/desconto-produtos
\nPara consultar produtos de um código promocional por produtos é necessário enviar uma requisição GET, sendo necessário informar o ID do código promocional por produtos na URL da requisição.
Atenção se o ID informado não existir ou pertencer a um código promocional que não seja por produtos será retornado um array vazio.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 9,\n \"desconto\": 5,\n \"quantidade_maxima\": 2,\n \"created\": \"2021-08-30T10:19:44-03:00\",\n \"modified\": \"2021-08-30T10:19:44-03:00\",\n \"produto\": {\n \"descricao\": \"Pipoca Nhac 60g Doce\",\n \"codigo_erp\": 1022\n }\n },\n {\n \"id\": 10,\n \"desconto\": 5,\n \"quantidade_maxima\": 2,\n \"created\": \"2021-08-30T10:19:44-03:00\",\n \"modified\": \"2021-08-30T10:19:44-03:00\",\n \"produto\": {\n \"descricao\": \"Doce Abóbora Artesanal Doces 400g Calda\",\n \"codigo_erp\": 27827\n }\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/{{ID_DESCONTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um código promocional.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO
\nPara excluir um código promocional é necessário enviar uma requisição DELETE, informando o ID do código na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do código promocional informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/descontos/84',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de ações de desconto por código promocional.
\nAtenção: para cadastrar uma ação de código promocional será necessário enviar o parametro \"tipo_desconto_id\" com o valor 7 (sete).
\n","event":[{"listen":"prerequest","script":{"id":"d263d46d-fe62-4c22-b4ca-d8eeac5cdc3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96d54da9-64ca-4393-9932-9acc96818383","type":"text/javascript","exec":[""]}}],"_postman_id":"4d87f5bc-04ad-4d27-80dc-04eec923ea73"},{"name":"Codigo promocional exclusivo","item":[{"name":"Adicionar código promocional exclusivo","id":"cdd60143-ce8b-4f05-90ce-61ed9432dfba","request":{"method":"POST","header":[{"key":"Accept","value":"application/json","description":"Tipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"filial_id\": 1,\n \"tipo_desconto_id\": 10,\n \"tipo_dispositivo\": \"S\",\n \"codigo\": \"vipcommerce\",\n \"quantidade_compras\": 12,\n \"desconto\": \"V\",\n \"valor\": 10.50,\n \"primeira_compra\": false,\n \"valor_minimo_compra\": 80.00,\n \"data_inicial\": \"2019-08-10 13:35:00\",\n \"data_final\": \"2019-08-11 13:33:00\",\n \"desconto_exclusivos\": [\n {\"documento\": \"143.662.421-50\"},\n {\"documento\": \"472.170.265-55\"},\n {\"documento\": \"988.388.433-84\"},\n {\"documento\": \"66.705.281/0001-96\"}\n ]\n}"},"url":"{{URL}}/importacao/descontos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um código promocional.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos
\nAtenção: ao enviar um documento invalido no array de \"desconto_exclusivos\", não será possível criar a ação de código promocional, será retornado o código de status: 422 Unprocessable Entity com a mensagem \"O documento informado é inválido\". Em casos assim, recomendamos que crie a ação de desconto sem enviar os documentos inicialmente e vincule os mesmos posteriormente, desta forma iremos retornar um objeto contendo os documentos invalidos, clique aqui para mais informações.
Atenção: o limite maximo permitido é de 1000 (mil) documentos inclusos no array, caso seja necessario enviar uma quantidade superior, recomendamos que crie a ação de desconto sem enviar os documentos inicialmente e vincule os documentos posteriormente enviando os mesmos de 1000 a 1000, clique aqui para mais informações.
\nAtenção: para cadastrar uma ação de código promocional exclusivo será necessário enviar o parametro \"tipo_desconto_id\" com o valor 10 (dez).
\nAtenção: somente os clientes (ou futuros clientes) cujo documento está incluso na ação de desconto, poderão usufruir deste código promocional durante sua vigência.
\nPara cadastrar um código promocional exclusivo é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do código (ver tabela abaixo).
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Valor númerico positivo. | \nSim | \n
| tipo_desconto_id | \nID do tipo de desconto. Atenção deverá ser informado o ID: 10 (dez) | \n Sim | \n
| tipo_cliente | \nTipo de cliente ao qual será permitido a aplicação do código. Atenção opções aceitas em maiúsculo ou minusculo Opções aceitas: \"AM\" para Ambos, \"PF\" para Pessoa Fisica ou \"PJ\" para Pessoa Juridica. Valor default: Ambos | \n Não | \n
| tipo_dispositivo | \nDefine em qual tipo de dispositivo o desconto será aplicado. Aplicativo, Site ou Todos. Atenção opções aceitas somente em maiúsculo\n Opções aceitas: A para Aplicativo, S para Site ou T para Todos | \n Sim | \n
| codigo | \nCódigo promocional. Atenção: o código promocional deverá conter apenas letras e números. | \n Sim | \n
| quantidade_compras | \nLimite de vezes em compras diferentes que um mesmo cliente poderá utilizar o código. Valor númerico positivo. | \nNão | \n
| desconto | \nTipo de desconto a ser aplicado. Valor ou percentual. Atenção opções aceitas somente em maiúsculo \n Opções aceitas: V para Valor ou P para Porcentagem. Valor default: Porcetagem | \n Não | \n
| valor | \nValor do desconto a ser aplicado. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50 | \n Sim | \n
| primeira_compra | \nDefine o desconto será utilizado somente na primeira compra. Opções aceitas:
Valor default: false | \n Não | \n
| valor_minimo_compra | \nDefine o valor minimo da compra para aplicação do desconto. Atenção deverá ser informado somente ponto como separador decimal. Ex: 10.50. Valor default: 0.00 | \n Não | \n
| data_inicial | \nData inicial de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| data_final | \nData final de vigência. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \ndesconto_exclusivos | \nArray contendo os documentos (CPF ou CNPJ) dos clientes que poderão utilizar o código. Atenção: poderá ser enviado os documentos com ou sem formatação. | \n Não | \n\n\n\n
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Código utilizado em outra ação de desconto\", quando o código promocional informado já estiver cadastrado. Verifique a requisição de deletar código promocional, clique aqui. A seguir é exibido um exemplo do erro.
{ success: false,\n data:\n { code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { codigo: 'Código utilizado em outra ação de desconto' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O documento informado é inválido\", quando um ou mais documentos forem invalidos no array de \"desconto_exclusivos\", não será possível criar a ação de código promocional. Em casos assim, recomendamos que crie a ação de desconto sem enviar os documentos inicialmente e vincule os mesmos posteriormente, desta forma iremos retornar um objeto contendo os documentos invalidos, clique aqui para mais informações. A seguir é exibido um exemplo do erro.
{\n success: false,\n data: {\n code: 422,\n url: \"/importacao/descontos\",\n message: \"Ocorreu um erro de validação\",\n errorCount: 1,\n errors: {\n desconto_exclusivos: {\n documento:\n { document: \"O documento informado é inválido\" }\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Tipo de desconto não disponível\", quando o ID do tipo de desconto informado for diferente de 10 (dez). A seguir é exibido um exemplo da mensagem de erro.
{\n success: false,\n data:\n { code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { tipo_desconto_id: 'Tipo de desconto não disponível' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Permitido somente letras e números\", quando o código promocional conter caracteres especiais, abaixo é exibido um exemplo do erro.
{ success: false,\n data: \n { code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { codigo: 'Permitido somente letras e números' }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o valor informado em \"tipo_dispositivo\" for diferente das opções aceitas: A para Aplicativo, S para Site ou T para Todos. Atenção: opções aceitas somente em maiusculo. A seguir é exibido um exemplo do erro.
{\n success: false,\n data:\n { code: 422,\n url: '/importacao/descontos',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors: { tipo_dispositivo: 'O valor fornecido é inválido' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o valor informado em \"desconto\" for diferente das opções aceitas: \"V\" para Valor ou \"P\" para Porcentagem. Atenção: opções aceitas somente em maiusculo. A seguir é exibido um exemplo do erro.
{\n success: false,\n data:\n { code: 422,\n url: '/importacao/descontos',\n message: '2 erros de validação ocorridos',\n errorCount: 2,\n errors: { desconto: 'O valor fornecido é inválido' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data inicial deve ser maior que hoje\", quando a data inicial de vigência for menor que a data atual. Recomendamos que crie a data inicial com 3 minutos posterior a data/hora atual. A seguir é exibido um exemplo da mensagem de erro.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: { data_inicial: 'A data inicial deve ser maior que hoje' } }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data final deve ser maior que a data inicial\", a data final for igual ou menor que a data inicial. A seguir é exibido um exemplo da mensagem de erro.
{ \n success: false,\n data: {\n code: 422,\n url: '/importacao/descontos',\n message: 'Ocorreu um erro de validação',\n errorCount: 1,\n errors: {\n data_final: 'A data final deve ser maior que a data inicial' } }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\"documento\": \"435.840.416-27\"},\n {\"documento\": \"616.257.023-10\"},\n {\"documento\": \"678.522.578-79\"},\n {\"documento\": \"617.763.537-73\"},\n {\"documento\": \"89.614.819/0001-52\"},\n {\"documento\": \"61.877.681/0001-65\"},\n {\"documento\": \"52.525.321/0001-03\"},\n {\"documento\": \"5.119.074/0001-65\"}\n]"},"url":"{{URL}}/importacao/descontos/{{ID_CODIGO}}/desconto-exclusivos/add-all","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar documentos (CPF ou CNPJ) a uma ação de desconto por código promocional exclusivos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO/desconto-exclusivos/add-all
\nAtenção: o limite maximo permitido é de 1000 (mil) documentos inclusos no array. Caso a quantidade ultrapasse esta quantidade recomendamos dividir as requisições cada uma contendo no máximo 1000 (mil) registros.
\nAtenção: somente os clientes (ou futuros clientes) cujo documento está incluso na ação de desconto, poderão usufruir deste código promocional durante sua vigência.
\nPara cadastrar um código promocional é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os documentos que serão vinculados a ação de desconto. (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| documento | \nCPF ou CNPJ a ser vinculado a ação de desconto. Poderá ser enviado documento com ou sem formatação. | \n Sim | \n
\n[\n {documento: \"435.840.416-27\"},\n {documento: \"616.257.023-10\"},\n {documento: \"678.522.578-79\"},\n {documento: \"617.763.537-73\"},\n {documento: \"89.614.819/0001-52\"},\n {documento: \"61.877.681/0001-65\"},\n {documento: \"52.525.321/0001-03\"},\n {documento: \"5.119.074/0001-65\"}\n]\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data:\n { ids:\n [ '0cb42588-b5ea-4572-ba54-7245b5a7d063',\n '4c7b0139-e3a7-4d0f-bc70-c84c57fef7ac',\n 'd1afeabd-4b67-4d57-9f51-2a1a133d4a0b',\n '17698c87-a292-4410-88c6-0dc937930ead',\n 'f4ba661c-da13-49c4-a144-ba4d26b29859',\n '0f3f7699-b37a-412c-b817-b252f7021b9e',\n '66864f10-0ff1-4448-9287-3a61dffa010a',\n '8d7dd195-dde3-4b7a-b7ab-a3914b87be6f' ] }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Record not found in table \"descontos\"\", quando o ID do desconto informado na URL não for encontrado. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos/9700/desconto-exclusivos/add-all\",\n \"message\": \"Informação: 1 erros, 0 advertências. Total criado: 0\",\n \"errorCount\": 1,\n \"errors\": {\n \"435.840.416-27\": \"Record not found in table \\\"descontos\\\"\"\n },\n \"warningsCount\": 0,\n \"warnings\": []\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O documento informado é inválido\", quando o CPF ou CNPJ for inválido. Em \"info.documento\": será exibido o CPF ou CNPJ inválido. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos/97/desconto-exclusivos/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": [\n {\n \"info\": {\n \"documento\": \"435.840.312-27\"\n },\n \"documento\": \"O documento informado é inválido\"\n }\n ]\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O documento informado já está cadastrado\", quando o CPF ou CNPJ já estiver cadastrado no código promocional exclusivo. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/descontos/97/desconto-exclusivos/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": [\n {\n \"info\": {\n \"documento\": \"616.257.023-10\"\n },\n \"documento\": \"O documento informado já está cadastrado\"\n }\n ]\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/{{ID_CODIGO}}/desconto-exclusivos/?documento=61776353773","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar documentos (CPF ou CNPJ) vinculados a uma ação de descontos.
\n\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por documento:
\n{{URL}}/importacao/descontos/ID_CODIGO/desconto-exclusivos/?documento=43584041627
Atenção: ao não informar o parametro documento, todos os documentos vinculados a ação de desconto serão retornados.
\nPara listar os documentos vinculados a uma ação de desconto é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data:\n [ { id: '760930d3-3b2c-412a-b5a5-8be1020ba3a2',\n desconto_id: 93,\n documento: '61776353773',\n created: '2019-06-18T15:51:03-03:00',\n modified: '2019-06-18T15:51:03-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/?codigo=vipcommerce","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar códigos promocionais exclusivos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/?codigo=vipcommerce
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por codigo:
\n{{URL}}/importacao/descontos/?codigo=vipcommerce
Para listar códigos promocionais exclusivos é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data:\n [ { id: 93,\n filial_id: 1,\n tipo_desconto_id: 10,\n tipo_cliente: null,\n tipo_dispositivo: 'S',\n codigo: 'VIPCOMMERCE',\n quantidade_compras: 12,\n quantidade_geral_compras: null,\n desconto: 'V',\n valor: 10.5,\n primeira_compra: false,\n valor_minimo_compra: 80,\n data_inicial: '2019-08-10T13:35:00-03:00',\n data_final: '2019-08-11T13:33:00-03:00',\n created: '2019-06-18T11:31:11-03:00',\n modified: '2019-06-18T11:31:11-03:00' } ],\n pagination:\n { page_count: 1,\n current_page: 1,\n has_next_page: false,\n has_prev_page: false,\n count: 1,\n limit: null } }\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/{{ID_DESCONTO}}/desconto-exclusivos/{{ID_DOCUMENTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um documento vinculado a uma ação de desconto.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_DESCONTO/desconto-exclusivos/ID_DOCUMENTO
\nPara excluir documento vinculado a um código promocional exclusivo é necessário enviar uma requisição DELETE, sendo necessário informar o ID do desconto e ID do documento na URL.
Na URL da requisição é obrigatório informar o ID do documento a ser excluido, conforme no exemplo abaixo:
\nPara verificar o ID do documento, recomendamos que a realize a requisição de listar documentos vinculados a ação de desconto, clique aqui para mais informações.
\n\n\nExemplo de URL:
\n{{URL}}/importacao/descontos/ID_DESCONTO/desconto-exclusivos/ID_DOCUMENTOExemplo de ID_DOCUMENTO:
\n760930d3-3b2c-412a-b5a5-8be1020ba3a2Quantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do desconto e/ou ID do documentos informados na URL não forem encontrados, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/descontos/93/desconto-exclusivos/760930d3-3b2c-412a-b5a5-8be1020ba3a2',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/importacao/descontos/{{ID_DESCONTO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um código promocional exclusivo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/descontos/ID_CODIGO
\nPara excluir um código promocional é necessário enviar uma requisição DELETE, informando o ID do código na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do código promocional informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/descontos/84',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de ações de desconto por código promocional exclusivo.
\nAtenção: para cadastrar uma ação de código promocional exclusivo será necessário enviar o parametro \"tipo_desconto_id\" com o valor 10 (dez).
\nAtenção: somente os clientes (ou futuros clientes) cujo documento está incluso na ação de desconto, poderão usufruir deste código promocional durante sua vigência.
\n","event":[{"listen":"prerequest","script":{"id":"585503b1-fa4a-479a-8ab5-8d85b1199155","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bc40d56-8e37-4f74-ae52-f2b7bde4e925","type":"text/javascript","exec":[""]}}],"_postman_id":"4706565c-b5b4-4287-9c59-8179544be134"},{"name":"Perfis","item":[{"name":"Adicionar perfil","id":"602c6108-ca70-4f52-b79d-d5633c5eac26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\"filial_id\": 1,\n\"descricao\": \"RA\",\n\"detalhamento\": \"Restrição Alimentar\",\n\"perfil_documentos\": [\n {\"documento\": \"06690459004\"},\n {\"documento\": \"42757190008\"},\n {\"documento\": \"02306600023\"},\n {\"documento\": \"03537580000149\"}\n ]\n}"},"url":"{{URL}}/importacao/perfis","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um perfil.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/perfis
\nAtenção: ao informar um CPF ou CNPJ invalido, será adicionado 0 (zeros) a esquerda para completar.\nExemplo: Ao enviar o CPF 104035, o CPF final será: 00000104035
\nAtenção: ao criar um perfil enviando os documentos na requisição, os clientes serão vinculados ao perfil em seguida. Já ao criar um perfil e enviar os documentos posteriormente, os clientes serão vinculados ao perfil no dia seguinte.
\nPara cadastrar um perfil é necessário enviar uma requisição POST, informando os dados do perfil no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| descricao | \nDescrição do perfil. Atenção: maximo de 2 (dois) caracteres. Ex: PF | \n Sim | \n
| detalhamento | \nBreve descrição do perfil. | \nSim | \n
| perfil_documentos | \nDocumentos vinculados ao perfil. CPF ou CNPJ. Atenção: os documentos vinculados ao perfil podem ser cadastrados posteriomente. Atenção: podem ser enviados CPF e CNPJ formatados ou sem formatação. | \n Não | \n
{\n\"filial_id\": 1,\n\"descricao\": \"RA\",\n\"detalhamento\": \"Restrição Alimentar\",\n\"perfil_documentos\": [\n {\"documento\": \"06690459004\"},\n {\"documento\": \"42757190008\"},\n {\"documento\": \"02306600023\"},\n {\"documento\": \"03537580000149\"}\n ]\n}\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true, \n data: { \n id: 44 } \n}\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção o perfil sera cadastrado mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais documentos. Em \"warnings.info.documento\" será retornado o(s) documento(s) inválidos.
{\n \"success\": true,\n \"data\": {\n \"id\": 5\n },\n \"warnings\": [\n {\n \"info\": {\n \"documento\": \"00413142341\"\n },\n \"documento\": \"O documento informado é inválido\"\n }\n ]\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Este campo é obrigatório\", quando um ou mais campos obrigatórios não forem informados. É exibido na resposta, a quantidade de erros de validação em message e os campos obrigatórios em errors, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/perfis\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"descricao\": \"Este campo é obrigatório\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite vincular documentos (CPF ou CNPJ) a perfil.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/perfis/ID_PERFIL/perfil-documentos/add-all
\nAtenção: o limite maximo permitido é de 1000 (mil) documentos inclusos no array. Caso a quantidade ultrapasse esta quantidade recomendamos dividir as requisições cada uma contendo no máximo 1000 (mil) registros.
\nAtenção: ao informar um CPF ou CNPJ invalido, será adicionado 0 (zeros) a esquerda para completar.\nExemplo: Ao enviar o CPF 104035, o CPF final será: 00000104035
\nAtenção: ao criar um perfil enviando os documentos na requisição, os clientes serão vinculados ao perfil em seguida. Já ao criar um perfil e enviar os documentos posteriormente, os clientes serão vinculados ao perfil no dia seguinte.
\nPara vincular documentos a um perfil é necessário enviar uma requisição POST, informando os documentos no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| documento | \nDocumento (CPF ou CNPJ) a ser vinculado ao perfil. Atenção: podem ser enviados CPF e CNPJ formatados ou sem formatação. | \n Sim | \n
[\n {\"documento\": \"03537580000149\"},\n {\"documento\": \"11850212000184\"},\n {\"documento\": \"11365703061\"},\n {\"documento\": \"64023857009\"}\n]\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n success: true,\n data: \n { ids: [\n 'd222675f-1603-41b7-a5d2-329d00c5d2fa',\n 'e9df11e5-8624-4d14-a36b-28b06930b2e6',\n '1cf522e3-c5a8-4437-be5d-6e09ea32c656',\n '250918ed-9a22-42c3-926d-0f68d6b14be0' ]\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Erro ao salvar documento, perfil interno (temporário).\", quando o ID do perfil informado na URL não for de um perfil externo. Os documentos poderão ser vinculados apenas a perfis externos.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/perfis/11/perfil-documentos/add-all\",\n \"message\": \"Informação: 0 erros, 4 advertências. Total criado: 6\",\n ids: [\n '47afda89-d7ec-43cd-a832-e07fe5eab91d',\n '3117adc9-648c-46a2-8574-dee587bdee63',\n 'c336d4df-4c31-48c0-8dbf-1fe72db83388',\n 'cc53e5c4-c0fb-464c-88fb-32e513877beb',\n '7b7cea15-394f-49b9-98c2-35c40f8732a1',\n '94213e2d-5cd2-4ce8-89ef-792111deb53f'\n ],\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 4,\n \"warnings\": [\n {\n \"info\": {\n \"documento\": \"03537580000149\"\n },\n \"documento\": \"Erro ao salvar documento, perfil interno (temporário).\"\n },\n {\n \"info\": {\n \"documento\": \"11850212000184\"\n },\n \"documento\": \"Erro ao salvar documento, perfil interno (temporário).\"\n },\n {\n \"info\": {\n \"documento\": \"11365703061\"\n },\n \"documento\": \"Erro ao salvar documento, perfil interno (temporário).\"\n },\n {\n \"info\": {\n \"documento\": \"64023857009\"\n },\n \"documento\": \"Erro ao salvar documento, perfil interno (temporário).\"\n }\n ]\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"O documento informado é inválido\", quando o CPF ou CNPJ não for valido, em \"warnings.info.documento\" é retornado o CPF/CNPJ inválido, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/perfis/2/perfil-documentos/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"ids\": [],\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": [\n {\n \"info\": {\n \"documento\": \"1354645\"\n },\n \"documento\": \"O documento informado é inválido\"\n }\n ]\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os dados de um perfil.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/perfis/ID_PERFIL
\nPara consultar os dados de um perfil é necessario enviar uma requisição GET, sendo necessario informa o ID do perfil na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n success: true,\n data: {\n id: 1,\n filial_id: 1,\n descricao: 'RA',\n cor: '#00d1ff',\n created: '2019-10-01T15:10:12-03:00',\n modified: '2019-10-01T15:10:12-03:00',\n tipo: 'Perfil externo (permanente)',\n total_documentos: 8\n }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do perfil informado na URL não for encontrado, conforme o exemplo abaixo.
{\n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/perfis/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar perfis.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/perfis
\nOs parametros permitidos são:
\nAtenção: ao não informar o parametro desativado na URL, todos os perfis serão retornados.
\nPara listar os perfis é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"filial_id\": 1,\n \"descricao\": \"PF\",\n \"cor\": \"#14ff00\",\n \"created\": \"2019-10-08T16:20:40-03:00\",\n \"modified\": \"2019-10-08T16:20:40-03:00\",\n \"tipo\": \"Perfil interno (temporário)\",\n \"total_documentos\": 0\n },\n {\n \"id\": 2,\n \"filial_id\": 1,\n \"descricao\": \"PJ\",\n \"cor\": \"#0057ff\",\n \"created\": \"2019-10-08T16:20:56-03:00\",\n \"modified\": \"2019-10-08T16:20:56-03:00\",\n \"tipo\": \"Perfil interno (temporário)\",\n \"total_documentos\": 0\n },\n {\n \"id\": 3,\n \"filial_id\": 2,\n \"descricao\": \"FL\",\n \"cor\": \"#fff500\",\n \"created\": \"2019-10-08T16:37:09-03:00\",\n \"modified\": \"2019-10-08T16:37:09-03:00\",\n \"tipo\": \"Perfil externo (permanente)\",\n \"total_documentos\": 0\n },\n {\n \"id\": 4,\n \"filial_id\": 1,\n \"descricao\": \"AP\",\n \"cor\": \"#00d1ff\",\n \"created\": \"2019-10-15T17:03:40-03:00\",\n \"modified\": \"2019-10-15T17:20:20-03:00\",\n \"tipo\": \"Perfil externo (permanente)\",\n \"total_documentos\": 1\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 17,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um perfil.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/perfis/ID_PERFIL
\nPara excluir um perfil é necessário enviar uma requisição DELETE, sendo necessário informar o ID do perfil na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do perfil informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/perfis/100',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nGerenciamento de perfis.
\nAtenção: ao informar um CPF ou CNPJ invalido, será adicionado 0 (zeros) a esquerda para completar.\nExemplo: Ao enviar o CPF 104035, o CPF final será: 00000104035
\nAtenção ao criar um perfil enviando os documentos na requisição, os clientes serão vinculados ao perfil em seguida. Já ao criar um perfil e enviar os documentos posteriormente, os clientes serão vinculados ao perfil no dia seguinte.
\n","event":[{"listen":"prerequest","script":{"id":"23e7df24-7816-47af-89cb-e4d2b2c9aa81","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e9403169-3368-460e-9c80-612f7d9355b6","type":"text/javascript","exec":[""]}}],"_postman_id":"19bb98e8-14e9-480d-83ab-eaceda4a887f"},{"name":"Oferta exclusiva por perfil","item":[{"name":"Adicionar oferta por perfil","id":"73d25c6f-fdee-461a-aabf-22b856fff117","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filial_id\": 1,\n \"nome\": \"Ofertas especiais\",\n \"data_inicial\": \"2019-10-15 00:00:00\",\n \"data_final\": \"2019-10-25 23:59:59\",\n \"perfis\" : {\n \t\"_ids\": [1,2,7]\n },\n \"oferta_configuracao_produtos\": [\n\t {\n\t \"erp\": 233,\n\t \"quantidade_maxima\": 25,\n\t \"valor\": 4.50\n\t },\n\t {\n\t \t\"erp\": 1268,\n\t \t\"quantidade_maxima\": 40,\n\t \t\"valor\": 3.99\n\t },\n\t {\n\t \t\"erp\": 1388,\n\t \t\"quantidade_maxima\": 100,\n\t \t\"valor\": 1.99\n\t }\n ]\n}"},"url":"{{URL}}/importacao/oferta-configuracoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar ofertas exclusivas para um ou mais perfis.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/oferta-configuracoes
\nAtenção é permitido cadastrar um total de 1000 ofertas por requisição.
\nPara cadastrar ofertas exclusivas por perfil é necessário enviar uma requisição POST, informando os dados da oferta no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| nome | \nNome da oferta a ser exibida no site. | \nSim | \n
| data_inicial | \nData e Hora inicial da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| data_final | \nData e Hora final da vigência da oferta. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| perfis | \nIDs dos perfis | \nSim | \n
| oferta_configuracao_produtos | \nArray de produtos vinculados à oferta. | \nSim | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto. | \nSim | \n
| quantidade_maxima | \nRepresenta a quantidade máxima possível a ser incluída no carrinho pelo cliente durante a vigência da oferta. | \nSim | \n
| valor | \nValor promocional do produto. Atenção o preco deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | \n Sim | \n
\n{\n \"filial_id\": 1,\n \"nome\": \"Ofertas especiais\",\n \"data_inicial\": \"2019-10-15 00:00:00\",\n \"data_final\": \"2019-10-25 23:59:59\",\n \"perfis\" : {\n \"_ids\": [1,2,7]\n },\n \"oferta_configuracao_produtos\": [\n {\n \"erp\": 233,\n \"quantidade_maxima\": 25,\n \"valor\": 4.50\n },\n {\n \"erp\": 1268,\n \"quantidade_maxima\": 40,\n \"valor\": 3.99\n },\n {\n \"erp\": 1388,\n \"quantidade_maxima\": 100,\n \"valor\": 1.99\n }\n ]\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"601726d2-3e6a-4c2d-8a5c-a88f7c23a8a5\"\n }\n}\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a oferta será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais produtos.
{\n \"success\": true,\n \"data\": {\n \"id\": \"4694161d-d61d-4600-8df7-ab05b58d582c\"\n },\n \"warnings\": {\n \"2\": {\n \"valor\": \"O valor da oferta deve ser menor que o valor do produto\"\n },\n \"1978976\": {\n \"erp\": \"Registro não encontrado na tabela de produtos\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando um ou mais campos obrigatórios no body da requisição não forem informados. É exibido na resposta, a quantidade de erros de validação em message e os campos obrigatórios em errors, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/oferta-configuracoes\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"nome\": \"Este campo é obrigatório\",\n \"data_inicial\": \"Este campo é obrigatório\",\n \"data_final\": \"Este campo é obrigatório\",\n \"oferta_configuracao_produtos\": \"Este campo é obrigatório\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma oferta exclusiva por perfil através do ID da oferta exclusiva.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/oferta-configuracoes/ID
\nPara consultar uma oferta exclusiva por perfil é necessário enviar uma requisição GET informando o ID da oferta na URL.
Na URL da requisição é obrigatório informar o ID da oferta a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/oferta-configuracoes/{{ID}}Exemplo de ID:
\nc566743b-34ed-4d65-9fb0-a5fe499d60a6Quantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": \"742af5aa-cd66-4db4-ba5b-4b23e1a97100\",\n \"api_usuario_id\": \"83e2d4ba-e9fc-11e9-8989-02b62390f8ca\",\n \"filial_id\": 1,\n \"nome\": \"Ofertas especiais\",\n \"data_inicial\": \"2019-10-15T00:00:00-03:00\",\n \"data_final\": \"2019-10-25T23:59:59-03:00\",\n \"processado\": true,\n \"informacoes\": \"Total de ofertas criadas: 12\",\n \"created\": \"2019-10-16T14:58:58-03:00\",\n \"modified\": \"2019-10-16T15:07:00-03:00\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID da oferta informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/oferta-configuracoes/922effa9-5a18-4a0d-a0b9-115aa4c164d8\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listas ofertas exclusivas por perfil cadastradas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/oferta-configuracoes
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por processado:
\n{{URL}}/importacao/oferta-configuracoes/?processado=1
Para listar ofertas exclusivas por perfil é necessário enviar uma requisição GET, quando não informado um parametro na URL todos os registro serão retornados.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"742af5aa-cd66-4db4-ba5b-4b23e1a97100\",\n \"api_usuario_id\": \"83e2d4ba-e9fc-11e9-8989-02b62390f8ca\",\n \"filial_id\": 1,\n \"nome\": \"Ofertas especiais\",\n \"data_inicial\": \"2019-10-15T00:00:00-03:00\",\n \"data_final\": \"2019-10-25T23:59:59-03:00\",\n \"processado\": true,\n \"informacoes\": \"Total de ofertas criadas: 12\",\n \"created\": \"2019-10-16T14:58:58-03:00\",\n \"modified\": \"2019-10-16T15:07:00-03:00\"\n },\n {\n \"id\": \"c025f838-254a-4173-ba69-dca8535fc708\",\n \"api_usuario_id\": \"83e2d4ba-e9fc-11e9-8989-02b62390f8ca\",\n \"filial_id\": 1,\n \"nome\": \"Oferta exclusiva\",\n \"data_inicial\": \"2019-10-15T00:00:00-03:00\",\n \"data_final\": \"2019-10-25T23:59:59-03:00\",\n \"processado\": false,\n \"informacoes\": null,\n \"created\": \"2019-10-16T15:12:53-03:00\",\n \"modified\": \"2019-10-16T15:12:53-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os produtos de uma oferta exclusiva por perfil através do ID da oferta exclusiva.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/oferta-configuracoes/ID/oferta-configuracao-produtos
\nPara listar os produtos vinculados a uma oferta exclusiva por perfil é necessário enviar uma requisição GET informando o ID da oferta na URL.
Na URL da requisição é obrigatório informar o ID da oferta a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/oferta-configuracoes/{{ID}}/oferta-configuracao-produtosExemplo de ID:
\nc566743b-34ed-4d65-9fb0-a5fe499d60a6Quantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"0090c765-691d-4931-8998-cebcdc222e2e\",\n \"oferta_configuracao_id\": \"0cea2c3b-d104-41a6-832f-51bcc23c5ba6\",\n \"erp\": \"2\",\n \"quantidade_maxima\": 50,\n \"preco\": 1.29,\n \"valor\": 1.1,\n \"created\": \"2019-10-16T16:10:12-03:00\",\n \"modified\": \"2019-10-16T16:10:12-03:00\"\n },\n {\n \"id\": \"151505c9-6eac-4020-a14e-bd16975008e5\",\n \"oferta_configuracao_id\": \"0cea2c3b-d104-41a6-832f-51bcc23c5ba6\",\n \"erp\": \"164\",\n \"quantidade_maxima\": 100,\n \"preco\": 5.49,\n \"valor\": 5.3,\n \"created\": \"2019-10-16T16:10:12-03:00\",\n \"modified\": \"2019-10-16T16:10:12-03:00\"\n },\n {\n \"id\": \"6c417226-e737-449a-a62d-951c8e4f6e16\",\n \"oferta_configuracao_id\": \"0cea2c3b-d104-41a6-832f-51bcc23c5ba6\",\n \"erp\": \"1\",\n \"quantidade_maxima\": 150,\n \"preco\": 1.29,\n \"valor\": 1,\n \"created\": \"2019-10-16T16:10:12-03:00\",\n \"modified\": \"2019-10-16T16:10:12-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID da oferta informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/oferta-configuracoes/922effa9-5a18-4a0d-a0b9-115aa4c164d8/oferta-configuracao-produtos\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma oferta exclusiva por perfil.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/oferta-configuracoes/ID
\nPara excluir uma oferta exclusiva por perfil é necessário enviar uma requisição DELETE informando o ID da oferta na URL.
Na URL da requisição é obrigatório informar o ID da oferta a ser excluída, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/oferta-configuracoes/{{ID}}Exemplo de ID:
\nfa92b83f-4641-4853-aa53-91727600451fQuantidade de caracteres: 36 caracteres.
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID da oferta informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/oferta-configuracoes/922effa9-5a18-4a0d-a0b9-115aa4c164d8\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os centros de distribuições.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/centro-distribuicoes
\nPara listar os centros de distribuições é necessário enviar uma requisição GET, podendo ou não informar parametro na URL.
Atenção: ao não informar nenhum parametro, todos os centros de distribuições serão retornados.
Exemplos:
\n\n\nBusca por cnpj: {{URL}}/importacao/centro-distribuicoes/?cnpj=84473044000129
\nBusca por id: {{URL}}/importacao/centro-distribuicoes/?id=1
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"74684127000103\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"13732550\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\"\n }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo. Atenção: caso seja uma busca pelo CNPJ verifique se não esta sendo enviado com formatação.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nCNPJ do centro de distribuicao
\n","type":"text/plain"},"key":"cnpj","value":"74684127000103"}],"variable":[]}},"response":[],"_postman_id":"1753652b-fa19-4f72-b739-36e93dc78e61"},{"name":"Consultar centro de distribuicao","id":"833c138a-37c7-4da0-88d9-506554651f16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"url":"{{URL}}/importacao/centro-distribuicoes/{{CENTRO_ID}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um centro de distribuição através do ID.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/centro-distribuicoes/ID
\nPara consultar um centro de distribuição é necessário enviar uma requisição GET informando o ID do centro de distribuição na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"74684127000103\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"13732550\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do centro de distribuição informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/centro-distribuicoes/100\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Network\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nID da filial
\n"},{"key":"titulo","value":"Ofertas especiais vipcommerce","type":"text","description":"Titulo da notificação. Maximo de 255 caracteres
\n"},{"key":"descricao","value":"Confira nossas ofertas especiais","type":"text","description":"Descrição da notificação
\n"},{"key":"data_envio","value":"2021-03-04 09:33","type":"text","description":"Data de envio da notificação
\n"},{"key":"data_final","value":"2021-03-21 18:05","type":"text","description":"Data final da vigência da notificação
\n"},{"key":"tipo_dispositivo","value":"T","type":"text","description":"Tipo de dispositivo da notificação
\n"},{"key":"model","value":"Oferta","type":"text","description":"Evento que a notificação será vinculada
\n"},{"key":"foreign_key","value":"2","type":"text","description":"ID do evento
\n"}]},"url":"{{URL}}/importacao/notificacoes","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar notificação geral por push
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes
\nPara cadastrar notificações gerais por push é necessário enviar uma requisição POST, informando os dados da notificação no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| titulo | \nTitulo da notificação. Atenção: tamanho máximo de 255 caracteres. | \nSim | \n
| descricao | \nDescrição da notificação. | \nSim | \n
| data_envio | \nData e hora do envio da notificação. Atenção: deve estar, no mínimo 15 minutos adiante do horário atual. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| tipo_dispositivo | \nTipo de dispositivo que a notificação será enviada. Atenção: opções aceitas somente em maiúsculo. Opções aceitas:\n
| \n Sim | \n
| data_final | \nData de expiração da notificação. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| model | \nEvento que a notificação será vinculada. Ao abrir a notificação será redirecionada para o evento. Opções aceitas:\n
| \n Sim | \n
| foreign_key | \nID do evento que a notificação foi vinculada. \n
| \n Sim | \n
\n{\n \"filial_id\": 1,\n \"titulo\": \"Ofertas especiais vipcommerce\",\n \"descricao\": \"Confira as ofertas que preparamos para você!\",\n \"data_envio\": \"2020-02-07 09:40\",\n \"tipo_dispositivo\": \"T\",\n \"data_final\": \"2020-02-07 18:05\"\n \"model\": \"Oferta\",\n \"foreign_key\": 2\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
\n{\n \"success\": true,\n \"data\": {\n \"id\": 200\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\" no campo \"data_envio\", quando a data de envio não estiver 15 minutos adiante do horário atual.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_envio\": \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando o tipo de dispositivo informado não for valido. Atenção: o tipo de dispositivo deverá ser informado em maiúsculo.
Opções aceitas:
'T' => Todas as plataformas (Site e Aplicativo de vendas)
S => Site.
A => Aplicativo de vendas.
Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_dispositivo\": \"O valor fornecido é inválido\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma notificação geral, através do ID da notificação.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO
\nPara consultar uma notificação geral é necessario enviar uma requisição GET, sendo necessario informa o ID da notificação na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"filial_id\": 1,\n \"titulo\": \"Ofertas especiais\",\n \"descricao\": \"Confira nossas ofertas\",\n \"imagem\": null,\n \"model\": \"Produto\",\n \"foreign_key\": 38,\n \"tipo_dispositivo\": \"T\",\n \"data_envio\": \"2020-02-04T15:40:00-03:00\",\n \"processada\": true,\n \"enviada\": true,\n \"qt_enviada\": 0,\n \"qt_visualizada\": 0,\n \"mensagem\": \"Produto inválido\",\n \"data_final\": \"2020-02-29T15:18:00-03:00\",\n \"tipo_contatos\": \"B\",\n \"tipo_notificacao\": \"G\",\n \"created\": \"2020-02-04T15:19:09-03:00\",\n \"modified\": \"2020-02-04T15:19:09-03:00\"\n }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID da notificação informado na URL não for encontrado, conforme o exemplo abaixo.
{\n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/notificacoes/3566',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar as notificações gerais cadastradas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes
\nPara consultar as notificações gerais cadastradas é necessario enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"filial_id\": 1,\n \"titulo\": \"Acafrao\",\n \"descricao\": \"Acafrao\",\n \"imagem\": null,\n \"model\": \"Produto\",\n \"foreign_key\": 38,\n \"tipo_dispositivo\": \"T\",\n \"data_envio\": \"2020-02-04T15:40:00-03:00\",\n \"processada\": true,\n \"enviada\": true,\n \"qt_enviada\": 0,\n \"qt_visualizada\": 0,\n \"mensagem\": \"Produto inválido\",\n \"data_final\": \"2020-02-29T15:18:00-03:00\",\n \"tipo_contatos\": \"B\",\n \"tipo_notificacao\": \"G\",\n \"created\": \"2020-02-04T15:19:09-03:00\",\n \"modified\": \"2020-02-04T15:19:09-03:00\"\n },\n {\n \"id\": 3,\n \"filial_id\": 1,\n \"titulo\": \"coleção super friday\",\n \"descricao\": \"coleção super friday\",\n \"imagem\": null,\n \"model\": \"Colecao\",\n \"foreign_key\": 1,\n \"tipo_dispositivo\": \"T\",\n \"data_envio\": \"2020-02-05T14:00:00-03:00\",\n \"processada\": true,\n \"enviada\": true,\n \"qt_enviada\": 1,\n \"qt_visualizada\": 1,\n \"mensagem\": \"Coleção inválida\",\n \"data_final\": \"2020-02-29T13:37:00-03:00\",\n \"tipo_contatos\": \"B\",\n \"tipo_notificacao\": \"G\",\n \"created\": \"2020-02-05T13:38:50-03:00\",\n \"modified\": \"2020-02-05T19:26:44-03:00\"\n },\n {\n \"id\": 4,\n \"filial_id\": 1,\n \"titulo\": \"Teste\",\n \"descricao\": \"Notificação por API\",\n \"imagem\": null,\n \"model\": \"Manual\",\n \"foreign_key\": null,\n \"tipo_dispositivo\": \"A\",\n \"data_envio\": \"2020-06-02T18:55:00-03:00\",\n \"processada\": true,\n \"enviada\": true,\n \"qt_enviada\": 0,\n \"qt_visualizada\": 0,\n \"mensagem\": null,\n \"data_final\": null,\n \"tipo_contatos\": \"B\",\n \"tipo_notificacao\": \"G\",\n \"created\": \"2020-02-05T17:55:50-03:00\",\n \"modified\": \"2020-02-05T17:55:50-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 5,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 99,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar notificação de por push por cliente.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes-por-cliente
\nPara cadastrar notificações por push por cliente é necessário enviar uma requisição POST, informando os dados da notificação no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| titulo | \nTitulo da notificação. Atenção: tamanho máximo de 255 caracteres. | \nSim | \n
| descricao | \nDescrição da notificação. | \nSim | \n
| data_envio | \nData e hora do envio da notificação. Atenção: deve estar, no mínimo 15 minutos adiante do horário atual. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| tipo_dispositivo | \nTipo de dispositivo que a notificação será enviada. Atenção: opções aceitas somente em maiúsculo. Opções aceitas:\n
| \n Sim | \n
| data_final | \nData de expiração da notificação. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| model | \nEvento em que a notificação será vinculada. Quando o cliente que receber a notificação clicar na mesma, a respectiva tela do evento (se houver) será aberta no aplicativo. Opções aceitas:\n
| \n Sim | \n
| foreign_key | \nID do evento em que a notificação foi vinculada. \n
| \n Sim | \n
| clientes | \nLista de CPFs de clientes que receberão a notificação de push. \n Atenção: A lista de CPFs deve ser enviada como string (texto), dentro de colchetes e sem pontuação. \n Ex: [\"14996903040\", \"85716041000\"]\n | \n Sim | \n
\n{\n \"filial_id\": 1,\n \"titulo\": \"Ofertas especiais vipcommerce\",\n \"descricao\": \"Confira as ofertas que preparamos para você!\",\n \"data_envio\": \"2020-02-07 09:40\",\n \"tipo_dispositivo\": \"T\",\n \"data_final\": \"2020-02-07 18:05\"\n \"model\": \"Oferta\",\n \"foreign_key\": 2\n \"clientes\": [\"14996903040\", \"85716041000\"]\n\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 200\n }\n}\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
Atenção a notificação por cliente será cadastrada mesmo contendo warnings, que são adventências que podem ocorrer com um ou mais contatos.
{\n \"success\": true,\n \"data\": {\n \"id\": 137,\n \"warning\": {\n \"naoEncontrados\": [\n \"59517631006\"\n ]\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\" no campo \"data_envio\", quando a data de envio não estiver 15 minutos adiante do horário atual.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_envio\": \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando o tipo de dispositivo informado não for valido. Atenção: o tipo de dispositivo deverá ser informado em maiúsculo.
Opções aceitas:
'T' => Todas as plataformas (Site e Aplicativo de vendas)
S => Site.
A => Aplicativo de vendas.
Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_dispositivo\": \"O valor fornecido é inválido\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request quando a lista de clientesnão for informada
Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Lista de clientes não informada\"\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar notificação de por push por perfis.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes-por-perfis
\nPara cadastrar notificações de push por perfis é necessário enviar uma requisição POST, informando os dados da notificação no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o ID da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| titulo | \nTitulo da notificação. Atenção: tamanho máximo de 255 caracteres. | \nSim | \n
| descricao | \nDescrição da notificação. | \nSim | \n
| data_envio | \nData e hora do envio da notificação. Atenção: deve estar, no mínimo 15 minutos adiante do horário atual. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| tipo_dispositivo | \nTipo de dispositivo que a notificação será enviada. Atenção: opções aceitas somente em maiúsculo. Opções aceitas:\n
| \n Sim | \n
| data_final | \nData de expiração da notificação. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS. Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| model | \nEvento em que a notificação será vinculada. Quando o cliente que receber a notificação clicar na mesma, a respectiva tela do evento (se houver) será aberta no aplicativo. Opções aceitas:\n
| \n Sim | \n
| foreign_key | \nID do evento em que a notificação foi vinculada. \n
| \n Sim | \n
| perfis | \nLista de perfis de clientes que receberão a notificação de push. Ex: [1,2,15]\n | \n Sim | \n
\n{\n \"filial_id\": 1,\n \"titulo\": \"Ofertas especiais vipcommerce\",\n \"descricao\": \"Confira as ofertas que preparamos para você!\",\n \"data_envio\": \"2020-02-07 09:40\",\n \"tipo_dispositivo\": \"T\",\n \"data_final\": \"2020-02-07 18:05\"\n \"model\": \"Oferta\",\n \"foreign_key\": 2\n \"perfis\": [1,2,15]\n\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 200\n }\n}\nSerá retornado o código de status 400 Bad Request quando um dos perfis informados não existir no sistema. A notificação não será criada. Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Entity save failure (perfil_id: \\\"_existsIn\\\").\",\n \"errorCount\": 1,\n \"errors\": {\n \"perfil_id\": {\n \"_existsIn\": \"Este valor não existe\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem: \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\" no campo \"data_envio\", quando a data de envio não estiver 15 minutos adiante do horário atual.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_envio\": \"Data e hora do envio. Deve estar, no mínimo 15 minutos adiante do horário atual.\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando o tipo de dispositivo informado não for valido. Atenção: o tipo de dispositivo deverá ser informado em maiúsculo.
Opções aceitas:
'T' => Todas as plataformas (Site e Aplicativo de vendas)
S => Site.
A => Aplicativo de vendas.
Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/notificacoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_dispositivo\": \"O valor fornecido é inválido\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request quando um ou mais campos obrigatórios não forem informados no body da requisição. Abaixo é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Entity save failure (titulo: \\\"_required\\\", filial_id: \\\"_required\\\", descricao: \\\"_required\\\", tipo_dispositivo: \\\"_required\\\", data_envio: \\\"_required\\\").\",\n \"errorCount\": 5,\n \"errors\": {\n \"titulo\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"filial_id\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"descricao\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"tipo_dispositivo\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"data_envio\": {\n \"_required\": \"Este campo é obrigatório\"\n }\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma notificação por perfil, através do ID da notificação e ID do perfil (não obrigatório).
\nURL Sandbox informando ID_PERFIL: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO/notificacoes-por-perfil/ID_PERFIL
\nURL Sandbox não informando ID_PERFIL: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO/notificacoes-por-perfil
\nPara consultar uma notificação por perfil é necessario enviar uma requisição GET, sendo necessario informa o ID da notificação e o ID do Perfil(não obrigatório) na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"846958a0-7d84-4778-9ba4-9ec4c6ce712e\",\n \"notificacao_id\": 63,\n \"perfil_id\": 3\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma notificação por cliente, através do ID da notificação e/ou do cliente.
\nURL Sandbox informando ID_CLIENTE: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO/notificacoes-por-cliente/ID_CLIENTE
\nURL Sandbox não informando ID_CLIENTE: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO/notificacoes-por-cliente
\nPara consultar uma notificação por cliente é necessario enviar uma requisição GET, sendo necessário informa o ID da notificação e o ID do cliente(não obrigatório) na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"46da6e7e-91e0-4984-9c8e-7400b0dfdf86\",\n \"cliente_id\": 5,\n \"notificacao_id\": 115,\n \"visualizada\": false,\n \"removida\": false,\n \"created\": \"2020-02-21T10:20:03-03:00\",\n \"modified\": \"2020-02-21T11:55:00-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK e data da resposta vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma notificação.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/ID_NOTIFICACAO
\nPara excluir uma notificação é necessário enviar uma requisição DELETE informando o ID da notificação na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad request com a mensagem \"Notificação não pode excluída ou nao encontrada.\", quando o ID da notificação informado na URL não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Notificação não pode excluída ou nao encontrada.\"\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os clientes que clicaram na notificação push no site ou app.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/notificacoes/NOTIFICACAO_ID/acessos-clientes
\nPara consultar uma notificação é necessário enviar uma requisição GET informando o ID da notificação na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"notificacao_id\": 13,\n \"cliente_id\": 45,\n \"filial_id\": 1,\n \"data_acesso\": \"2021-06-15T10:35:34-03:00\"\n },\n {\n \"notificacao_id\": 13,\n \"cliente_id\": 6,\n \"filial_id\": 1,\n \"data_acesso\": \"2021-06-15T10:35:15-03:00\"\n },\n {\n \"notificacao_id\": 13,\n \"cliente_id\": 716,\n \"filial_id\": 1,\n \"data_acesso\": \"2021-06-15T10:35:24-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\nSerá retornado o código de status 200 OK e data vazio quando a requisição ocorrer com sucesso e o parametro informado na URL não for encontrado ou a notificação não tiver sido clicada por nenhum cliente, conforme o exemplo.
{\n \"success\": true,\n \"data\": [],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 0,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o pré-cadastro de produtos em lote.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/pre-cadastro/add-all
\nA API de pré-cadastros permite fazer alterações em um produto mesmo após sua criação/processamento no sistema. Basta enviar os mesmos dados do item existente (Código de Barras e Código ERP). Após processamento do pré-cadastro, o produto será editado.
\nAtenção deverá ser enviado o formato JSON no body da requisição, conforme o exemplo.
Para realizar o pré-cadastro em lote é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto. | \nSim | \n
| codigo_barras | \nCódigo de barras do produto. Tamanho máximo de 15 caracteres. | \n Sim | \n
| descricao | \nDescrição do produto. | \nNão | \n
| informacoes | \nInformações do produto. | \nNão | \n
| preco | \nPreço do produto. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | \n Sim | \n
| estoque_loja | \nEstoque da loja. Atenção deverá ser informado um valor númerico positivo, sem decimal. Exemplo: 500 | \n Sim | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
| estoque_seguranca | \nEstoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Deverá ser informado um valor númerico positivo, conforme o exemplo: 30 | \n Não | \n
\n\n\n[\n { \n \"codigo_erp\": 1412,\n \"codigo_barras\": \"7622300863308\",\n \"preco\": 1.19,\n \"estoque_loja\": 121,\n \"descricao\": \"Pate Whiskas Atum 290g\",\n \"informacoes\": \"-\",\n \"desativado\": true\n },\n { \n \"codigo_erp\": 4987,\n \"codigo_barras\": \"76223008673081\",\n \"preco\": 1.19,\n \"estoque_loja\": 121,\n \"descricao\": \"Toddy Light 28\",\n \"informacoes\": \"-\",\n \"estoque_seguranca\": 20\n },\n { \n \"codigo_erp\": 48970,\n \"codigo_barras\": \"76223008683082\",\n \"preco\": 1.19,\n \"estoque_loja\": 121,\n \"descricao\": \"Achocolatado Gold Premium Sweet Diet 210g\",\n \"informacoes\": \"-\" \n }\n]\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"ids\": [\n \"7ea4973f-343f-47e4-894d-82a020bd0f88\",\n \"b2bb7de5-9f58-41e3-92bb-9df97d899e17\",\n \"b741a5b3-f303-44bc-b512-293713b8b574\"\n ]\n }\n}\nSerá retornado o código de status 201 Created com warnings, quando a requisição ocorrer com sucesso e um ou mais pre-cadastro conflitar com uma validação.\nAtenção o pré-cadastro será cadastrado mesmo contendo warnings, que são adventências. O total de cadastros será retornado em message.
\nAtenção em warnings será retornado o código ERP que gerou erro no cadastro.
A seguir é exibido um exemplo de pré-cadastro com warnings.
{\n \"success\": true,\n \"data\": {\n \"code\": 200,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 3 advertências. Total criado: 1\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 3,\n \"warnings\": {\n \"785259\": {\n \"codigo_barras\": \"Código de barras já cadastrado\"\n },\n \"512655\": {\n \"codigo_erp\": \"Código ERP já cadastrado\",\n \"codigo_barras\": \"Código de barras já cadastrado\"\n },\n \"1009988\": {\n \"codigo_erp\": \"Código ERP já cadastrado\",\n \"preco\": \"Este campo é obrigatório\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity quando um ou mais campos obrigatórios no body da requisição não forem informados, em warnings será exibido o código ERP com erro. A seguir é exibido um exemplo do retorno.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"782059\": {\n \"codigo_barras\": \"Este campo é obrigatório\",\n \"preco\": \"Este campo é obrigatório\",\n \"estoque_loja\": \"Este campo é obrigatório\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"codigo_barras\" com a mensagem \"Código de barras já cadastrado\", quando o código de barras informado no body da requisição já estiver cadastrado na base, em warnings será exibido o código ERP com erro. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"782059\": {\n \"codigo_barras\": \"Código de barras já cadastrado\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"codigo_erp\" com a mensagem \"Código ERP já cadastrado\", quando o código ERP informado no body da requisição já estiver cadastrado na base. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"10099812\": {\n \"codigo_erp\": \"Código ERP já cadastrado\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"estoque_loja\" com a mensagem \"O valor fornecido é inválido\", quando o estoque da loja não for um valor númerico positivo, conforme o exemplo: 500. Em warnings será retornado o código ERP com erro. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"516456\": {\n \"estoque_loja\": \"O valor fornecido é inválido\"\n }\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite realizar o pré-cadastro de produtos em lote na versão CD.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/pre-cadastro/add-all
\nA API de pré-cadastros permite fazer alterações em um produto mesmo após sua criação/processamento no sistema. Basta enviar os mesmos dados do item existente (Código de Barras e Código ERP). Após processamento do pré-cadastro, o produto será editado.
\nAtenção é permitido cadastrar um total de 1000 (mil) registros por requisição. Caso a quantidade ultrapasse esta quantidade recomendamos dividir as requisições cada uma contendo no máximo 1000 (mil) registros.
\nAtenção deverá ser enviado o formato JSON no body da requisição, conforme o exemplo.
Para realizar o pré-cadastro em lote é necessário enviar uma requisição POST, informando os dados no corpo body da requisição.
Descrição do corpo body da requisição:
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo_erp | \nCódigo ERP do produto. | \nSim | \n
| codigo_barras | \nCódigo de barras do produto. Tamanho máximo de 15 caracteres. | \n Sim | \n
| descricao | \nDescrição do produto. | \nNão | \n
| informacoes | \nInformações do produto. | \nNão | \n
| estoque_precos | \nArray com objetos contendo informações referente ao produto no centro de distribuição. | \nSim | \n
| volumes | \nArray com objetos contendo informações referente ao volume do produto. | \nNão | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| centro_distribuicao_id | \nID do centro de distribuição. Atenção deverá ser enviado um valor númerico positivo. | \n Sim | \n
| preco | \nPreço do produto. Atenção o valor deverá ser informado utilizando somente ponto como separador decimal. Conforme o exemplo: 10.75 | \n Sim | \n
| estoque_loja | \nEstoque da loja. Atenção poderá ser informado um valor com decimal. Exemplo: 500.05 | \n Sim | \n
| estoque_seguranca | \nEstoque de segurança. Uma margem de segurança a ser deduzida para o cálculo do estoque disponível, visando reduzir quebras na loja virtual devido ao movimento da loja física. Atenção poderá ser informado um valor com decimal. Exemplo: 500.05 | \n Não | \n
| desativado | \nDefine se o produto estará desativado para venda. Atenção produtos desativado não são exibidos na loja. Opções aceitas:
Valor default: false | \n Não | \n
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| codigo | \nCódigo do volume. Tamanho mínimo 7 (sete) caracteres e máximo de 20 (vinte) caracteres. | \n Sim | \n
| quantidade | \nQuantidade de itens do volume. Atenção deverá ser informado um valor númerico positivo. | \nSim | \n
\n[\n {\n \"codigo_erp\": 1123121,\n \"codigo_barras\": \"7898951621329\",\n \"descricao\": \"Produto de teste\",\n \"informacoes\": \"-\",\n \"estoque_precos\": [\n {\n \"centro_distribuicao_id\": 1,\n \"preco\": 100.19,\n \"estoque_loja\": 1900,\n \"estoque_seguranca\": 10,\n \"desativado\": 0\n },\n {\n \"centro_distribuicao_id\": 2,\n \"preco\": 199.99,\n \"estoque_loja\": 1000,\n \"estoque_seguranca\": 10,\n \"desativado\": 0\n }\n ],\n \"volumes\": [\n {\n \"codigo\": \"20000900\",\n \"quantidade\": 12\n },\n {\n \"codigo\": \"20000901\",\n \"quantidade\": 24\n }\n ]\n }\n]\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"ids\": [\n \"71065cdb-96b6-4b1f-ae92-a24fa1b456dd\"\n ]\n }\n}\nSerá retornado o código de status 201 Created com warnings, quando a requisição ocorrer com sucesso e um ou mais pre-cadastro conflitar com uma validação.\nAtenção o pré-cadastro será cadastrado mesmo contendo warnings, que são adventências. O total de cadastros será retornado em message.
\nAtenção em warnings será retornado o código ERP que gerou erro no cadastro.
A seguir é exibido um exemplo de pré-cadastro com warnings.
{\n \"success\": true,\n \"data\": {\n \"code\": 200,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 1\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"468787\": {\n \"volumes\": {\n \"codigo\": {\n \"unique\": \"O valor fornecido é inválido\"\n }\n }\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"codigo_erp\" com a mensagem \"Código ERP já cadastrado\", quando o código ERP informado no body da requisição já estiver cadastrado na base. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"7890123\": {\n \"codigo_erp\": \"Código ERP já cadastrado\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"codigo_barras\" com a mensagem \"Código de barras já cadastrado\", quando o código de barras informado no body da requisição já estiver cadastrado na base, em warnings será exibido o código ERP com erro. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"546877\": {\n \"codigo_barras\": \"Código de barras já cadastrado\"\n }\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo \"volumes.codigo\" com a mensagem \"O valor fornecido é inválido\", quando a quantidade de caracteres do volume ultrapassar 20 (vinte) caracteres no body da requisição. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/produtos/pre-cadastro/add-all\",\n \"message\": \"Informação: 0 erros, 1 advertências. Total criado: 0\",\n \"errorCount\": 0,\n \"errors\": [],\n \"warningsCount\": 1,\n \"warnings\": {\n \"13787245\": {\n \"volumes\": {\n \"codigo\": {\n \"maxLength\": \"O valor fornecido é inválido\"\n }\n }\n }\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar produtos pre-cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/pre-cadastro
\nOs parametros permitidos são:
\nExemplos:
\n\n\nBusca por codigo ERP:
\n{{URL}}/importacao/produtos/pre-cadastro/?codigo_erp=12345Busca por id:
\n{{URL}}/importacao/produtos/pre-cadastro/?id=02d2fec2-a5ef-4bb7-b874-91ca2e0c5400Busca por codigo de barras:
\n{{URL}}/importacao/produtos/pre-cadastro/?codigo_barras=7896663315932Busca por processado:
\n{{URL}}/importacao/produtos/pre-cadastro/?processado=1
Para listar os pré-cadastro é necessário enviar uma requisição GET, podendo ou não informar parametros na URL da requisição. Atenção ao não informar nenhum parametro todos os pre-cadastrados serão retornados.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"24b80514-57a8-41c4-871e-46360aed13c7\",\n \"departamento\": \"Mercearia\",\n \"secao\": \"Doces E Frutas Em Calda\",\n \"codigo_erp\": 2749,\n \"codigo_barras\": \"100003407\",\n \"codigo_embalagem\": \"2340700\",\n \"descricao\": \"Doce Abóbora Artesanal Doces 400g Calda\",\n \"informacoes\": \".\",\n \"preco\": 555,\n \"estoque_loja\": 570,\n \"estoque_seguranca\": 100,\n \"acrescimo\": 15,\n \"sem_validacao_estoque\": false,\n \"unidade_diferente\": false,\n \"quantidade_unidade_diferente\": 1,\n \"desativado\": false,\n \"processado\": true,\n \"created\": \"2021-04-24T12:50:13-03:00\",\n \"modified\": \"2021-04-24T12:50:20-03:00\",\n \"volumes\": [],\n \"estoque_precos\": [\n {\n \"id\": \"fc1ccc99-ca46-4c9a-b50f-aa14c46d6f89\",\n \"prototipo_produto_id\": \"24b80514-57a8-41c4-871e-46360aed13c7\",\n \"centro_distribuicao_id\": 1,\n \"preco\": 555,\n \"estoque_loja\": 570,\n \"estoque_seguranca\": 100,\n \"desativado\": false,\n \"created\": \"2021-04-24T12:50:13-03:00\",\n \"modified\": \"2021-04-24T12:50:13-03:00\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"page_count\": 12,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 12,\n \"limit\": 1\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um pre-cadastro.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/produtos/pre-cadastro/ID_PRE_CADASTRO
\nPara excluir um pré-cadastro é necessário enviar uma requisição DELETE, sendo necessário informar o ID do pré-cadastro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID do pré-cadastro informado na URL não for encontrado, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/produtos/pre-cadastro/9614691a-7d5f-4cf0-a8fd-8ceec007764c',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } } \n}\nA API de pré-cadastro permite enviar ao sistema VIPCommerce dados sobre um produto no qual não se tem informações web suficientes para cadastro. O pré-cadastro é processado frequentemente ao longo do dia. Caso a base de dados do VIPCommerce possua as informações ausentes sobre o item, o produto é cadastrado no VIPCommerce, utilizando essas informações. O respectivo pré-cadastro é removido.
\n","event":[{"listen":"prerequest","script":{"id":"416c87d5-0b78-4d24-bf80-a567970a6b0e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f24f0f3e-75a9-4ac1-a0e9-884df5c79bf0","type":"text/javascript","exec":[""]}}],"_postman_id":"7ebfa33c-0be1-4f9b-b570-dfdb504f774b"},{"name":"Autenticador","item":[{"name":"Buscar token jwt","id":"9cfb4c9b-407c-4e3f-a1d5-1b524641fc39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"maria@parceiroautorizado.com.br","type":"text"},{"key":"key","value":"df072f85df9bf7dd71b6811c34bdbaa4f219d98775b56cff9dfa5f8ca1bf846","type":"text"}]},"url":"https://api.{{DOMINIO_CLIENTE}}/v1/auth/loja/login","description":"Permite buscar o token jwt de parceiro autenticado
\nURL: https://api.DOMINIO_CLIENTE/v1/auth/loja/login
\nPara buscar o token jwt é necessário enviar uma requisição POST informando os campos: 'username' sendo o email usuário da API do parceiro cadastrado e 'key' sendo a chave de acesso do usuário da API.
\nObservação: O usuário da API deverá estar ativo e com a flag 'Permitir Logar com Cliente' habilitada.
Atenção o token gerado tem validade de 24 horas.
\nDescrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| username | \nEmail do usuário da API do parceiro cadastado. | \nSim | \n
| key | \nChave de acesso do usuário da API. | \nSim | \n
Visualizando chave de acesso do usuário da API:
\nNo admin acesse: Configurações -> Funcionários e Permissões -> API - Usuários e clique no ícone de lupa ![\"Icone](\"http://wiki.vipcommerce.com.br/images/c/cc/Visualizar.png\")
do usuário.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso e os campos estiverem validos, conforme o exemplo.
{\n success: true,\n data: \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJ2aXBjb21tZXJjZSIsImF1ZCI6ImFwaS1hZG1pbiIsInN1YiI6IjFiYjQ2YzQ0LWIxOGYtMTFlYS05ZWU1LTBlMTIxM2EwMDkwMyIsImlhdCI6MTU5NjU1MjEzOSwidmVyIjoxLCJjbGllbnQiOm51bGwsIm9wZXJhdG9yIjpudWxsLCJvcmciOm51bGx9.YxNLPUSR4UDWqLdoeiEKXj8tKfMSSF-rrKNIFDm2HET7EBgF1bDJY2HNvt-5XR-lyTHh4W3ubdd_zvp5CpxKNA\"\n}\nPermite logar um cliente pelo parceiro com login e senha. Este login só é realizado caso o usuário da API possua um Token JWT gerado e utilize-o no header da descrição.
\nURL: https://api.DOMINIO_CLIENTE/v1/loja/cliente/logar
Descrição do corpo header da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| Accept | \nInforma o servidor sobre o tipo de dado que será retornado.\nAtenção: o tipo de retorno permitido é json. Conforme o exemplo: Accept: application/json | \nSim | \n
| Authorization | \nToken JWT de parceiro autenticado. Deverá ser concatenado a palavra 'Bearer' antes do TOKEN_JWT Ex: Bearer TOKEN_JWT\n Para mais informações sobre o TOKEN_JWT clique aqui | \nSim | \n
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| login | \nEmail, CPF ou CNPJ do usuário cadastrado na loja. O CPF e o CNPJ pode ser com ou sem caracteres especiais. | \nSim | \n
| password | \nSenha do usuário cadastrado na loja. | \nSim | \n
\n{\n \"login\": \"34.816.742/1276-08\",\n \"password\": \"teste123\"\n}\n\n\n\n{\n \"login\": \"237.880.343-51\",\n \"password\": \"teste123\"\n}\n\n\n\n{\n \"login\": \"kingfisher2@tst.com\",\n \"password\": \"teste123\"\n}\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso e os campos estiverem validos, conforme o exemplo.
{\n\n \"success\": true,\n \"data\": {\n \"cliente\": {\n \"id\": 9,\n \"filial_origem_id\": 1,\n \"tipo_cliente\": \"PJ\",\n \"nome\": \"Kingfisher\",\n \"sobrenome\": \"Darryl-M-PJ- SF\",\n \"nome_completo\": \"Kingfisher Darryl,M,PJ\",\n \"telefone_fixo\": \"0199723322\",\n \"telefone_celular\": \"00815077806\",\n \"twitter\": \"\",\n \"email\": \"kingfisher2@tst.com\",\n \"sexo\": \"M\",\n \"data_nascimento\": \"1954-08-14 00:00:00\",\n \"cpf\": \"23788034351\",\n \"rg\": \"132646\",\n \"emissor\": \"ssp mg\",\n \"nome_fantasia\": \"Darryl-M-PJ-um-SF\",\n \"inscricao_estadual\": \"Isento\",\n \"razao_social\": \"Darryl-M-PJ-um-SF\",\n \"cnpj\": \"34816742127608\",\n \"comunicacao_sms\": false,\n \"comunicacao_email\": false,\n \"comunicacao_aplicativo\": null,\n \"codigo\": \"TESTE9\",\n \"maioridade\": false,\n \"cpf_formatado\": \"237.880.343-51\",\n \"cnpj_formatado\": \"34.816.742/1276-08\",\n \"telefone_celular_formatado\": \"(00) 81507-7806\",\n \"telefone_fixo_formatado\": \"(01) 9972-3322\",\n \"url_codigo\": \"https://www.develop.vipcommerce.com.br/i/TESTE9\",\n \"documento\": \"34816742127608\",\n \"data_nascimento_formatada\": \"14/08/1954\",\n \"termos_aceite\": true\n },\n\n \"filiais_autorizadas\": [\n 1\n ]\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Falha no processo de Autenticação\" quando o payload da requisição não informar os campos obrigatórios. conforme exemplo abaixo:
{\n \"success\": false,\n \"error\": \"Falha no processo de Autenticação.\"\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Autorização negada. Credenciais inválidas\" quando o payload da requisição informar dados inválidos do cliente, conforme exemplo abaixo:
{\n \"success\": false,\n \"error\": \"Autorização negada. Credenciais inválidas.\"\n}\nSerá retornado o código de status 401 Unauthorized com a mensagem relacionada ao erro do Token quando o valor enviado for incorreto, conforme exemplo abaixo:
{\n \"success\": false,\n \"error\": \"An error while decoding token.\"\n}\nSerá retornado o código de status 401 Unauthorized com a mensagem relacionada à ausência de Token ao enviar a requisição sem esta informação, conforme exemplo abaixo:
{\n \"success\": false,\n \"error\": \"Token not provided.\"\n}\nO autenticador VipCommerce permite que parceiros possam logar na loja como um cliente através da URL da loja e 3 (três) parametros complementares.
\nAtenção para que o parceiro logue será necessário que seu usuário da API esteja ativo, com a flag 'Permitir Logar com Cliente' habilitada e possuir o CPF, CNPJ ou email do cliente previamente cadastrado na loja.
Parâmetros URL:
\nNos exemplos abaixo, utilizaremos os seguintes termos:
\nExemplos de URL:
\nhttps://DOMINIO_CLIENTE/?cliente=DADO_CONSUMIDOR_FINAL_BASE64&token=TOKEN_JWT&inApp=true
Exemplo de URL final:
\n\nExemplo do parâmetro 'cliente':
\nSuponhamos que o email do cliente seja: joao@cliente.com.br a codificação base64 irá gerar: am9hb0BjbGllbnRlLmNvbS5icg==
Como buscar o parametro 'token jwt de parceiro autenticado':
\neyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ2aXBjb21tZXJjZSIsImF1ZCI6ImFwaS1hZG1pbiIsInN1YiI6IjVlZjNhOWIyLTI5NjQtNGMwMC1iNDFlLTUxODhhYzMyMDBhMSIsImlhdCI6MTU5NTM3MDMyNywidmVyc2lvbiI6MSwiY2xpZW50IjpudWxsLCJvcGVyYXRvciI6bnVsbH0.FaYRVEwTRdJZ5RAN8jddAgzvcI4iONcwUmb8BrpBh-fbYYaJw7Js9JD1sIRdVtzTgjYuaioRbHXkPuUIzkdh2
\nPara obter mais informações sobre a requisição clique aqui
\nPara ativar a flag 'Permitir Logar com Cliente' acesse no admin:
Configurações -> Funcionários e Permissões -> API - Usuários e clique no ícone de chave (ver imagem abaixo).
\n![\"Icone](\"http://wiki.vipcommerce.com.br/images/c/c4/Icone_permite_logar_cliente.png\")
Caso todos os parametros informados na URL estejam corretos, usuário da API esteja ativo, com a flag 'Permitir Logar com Cliente' habilitada e existir o CPF, CNPJ ou email do cliente na loja, será carregada a loja com o cliente autenticado.
\nCaso ocorra algum erro na autenticação, será carregada a loja sem o cliente estar autenticado. Verifique alguns dos possíveis erros:
Permite buscar o ID da organização.
\nURL: https://api.DOMINIO_CLIENTE/v1/organizacao
\nPara buscar o ID da organização é necessário enviar uma requisição GET informando o DOMINIO DO CLIENTE na URL. Suponhamos que o dominio do cliente seja 'vipcommerce.com.br' então a URL seria: https://api.vipcommerce.com.br/v1/organizacao
{\n success: true,\n data: 20\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um tipo de entrega através do ID da entrega.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-entregas/ID_TIPO_ENTREGA
\nPara consultar as informações de um tipo de entrega é necessário enviar uma requisição GET, sendo necessário informar o ID da entrega na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"descricao\": \"Retirada CD1\",\n \"resumo\": \"Retirada CD1\",\n \"quantidade_maxima_itens\": null,\n \"desativado\": false,\n \"retirada_loja\": true,\n \"tipo_intervalo\": \"sem-intervalos\",\n \"exclusivo_televendas\": false,\n \"centro_distribuicoes\": [\n {\n \"id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"00000000000000\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"00000000\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\",\n \"tipo_exibicao_retirada\": 1,\n \"observacao_retirada\": \"\"\n }\n ],\n \"tipo_entrega_horarios\": [\n {\n \"id\": 15,\n \"tipo_entrega_id\": 4,\n \"dia_semana\": \"Domingo\",\n \"hora_inicial\": \"21:00:00\",\n \"hora_final\": \"21:00:00\"\n },\n {\n \"id\": 16,\n \"tipo_entrega_id\": 4,\n \"dia_semana\": \"Segunda\",\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"22:30:00\"\n },\n {\n \"id\": 19,\n \"tipo_entrega_id\": 4,\n \"dia_semana\": \"Quinta\",\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"22:30:00\"\n }\n ]\n }\n}\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"descricao\": \"Retirada Todos CDs\",\n \"resumo\": \"Retirada Todos CDs\",\n \"quantidade_maxima_itens\": null,\n \"desativado\": false,\n \"retirada_loja\": true,\n \"tipo_intervalo\": \"intervalos-fixos\",\n \"exclusivo_televendas\": false,\n \"centro_distribuicoes\": [\n {\n \"id\": 1,\n \"nome\": \"CD Principal\",\n \"cnpj\": \"00000000000000\",\n \"inscricao_estadual\": \"ISENTO\",\n \"endereco_cep\": \"00000000\",\n \"endereco_logradouro\": \"Logradouro\",\n \"endereco_numero\": \"100\",\n \"endereco_complemento\": \"\",\n \"endereco_bairro\": \"Bairro\",\n \"endereco_cidade\": \"Cidade\",\n \"endereco_estado\": \"Estado\",\n \"tipo_exibicao_retirada\": 1,\n \"observacao_retirada\": \"\"\n },\n {\n \"id\": 2,\n \"nome\": \"CD dois\",\n \"cnpj\": \"56246832000147\",\n \"inscricao_estadual\": \"324234\",\n \"endereco_cep\": \"13732550\",\n \"endereco_logradouro\": \"rua americo assoline\",\n \"endereco_numero\": \"234234\",\n \"endereco_complemento\": \"234234\",\n \"endereco_bairro\": \"jardim alvorada\",\n \"endereco_cidade\": \"Mococa\",\n \"endereco_estado\": \"SP\",\n \"tipo_exibicao_retirada\": 2,\n \"observacao_retirada\": \"Campo de Observação\"\n }\n ],\n \"tipo_entrega_fixos\": [\n {\n \"id\": 4,\n \"tipo_entrega_id\": 6,\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"22:00:00\",\n \"dias_semana\": [\n \"Segunda\",\n \"Terça\",\n \"Quarta\",\n \"Quinta\",\n \"Sexta\"\n ]\n },\n {\n \"id\": 5,\n \"tipo_entrega_id\": 6,\n \"hora_inicial\": \"09:00:00\",\n \"hora_final\": \"15:00:00\",\n \"dias_semana\": [\n \"Domingo\",\n \"Sábado\"\n ]\n }\n ]\n }\n}\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"descricao\": \"Entrega CD1 \",\n \"resumo\": \"Entrega CD1 semi-intevalos\",\n \"quantidade_maxima_itens\": null,\n \"desativado\": false,\n \"retirada_loja\": false,\n \"tipo_intervalo\": \"sem-intervalos\",\n \"exclusivo_televendas\": true,\n \"tipo_entrega_horarios\": [\n {\n \"id\": 1,\n \"tipo_entrega_id\": 1,\n \"dia_semana\": \"Domingo\",\n \"hora_inicial\": \"21:00:00\",\n \"hora_final\": \"21:00:00\"\n },\n {\n \"id\": 3,\n \"tipo_entrega_id\": 1,\n \"dia_semana\": \"Terça\",\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"18:00:00\"\n },\n {\n \"id\": 7,\n \"tipo_entrega_id\": 1,\n \"dia_semana\": \"Sábado\",\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"13:00:00\"\n }\n ]\n }\n}\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 3,\n \"descricao\": \"Entrega Todos os CDs\",\n \"resumo\": \"Entrega Todos os CDs Intervalos Fixos\",\n \"quantidade_maxima_itens\": null,\n \"desativado\": false,\n \"retirada_loja\": false,\n \"tipo_intervalo\": \"intervalos-fixos\",\n \"exclusivo_televendas\": false,\n \"tipo_entrega_fixos\": [\n {\n \"id\": 1,\n \"tipo_entrega_id\": 3,\n \"hora_inicial\": \"08:00:00\",\n \"hora_final\": \"12:00:00\",\n \"dias_semana\": [\n \"Segunda\",\n \"Terça\",\n \"Quarta\",\n \"Quinta\",\n \"Sexta\",\n \"Sábado\"\n ]\n },\n {\n \"id\": 2,\n \"tipo_entrega_id\": 3,\n \"hora_inicial\": \"12:01:00\",\n \"hora_final\": \"19:00:00\",\n \"dias_semana\": [\n \"Segunda\",\n \"Quarta\",\n \"Sexta\"\n ]\n },\n {\n \"id\": 3,\n \"tipo_entrega_id\": 3,\n \"hora_inicial\": \"12:01:00\",\n \"hora_final\": \"20:00:00\",\n \"dias_semana\": [\n \"Terça\",\n \"Quinta\",\n \"Sábado\"\n ]\n }\n ]\n }\n}\nSerá retornado o código de status 404 Not found quando o ID do tipo de entrega informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/tipo-entregas/200\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os tipos de entregas cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-entregas
\nPara listar todas os tipos de entregas é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"descricao\": \"Entrega CD1 \",\n \"desativado\": true,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 2,\n \"descricao\": \"Entrega CD 2\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 3,\n \"descricao\": \"Entrega Televendas\",\n \"desativado\": false,\n \"exclusivo_televendas\": true\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 13,\n \"limit\": null\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os tipos de entregas ativos.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-entregas/ativos
\nPara listar os tipos de entregas ativos é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"descricao\": \"Entrega CD 2\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 3,\n \"descricao\": \"Entrega Todos os CDs\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 4,\n \"descricao\": \"Retirada CD1\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n }\n ]\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite listar os tipos de entregas não exclusivos para o televendas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-entregas/nao-exclusivos
\nPara listar os tipos de entregas não exclusivos para o televendas é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"descricao\": \"Entrega CD1 \",\n \"desativado\": true,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 2,\n \"descricao\": \"Entrega CD 2\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n },\n {\n \"id\": 3,\n \"descricao\": \"Entrega Todos os CDs\",\n \"desativado\": false,\n \"exclusivo_televendas\": false\n }\n ]\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos
\nPara cadastrar um veículo é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do veiculo (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| tipo_veiculo_id | \nID do tipo de veículo. | \nSim | \n
| placa | \nPlaca do veículo | \nSim | \n
| modelo | \nModelo do veículo. | \nSim | \n
| ano | \nAno do veículo. | \nSim | \n
| km | \nQuilometragem do veículo. | \nNão | \n
| capacidade_normal | \nCapacidade máxima de volumes normais que o veículo pode transportar. | \nNão | \n
| capacidade_frios | \nCapacidade máxima de volumes frios que o veículo pode transportar. | \nNão | \n
| capacidade_maxima_kg | \nPeso máximo de cargas (em KG) que o veículo pode transportar. | \nNão | \n
| capacidade_máxima volumétrica | \nVolume máximo volumétrico de cargas que o veículo pode trasportar. | \nNão | \n
| cor | \nCor predominante do veículo. | \nNão | \n
| ativo | \nInforma se o veículo está ativo ou não. Valores podem ser \"true\" para ativo ou \"false\" para desativado. | \nNão | \n
Atenção caso não informado o campo \"ativo\", é assumido o valor \"true\".
\n\n{\n \"tipo_veiculo_id\": 1,\n \"placa\": \"HAX-9731\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2015,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 62\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem de campo obrigatório quando o campo não for informado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"placa\": \"Este campo é obrigatório\",\n \"modelo\": \"Este campo é obrigatório\",\n \"ano\": \"Este campo é obrigatório\",\n \"tipo_veiculo_id\": \"Este campo é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo tipo_veiculo_id com a mensagem \"Este valor não existe\", quando o ID do tipo de veículo não estiver cadastrado.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_veiculo_id\": \"Este valor não existe\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem de campo obrigatório está com valor vazio informado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/69\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"placa\": \"Este campo não pode ser deixado vazio\",\n \"modelo\": \"Este campo não pode ser deixado vazio\",\n \"ano\": \"Este campo não pode ser deixado vazio\",\n \"tipo_veiculo_id\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/ID_VEICULOS
\nPara editar um veículo é necessário enviar uma requisição PUT. No corpo body da requisição será necessário informar os dados do veículo (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| tipo_veiculo_id | \nID do tipo de veículo. | \nNão | \n
| placa | \nPlaca do veículo | \nNão | \n
| modelo | \nModelo do veículo. | \nSim | \n
| ano | \nAno do veículo. | \nNão | \n
| km | \nQuilometragem do veículo. | \nNão | \n
| capacidade_normal | \nCapacidade máxima de volumes normais que o veículo pode transportar. | \nNão | \n
| capacidade_frios | \nCapacidade máxima de volumes frios que o veículo pode transportar. | \nNão | \n
| capacidade_maxima_kg | \nPeso máximo de cargas (em KG) que o veículo pode transportar. | \nNão | \n
| capacidade_máxima volumétrica | \nVolume máximo volumétrico de cargas que o veículo pode trasportar. | \nNão | \n
| cor | \nCor predominante do veículo. | \nNão | \n
| ativo | \nInforma se o veículo está ativo ou não. | \nNão | \n
\n{\n \"tipo_veiculo_id\": 1,\n \"placa\": \"HAX-9731\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2015,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true\n}\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{ \n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem de campo obrigatório está com valor vazio informado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/69\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"placa\": \"Este campo não pode ser deixado vazio\",\n \"modelo\": \"Este campo não pode ser deixado vazio\",\n \"ano\": \"Este campo não pode ser deixado vazio\",\n \"tipo_veiculo_id\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity no campo tipo_veiculo_id com a mensagem \"Este valor não existe\", quando o ID do tipo de veículo não estiver cadastrado.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_veiculo_id\": \"Este valor não existe\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar veículos cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos
\nOs parâmetros permitidos são:
\nExemplos:
\n\n\nBusca por ativo:
\n{{URL}}/importacao/veiculos?ativo=1Busca por tipo de veiculo:
\n{{URL}}/importacao/veiculos?tipo_veiculo_id=2Busca por status do veiculo:
\n{{URL}}/importacao/veiculos?status=D
Atenção ao não informar nenhum parâmetro, será retornado todos os veículos cadastrados.
\nPara listar o(s) veículos(s) é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"tipo_veiculo_id\": 1,\n \"placa\": \"HMJ-9731\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2013,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true,\n \"status\": \"D\",\n \"created\": \"2020-06-18T15:11:12-03:00\",\n \"modified\": \"2020-06-18T15:11:12-03:00\"\n },\n {\n \"id\": 2,\n \"tipo_veiculo_id\": 1,\n \"placa\": \"HAX-9731\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2015,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true,\n \"status\": \"D\",\n \"created\": \"2020-06-18T15:11:12-03:00\",\n \"modified\": \"2020-06-18T15:11:12-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 2,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um veiculo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/ID_VEICULO
\nPara consultar um veículo é necessário enviar uma requisição GET, sendo necessário informar o ID do veículo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 3,\n \"tipo_veiculo_id\": 1,\n \"placa\": \"QJU-9731\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2015,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true,\n \"status\": \"E\",\n \"created\": \"2020-06-18T15:11:12-03:00\",\n \"modified\": \"2020-06-18T15:11:12-03:00\"\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/veiculos/50\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/ID_VEICULO
\nPara excluir um veículo é necessário enviar uma requisição DELETE informando o ID do veículo na URL.
Atenção não é possivel excluir um veículo que já realizou ou está realizando uma entrega.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do veiculo informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/veiculos/222\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 403 Forbidden quando existirem entregas associadas ao veículo, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Exclusão não pode ser realizada. Existem entregas associadas ao veículo\",\n \"url\": \"/importacao/veiculos/1\",\n \"code\": 403,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\BadRequestException\",\n \"code\": 403,\n \"message\": \"Exclusão não pode ser realizada. Existem entregas associadas ao veículo\"\n }\n }\n}\nÉ possível listar os veículos cadastrados,consultar um veículo específico, editar, excluir e cadastrar uma novo veículo.
\n","event":[{"listen":"prerequest","script":{"id":"152c52f7-3d1a-47e8-848f-642e87cd60b1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2fc7e3c6-613c-4d10-bcfe-08edbf89182f","type":"text/javascript","exec":[""]}}],"_postman_id":"7c3d0cc2-c44d-4838-9ee7-8ec572e7deb8"},{"name":"Tipo veículo","item":[{"name":"Adicionar tipo de veículo ","id":"783220dd-4d01-4f8d-9ff4-9a85c786aa89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"descricao\": \"Van\", \n \"habilitacao_categorias\": [1,3,4,5]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/tipo-veiculos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um tipo de veiculo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-veiculos
\nPara cadastrar um tipo de veiculo é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do tipo de veiculo (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do tipo de veiculo | \nSim | \n
| habilitacao_categorias | \nID da categoria de habilitação | \nSim | \n
Tipos de ID da categoria aceitos:
\n| ID | \nTipo de categoria | \n
|---|---|
| 1 | \nA | \n
| 2 | \nB | \n
| 3 | \nC | \n
| 4 | \nD | \n
| 5 | \nE | \n
\n{\n \"descricao\": \"Van\", \n \"habilitacao_categorias\": [1,3,4,5]\n}\n\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 72\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\" quando campos obrigatórios não forem informados no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/tipo-veiculos\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 2,\n \"errors\": {\n \"descricao\": \"Este campo é obrigatório\"\n \"habilitacao_categorias\": \"Este campo é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\" quando os campos \"descricao\" e/ou \"habilitacao_categorias\" forem informados em branco no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/tipo-veiculos/\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 2,\n \"errors\": {\n \"descricao\": \"Este campo não pode ser deixado vazio\"\n \"habilitacao_categorias: \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"ID de categoria inválido\" quando o campo \"habilitacao_categorias\" for inválido no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/tipo-veiculos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"habilitacao_categorias. \": \"id de categoria inválido\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um tipo de veiculo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-veiculos/ID_TIPO_VEICULO
\nPara editar um tipo de veiculo é necessário enviar uma requisição PUT, no corpo body da requisição será necessário informar os dados do tipo de veiculo a ser editado (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| descricao | \nDescrição do tipo de veiculo | \nNão | \n
| habilitacao_categorias | \nID da categoria de habilitação | \nNão. | \n
Tipos de ID da categoria aceitos:
\n| ID | \nTipo de categoria | \n
|---|---|
| 1 | \nA | \n
| 2 | \nB | \n
| 3 | \nC | \n
| 4 | \nD | \n
| 5 | \nE | \n
\n{\n \"descricao\": \"Kombi\",\n \"habilitacao_categorias\": [3,4,5]\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\" quando os campos \"descricao\" e/ou \"habilitacao_categorias\" forem informados em branco no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/tipo-veiculos/\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 2,\n \"errors\": {\n \"descricao\": \"Este campo não pode ser deixado vazio\"\n \"habilitacao_categorias: \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"ID de categoria inválido\" quando um ID inválido for informado no campo \"habilitacao_categorias\" no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/tipo-veiculos/1\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"habilitacao_categorias. 23\": \"id de categoria inválido\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando um ID do tipo de veículo inválido for informado na URL da requisição.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/tipo-veiculos/10\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar tipos de veiculos cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-veiculos
\nPara listar o(s) tipos(s) de veiculo(s) é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"descricao\": \"Kombi\",\n \"habilitacao_categorias\": [\n {\n \"id\": 2,\n \"categoria\": \"B\"\n },\n {\n \"id\": 3,\n \"categoria\": \"C\"\n }\n ]\n },\n {\n \"id\": 2,\n \"descricao\": \"Caminhão\",\n \"habilitacao_categorias\": [\n {\n \"id\": 2,\n \"categoria\": \"B\"\n },\n {\n \"id\": 4,\n \"categoria\": \"D\"\n },\n {\n \"id\": 5,\n \"categoria\": \"E\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 5,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um tipo de veiculo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-veiculos/ID_TIPO_VEICULO
\nPara consultar um tipo de veiculo é necessário enviar uma requisição GET, sendo necessário informar o ID do tipo de veiculo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"descricao\": \"Kombi\",\n \"habilitacao_categorias\": [\n {\n \"id\": 3,\n \"categoria\": \"C\"\n },\n {\n \"id\": 4,\n \"categoria\": \"D\"\n },\n {\n \"id\": 5,\n \"categoria\": \"E\"\n },\n {\n \"id\": 2,\n \"categoria\": \"Z\"\n }\n ]\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do tipo de veiculo informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/tipo-veiculos/100000\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um tipo de veiculo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/tipo-veiculos/ID_TIPO_VEICULO
\nPara excluir um tipo de veiculo é necessário enviar uma requisição DELETE, informando como parâmetro o ID do tipo de veículo.
Atenção Não será possível remover um tipo de veículo que possua relacionamentos. Caso seja realizado uma requisição de exclusão de um tipo de veículo que possua relacionamento com um veículo por exemplo, a API retornará erro conforme o exemplo determinado 500 - Internal Server Error .
Os parametros permitidos são
\nExemplos:
\n\n\nID do Tipo de Veículo:
\n{{URL}}/importacao/tipo-veiculos/2
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Not Found quando o ID informado na URL for inválido, conforme exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/tipo-veiculos/233\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 403 Forbidden quando um tipo de veículo estiver associado a um veículo. Neste caso, o tipo de veículo não pode ser removido, conforme o exemplo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Exclusão não pode ser realizada. Existem veículos associados ao tipo de veículo\",\n \"url\": \"/importacao/tipo-veiculos/1\",\n \"code\": 403,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\BadRequestException\",\n \"code\": 403,\n \"message\": \"Exclusão não pode ser realizada. Existem veículos associados ao tipo de veículo\"\n }\n }\n}\nTipos de veículos são categorias de veículos utilizados para a entrega. Por meio da API é possível visualizar todos os tipos de veículos cadastrados, consultar um tipo de veículo específico, editar, excluir e cadastrar um novo tipo de veículo.
\n","event":[{"listen":"prerequest","script":{"id":"471558de-b7ff-44a0-a931-79a745467574","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9f6602ee-34a7-42b7-8a86-57289b6ef659","type":"text/javascript","exec":[""]}}],"_postman_id":"9196401b-24d5-4ade-86ef-6d40992d417e"}],"id":"d4243697-f6e2-4fe3-9796-79b4c7162dbf","description":"A API de Veículos é um módulo que permite gerenciar os tipos de veículos e veículos do sistema de forma rápida e prática, oferecendo maior flexibilidade e agilidade no processo.
\n","event":[{"listen":"prerequest","script":{"id":"0de9a5a1-d500-4b10-b5f8-520db1b9b3eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9c5cc8aa-be0b-4ada-91eb-aae15387b910","type":"text/javascript","exec":[""]}}],"_postman_id":"d4243697-f6e2-4fe3-9796-79b4c7162dbf"},{"name":"Usuários","item":[{"name":"Grupo de Usuários","item":[{"name":"Listar grupo de usuários","id":"24056964-40e5-4fed-ae03-22ccb9d1026a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"url":"{{URL}}/importacao/grupos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui.
\nPermite listar os grupos de usuários cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/grupos/
\nPara listar todos os grupos de usuários cadastrados é necessário enviar uma requisição GET, não sendo necessário informar nenhum parâmetro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"descricao\": \"Administrador do Sistema\"\n },\n {\n \"id\": 2,\n \"descricao\": \"Supervisor\"\n },\n {\n \"id\": 3,\n \"descricao\": \"Suporte\"\n },\n {\n \"id\": 4,\n \"descricao\": \"Comunicação\"\n },\n {\n \"id\": 5,\n \"descricao\": \"Comercial\"\n },\n {\n \"id\": 6,\n \"descricao\": \"Atendimento\"\n },\n {\n \"id\": 7,\n \"descricao\": \"Separador\"\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 7,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um grupo de usuários através do ID do grupo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/grupos/ID_GRUPO
\nPara consultar as informações de um grupo de usuários é necessário enviar uma requisição GET, sendo necessário informar o ID do grupo na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"descricao\": \"Administrador do Sistema\"\n }\n}\nSerá retornado o código de status 404 Not found quando o ID do grupo de usuários informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/grupos/100\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nÉ possivél listar os grupos de usários cadastrados, além de realizar a consulta de um grupo especifico.
\n","event":[{"listen":"prerequest","script":{"id":"dd58b7c5-704c-471c-863a-2e936b6d0fa1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c2b4aaf8-9296-4c4a-9b01-0da48b67635b","type":"text/javascript","exec":[""]}}],"_postman_id":"af3218c5-6cc1-4fc8-a1a2-27506f15fab0"},{"name":"Usuários","item":[{"name":"Adicionar usuário","id":"82967011-b77c-44ad-a508-e25f919d0360","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n\t\"grupo_id\": 2,\n\t\"nome\": \"Motorista\",\n\t\"username\": \"motorista\",\n\t\"cpf\": \"11111111111\",\n\t\"email\": \"motorista@vipcommerce.com.br\",\n\t\"cep\": \"30840-400\",\n\t\"logradouro\": \"Logradouro\",\n\t\"numero\": 155,\n\t\"complemento\": null,\n\t\"bairro\": \"Bairro\",\n\t\"cidade\": \"Cidade\",\n\t\"uf\": \"UF\",\n\t\"sigla\": \"\",\n\t\"telefone_fixo\": \"319999999\",\n\t\"telefone_celular\": \"31999999999\",\n\t\"expirar\": null,\n\t\"desativar\": false,\n\t\"funcionario\": true,\n\t\"status\": \"B\",\n\t\"numero_habilitacao\": \"12345678901\",\n\t\"padrao\": false,\n\t\"habilitacao_categorias\": [1],\n\t\"cargos\": [2],\n\t\"centro_distribuicoes\": [1,2,3],\n\t\"filiais\": [1,2]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/usuarios","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um usuário.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/usuarios
\nAtenção
\nPara cadastrar um usuário é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados do funcionario (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| grupo_id | \nDefine o grupo no qual o usuário e funções o mesmo terá acesso. | \nSim | \n
| nome | \nNome do usuário. | \nSim | \n
| username | \nLogin de acesso. | \nSim | \n
| cpf | \nCPF do usuário. | \nSim | \n
| Email do usuário. | \nSim | \n|
| cep | \nCep do usuário. | \nSim | \n
| logradouro | \nEndereço do usuário. Ex: Av. Afonso Pena. | \nSim | \n
| numero | \nNúmero do endereço usuário. | \nSim | \n
| complemento | \nComplemento do endereço usuário. | \nNão | \n
| bairro | \nBairro em que o logradouro está situado. | \nSim | \n
| cidade | \nCidade em que o logradouro está situado. | \nSim | \n
| uf | \nEstado em que o logradouro está situado. Ex: MG, SP, RJ. | \nSim | \n
| sigla | \n. | \nNão | \n
| telefone_fixo | \nNúmero do telefone fixo do usuário. | \nNão | \n
| telefone_celular | \nNúmero do telefone celular do usuário. | \nSim | \n
| expirar | \nData em que o acesso do usuário será expirado. | \nNão | \n
| desativar | \nInforma se o usuário está desativado ou não. Valores: \"0\" para ativo e \"1\" para desativado.\n | \nNão | \n
| funcionario | \nAo desativar um usuário, este não poderá mais fazer login no sistema\n
| \n Não | \n
| cargos | \nCargo do usuário. É necessário informar o ID do cargo, sendo:\n
| \n Não | \n
| numero_habilitacao | \nNúmero da habilitação do motorista . | \nObrigatório quando \"cargo = 2\" | \n
| habilitacao_categorias | \nCategorias da Habilitaçao. É necessário informar o ID na requisição, sendo:\n
| \n Obrigatório quando \"cargo = 2\" | \n
| filiais | \nExibe o nome das filiais nas quais o usuário pode realizar ações | \nNão | \n
| centro_distribuicoes | \nExibe o nome dos centros de distribuições nas quais o usuário pode realizar ações | \nNão | \n
\n{\n \"grupo_id\": 2,\n \"nome\": \"Motorista\",\n \"username\": \"motorista\",\n \"cpf\": \"11111111111\",\n \"email\": \"motorista@vipcommerce.com.br\",\n \"cep\": \"30840-400\",\n \"logradouro\": \"Logradouro\",\n \"numero\": 155,\n \"complemento\": null,\n \"bairro\": \"Bairro\",\n \"cidade\": \"Cidade\",\n \"uf\": \"UF\",\n \"sigla\": \"\",\n \"telefone_fixo\": \"319999999\",\n \"telefone_celular\": \"31999999999\",\n \"expirar\": null,\n \"desativar\": false,\n \"funcionario\": true,\n \"status\": \"B\",\n \"numero_habilitacao\": \"12345678901\",\n \"padrao\": false,\n \"habilitacao_categorias\": [1],\n \"cargos\": [2],\n \"centro_distribuicoes\": [1,2,3],\n \"filiais\": [1,2]\n}\n\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso informado o id gerado, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 148\n }\n}\nSerá retornado o código de status 422 Bad Request quando algum campo obrigatorio não for enviado.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios\",\n \"message\": \"11 erros de validação ocorridos\",\n \"errorCount\": 11,\n \"errors\": {\n \"nome\": \"Este campo é obrigatório\",\n \"username\": \"Este campo é obrigatório\",\n \"cpf\": \"O campo CPF é obrigatório\",\n \"grupo_id\": \"Este campo é obrigatório\",\n \"cep\": \"Este campo é obrigatório\",\n \"logradouro\": \"Este campo é obrigatório\",\n \"numero\": \"Este campo é obrigatório\",\n \"bairro\": \"Este campo é obrigatório\",\n \"cidade\": \"Este campo é obrigatório\",\n \"uf\": \"Este campo é obrigatório\",\n \"telefone_celular\": \"Este campo é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 422 Bad Request quando já houver a informação cadastrada.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"username\": \"Username já cadastrado\",\n \"cpf\": \"CPF já cadastrado\"\n }\n }\nSerá retornado o código de status 422 Bad Request quando já houver a informação inválida.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios\",\n \"message\": \"8 erros de validação ocorridos\",\n \"errorCount\": 8,\n \"errors\": {\n \"cpf\": \"O CPF informado é inválido\",\n \"cep\": \"O CEP informado é inválido\",\n \"email\": \"O valor fornecido é inválido\",\n \"telefone_fixo\": \"O valor fornecido é inválido\",\n \"telefone_celular\": \"O valor fornecido é inválido\",\n \"status\": \"O valor fornecido é inválido\",\n }\n }\n}\nSerá retornado o código de status 422 Bad Request quando já houver a informação não encontrada.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"cargos\": \"Cargo não encontrado\",\n \"filiais\": \"Filial não encontrada\",\n \"centro_distribuicoes\": \"Centro distribuição não encontrado\"\n \"habilitacao_categorias\": \"Habilitação categoria não encontrado\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar um usuário.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/usuarios/ID_USUARIO
\nPara editar um usuário é necessário enviar uma requisição PUT. No corpo body da requisição será necessário informar os dados do cliente (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| grupo_id | \nDefine o grupo no qual o usuário e funções o mesmo terá acesso. | \nSim | \n
| nome | \nNome do usuário. | \nSim | \n
| username | \nLogin de acesso. | \nSim | \n
| cpf | \nCPF do usuário. | \nSim | \n
| Email do usuário. | \nSim | \n|
| cep | \nCep do usuário. | \nSim | \n
| logradouro | \nEndereço do usuário. Ex: Av. Afonso Pena. | \nSim | \n
| numero | \nNúmero do endereço usuário. | \nSim | \n
| complemento | \nComplemento do endereço usuário. | \nNão | \n
| bairro | \nBairro em que o logradouro está situado. | \nSim | \n
| cidade | \nCidade em que o logradouro está situado. | \nSim | \n
| uf | \nEstado em que o logradouro está situado. Ex: MG, SP, RJ. | \nSim | \n
| sigla | \n. | \nNão | \n
| telefone_fixo | \nNúmero do telefone fixo do usuário. | \nNão | \n
| telefone_celular | \nNúmero do telefone celular do usuário. | \nSim | \n
| expirar | \nData em que o acesso do usuário será expirado. | \nNão | \n
| desativar | \nInforma se o usuário está desativado ou não. Valores: \"0\" para ativo e \"1\" para desativado.\n | \nNão | \n
| funcionario | \nAo desativar um usuário, este não poderá mais fazer login no sistema\n
| \n Não | \n
| cargos | \nCargo do usuário. É necessário informar o ID do cargo, sendo:\n
| \n Não | \n
| numero_habilitacao | \nNúmero da habilitação do motorista . | \nObrigatório quando \"cargo = 2\" | \n
| habilitacao_categorias | \nCategorias da Habilitaçao. É necessário informar o ID na requisição, sendo:\n
| \n Obrigatório quando \"cargo = 2\" | \n
| filiais | \nExibe o nome das filiais nas quais o usuário pode realizar ações | \nNão | \n
| centro_distribuicoes | \nExibe o nome dos centros de distribuições nas quais o usuário pode realizar ações | \nNão | \n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do usuário informado na URL da requisição for inválido ou quando o ID do usuário for referente a um usuário padrão de sistema.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/usuarios/34343\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem de campo obrigatório está com valor vazio informado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/2\",\n \"message\": \"11 erros de validação ocorridos\",\n \"errorCount\": 11,\n \"errors\": {\n \"nome\": \"Este campo não pode ser deixado vazio\",\n \"username\": \"Este campo não pode ser deixado vazio\",\n \"cpf\": \"O campo CPF é obrigatório\",\n \"grupo_id\": \"Este campo não pode ser deixado vazio\",\n \"cep\": \"Este campo não pode ser deixado vazio\",\n \"logradouro\": \"Este campo não pode ser deixado vazio\",\n \"numero\": \"Este campo não pode ser deixado vazio\",\n \"bairro\": \"Este campo não pode ser deixado vazio\",\n \"cidade\": \"Este campo não pode ser deixado vazio\",\n \"uf\": \"Este campo não pode ser deixado vazio\",\n \"telefone_celular\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\" quando os campos forem enviados em branco, possuirem valores inválidos, como quantidade de caracteres, espaços, formatos incorretos e etc, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/125\",\n \"message\": \"17 erros de validação ocorridos\",\n \"errorCount\": 17,\n \"errors\": {\n \"grupo_id\": \"O valor fornecido é inválido\",\n \"nome\": \"O valor fornecido é inválido\",\n \"username\": \"O valor fornecido é inválido\",\n \"telefone_fixo\": \"O valor fornecido é inválido\",\n \"telefone_celular\": \"O valor fornecido é inválido\",\n \"email\": \"O valor fornecido é inválido\",\n \"cpf\": \"O CPF informado é inválido\", \n \"cep\": \"O CEP informado é inválido\",\n \"logradouro\": \"O valor fornecido é inválido\",\n \"numero\": \"O valor fornecido é inválido\",\n \"bairro\": \"O valor fornecido é inválido\",\n \"cidade\": \"O valor fornecido é inválido\",\n \"uf\": \"O valor fornecido é inválido\",\n \"expirar\": \"O valor fornecido é inválido\", \n \"numero_habilitacao\": \"O valor fornecido é inválido\",\n \"desativar\": \"O valor fornecido é inválido\"\n \n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor já está em uso\" quando os campos possuirem valores que já estão em uso por outro usuário, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/147\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"email\": \"Esse valor já está em uso\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"[Campo] não encontrado(a)\" quando o valor do campo informado no payload no body da requisição for inválido, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/125\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"filiais\": \"Filial não encontrada\",\n \"centro_distribuicoes\": \"Centro distribuição não encontrado\", \n \"cargos\": \"Cargo não encontrado\",\n \"habilitacao_categorias\": \"Habilitação categoria não encontrado\"\n\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"[Campo] já cadastrado\" quando o valor do campo informado no payload no body da requisição estiver sido cadastrado para outro usuário, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/125\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"username\": \"Username já cadastrado\",\n \"cpf\": \"CPF já cadastrado\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Motorista precisa ter número e categoria de habilitação\", quando o cargo do usuário for igual a 2 (Motorista) e não for informado os campos \"habilitacao_categoriashabilitacao_categorias\" e \"numero_habilitacao\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/usuarios/125\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"cargos\": \"Motorista precisa ter número e categoria de habilitação\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar todos os usuários cadastrados.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/usuarios
\n\n\nBusca por ID:
\n{{URL}}/importacao/usuarios/?id=12Busca por status:
\n{{URL}}/importacao/usuarios/?status=dBusca por Cargo:
\n{{URL}}/importacao/usuarios/?cargo_id=2Busca por grupo:
\n{{URL}}/importacao/usuarios/?grupo_id=3Busca por filial:
\n{{URL}}/importacao/usuarios/?filial_id=2Busca por centro de distribuição:
\n{{URL}}/importacao/usuarios/?centro_distribuicao_id=1
Para listar todos os usuários cadastrados é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"grupo_id\": 8,\n \"nome\": \"separador gestor 01 filial 01\",\n \"username\": \"separador.gestor01\",\n \"cpf\": \"64591205010\",\n \"email\": \"separador01@hotmail.com\",\n \"cep\": \"30881-550\",\n \"logradouro\": \"teste\",\n \"numero\": 8210928,\n \"complemento\": \"teste\",\n \"bairro\": \"teste\",\n \"cidade\": \"teste\",\n \"uf\": \"SP\",\n \"sigla\": \"\",\n \"telefone_fixo\": \"88888888888\",\n \"telefone_celular\": \"888888888888\",\n \"expirar\": null,\n \"desativar\": true,\n \"funcionario\": true,\n \"status\": \"D\",\n \"numero_habilitacao\": \"\",\n \"push_notification_token\": null\n },\n {\n \"id\": 3,\n \"grupo_id\": 8,\n \"nome\": \"separador gestor 02 filial 02\",\n \"username\": \"separador.gestor02\",\n \"cpf\": \"22460871040\",\n \"email\": \"separador02@hotmail.com\",\n \"cep\": \"30881-550\",\n \"logradouro\": \"teste\",\n \"numero\": 123,\n \"complemento\": \"teste\",\n \"bairro\": \"teste\",\n \"cidade\": \"teste\",\n \"uf\": \"teste\",\n \"sigla\": \"\",\n \"telefone_fixo\": \"11111111111\",\n \"telefone_celular\": \"222222222222\",\n \"expirar\": null,\n \"desativar\": true,\n \"funcionario\": true,\n \"status\": \"D\",\n \"numero_habilitacao\": \"\",\n \"push_notification_token\": null\n }\n ],\n \"pagination\": {\n \"page_count\": 6,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 107,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar um usuário.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/usuarios/ID_USUARIO
\nPara consultar um usuário é necessário enviar uma requisição GET, sendo necessário informar o ID do usuário na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 80,\n \"grupo_id\": 1,\n \"nome\": \"teste cadastro api 117\",\n \"username\": \"teste_api_1177\",\n \"cpf\": \"999999999\",\n \"email\": null,\n \"cep\": \"31275-000\",\n \"logradouro\": \"teste\",\n \"numero\": 444,\n \"complemento\": \"casa\",\n \"bairro\": \"44\",\n \"cidade\": \"ddd\",\n \"uf\": \"MG\",\n \"sigla\": \"\",\n \"telefone_fixo\": \"\",\n \"telefone_celular\": \"31333333333\",\n \"expirar\": null,\n \"desativar\": false,\n \"funcionario\": false,\n \"status\": \"D\",\n \"numero_habilitacao\": \"12345678912\",\n \"padrao\": false,\n \"push_notification_token\": \"\",\n \"created\": \"2020-09-23T15:01:46-03:00\",\n \"modified\": \"2020-09-23T15:55:05-03:00\",\n \"habilitacao_categorias\": [\n \n {\n \"id\": 2,\n \"categoria\": \"B\"\n },\n {\n \"id\": 3,\n \"categoria\": \"C\"\n },\n {\n \"id\": 4,\n \"categoria\": \"D\"\n }\n ],\n \"cargos\": [\n {\n \"id\": 1,\n \"descricao\": \"Separador\"\n },\n {\n \"id\": 2,\n \"descricao\": \"Motorista\"\n }\n ],\n \"centro_distribuicoes\": [\n {\n \"id\": 1,\n \"nome\": \"CD Principal\"\n }\n ],\n \"filiais\": [\n {\n \"id\": 1,\n \"nome\": \"Filial 1 Develop\",\n \"site_url\": \"https://www.develop.vipcommerce.com.br/\"\n }\n ]\n}\n}\nSerá retornado o código de status 404 Not Found quando o ID do usuário informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/usuarios/8000\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do usuário informado na URL for de usuários de sistema (campo padrão = 1) conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/usuarios/8000\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nÉ possivél cadastrar, editar, lista e consultar usuários cadastrados.
\n","event":[{"listen":"prerequest","script":{"id":"802a1ff8-a6d7-4ae5-97b9-11719d69d858","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cc11d007-aad3-4432-9190-508670e3aa16","type":"text/javascript","exec":[""]}}],"_postman_id":"8b034e02-5b94-4b54-aa99-ab606ed2df68"}],"id":"4668199d-c755-4e00-985e-e8e6d4cd9b2c","description":"A API de usuários permite que sistemas externos ao VIP Commerce gerenciem usuários da plataforma.
\n","event":[{"listen":"prerequest","script":{"id":"94be7573-ac58-4f05-871f-cc45e3a81cf6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"06e9b3b6-0ff3-45f6-8e47-64be31660041","type":"text/javascript","exec":[""]}}],"_postman_id":"4668199d-c755-4e00-985e-e8e6d4cd9b2c"},{"name":"Faturamento","item":[{"name":"Confirmação pagamento","item":[{"name":"Confirmar pagamento","id":"93650d50-5ecf-4115-adf1-510389dc9103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [100,102,452]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/pedidos/{{PEDIDO_ID}}/faturamento/pagamentos","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite confirmar o pagamento de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/PEDIDO_ID/faturamento/pagamentos
\nAtenção a confirmação de pagamento só é realizada para pagamentos pré-pagos e que já estejam capturados.
\nPara confirmar o pagamento de um pedido é necessário enviar uma requisição POST informando como parâmetro o ID da compra. No corpo body da requisição será necessário informar os ids dos pagamentos do pedido.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| ids | \nIDs dos pagamentos do pedido. | \nSim | \n
\n{\n \"ids\": [100,102,452]\n}\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n 684\n ],\n \"warnings\": []\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pagamento não capturado\", quando o pagamento do pedido não foi capturado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": [],\n \"warnings\": {\n \"684\": \"Pagamento não capturado\"\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pagamento pós pago\", quando o pagamento do pedido for pós-pago, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": [],\n \"warnings\": {\n \"684\": \"Pagamento pós pago\"\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"O campo ids é obrigatório\", quando o campo ids não for informado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000149/faturamento/pagamentos\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PayloadConfirmacaoPagamentoNaoInformadoException\",\n \"code\": 400,\n \"message\": \"O campo ids é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID \"ID Compra\" informado como parâmetro na URL da requisição não for encontrado, conforme o exemplo.
\"success\": false,\n\"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/213123123/faturamento/recibo_compra\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n}\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite gerar o recibo de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{PEDIDO_ID}}/faturamento/recibo_compra
\nAtenção para gerar o recibo de um pedido, ele deverá estar no status \"Em Faturamento\" e com o número do recibo gerado.
\nPara gerar o recibo de um pedido é necessário enviar uma requisição POST, informando o ID do pedido na URL.
Será retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request quando o ID do pedido for inválido, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/123123123/faturamento/recibo_compra\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Número fiscal do pedido não preenchido\" quando o número fiscal do pedido não tenha sido gerado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000062/faturamento/recibo_compra\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\NumeroFiscaoNaoPreenchidoException\",\n \"code\": 400,\n \"message\": \"Número fiscal do pedido não preenchido\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pré-venda do pedido não gerada\" quando a pré-venda do pedido não tenha sido gerada, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000042/faturamento/recibo_compra\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PreVendaNaoGeradaException\",\n \"code\": 400,\n \"message\": \"Pré-venda do pedido não gerada\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pedido não disponível para geração do recibo da compra\" quando o pedido não estiver na etapa de faturamento, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000093/faturamento/recibo_compra\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PedidoNaoDisponivelParaGeracaoReciboException\",\n \"code\": 400,\n \"message\": \"Pedido não disponível para geração do recibo da compra\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar se o recibo de uma compra foi gerado.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{PEDIDO_ID}}/faturamento/recibo_compra
\nPara consultar se o recibo de uma compra foi gerado é necessário enviar uma requisição GET, sendo necessário informar o ID do pedido na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"impressao_recibo\": true\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID do pedido informado na URL for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/10555555/faturamento/recibo_compra\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar a pré-venda de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{PEDIDO_ID}}/faturamento/prevenda
\nPara cadastrar a pré-venda de um pedido é necessário enviar uma requisição POST, sendo necessário informar o ID do pedido na URL.
Atenção caso o parâmetro \"Permitir captura após geração da pré-venda\" (localização: Configurações -> Preferências -> Gerenciar -> Infra-estrutura) esteja desabilitado, a pré-venda de um pedido com pagamento pré-pago e captura manual, só será gerada após a captura e a confirmação do pagamento. Caso este parâmetro esteja habilitado, a pré-venda poderá ser gerada antes da captura do pagamento.
\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Não encontrado\", quando o ID do pedido informado na URL não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1515151/faturamento/prevenda\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Captura do pagamento não realizada\", quando a captura do pagamento do pedido ainda não foi realizada, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/190/faturamento/prevenda\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PreVendaCompraNaoCapturadaException\",\n \"code\": 400,\n \"message\": \"Captura do pagamento não realizada\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pré-venda já gerada previamente\", quando a pré-venda do pagamento do pedido já foi realizada, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/239/faturamento/prevenda\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PreVendaJaRealizadaException\",\n \"code\": 400,\n \"message\": \"Pré-venda já gerada previamente\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Pedido não disponível para geração de pré-venda\", quando a compra está fora do módulo de faturamento e ainda não passou por este módulo, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/155/faturamento/prevenda\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PedidoNaoDisponivelParaPreVendaException\",\n \"code\": 400,\n \"message\": \"Pedido não disponível para geração de pré-venda\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir a pré-venda de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/{{PEDIDO_ID}}/faturamento/prevenda
\nPara excluir a pré-venda é necessário enviar uma requisição DELETE, sendo necessário informar o ID do pedido na URL.
Atenção ao excluir a pré-venda de uma compra que está \"EM FATURAMENTO\" ele irá voltar para o status \"AGUARDANDO FATURAMENTO\", caso a compra não esteja nesse cenário, ao excluir a pré-venda, a compra irá permanecer no mesmo status que ela se encontra.
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"Não encontrado\", quando o ID do pedido informado na URL não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/4545000/faturamento/prevenda\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PreVendaNaoLocalizadaException\",\n \"code\": 400,\n \"message\": \"Pré-venda não localizada\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite finalizar o faturamento de um pedido.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/pedidos/PEDIDO_ID/faturamento/finalizar
\nPara finalizar o faturamento de um pedido é necessário enviar uma requisição POST informando como parâmetro o ID da compra.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request quando o pedido não tiver o número fiscar gerado com a mensagem \"Número fiscal do pedido não preenchido\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000061/faturamento/finalizar\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\NumeroFiscaoNaoPreenchidoException\",\n \"code\": 400,\n \"message\": \"Número fiscal do pedido não preenchido\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request quando o pedido não tiver o recibo gerado com a mensagem \"O Pedido não tem o recibo gerado\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000089/faturamento/finalizar\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PedidoSemReciboException\",\n \"code\": 400,\n \"message\": \"O Pedido não tem o recibo gerado\"\n }\n }\n}\n\nSerá retornado o código de status 400 Bad Request quando o pedido não estiver na etapa de faturamento com a mensagem \"Pedido não disponível para geração do recibo da compra\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000140/faturamento/finalizar\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PedidoNaoDisponivelParaGeracaoReciboException\",\n \"code\": 400,\n \"message\": \"Pedido não disponível para geração do recibo da compra\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request quando o pedido não tiver a pré-venda gerada com a mensagem \"Pré-venda do pedido não gerada\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/1000054/faturamento/finalizar\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Faturamento\\\\PreVendaNaoGeradaException\",\n \"code\": 400,\n \"message\": \"Pré-venda do pedido não gerada\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID \"ID Compra\" informado como parâmetro na URL da requisição não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/pedidos/213123123/faturamento/finalizar\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n }\n}\nGerenciamento de ações do faturamento, sendo possivél realizar a confirmação de pagamento, gerar recibo, gerar pré-venda e finalizar o faturamento de uma compra.
\n","event":[{"listen":"prerequest","script":{"id":"f9c67d3a-08e1-48ac-bdec-6ba4bb20b4e1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"51d2017b-98ec-4d29-ba0e-74d7649a86e6","type":"text/javascript","exec":[""]}}],"_postman_id":"adcd7f51-7f40-4031-a460-0779f2be1725"},{"name":"Logística","item":[{"name":"Bloquear veículo","id":"523e7bf6-59ef-409e-9e76-2504bea01eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/veiculos/{{ID_VEICULO}}/bloquear","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite bloquear veículos por meio do ID do Veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/{{ID_VEICULO}}/bloquear
\nPara bloquear um veículo é necessário enviar uma requisição POST, informando o ID do veículo na URL.
Será retornado o código de status 201 Created quando a requisição de bloqueio ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"O veículo já se encontra bloqueado\" quando o ID do veículo informado na URL da requisição já estiver bloqueado.
{\n \"success\": false,\n \"data\": \"O Veículo já se encontra bloqueado\"\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"O veículo não se encontra disponível\" quando o ID do veículo informado na URL da requisição não estiver disponível para bloqueio.
{\n \"success\": false,\n \"data\": \"Veículo não se encontra disponível\"\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL da requisição for inválido.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/veiculos/1700/bloquear\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not Found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite desbloquear veículos por meio do ID do Veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/{{ID_VEICULO}}/desbloquear
\nPara desbloquear um veículo é necessário enviar uma requisição POST, informando o ID do veículo na URL.
Será retornado o código de status 201 Created quando a requisição de desbloqueio ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Veículo bloqueado para outro usuário\" quando o ID do veículo informado na URL da requisição estiver bloqueado para outro usuário diferente do usuário que está sendo usado na API ou estiver bloqueado para algum usuário do admin.
{\n \"success\": false,\n \"data\": \"Veículo bloqueado para outro usuário\"\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"O veículo não se encontra bloqueado\" quando o ID do veículo informado na URL da requisição não estiver bloqueado.
{\n \"success\": false,\n \"data\": \"O veículo não se encontra bloqueado\"\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL da requisição for inválido.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/veiculos/1700/bloquear\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not Found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite alocar compras nos veículos por meio do ID do Veículo e ID da compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/{{ID_VEICULO}}/alocar_pedidos
\nPara alocar compras de um veículo é necessário enviar uma requisição POST informando o ID do veículo na URL. No corpo body da requisição será necessário informar o ID das compras que serão alocadas.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| Compras | \nID da compra que será alocada no veículo | \nSim | \n
\n{\n \"compras\":[150,166]\n}\n\n\n\n\nSerá retornado o código de status 201 Created quando a requisição de alocação ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Compra não pode ser alocada\" quando o ID da compra informada no payload da requisição não estiver disponível para alocação, como por exemplo, compras que estão diferente de aguardando logística.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/17/alocar_pedidos\",\n \"message\": \"2 erros de validação ocorridos:\",\n \"errorCount\": 2,\n \"errors\": {\n \"compras.id:150\": \"Compra não pode ser alocada.\",\n \"compras.id:166\": \"Compra não pode ser alocada.\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"2 erros de validação ocorridos:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Este campo é obrigatório\" quando o payload da requisição não informar o campo \"compras\", conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Este campo é obrigatório\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Informe pelo menos uma compra\" quando o payload da requisição informar o campo \"compras\" vazio, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Informe pelo menos uma compra\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Formato de dados inválido. Por favor, informe todos as compras com números inteiros\" quando o payload da requisição informar o atributo \"compras\" como string, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Formato de dados inválido. Por favor, informe todos as compras com números inteiros\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Compra não encontrada\" quando um ID de compra inválido for informado no payload da requisição, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/19/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras.id:999999\": \"Compra não encontrada.\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"A alocação não pode ser feita neste veículo\" quando o veículo não estiver disponível para alocação, como por exemplo, quando o veículo estiver bloqueado para outro usuário da API ou admin. Exemplo:
{\n \"success\": false,\n \"data\": \"A alocação não pode ser feita neste veículo\"\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Centro de distribuição das compras não corresponde ao das compras no veículo\" quando o ID da compra informado no payload da requisição for de um centro de distribuição diferente das compras que já estão alocadas no veículo. Exemplo:
{\n \"success\": false,\n \"data\": \"Centro de distribuição das compras não corresponde ao das compras no veículo\"\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Alocar somente compras vinculadas ao mesmo CD\" quando o ID das compras informadas no payload da requisição forem de centro de distribuição diferentes. Exemplo:
{\n \"success\": false,\n \"data\": \"Alocar somente compras vinculadas ao mesmo CD\"\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL da requisição for inválido, conforme exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/veiculos/2766/desalocar_pedidos\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not Found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite desalocar compras dos veículos por meio do ID do Veículo e ID da compra.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/{{ID_VEICULO}}/desalocar_pedidos
\nPara desalocar compras de um veículo é necessário enviar uma requisição POST informando o ID do veículo na URL. No corpo body da requisição será necessário informar o ID das compras que serão alocadas.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| Compras | \nID da compra que será desalocada no veículo | \nSim | \n
\n{\n \"compras\":[166,140]\n}\n\n\n\n\nSerá retornado o código de status 201 Created quando a requisição de desalocação ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Este campo é obrigatório\" quando o payload da requisição não informar o campo obrigatório \"compras\", conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Este campo é obrigatório\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Informe pelo menos uma compra\" quando o payload da requisição informar o campo \"compras\" vazio, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Informe pelo menos uma compra\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Formato de dados inválido. Por favor, informe todos as compras com números inteiros\" quando o payload da requisição informar o campo \"compras\" como string, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/20/alocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras\": \"Formato de dados inválido. Por favor, informe todos as compras com números inteiros\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Compra não alocada no veículo\" quando o ID da compra informada no payload da requisição não estiver alocada para o ID do veículo informado na URL.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/veiculos/17/desalocar_pedidos\",\n \"message\": \"1 erro de validação ocorrido:\",\n \"errorCount\": 1,\n \"errors\": {\n \"compras.id:206\": \"Compra não alocada no veículo.\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"1 erro de validação ocorrido:\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"A desalocação não pode ser feita neste veículo\" quando o veículo não estiver disponível para desalocação, como por exemplo, quando o veículo estiver desbloqueado, bloqueado para um usuário do admin ou da API e etc. Exemplo:
{\n \"success\": false,\n \"data\": \"A desalocação não pode ser feita neste veículo\"\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL da requisição for inválido, conforme exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not Found\",\n \"url\": \"/importacao/veiculos/2766/desalocar_pedidos\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not Found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite criar entregas por meio do ID do Veículo e ID da usuário.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/entregas
\nPara criar entregas é necessário enviar uma requisição POST informando o ID do veículo e ID do usuário motorista no corpo body da requisição.
\nDescrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| veiculo_id | \nID do veículo | \nSim | \n
| usuario_id | \nID do usuário motorista | \nSim | \n
\n{\n \"veiculo_id\":16, \n \"usuario_id\": 51\n}\n\n\n\n\nSerá retornado o código de status 201 Created quando a requisição de criação de entrega ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Enity com a mensagem \"Este campo é obrigatório\" quando algum campo obrigatório não for informado no payload da requisição, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/entregas\",\n \"message\": \"2 erros de validação ocorridos:\",\n \"errorCount\": 2,\n \"errors\": {\n \"veiculo_id\": \"Este campo é obrigatório\",\n \"usuario_id\": \"Este campo é obrigatório\"\n },\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\ValidationException\",\n \"code\": 422,\n \"message\": \"2 erros de validação ocorridos:\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Usuário não encontrado\" quando o ID do usuário informado payload da requisição for inválido, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Usuarios\\\\UsuarioNaoEncontradoException\",\n \"code\": 400,\n \"message\": \"Usuário não encontrado\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Veículo sem compras na pré-entrega\"\nquando o ID do veículo informado no payload da requisição não possui compras alocadas, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Veiculos\\\\VeiculoSemComprasNaPreEntregaException\",\n \"code\": 400,\n \"message\": \"Veículo sem compras na pré-entrega\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Usuário não disponível\"\nquando o ID do usuário informado no payload da requisição não estiver disponível, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Usuarios\\\\UsuarioNaoDisponivelException\",\n \"code\": 400,\n \"message\": \"Usuário não disponível\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Usuário não é motorista\"\nquando o ID do usuário informado no payload da requisição não for motorista, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Usuarios\\\\UsuarioNaoMotoristaException\",\n \"code\": 400,\n \"message\": \"Usuário não é um motorista\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Veículo bloqueado para outro usuário\"\nquando o ID do veículo informado no payload da requisição estiver bloqueado para outro usuário, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Ocorreu um erro interno.\",\n \"url\": \"/importacao/entregas\",\n \"code\": 500,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Veiculos\\\\VeiculoBloqueadoOutroUsuarioException\",\n \"code\": 0,\n \"message\": \"Veículo bloqueado para outro usuário\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"O veículo não se encontra bloqueado\"\nquando o ID do veículo informado no payload da requisição não estiver bloqueado, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Veiculos\\\\VeiculoNaoBloqueadoException\",\n \"code\": 400,\n \"message\": \"O veículo não se encontra bloqueado\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Veículo não encontrado\"\nquando o ID do veículo informado no payload da requisição for inválido, conforme exemplo abaixo:
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/importacao/entregas\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"App\\\\Exception\\\\Table\\\\Veiculos\\\\VeiculoNaoEncontradoException\",\n \"code\": 400,\n \"message\": \"Veículo não encontrado\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar a entrega através do ID da entrega.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/entregas
\nPara consultar lista de entrega é necessário enviar uma requisição GET, sendo ou não necessário informar os paramentros abaixo na URL:
Os parametros permitidos são
\n\n\nBusca por ID do veículo:
\n{{URL}}/importacao/entregas/?veiculo.id=12Busca por ID do motorista:
\n{{URL}}/importacao/entregas?usuario.id=4Busca por status da compra:
\n{{URL}}/importacao/entregas?status=A
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"status\": \"C\",\n \"total_compras\": 0,\n \"total_volumes_frios\": 0,\n \"total_volumes_comuns\": 0,\n \"veiculo_id\": 4,\n \"usuario_id\": 44\n },\n {\n \"id\": 2,\n \"status\": \"F\",\n \"total_compras\": 3,\n \"total_volumes_frios\": 4,\n \"total_volumes_comuns\": 9,\n \"veiculo_id\": 3,\n \"usuario_id\": 6\n },\n {\n \"id\": 3,\n \"status\": \"F\",\n \"total_compras\": 1,\n \"total_volumes_frios\": 5,\n \"total_volumes_comuns\": 4,\n \"veiculo_id\": 1,\n \"usuario_id\": 48\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 3,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar a entrega através do ID da entrega.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/entregas/{{ENTREGA_ID}}
\nPara consultar as informações de entrega é necessário enviar uma requisição GET, sendo necessário informar o ID da entrega na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"status\": \"F\",\n \"motivo_pendencia\": null,\n \"tempo_rota\": 0,\n \"veiculo_partida\": \"2020-10-08T09:37:28-03:00\",\n \"veiculo_retorno\": \"2020-10-08T09:38:00-03:00\",\n \"total_compras\": 1,\n \"total_compras_concluidas\": 1,\n \"total_volumes_frios\": 15,\n \"total_volumes_comuns\": 10,\n \"created\": \"2020-10-08T09:37:13-03:00\",\n \"modified\": \"2020-10-08T09:38:04-03:00\",\n \"usuario\": {\n \"id\": 48,\n \"nome\": \"Mike\"\n },\n \"veiculo\": {\n \"id\": 1,\n \"placa\": \"HMJ9731\",\n \"modelo\": \"Standart\"\n },\n \"compras\": [\n {\n \"id\": 208,\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"compra_status_id\": 15,\n \"data_entrega\": \"2020-06-23T19:40:00-03:00\",\n \"volumes_frios\": 15,\n \"volumes_comuns\": 10\n }\n ]\n }\n}\nSerá retornado o código de status 404 Not found quando o ENTREGA_ID informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/entregas/656\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite consultar veículos que estão em pré-entrega no módulo de logística por meio do ID do Veículo.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/veiculos/{{ID_VEICULO}}/pre_entrega
\nPara consultar os veículos é necessário enviar uma requisição GET, informando o ID do veículo na URL.
Será retornado o código de status 200 OK e a listagem das compras que estão alocadas no veículo quando a requisição ocorrer com sucesso e o veículo possuir compras alocadas, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 5,\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 1,\n \"compra_status_id\": 25,\n \"descricao\": \"EM LOGÍSTICA\",\n \"data_entrega\": \"2020-06-24T10:55:00-03:00\",\n \"volumes_frios\": 4,\n \"volumes_comuns\": 8\n },\n {\n \"id\": 117,\n \"filial_id\": 1,\n \"centro_distribuicao_id\": 1,\n \"compra_status_id\": 25,\n \"descricao\": \"EM LOGÍSTICA\",\n \"data_entrega\": \"2020-06-23T18:10:00-03:00\",\n \"volumes_frios\": 5,\n \"volumes_comuns\": 7\n }\n ]\n}\n| Propriedade | \nDescrição | \n
|---|---|
| data.id | \nID da compra. | \n
| data.filial_id | \nID da filial. | \n
| data.centro_distribuicao_id | \nID do centro de distribuição. | \n
| data.compra_status_id | \nID do status da compra | \n
| data.descricao | \nDescrição do status da compra. | \n
| data.data_entrega | \nData prevista de entrega. | \n
| data.volumes_frios | \nQuantidade de volumes frios da compra. | \n
| data.volumes_comuns | \nQuantidade de volumes comuns da compra. | \n
Será retornado o código de status 200 OK e sem listagem das compras quando o veículo existir, mas não estiver em processo de pré-entrega, conforme o exemplo abaixo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not Found quando o ID do veículo informado na URL da requisição for inválido.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/veiculos/54/pre_entrega\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nGerenciamento de ações da logistica, sendo possivél realizar ações com veículos, alocar pedidos e criar entregas.
\n","event":[{"listen":"prerequest","script":{"id":"e0ac3f18-2047-47b8-bf51-4e9ca895ad3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"99701263-bd5f-497a-abdb-14e6ae7b4a1a","type":"text/javascript","exec":[""]}}],"_postman_id":"3be461ec-3659-4e4d-a59c-8de71706ecda"},{"name":"Pagamentos","item":[{"name":"Consultar pagamentos","id":"fdbf7fc6-857a-4e13-a3d6-7843b5899db0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{TOKEN}}"},{"key":"DomainKey","type":"text","value":"{{DOMAIN_KEY}}"}],"url":"{{URL}}/importacao/forma-pagamentos/filial/{{ID_FILIAL}}/centro-distribuicao/{{ID_CD}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar formas de pagamento vinculadas a uma filial e um centro de distribuição.
\n\nPara listar as formas de pagamento vinculadas a uma filial e centro de distribuição é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"adquirente_id\": null,\n \"adquirente_secundario_id\": null,\n \"descricao\": \"Dinheiro\",\n \"mensagem\": \"\",\n \"sigla\": \"\",\n \"validacao_no_atendimento\": \"N\",\n \"bandeira_cielo\": \"\",\n \"bandeira_stone\": null,\n \"bandeira\": null,\n \"valor_minimo_parcela\": 30,\n \"parcelas\": 1,\n \"parcelas_sem_juros\": 0,\n \"juros\": 0,\n \"parcelas_proprias\": 1,\n \"expira_em\": null,\n \"logomarca\": \"dinheiro.png\",\n \"pagamento\": \"Pos\",\n \"cor\": \"#3fb001\",\n \"enviar_documento\": false,\n \"nao_repetir\": false,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-06-23T09:12:32-03:00\"\n },\n {\n \"id\": 2,\n \"adquirente_id\": 4,\n \"adquirente_secundario_id\": null,\n \"descricao\": \"Visa Crédito\",\n \"mensagem\": \"<p>O Vipcommerce não se responsabiliza por eventuais problemas relacionados diretamente aos bancos e às operadoras de cartões, tais como indisponibilidade de acesso para processamento de débito etc.<br />\\r\\n <br />\\r\\nNa primeira compra realizada pelo cliente, no momento da entrega, é necessário que o titular do cartão de crédito esteja presente e que apresente os documentos originais de identidade e CPF.</p>\\r\\n\",\n \"sigla\": \"VC\",\n \"validacao_no_atendimento\": \"S\",\n \"bandeira_cielo\": \"visa\",\n \"bandeira_stone\": \"Visa\",\n \"bandeira\": \"visa\",\n \"valor_minimo_parcela\": 122.22,\n \"parcelas\": 3,\n \"parcelas_sem_juros\": 0,\n \"juros\": 10,\n \"parcelas_proprias\": 3,\n \"expira_em\": null,\n \"logomarca\": \"visa.png\",\n \"pagamento\": \"Pre\",\n \"cor\": \"#008bde\",\n \"enviar_documento\": false,\n \"nao_repetir\": true,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"9999 9999 9999 9999\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-12-15T12:40:28-03:00\"\n },\n {\n \"id\": 3,\n \"adquirente_id\": null,\n \"adquirente_secundario_id\": null,\n \"descricao\": \"Ticket Alimentação\",\n \"mensagem\": \"<p>O pagamento com o Cartão Alimentação será realizado no momento da entrega.</p>\\r\\n\\r\\n<p>Atenção, não recebemos Cartões Refeição ou Restaurante.</p>\\r\\n\",\n \"sigla\": \"TA\",\n \"validacao_no_atendimento\": \"N\",\n \"bandeira_cielo\": \"\",\n \"bandeira_stone\": null,\n \"bandeira\": null,\n \"valor_minimo_parcela\": 50,\n \"parcelas\": 1,\n \"parcelas_sem_juros\": 0,\n \"juros\": 0,\n \"parcelas_proprias\": 1,\n \"expira_em\": null,\n \"logomarca\": \"ticket_alimentacao.gif\",\n \"pagamento\": \"Pos\",\n \"cor\": \"#ed1c24\",\n \"enviar_documento\": false,\n \"nao_repetir\": false,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-06-23T09:16:43-03:00\"\n }\n ]\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar formas de pagamento cadastradas vinculadas a uma filial, a um centro de distribuição e a um tipo de entrega.
\n\nPara listar as formas de pagamento vinculadas a uma filial, centro de distribuição e um tipo de entrega é necessário enviar uma requisição GET.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 7,\n \"adquirente_id\": 10,\n \"adquirente_secundario_id\": 10,\n \"descricao\": \"Master Crédito\",\n \"mensagem\": \"<p>O Vipcommerce não se responsabiliza por eventuais problemas relacionados diretamente aos bancos e às operadoras de cartões, tais como indisponibilidade de acesso para processamento de débito etc.<br />\\r\\n <br />\\r\\nNa primeira compra realizada pelo cliente, no momento da entrega, é necessário que o titular do cartão de crédito esteja presente e que apresente os documentos originais de identidade e CPF.</p>\\r\\n\",\n \"sigla\": \"MC\",\n \"validacao_no_atendimento\": \"S\",\n \"bandeira_cielo\": \"visa\",\n \"bandeira_stone\": \"Visa\",\n \"bandeira\": \"visa\",\n \"valor_minimo_parcela\": 50,\n \"parcelas\": 3,\n \"parcelas_sem_juros\": 0,\n \"juros\": 0.1,\n \"parcelas_proprias\": 3,\n \"expira_em\": null,\n \"logomarca\": \"mastercard.png\",\n \"pagamento\": \"Pre\",\n \"cor\": \"#d40404\",\n \"enviar_documento\": false,\n \"nao_repetir\": true,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"9999 9999 9999 9999\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-12-09T10:08:38-03:00\",\n \"intervalo_pagamento\": 0\n },\n {\n \"id\": 15,\n \"adquirente_id\": 13,\n \"adquirente_secundario_id\": 13,\n \"descricao\": \"Amex\",\n \"mensagem\": \"<p>O Vipcommerce não se responsabiliza por eventuais problemas relacionados diretamente aos bancos e às operadoras de cartões, tais como indisponibilidade de acesso para processamento de débito etc.<br />\\r\\n <br />\\r\\nNa primeira compra realizada pelo cliente, no momento da entrega, é necessário que o titular do cartão de crédito esteja presente e que apresente os documentos originais de identidade e CPF.</p>\\r\\n\",\n \"sigla\": \"AX\",\n \"validacao_no_atendimento\": \"S\",\n \"bandeira_cielo\": \"mastercard\",\n \"bandeira_stone\": \"Mastercard\",\n \"bandeira\": \"mastercard\",\n \"valor_minimo_parcela\": 60,\n \"parcelas\": 3,\n \"parcelas_sem_juros\": 0,\n \"juros\": 1,\n \"parcelas_proprias\": 3,\n \"expira_em\": null,\n \"logomarca\": \"amex.gif\",\n \"pagamento\": \"Pre\",\n \"cor\": \"#00ffd1\",\n \"enviar_documento\": false,\n \"nao_repetir\": false,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"9999 9999 9999 9999\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-12-15T10:51:37-03:00\",\n \"intervalo_pagamento\": 0\n },\n {\n \"id\": 6,\n \"adquirente_id\": 5,\n \"adquirente_secundario_id\": null,\n \"descricao\": \"Diners\",\n \"mensagem\": \"<p>O Vipcommerce não se responsabiliza por eventuais problemas relacionados diretamente aos bancos e às operadoras de cartões, tais como indisponibilidade de acesso para processamento de débito etc.<br />\\r\\n <br />\\r\\nNa primeira compra realizada pelo cliente, no momento da entrega, é necessário que o titular do cartão de crédito esteja presente e que apresente os documentos originais de identidade e CPF.</p>\\r\\n\",\n \"sigla\": \"DN\",\n \"validacao_no_atendimento\": \"N\",\n \"bandeira_cielo\": \"diners\",\n \"bandeira_stone\": \"Diners\",\n \"bandeira\": \"elo\",\n \"valor_minimo_parcela\": 50,\n \"parcelas\": 3,\n \"parcelas_sem_juros\": 0,\n \"juros\": 0.1,\n \"parcelas_proprias\": 3,\n \"expira_em\": null,\n \"logomarca\": \"diners.png\",\n \"pagamento\": \"Pre\",\n \"cor\": \"#c1e043\",\n \"enviar_documento\": false,\n \"nao_repetir\": true,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"9999 99999 9999 9999 \",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-06-24T14:12:46-03:00\",\n \"intervalo_pagamento\": 0\n },\n {\n \"id\": 14,\n \"adquirente_id\": 14,\n \"adquirente_secundario_id\": 14,\n \"descricao\": \"Elo Crédito\",\n \"mensagem\": \"<p>O Vipcommerce não se responsabiliza por eventuais problemas relacionados diretamente aos bancos e às operadoras de cartões, tais como indisponibilidade de acesso para processamento de débito etc.<br />\\r\\n <br />\\r\\nNa primeira compra realizada pelo cliente, no momento da entrega, é necessário que o titular do cartão de crédito esteja presente e que apresente os documentos originais de identidade e CPF.</p>\\r\\n\",\n \"sigla\": \"EC\",\n \"validacao_no_atendimento\": \"S\",\n \"bandeira_cielo\": \"mastercard\",\n \"bandeira_stone\": \"Mastercard\",\n \"bandeira\": \"mastercard\",\n \"valor_minimo_parcela\": 50,\n \"parcelas\": 3,\n \"parcelas_sem_juros\": 0,\n \"juros\": 10,\n \"parcelas_proprias\": 3,\n \"expira_em\": null,\n \"logomarca\": \"elo.gif\",\n \"pagamento\": \"Pre\",\n \"cor\": \"#0b2c80\",\n \"enviar_documento\": false,\n \"nao_repetir\": true,\n \"somente_pessoa_juridica\": false,\n \"tipo_cliente\": \"AM\",\n \"debito\": false,\n \"carteira_digital\": false,\n \"mascara_cartao\": \"9999 9999 9999 9999\",\n \"exibe_loja\": true,\n \"created\": \"2020-05-22T10:31:03-03:00\",\n \"modified\": \"2020-12-15T12:07:06-03:00\",\n \"intervalo_pagamento\": 0\n }\n ]\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar uma coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes
\nPara cadastrar uma coleção é necessário enviar uma requisição POST, informando os dados da coleção no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nId da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| descricao | \nDescrição da coleção. | \nSim | \n
| data_inicial | \nData inicial da vigência da coleção. Deverá ser informada no formato: YYYY-MM-DD. Conforme o exemplo: 2018-04-01Atenção: a data inicial não pode ser igual ou inferior a data final./td>\n | Sim | \n
| data_final | \nData final da vigência da coleção. Deverá ser informada no formato: YYYY-MM-DD. Conforme o exemplo: 2018-04-01Atenção: a data inicial não pode ser igual ou inferior a data final./td>\n | Sim | \n
| mostrar_no_menu | \nInforma se a coleção é exibida no menu da loja. Sendo valor \"0\" para não mostrar e \"1\" para mostrar. | \nSim | \n
\n {\n \"descricao\":\"Linha Diet\",\n \"mostra_no_menu\": 0,\n \"data_inicial\": \"2021-01-10 00:00:01\",\n \"data_final\": \"2021-12-31 00:00:01\",\n \"filial_id\": 2\n }\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 60\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo é obrigatório\", quando um campo obrigatório não for enviado no body da requisição, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"descricao\": \"Este campo é obrigatório\",\n \"filial_id\": \"Este campo é obrigatório\",\n \"data_inicial\": \"Este campo é obrigatório\",\n \"data_final\": \"Este campo é obrigatório\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\", quando o valor de um campo obrigatório estiver com valor vazio, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes\",\n \"message\": \"4 erros de validação ocorridos\",\n \"errorCount\": 4,\n \"errors\": {\n \"descricao\": \"Este campo não pode ser deixado vazio\",\n \"filial_id\": \"Este campo não pode ser deixado vazio\",\n \"data_inicial\": \"Este campo não pode ser deixado vazio\",\n \"data_final\": \"Este campo não pode ser deixado vazio\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando os campos tiverem valores inválidos, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes\",\n \"message\": \"3 erros de validação ocorridos\",\n \"errorCount\": 3,\n \"errors\": {\n \"data_inicial\": \"O valor fornecido é inválido\",\n \"data_final\": \"O valor fornecido é inválido\",\n \"mostrar_no_menu\": \"O valor fornecido é inválido\"\n }\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data inicial deve ser menor que a data final.\", quando a data inicial for maior que a data final, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_inicial\": \"A data inicial deve ser menor que a data final.\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cadastrar um(ns) produto(s) da coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes/ID_COLECAO/colecoes-produtos
\nPara cadastrar um(ns) produto(s) em uma coleção coleção é necessário enviar uma requisição POST, informando o(s) ID(s) do(s) produto(s) da coleção no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| id | \nID do produto | \nSim | \n
\n[\n {\n \"id\": 2208\n },\n {\n \"id\": 2210\n },\n {\n \"id\": 133\n },\n {\n \"id\": 134\n },\n {\n \"id\": 155\n }\n]\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Produtos adicionados: 5. Erros: 0. \",\n \"errors\": []\n }\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Produto já pertence a coleção\", quando o produto informado já pertencer a coleção, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Produtos adicionados: 0. Erros: 5. \",\n \"errors\": {\n \"2208\": [\n \"Produto já pertence a coleção\"\n ],\n \"2210\": [\n \"Produto já pertence a coleção\"\n ],\n \"133\": [\n \"Produto já pertence a coleção\"\n ],\n \"134\": [\n \"Produto já pertence a coleção\"\n ],\n \"155\": [\n \"Produto já pertence a coleção\"\n ]\n }\n }\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"ID do produto inválido\", quando o ID do produto não existir na base, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Produtos adicionados: 0. Erros: 1. \",\n \"errors\": {\n \"12222\": [\n \"ID do produto inválido\"\n ]\n }\n }\n}\nTipo de dado que será retornado
\n"},{"key":"Authorization","value":"Basic {{TOKEN}}","description":"Token de acesso - base64 do username e password
\n"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","description":"Identificador do dominio
\n"}],"body":{"mode":"raw","raw":"{\n \"descricao\": \"Linha Diet\",\n \"mostrar_no_menu\": 0,\n \"data_final\": \"2021-01-10 00:00:01\",\n \"data_inicial\": \"2021-12-31 00:00:01\",\n \"filial_id\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/colecoes/{{ID_COLECAO}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite editar uma coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes/ID_COLECAO
\nPara editar uma coleção é necessário enviar uma requisição PUT informando o ID da coleção na URL e os dados da coleção no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nId da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | \n Não | \n
| descricao | \nDescrição da coleção. | \nNão | \n
| data_inicial | \nData inicial da vigência da coleção. Deverá ser informada no formato: YYYY-MM-DD. Conforme o exemplo: 2018-04-01Atenção: a data inicial não pode ser igual ou inferior a data final./td>\n | Não | \n
| data_final | \nData final da vigência da coleção. Deverá ser informada no formato: YYYY-MM-DD. Conforme o exemplo: 2018-04-01Atenção: a data inicial não pode ser igual ou inferior a data final./td>\n | Não | \n
| mostrar_no_menu | \nInforma se a coleção é exibida no menu da loja. Sendo valor \"0\" para não mostrar e \"1\" para mostrar. | \nNão | \n
\n {\n \"descricao\":\"Linha Diet\",\n \"mostra_no_menu\": 0\n }\n\n\n\n {\n \"data_inicial\": \"2021-01-10 00:00:01\",\n \"data_final\": \"2021-12-31 00:00:01\",\n \"filial_id\": 2\n }\n\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este campo não pode ser deixado vazio\", quando os parametros forem enviados vazio, conforme o exemplo.
{\n {\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes/2\",\n \"message\": \"3 erros de validação ocorridos\",\n \"errorCount\": 3,\n \"errors\": {\n \"descricao\": \"Este campo não pode ser deixado vazio\",\n \"data_inicial\": \"Este campo não pode ser deixado vazio\",\n \"data_final\": \"Este campo não pode ser deixado vazio\"\n }\n }\n }\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"A data inicial deve ser menor que a data final.\", quando a data inicial for maior que a data final, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/colecoes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_inicial\": \"A data inicial deve ser menor que a data final.\"\n }\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID da coleção for inexistente, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/colecoes/1\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPara detalhes sobre paginação e limite de resultados, clique aqui
\nPermite listar coleções cadastradas.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes
\nOs parametros permitidos são
\nExemplos:
\n\n\nVigência:
\n{{URL}}/importacao/colecoes?vigente=1ID da filial:
\n{{URL}}/importacao/colecoes/?filial_id=2Descrição:
\n{{URL}}/importacao/colecoes/?descricao=Linha DietData inical de vigência:
\n{{URL}}/importacao/colecoes/?data_inicial=2020-11-30Data final de vigência:
\n{{URL}}/importacao/colecoes/?data_final=2020-11-30
Para listar as coleções é necessário enviar uma requisição GET, não sendo necessário informar nenhum paramêtro na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"descricao\": \"Linha Diet\",\n \"filial_id\": 1,\n \"mostrar_no_menu\": true,\n \"data_inicial\": \"2020-11-30T08:18:57-03:00\",\n \"data_final\": \"2020-12-20T08:18:57-03:00\"\n },\n {\n \"id\": 2,\n \"descricao\": \"Linha Light\",\n \"filial_id\": 1,\n \"mostrar_no_menu\": false,\n \"data_inicial\": \"2020-11-30T08:18:57-03:00\",\n \"data_final\": \"2020-12-20T08:18:57-03:00\"\n },\n {\n \"id\": 3,\n \"descricao\": \"Linha Light\",\n \"filial_id\": 2,\n \"mostrar_no_menu\": true,\n \"data_inicial\": \"2020-11-30T08:18:57-03:00\",\n \"data_final\": \"2020-12-20T08:18:57-03:00\"\n },\n {\n \"id\": 4,\n \"descricao\": \"Linha Bebe\",\n \"filial_id\": 1,\n \"mostrar_no_menu\": true,\n \"data_inicial\": \"2020-11-30T08:18:57-03:00\",\n \"data_final\": \"2020-12-20T08:18:57-03:00\"\n }\n ],\n \"pagination\": {\n \"page_count\": 3,\n \"current_page\": 1,\n \"has_next_page\": true,\n \"has_prev_page\": false,\n \"count\": 56,\n \"limit\": null\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes/ID_COLECAO
\nPara consultar uma coleção é necessário enviar uma requisição GET informando o ID da coleção na URL.
Na URL da requisição é obrigatório informar o ID da coleção a ser consultada, conforme no exemplo abaixo:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/colecoes/{{ID_COLECAO}}Exemplo de ID_OFERTA:
\n105
{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"filial_id\": 1,\n \"descricao\": \"Linha Diet - Menu = true, filial 01\",\n \"mostrar_no_menu\": true,\n \"data_inicial\": \"2020-11-30T08:18:57-03:00\",\n \"data_final\": \"2020-12-20T08:18:57-03:00\",\n \"created\": \"2020-06-19T12:08:17-03:00\",\n \"modified\": \"2020-06-19T12:08:17-03:00\",\n \"produtos\": [\n {\n \"id\": 1357,\n \"codigo_erp\": 3531\n },\n {\n \"id\": 1445,\n \"codigo_erp\": 3442\n },\n {\n \"id\": 1450,\n \"codigo_erp\": 3451\n }\n ],\n \"link_colecao\": \"https://www.develop.vipcommerce.com.br//produtos/colecoes/1/linha-diet-menu-true-filial-01\"\n }\n}\n\nSerá retornado o código de status 404 Not Found com a mensagem \"Not found\", quando o ID da coleção informada na URL não for encontrada, conforme o exemplo abaixo.
{ \n success: false,\n data: { \n message: 'Not found',\n url: '/importacao/ofertas/1231',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found'\n }\n } \n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir uma coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes/ID_COLECAO
\nPara excluir uma coleção é necessário enviar uma requisição DELETE informando o ID da coleção na URL.
Na URL da requisição é obrigatório informar o ID da coleção a ser excluída, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/colecoes/{{ID_COLECAO}}Exemplo de ID:
\n192
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 404 Not found quando o ID da coleção informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Not found\",\n \"url\": \"/importacao/colecoes/1\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Http\\\\Exception\\\\NotFoundException\",\n \"code\": 404,\n \"message\": \"Not found\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite excluir um produto da coleção.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/colecoes/ID_COLECAO/colecoes-produtos/ID_PRODUTO
\nPara excluir um produto da coleção é necessário enviar uma requisição DELETE informando o ID da coleção e o ID do produto da coleção.
Na URL da requisição é obrigatório informar o ID da coleção e o ID do produto na coleção, conforme no exemplo a seguir:
\n\n\nExemplo de URL:
\n{{URL}}/importacao/ofertas/{{ID_OFERTA}}/oferta-produtos/{{ID_PRODUTO}}Exemplo de ID_COLECAO: 196
\nExemplo de ID_PRODUTO: 12
\n
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Produtos removido da coleção com sucesso.\"\n }\n}\nSerá retornado o código de status 400 Bad Request quando o ID do produto não está vinculado ao ID da coleção, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Produtos não consta na coleção.\"\n }\n}\nSerá retornado o código de status 400 Bad Request quando o ID da coleção não existir, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Coleção não encontrada.\"\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Esta Coleção possui somente esse produto vinculado a ela e por esse motivo não pode ser removido. As coleções precisam ter pelo menos 1 produto.\" quando o a coleção tiver somente um produto vinculada a ela, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Esta Coleção possui somente esse produto vinculado a ela e por esse motivo não pode ser removido. As coleções precisam ter pelo menos 1 produto.\"\n }\n}\nA API de importacao de coleções VIP Commerce visa disponibilizar o gerenciamento de coleções.
\n","_postman_id":"4efd2ae9-87cf-407e-9a89-e52c09bc0006"},{"name":"Eventos","item":[{"name":"Inscrever em evento","id":"425f68a6-503b-4728-8ad7-5187702e6999","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN_BEARER}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{URL}}/eventos/{{NOME_EVENTO}}/organizacoes/{{ORGANIZACAO_ID}}/inscrever","description":"Permite inscrever-se em um evento.
\nURL: https://api.vipcommerce.com.br/eventos/{{NOME_EVENTO}}/organizacoes/{{ORGANIZACAO_ID}}/inscrever
\nPara inscrever-se em um evento é necessário enviar uma requisição POST, informando os dados do evento no corpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| organizacao_id | \nID da organização. Atenção deverá ser informado apenas valores numéricos. Conforme\n o exemplo: 1 | \n Sim | \n
| evento | \nNome do evento. | \nSim | \n
| url_callback | \nURL a ser vinculado o callback do evento. | \nSim | \n
\n{\n \"organizacao_id\": 1,\n \"evento\": \"nome_do_evento\",\n \"url_callback\": \"https://url.teste\"\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"organizacao_id\": \"75\",\n \"usuario_id\": 1,\n \"url_callback\": \"https://url.teste\",\n \"evento\": {\n \"id\": 1,\n \"nome\": \"Evento 2022\",\n \"modified\": \"2021-04-19T12:24:49.000Z\",\n \"created\": \"2021-04-19T12:16:46.000Z\"\n },\n \"id\": 24\n }\n}\n\n{\n \"event\": [NOME_DO_EVENTO],\n \"organization\": [ORGANIZACAO_ID]\n \"message\": [MENSAGEM_DO_EVENTO],\n \"content\": [CONTEUDO_DO_EVENTO],\n \"date\": [DATA_DO_DISPARO_DO_EVENTO]\n}\n","urlObject":{"path":["eventos","{{NOME_EVENTO}}","organizacoes","{{ORGANIZACAO_ID}}","inscrever"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"425f68a6-503b-4728-8ad7-5187702e6999"},{"name":"Remover inscrição em evento","id":"04ad9cf1-a73c-4d73-9f8d-cf182b806910","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN_BEARER}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{URL}}/eventos/{{NOME_EVENTO}}/organizacoes/{{ORGANIZACAO_ID}}/remover_inscricao","description":"Permite remover a inscrição em um evento.
\n\nPara remover a inscrição em um evento é necessário enviar uma requisição POST, informando os dados do evento no\ncorpo body da requisição.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| organizacao_id | \nID da organização. Atenção deverá ser informado apenas valores numéricos. Conforme\n o exemplo: 1 | \n Sim | \n
| evento | \nNome do evento. | \nSim | \n
\n{\n \"organizacao_id\": 1,\n \"evento\": \"nome_do_evento\"\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": []\n}\nSerá retornado o código de status 401 Unauthorized quando o token informado no header da requisição for invalido ou não informado. A seguir é exibido um exemplo.
{\n \"success\": false,\n \"error\": \"Token não informado\"\n}\nSerá retornado a mensagem \"Evento não encontrado\", quando o evento informado na URL da requisição for inexistente. A seguir é exibido um exemplo.
\n{\n \"success\": false,\n \"error\": [\n \"Evento não encontrado\"\n ]\n}\nSerá retornado a mensagem \"Registro não encontrado\", quando o ID da organização informado na URL da requisição for inexistente. A seguir é exibido um exemplo.
\n{\n \"success\": false,\n \"error\": \"Registro não encontrado\"\n}\nEvento disparado quando cupom de crédito é utilizado em uma compra.
\nAtenção deverá ser enviado o nome do evento: 'CompraRealizadaComCupomDeCredito'
\nPara realizar a inscrição em um evento utilize a requisição a seguir: clique aqui
\nPara remover a inscrição em um evento utilize a requisição a seguir: clique aqui
\nA resposta será enviada na URL de callback cadastrada na inscrição do evento. A seguir é exibido um exemplo da resposta.
\n{\n \"event\": \"CompraRealizadaComCupomDeCredito\",\n \"organization\": 1,\n \"message\": \"Mensagem teste\",\n \"content\": {\n \"compra_id\": 1000685,\n \"data_compra\": \"07/05/2021 11:43:26\",\n \"cupons\": [\n {\n \"cupom_id\": 96,\n \"valor_cupom\": 15\n }\n ]\n },\n \"date\": 07/05/2021 11:43:26\n}\nEvento disparado quando uma compra é realizada contendo um produto em oferta
\nAtenção deverá ser enviado o nome do evento: 'CompraRealizadaComProdutoEmOferta'
\nPara realizar a inscrição em um evento utilize a requisição a seguir: clique aqui
\nPara remover a inscrição em um evento utilize a requisição a seguir: clique aqui
\nA resposta será enviada na URL de callback cadastrada na inscrição do evento. A seguir é exibido um exemplo da resposta.
\n{\n \"event\": \"CompraRealizadaComProdutoEmOferta\",\n \"organization\": 1,\n \"message\": \"Compra com produto em oferta exclusiva ou por perfil\",\n \"content\": {\n \"compra_id\": 1625,\n \"produtos\": [\n {\n \"oferta_id\": 105,\n \"codigo_erp\": 465,\n \"produto_id\": 115,\n \"quantidade\": 1\n },\n {\n \"oferta_id\": 104,\n \"codigo_erp\": 235,\n \"produto_id\": 57,\n \"quantidade\": 1\n }\n ]},\n \"date\": \"Tue May 25 2021 17:29:04 GMT-0300 (GMT-03:00)\"\n}\nO que é um eventos?
\nOs eventos são ações que serão emitidas para todos os inscritos via webhook.
O que é webhook?
\nWebhook é uma forma de recebimento de informações, que são passadas quando um evento acontece.\nDessa forma, o webhook na prática, é a forma de receber informações entre dois sistemas de uma forma passiva, ou seja, sem realizar nenhuma ação.
Para detalhes sobre o cabeçalho da requisição, clique aqui.
\n\nPermite cadastrar campanhas de fretes
\n\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/campanha-fretes
\n\n## Cadastrando uma campanha de frete\n\n
Para cadastrar uma campanha de frete é necessário enviar uma requisição POST, no corpo body da requisição será necessário informar os dados da campanha (ver tabela abaixo).
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | \n Sim | \n
| tipo_campanha_frete_id | \nID do tipo de campanha de frete.\n \n Opções aceitas:\n
| \n Sim | \n
| produto_id | \nID do produto a ser vinculado na campanha.\n \n Atenção: este campo deverá ser enviados\n em campanhas do tipo Produto.\n | \n Não. Atenção: este campo deverá ser enviados\n em campanhas do tipo Produto. | \n
| colecoes | \nID da coleção vinculada na campanha.\n \n Atenção: este campo deverá ser enviado em formato de array\n \n Conforme o exemplo: [1, 45]\n Atenção: este campo deverá ser enviados em campanhas do tipo Coleções.\n | \n Não. Atenção: este campo deverá ser enviados\n em campanhas do tipo Coleções. | \n
| tipo_cliente | \nTipo de cliente. Opções aceitas em maiúsculo ou minúsculo Opções aceitas:\n
| \n Sim | \n
| descricao | \nDescrição da campanha. | \nSim | \n
| nota_explicativa | \nNota explicativa vinculada a campanha. | \nNão | \n
| desconto | \nTipo de desconto a ser aplicado.\n \n Atenção: caso não seja enviado o tipo de desconto o valor padão será de porcentagem\n \n Opções aceitas:\n
| \n Não | \n
| valor | \nValor a ser aplicado para a campanha. | \nSim | \n
| dias_da_semana | \nDias da semana que o desconto será aplicado.\n \n Atenção: enviar os 3 (três) primeiros caracteres do dia.\n \n Opções aceitas:\n
| \n Sim | \n
| data_inicial | \nData inicial da vigência da campanha. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS.Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| data_final | \nData final da vigência da campanha. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS.Conforme o exemplo: 2018-04-01 00:01:01 | \n Sim | \n
| patrocinado | \nDefine se a campanha de frete possui um patricionador. | \nNão | \n
| valor_campanha | \nDefine o valor do patrocínio. | \nNão | \n
| primeira_compra | \nDefine se o cliente irá utilizar o desconto apenas na primeira compra.\n \n Opções aceitas:\n
| \n Não | \n
| quantidade_geral_compras | \nQuantidade máxima geral de compras da campanha. | \nNão | \n
| quantidade_minima_de_itens | \nQuantidade minima de itens para aplicação da campanha. | \nNão | \n
| tipo_entregas | \nTipos de entrega vinculado a campanha. Exemplo: \"tipo_entregas\": { \"_ids\": [1,3,6] } | \nSim | \n
| regioes | \nRegiões vinculadas a campanha. Exemplo: \"regioes\": { \"_ids\": [1,2,3] } | \nNão | \n
| perfis | \nPerfis vinculados a campanha. Exemplo: \"perfis\": { \"_ids\": [1,2] } | \nNão | \n
\n {\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 3,\n \"produto_id\": 15,\n \"tipo_cliente\": \"AM\",\n \"descricao\": \"Teste api\",\n \"nota_explicativa\": \"teste descrição\",\n \"desconto\": \"P\",\n \"valor\": 8.50,\n \"dias_da_semana\": [\"seg\", \"ter\", \"qua\"],\n \"data_inicial\": \"2050-05-12 12:09:42\",\n \"data_final\": \"2050-06-01 12:09:42\",\n \"quantidade_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"quantidade_geral_compras\": 50,\n \"quantidade_minima_de_itens\": 83,\n \"tipo_entregas\": {\n \"_ids\": [\n 1\n ]\n },\n \"regioes\": {\n \"_ids\": [\n 1\n ]\n },\n \"perfis\": {\n \"_ids\": [\n 1\n ]\n }\n }\n\n\n\n {\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 13,\n \"tipo_cliente\": \"AM\",\n \"descricao\": \"Teste api\",\n \"nota_explicativa\": \"teste descrição\",\n \"desconto\": \"P\",\n \"valor\": 8.50,\n \"dias_da_semana\": [\"seg\", \"ter\", \"qua\"],\n \"data_inicial\": \"2050-05-12 12:09:42\",\n \"data_final\": \"2050-06-01 12:09:42\",\n \"quantidade_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"quantidade_geral_compras\": 50,\n \"quantidade_minima_de_itens\": 83,\n \"colecoes\": {\n \"_ids\": [\n 2,4\n ]\n },\n \"tipo_entregas\": {\n \"_ids\": [\n 1\n ]\n },\n \"regioes\": {\n \"_ids\": [\n 1\n ]\n },\n \"perfis\": {\n \"_ids\": [\n 1\n ]\n }\n }\n\n\n## Respostas
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo:
\n{\n \"success\": true,\n \"data\": {\n \"id\": \"601726d2-3e6a-4c2d-8a5c-a88f7c23a8a5\"\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando o ID da filial fornecida não existir, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"filial_id\": \"Este valor não existe\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o ID do tipo de campanha for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_campanha_frete_id\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o tipo de cliente for inválido, conforme o exemplo.
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"tipo_cliente\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o desconto for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"desconto\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Deve ser informado no mínimo um dia da semana\", conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"dias_semana\": \"Deve ser informado no mínimo um dia da semana\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O dia da semana informado é inválido\", quando algum dia informado não seguir as opçoes aceitas, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"dias_semana\": \"O dia da semana informado é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando a data inicial for inválida, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_inicial\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando a data final for inválida, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_final\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"valor_campanha\": \"O valor fornecido é inválido\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado não seguir as opçoes aceitas, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"primeira_compra\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"quantidade_geral_compras\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"quantidade_geral_compras\": \"O valor fornecido é inválido\"\n }\n }\n}\n","urlObject":{"path":["importacao","campanha-fretes"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"613f78c2-010a-424c-909d-7f173fbe2fc3"},{"name":"Editar campanha de frete","id":"9c423614-645c-4702-b4db-bbde7d1c563e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 3,\n \"produto_id\": 15,\n \"tipo_cliente\": \"AM\",\n \"descricao\": \"Teste api\",\n \"nota_explicativa\": \"Teste descrição\",\n \"desconto\": \"P\",\n \"valor\": 8.50,\n \"dias_da_semana\": [\"seg\", \"ter\", \"qua\"],\n \"data_inicial\": \"2050-05-12 12:09:42\",\n \"data_final\": \"2050-06-01 12:09:42\",\n \"quantidade_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"quantidade_geral_compras\": 50,\n \"quantidade_minima_de_itens\": 83,\n \"tipo_entregas\": {\n \"_ids\": [\n 1\n ]\n },\n \"regioes\": {\n \"_ids\": [\n 1\n ]\n },\n \"perfis\": {\n \"_ids\": [\n 1\n ]\n }\n }","options":{"raw":{"language":"json"}}},"url":"{{URL}}/importacao/campanha-fretes/{{ID_CAMPANHA}}","description":"Para detalhes sobre o cabeçalho da requisição, clique aqui.
\n\nPermite editar campanhas de fretes
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/importacao/campanha-fretes/ID_CAMPANHA
\nPara editar uma campanha de frete é necessário enviar uma requisição PUT, informando na URL o ID da campanha
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| filial_id | \nID da filial. Atenção deverá ser informado o id da filial utilizando apenas números. Conforme o exemplo: 1 | \n Não | \n
| tipo_campanha_frete_id | \nID do tipo de campanha de frete.\n \n Opções aceitas:\n
| \n Não | \n
| produto_id | \nID do produto a ser vinculado na campanha.\n \n Atenção: este campo deverá ser enviados\n em campanhas do tipo Produto.\n | \n Não | \n
| colecoes | \nID da coleção vinculada na campanha.\n \n Atenção: este campo deverá ser enviado em formato de array\n \n Conforme o exemplo: [1, 45]\n Atenção: este campo deverá ser enviados em campanhas do tipo Coleções.\n | \n Não | \n
| tipo_cliente | \nTipo de cliente. Opções aceitas em maiúsculo ou minúsculo Opções aceitas:\n
| \n Não | \n
| descricao | \nDescrição da campanha. | \nNão | \n
| nota_explicativa | \nNota explicativa vinculada a campanha. | \nNão | \n
| desconto | \nTipo de desconto a ser aplicado.\n \n Atenção: caso não seja enviado o tipo de desconto o valor padão será de porcentagem\n \n Opções aceitas:\n
| \n Não | \n
| valor | \nValor a ser aplicado para a campanha. | \nNão | \n
| dias_da_semana | \nDias da semana que o desconto será aplicado.\n \n Atenção: enviar os 3 (três) primeiros caracteres do dia.\n \n Opções aceitas:\n
| \n Não | \n
| data_inicial | \nData inicial da vigência da campanha. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS.Conforme o exemplo: 2018-04-01 00:01:01 | \n Não | \n
| data_final | \nData final da vigência da campanha. Deverá ser informada no formato: YYYY-MM-DD HH:MM:SS.Conforme o exemplo: 2018-04-01 00:01:01 | \n Não | \n
| patrocinado | \nDefine se a campanha de frete possui um patricionador. | \nNão | \n
| valor_campanha | \nDefine o valor do patrocínio. | \nNão | \n
| primeira_compra | \nDefine se o cliente irá utilizar o desconto apenas na primeira compra.\n \n Opções aceitas:\n
| \n Não | \n
| quantidade_geral_compras | \nQuantidade máxima geral de compras da campanha. | \nNão | \n
| quantidade_minima_de_itens | \nQuantidade minima de itens para aplicação da campanha. | \nNão | \n
| tipo_entregas | \nTipos de entrega vinculado a campanha. Exemplo: \"tipo_entregas\": { \"_ids\": [1,3,6] } | \nNão | \n
| regioes | \nRegiões vinculadas a campanha. Exemplo: \"regioes\": { \"_ids\": [1,2,3] } | \nNão | \n
| perfis | \nPerfis vinculados a campanha. Exemplo: \"perfis\": { \"_ids\": [1,2] } | \nNão | \n
\n {\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 3,\n \"produto_id\": 15,\n \"tipo_cliente\": \"AM\",\n \"descricao\": \"Teste api\",\n \"nota_explicativa\": \"teste descrição\",\n \"desconto\": \"P\",\n \"valor\": 8.50,\n \"dias_da_semana\": [\"seg\", \"ter\", \"qua\"],\n \"data_inicial\": \"2050-05-12 12:09:42\",\n \"data_final\": \"2050-06-01 12:09:42\",\n \"quantidade_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"quantidade_geral_compras\": 50,\n \"quantidade_minima_de_itens\": 83,\n \"tipo_entregas\": {\n \"_ids\": [\n 1\n ]\n },\n \"regioes\": {\n \"_ids\": [\n 1\n ]\n },\n \"perfis\": {\n \"_ids\": [\n 1\n ]\n }\n }\n\n\n\n {\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 13,\n \"tipo_cliente\": \"AM\",\n \"descricao\": \"Teste api\",\n \"nota_explicativa\": \"teste descrição\",\n \"desconto\": \"P\",\n \"valor\": 8.50,\n \"dias_da_semana\": [\"seg\", \"ter\", \"qua\"],\n \"data_inicial\": \"2050-05-12 12:09:42\",\n \"data_final\": \"2050-06-01 12:09:42\",\n \"quantidade_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"quantidade_geral_compras\": 50,\n \"quantidade_minima_de_itens\": 83,\n \"colecoes\": {\n \"_ids\": [\n 2,4\n ]\n },\n \"tipo_entregas\": {\n \"_ids\": [\n 1\n ]\n },\n \"regioes\": {\n \"_ids\": [\n 1\n ]\n },\n \"perfis\": {\n \"_ids\": [\n 1\n ]\n }\n }\n\n\n## Respostas
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo:
\n{\n \"success\": true,\n \"data\": []\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Este valor não existe\", quando o ID da filial fornecida não existir, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"filial_id\": \"Este valor não existe\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o ID do tipo de campanha for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"tipo_campanha_frete_id\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o tipo de cliente for inválido, conforme o exemplo.
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"tipo_cliente\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando o desconto for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"2 erros de validação ocorridos\",\n \"errorCount\": 2,\n \"errors\": {\n \"desconto\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"Deve ser informado no mínimo um dia da semana\", conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"dias_semana\": \"Deve ser informado no mínimo um dia da semana\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O dia da semana informado é inválido\", quando algum dia informado não seguir as opçoes aceitas, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"dias_semana\": \"O dia da semana informado é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando a data inicial for inválida, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_inicial\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", quando a data final for inválida, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"data_final\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválido\", conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"valor_campanha\": \"O valor fornecido é inválido\"\n }\n }\n}\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado não seguir as opçoes aceitas, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"primeira_compra\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"quantidade_geral_compras\": \"O valor fornecido é inválido\"\n }\n }\n}\n\n\nSerá retornado o código de status 422 Unprocessable Entity com a mensagem \"O valor fornecido é inválida, quando o valor informado for inválido, conforme o exemplo:
\n{\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/importacao/campanha-fretes\",\n \"message\": \"Ocorreu um erro de validação\",\n \"errorCount\": 1,\n \"errors\": {\n \"quantidade_geral_compras\": \"O valor fornecido é inválido\"\n }\n }\n}\n","urlObject":{"path":["importacao","campanha-fretes","{{ID_CAMPANHA}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c423614-645c-4702-b4db-bbde7d1c563e"},{"name":"Listar campanha de fretes","id":"2c4c7329-8e7e-4456-b7f1-01d3f2b52556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{TOKEN}}","type":"text"},{"key":"DomainKey","value":"{{DOMAIN_KEY}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{URL}}/importacao/campanha-fretes","description":"Para detalhes sobre o cabeçalho da requisição,
\n\nPermite listar campanhas de frete.
\nURL Sandbox:
\nhttps://api.sandbox.vipcommerce.com.br/importacao/campanha-fretes
\nPara listar as campanhas de frete é necessário enviar uma requisição GET, não sendo necessario informar nenhum parametro na URL.
Os parametros permitidos são
\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 29,\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 3,\n \"produto_id\": 14,\n \"tipo_cliente\": \"PJ\",\n \"descricao\": \"Teste api\",\n \"desconto\": \"V\",\n \"nota_explicativa\": null,\n \"valor\": 0.5,\n \"data_inicial\": \"2021-05-12T12:09:42-03:00\",\n \"data_final\": \"2021-06-01T12:09:42-03:00\",\n \"quantidade_geral_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"ordem_da_compra\": null,\n \"valor_minimo_compra\": 0.01,\n \"quantidade_minima_de_itens\": 83,\n \"created\": \"2020-06-24T16:10:14-03:00\",\n \"modified\": \"2020-06-24T16:10:14-03:00\",\n \"dias_da_semana\": [\n \"Seg\"\n ]\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\n\nID dos Tipos de Campanhas de Frete
\n| ID | Descrição |
|---|---|
1 | Isenção para cliente específico |
2 | Isenção com base no perfil do cliente |
3 | Isenção na quantidade de itens por produto |
4 | Isenção na quantidade de itens por compra |
5 | Isenção na quantidade de compras |
6 | Isenção na forma de pagamento |
7 | Isenção por código promocional |
8 | Isenção por categoria |
9 | Isenção pela ordem da compra |
10 | Isenção por data |
11 | Isenção por rota |
12 | Isenção por valor da compra |
13 | Isenção por coleção |
Para detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar uma campanha de frete.
\nURL Sandbox: https://api.sandbox.vipcommerce.com.br/importacao/campanha-fretes/ID_CAMPANHA
\nPara consultar uma campanha de frete é necessário enviar uma requisição GET, sendo necessário informar o ID da campanha na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": [\n {\n \"id\": 29,\n \"filial_id\": 1,\n \"tipo_campanha_frete_id\": 3,\n \"produto_id\": 14,\n \"tipo_cliente\": \"PJ\",\n \"descricao\": \"Teste api\",\n \"desconto\": \"V\",\n \"nota_explicativa\": null,\n \"valor\": 0.5,\n \"data_inicial\": \"2021-05-12T12:09:42-03:00\",\n \"data_final\": \"2021-06-01T12:09:42-03:00\",\n \"quantidade_geral_compras\": null,\n \"patrocinado\": true,\n \"valor_campanha\": 50,\n \"primeira_compra\": true,\n \"ordem_da_compra\": null,\n \"valor_minimo_compra\": 0.01,\n \"quantidade_minima_de_itens\": 83,\n \"created\": \"2020-06-24T16:10:14-03:00\",\n \"modified\": \"2020-06-24T16:10:14-03:00\",\n \"dias_da_semana\": [\n \"Seg\"\n ]\n }\n ],\n \"pagination\": {\n \"page_count\": 1,\n \"current_page\": 1,\n \"has_next_page\": false,\n \"has_prev_page\": false,\n \"count\": 1,\n \"limit\": null\n }\n}\nSerá retornado o código de status 404 Not Found quando o ID da campanha de frete informado na URL for inexistente, conforme o exemplo.
{\n success: false,\n data: {\n message: 'Not found',\n url: '/importacao/campanha-fretes/10',\n code: 404,\n exception: {\n class: 'Cake\\\\Http\\\\Exception\\\\NotFoundException',\n code: 404,\n message: 'Not found' } }\n}\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cadastrar uma carga
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/cargas
\nPara adicionar uma carga sem remessa, é necessário enviar uma requisição POST. No corpo body da requisição será necessário enviar as informações vinculadas à carga.
Em caso de carga sem remessa, não será necessário enviar o campo \"remessa_id\".
Para vincular uma carga a uma remessa é necessário enviar uma requisição POST. No corpo body da requisição será necessário enviar as informações vinculadas a carga (ver tabela abaixo).
Atenção caso o usuário não esteja cadastrado, será cadastrado um novo usuário no admin. Caso já esteja cadastrado a carga será apenas vinculada.
\nAtenção caso o veículo não esteja cadastrado, será cadastrado um novo veículo no admin. Caso já esteja cadastrado a carga será apenas vinculada.
\nAtenção o ID da remessa será enviado para a 'Url Callback' informada no cadastro do parceiro e está disponível no menu de 'Parceiros logístico' no admin.
\nAtenção em caso de novo usuário cadastrado, o mesmo terá o CPF como senha de acesso, sendo possível alterar posteriormente pelo admin.
\nDescrição do corpo body da requisição
| Propriedade | Descrição | Obrigatório |
|---|---|---|
compras.id | ID da compra a ser alocada no veículo. Exemplo: 200001 | Sim |
compras.track | Link para rastreio da compra. Exemplo: https://rastreio.com/codigo | Não |
remessa_id | ID da remessa. O ID é enviado na URL Callback cadastrada no parceiro e também pode ser consultado no menu de 'Parceiros logístico' no admin. Quando o parceiro logístico permitir a criação de carga sem remessa e a carga não tiver remessa, não é necessário enviar este campo. Exemplo de ID: 93dc5fcc-e722-4c1c-a93b-925e50fa2cb3 | Não |
motorista.nome | Nome do usuário. | Sim |
motorista.username | Login de acesso na plataforma. | Sim |
motorista.cpf | CPF do usuário. Atenção este campo deverá ser enviado sem formatação e contendo 11 (onze) dígitos. Exemplo: 49583346020 | Sim |
motorista.email | Email do usuário. | Sim |
motorista.cep | Cep do usuário. Atenção este campo deverá ser enviado com formatação e contendo 9 (nove) dígitos. Exemplo: 33950-123 | Sim |
motorista.logradouro | Endereço do usuário. Ex: Av. Afonso Pena. | Sim |
motorista.numero | Número do endereço usuário. | Sim |
motorista.usuario_parceiro_logistico | Enviar true para informaçao que é um usuário criado pelo parceiro logístico. | Sim |
motorista.cargos | Cargo do usuário. É necessário informar o ID do cargo, sendo: Sempre enviar somente 2 para criação do motorista 2 = Motorista | Sim |
motorista.complemento | Complemento do endereço usuário. | Não |
motorista.bairro | Bairro em que o logradouro está situado. | Sim |
motorista.cidade | Cidade em que o logradouro está situado. | Sim |
motorista.uf | Estado em que o logradouro está situado. Ex: MG, SP, RJ. | Sim |
motorista.sigla | Sigla em que a uf está situada. | Não |
motorista.telefone_fixo | Número do telefone fixo do usuário. | Não |
motorista.telefone_celular | Número do telefone celular do usuário. | Sim |
motorista.expirar | Data em que o acesso do usuário será expirado. | Não |
motorista.desativar | Informa se o usuário está desativado ou não. Valores: \"0\" para ativo e \"1\" para desativado. | Não |
motorista.funcionario | Ao desativar um usuário, este não poderá mais fazer login no sistema. Opções aceitas: \"true\" para sim \"false\" para não | Não |
motorista.numero_habilitacao | Número da habilitação do motorista. | Sim |
motorista.habilitacao_categorias | Categorias da Habilitaçao.
| Sim |
motorista.filiais | Exibe o nome das filiais nas quais o usuário pode realizar ações. | Não |
motorista.centro_distribuicoes | Exibe o nome dos centros de distribuições nas quais o usuário pode realizar ações. | Não |
veiculo.placa | Placa do veículo. | Sim |
veiculo.modelo | Modelo do veículo. | Sim |
veiculo.ano | Ano do veículo. | Sim |
veiculo.veiculo_parceiro_logistico | Enviar true para informação que é um veículo criado pelo parceiro logístico. | Sim |
veiculo.km | Quilometragem do veículo. | Não |
veiculo.capacidade_normal | Capacidade máxima de volumes normais que o veículo pode transportar. | Não |
veiculo.capacidade_frios | Capacidade máxima de volumes frios que o veículo pode transportar. | Não |
veiculo.capacidade_maxima_kg | Peso máximo de cargas (em KG) que o veículo pode transportar. | Não |
veiculo.cor | Cor predominante do veículo. | Não |
veiculo.ativo | Informa se o veículo está ativo ou não. Opções aceitas: \"true\" para sim e \"false\" para não | Sim |
Exemplo de body em JSON
\n{\n \"compras\":[{\n \"id\": 123,\n \"track\": \"https://rastreio.com/codigo123\",\n \"id\": 456,\n \"track\": \"https://rastreio.com/codigo456\",\n }],\n \"remessa_id\": \"f710315c-ba50-48b6-b2be-9c3641fc22f3\",\n \"motorista\":\n {\n \"nome\": \"Nome Motorista\",\n \"username\": \"motorista.teste\",\n \"email\": \"motorista@teste.com.br\",\n \"cep\": \"00000-000\",\n \"logradouro\": \"Logradouro\",\n \"cpf\": \"55709859052\",\n \"numero\": 155,\n \"usuario_parceiro_logistico\":true,\n \"cargos\": [2],\n \"complemento\": null,\n \"bairro\": \"Bairro\",\n \"cidade\": \"Cidade\",\n \"uf\": \"UF\",\n \"sigla\": \"\",\n \"telefone_fixo\": \"319999999\",\n \"telefone_celular\": \"31999999999\",\n \"expirar\": null,\n \"desativar\": false,\n \"funcionario\": true,\n \"numero_habilitacao\": \"12345678901\",\n \"habilitacao_categorias\": [1],\n \"centro_distribuicoes\": [1,2,3],\n \"filiais\": [1,2]\n },\n \"veiculo\":\n {\n \"placa\": \"ABC-1234\",\n \"modelo\": \"Standart\",\n \"cor\": \"Branco\",\n \"ano\": 2015,\n \"veiculo_parceiro_logistico\":true,\n \"km\": 123,\n \"renavam\": \"\",\n \"capacidade_normal\": 100,\n \"capacidade_frios\": 50,\n \"capacidade_maxima_kg\": 0,\n \"capacidade_maxima_volumetrica\": 5,\n \"ativo\": true\n }\n}\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"veiculo_id\": 54,\n \"usuario_id\": 127,\n \"total_volumes_frios\": 0,\n \"total_volumes_comuns\": 1,\n \"total_compras\": 1,\n \"status\": \"A\",\n \"created\": \"2022-05-17T14:51:57-03:00\",\n \"modified\": \"2022-05-17T14:51:57-03:00\",\n \"id\": 179,\n \"status_descricao\": \"Alocada\"\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Record not found in table \"logistica_remessas\"\" quando o ID da remessa não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Record not found in table \\\"logistica_remessas\\\"\"\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Carga já finalizada\", quando a carga informada no body da requisição já estiver em uma remissa
com status de finalizada, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Carga já finalizada\"\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"O CEP informado é inválido\" quando o CEP informando estiver no formato inválido. Deverá ser enviado com formatação
contendo 9 (nove) digitos, exemplo: 31830-831. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível salvar usuario.\",\n \"errorCount\": 1,\n \"errors\": {\n \"cep\": {\n \"cep\": \"O CEP informado é inválido\"\n }\n }\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"O CPF informado é inválido\" quando o CPF informando estiver no formato inválido. Deverá ser enviado sem
formatação e contendo 11 (onze) digitos.
Exemplo: 49583346020. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível salvar usuario.\",\n \"errorCount\": 1,\n \"errors\": {\n \"cpf\": {\n \"document\": \"O CPF informado é inválido\"\n }\n }\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Usuário não disponível\", quando o usuário informado estiver vinculado a outra entrega e seu status não estiver
com disponível no sistema. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Usuário não disponível\"\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Veículo não se encontra disponível\", quando o veículo informado estiver vinculado a outra entrega e
seu status não estiver com disponível no sistema. A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Veículo não se encontra disponível\"\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Motorista precisa ter número e categoria de habilitação\", quando o campo \"habilitacao_categorias\" não for informado.
A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível salvar usuario.\",\n \"errorCount\": 1,\n \"errors\": {\n \"cargos\": {\n \"cargos\": \"Motorista precisa ter número e categoria de habilitação\"\n }\n }\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Este campo é obrigatório\", quando um ou mais campos obrigatórios não forem informados.
A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível salvar veiculo.\",\n \"errorCount\": 4,\n \"errors\": {\n \"placa\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"modelo\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"ano\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"ativo\": {\n \"_required\": \"Este campo é obrigatório\"\n }\n }\n },\n \"warnings\": []\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"Este campo é obrigatório\", quando um ou mais campos obrigatórios não forem informados.
A seguir é exibido um exemplo da mensagem de erro.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível salvar usuario.\",\n \"errorCount\": 12,\n \"errors\": {\n \"nome\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"username\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"password\": {\n \"_empty\": \"Este campo não pode ser deixado vazio\"\n },\n \"cpf\": {\n \"_required\": \"O campo CPF é obrigatório\"\n },\n \"cep\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"email\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"logradouro\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"numero\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"bairro\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"cidade\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"uf\": {\n \"_required\": \"Este campo é obrigatório\"\n },\n \"telefone_celular\": {\n \"_required\": \"Este campo é obrigatório\"\n }\n }\n },\n \"warnings\": []\n}\n\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite finalizar a entrega
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/entregas/finalizar/COMPRA_ID
\nPara finalizar a entrega da compra é necessário enviar uma requisição POST informando na URL da requisição o ID da compra.
Descrição do corpo body da requisição
| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| data_entrega | \nData da entrega da compra. Deverá ser informado no formato: YYYY-MM-DD HH:MM:SS. Exemplo: 2022-06-20 10:10:10 | \n Sim | \n
| evidencias.tipo | \nTipo do conteúdo. | \nNão | \n
| evidencias.conteudo | \nRecibo da compra assinado e comprovante de pagamento. Atenção: Para recibo da compra assinado obrigatório sempre enviar: \"recibo_compra_assinado\". Atenção: Para comprovante de pagamento, enviar: \"comprovante_pagamento\". Obrigatório somente quando houver pagamento pós-pago com cartão. | \n Sim | \n
| evidencias.base64_arquivo | \nArquivo do conteúdo enviado em formato base64 | \nSim | \n
Exemplo de body em JSON
\n\n{\n \"data_entrega\": \"2022-06-20 10:10:10\",\n \"evidencias\" : [\n {\n \"tipo\": \"evidencia_de_entrega\",\n \"conteudo\": \"recibo_compra_assinado\",\n \"base64_arquivo\": \"base64:45nefetkj34br2kjtb34jk42kb34kj5b45k42b524kj43hb5\"\n },\n {\n \"tipo\": \"evidencia_de_entrega\",\n \"conteudo\": \"comprovante_pagamento\",\n \"base64_arquivo\": \"base64:45nefetkj34br2kjtb34jk42kb34kj5b45k42b524kj43hb5\"\n }\n ]\n}\n\n\nSerá retornado o código de status 201 Created quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 3756,\n \"vipcommerce_compra_id\": \"4564cb0c-fee3-11ec-9a5e-02fdb34cbcf5\",\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"compra_status_id\": 35,\n \"tipo_entrega_id\": 1,\n \"cliente_id\": 748,\n \"endereco_id\": 758,\n \"usuario_id\": null,\n \"api_usuario_id\": null,\n \"external_compra_id\": null,\n \"cnpj_gerador_pedido\": null,\n \"foreign_key\": null,\n \"parent_id\": null,\n \"lft\": 6963,\n \"rght\": 6964,\n \"tipo_compra\": \"N\",\n \"data_original_entrega\": \"2022-07-12T08:50:00-03:00\",\n \"data_entrega\": \"2022-07-12T08:50:00-03:00\",\n \"data_entregue\": \"2022-06-20T10:10:10-03:00\",\n \"data_faturamento\": \"2022-07-08T14:29:18-03:00\",\n \"faturamento\": true,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": \"3756\",\n \"numero_fiscal_devolucao\": null,\n \"prevenda\": true,\n \"numero_prevenda\": \"3756.xml\",\n \"frete\": 102.98,\n \"valor_inicial\": 20.49,\n \"valor_desconto\": 2,\n \"impressao_recibo\": true,\n \"tipo_reposicao\": \"C\",\n \"observacoes_do_cliente\": null,\n \"observacoes_do_atendimento\": null,\n \"observacoes_na_entrega\": null,\n \"observacoes_retorno_entrega\": null,\n \"intervalo\": 0,\n \"cancelamento\": false,\n \"ip\": \"170.79.55.34\",\n \"navegador\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/101.0.4951.54 Safari/537.36\",\n \"data_status\": null,\n \"envio_automatico\": true,\n \"peso_bruto\": 0,\n \"peso_liquido\": 0,\n \"qtd_itens\": 1,\n \"qtd_produtos\": 1,\n \"valor_produtos\": 20.49,\n \"validar_cartao\": false,\n \"adwords\": 0,\n \"mobile\": 1,\n \"tipo_dispositivo\": \"S\",\n \"retirada_loja\": false,\n \"notificacao_retirada\": 0,\n \"antifraude_session_id\": null,\n \"score_priorizacao\": null,\n \"informacoes_cashback\": null,\n \"desconto_aplicado\": true,\n \"fonte_compra\": \"V\",\n \"marketplace\": 0,\n \"created\": \"2022-07-08T14:27:41-03:00\",\n \"modified\": \"2022-07-19T17:15:03-03:00\",\n \"codigo\": 3756,\n \"status_cliente\": \"Entregue\",\n \"total_itens\": 1,\n \"valor_descontos\": 2,\n \"valor_final\": 123.47,\n \"concluir_compra\": false,\n \"comprar_novamente\": false,\n \"efetuar_cancelamento\": false,\n \"efetuar_troca\": false,\n \"efetuar_devolucao\": false,\n \"data_entrega_formatada\": \"Ter, 12 de Julho de 2022 até às 08:50\",\n \"volumes_frios\": 0,\n \"volumes_comuns\": 1\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Status da compra não permite enviar para próxima etapa.\", quando a compra não estiver no status \"em entrega\", conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/parceiro_logistico/entregas/finalizar/3772\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"Exception\",\n \"code\": 400,\n \"message\": \"Status da compra não permite enviar para próxima etapa.\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite cancelar entrega da compra
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/entregas/cancelar/{COMPRA_ID}
\nPara cancelar a entrega da compra é necessário enviar uma requisição POST informando o ID da compra na URL.\nA seguir é exibido a descrição do body da requisição.
Atenção para realizar o cancelamento a compra deverá estar no status \"Em entrega\".
\n| Propriedade | \nDescrição | \nObrigatório | \n
|---|---|---|
| data_cancelamento | \nData de cancelamento. Deverá ser informado no formato: YYYY-MM-DD HH:MM:SS. Exemplo: 2022-06-20 10:10:10 | \n Não | \n
| motivo_cancelamento | \nMotivo de cancelamento. | \nSim | \n
Exemplo de body em JSON
\n\n{\n \"data_cancelamento\": \"2022-06-20 10:10:10\",\n \"motivo_cancelamento\" : \"teste\"\n}\n\n\nSerá retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"id\": 2788,\n \"vipcommerce_compra_id\": \"a0a2d676-9415-11ec-ad79-02fdb34cbcf5\",\n \"centro_distribuicao_id\": 1,\n \"filial_id\": 1,\n \"compra_status_id\": 36,\n \"tipo_entrega_id\": 6,\n \"cliente_id\": 714,\n \"endereco_id\": 717,\n \"usuario_id\": null,\n \"api_usuario_id\": \"61eeeab0-fa1c-433b-8726-2ddfac1402de\",\n \"external_compra_id\": null,\n \"cnpj_gerador_pedido\": \"03042519000120\",\n \"foreign_key\": null,\n \"parent_id\": null,\n \"lft\": 5539,\n \"rght\": 5540,\n \"tipo_compra\": \"N\",\n \"data_original_entrega\": \"2020-12-23T13:00:00-03:00\",\n \"data_entrega\": \"2022-03-31T19:04:22-03:00\",\n \"data_entregue\": null,\n \"data_faturamento\": \"2022-02-22T16:30:02-03:00\",\n \"faturamento\": true,\n \"tipo_fiscal\": \"CF\",\n \"numero_fiscal\": \"465320\",\n \"numero_fiscal_devolucao\": \"687620\",\n \"prevenda\": true,\n \"numero_prevenda\": null,\n \"frete\": 10.72,\n \"valor_inicial\": 1480,\n \"valor_desconto\": 0,\n \"impressao_recibo\": true,\n \"tipo_reposicao\": \"C\",\n \"observacoes_do_cliente\": \"observacoes do cliente\",\n \"observacoes_do_atendimento\": \"ola\",\n \"observacoes_na_entrega\": null,\n \"observacoes_retorno_entrega\": null,\n \"intervalo\": 0,\n \"cancelamento\": false,\n \"ip\": \"179.234.17.67\",\n \"navegador\": \"PostmanRuntime/7.28.4\",\n \"data_status\": null,\n \"envio_automatico\": false,\n \"peso_bruto\": 0.25,\n \"peso_liquido\": 0.25,\n \"qtd_itens\": 3,\n \"qtd_produtos\": 2,\n \"valor_produtos\": 0,\n \"validar_cartao\": false,\n \"adwords\": 0,\n \"mobile\": 0,\n \"tipo_dispositivo\": \"I\",\n \"retirada_loja\": false,\n \"notificacao_retirada\": 0,\n \"antifraude_session_id\": null,\n \"score_priorizacao\": null,\n \"informacoes_cashback\": null,\n \"desconto_aplicado\": false,\n \"fonte_compra\": \"P\",\n \"marketplace\": 0,\n \"created\": \"2022-02-22T16:28:35-03:00\",\n \"modified\": \"2022-09-13T10:50:24-03:00\",\n \"codigo\": 2788,\n \"status_cliente\": \"Entrega não realizada\",\n \"total_itens\": 3,\n \"valor_descontos\": 0,\n \"valor_final\": 1490.72,\n \"concluir_compra\": false,\n \"comprar_novamente\": false,\n \"efetuar_cancelamento\": false,\n \"efetuar_troca\": false,\n \"efetuar_devolucao\": false,\n \"data_entrega_formatada\": \"Qui, 31 de Março de 2022 até às 19:04\",\n \"volumes_frios\": 0,\n \"volumes_comuns\": 1\n }\n}\nSerá retornado o código de status 404 Not found com a mensagem \"Record not found in table \"compras\"\",\nquando o ID da compra informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/parceiro_logistico/entregas/cancelar/654987\",\n \"code\": 404,\n \"exception\": {\n \"class\": \"Cake\\\\Datasource\\\\Exception\\\\RecordNotFoundException\",\n \"code\": 404,\n \"message\": \"Record not found in table \\\"compras\\\"\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Status da compra não permite enviar para próxima etapa.\",\nquando a compra informada na URL não estiver no status \"Em entrega\", conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/parceiro_logistico/entregas/cancelar/2788\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"Exception\",\n \"code\": 400,\n \"message\": \"Status da compra não permite enviar para próxima etapa.\"\n }\n }\n}\nSerá retornado o código de status 400 Bad Request com a mensagem \"Informe o motivo de cancelamento.\",\nquando o motivo do cancelamento não for informado no body da requisição, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não encontrado\",\n \"url\": \"/parceiro_logistico/entregas/cancelar/3766\",\n \"code\": 400,\n \"exception\": {\n \"class\": \"Exception\",\n \"code\": 400,\n \"message\": \"Informe o motivo de cancelamento.\"\n }\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite confirmar o recebimento da remessa
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/remessas/REMESSA_ID
\nPara confirmar o recebimento de uma remessa é necessário enviar uma requisição PUT informando o ID da remessa na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"info\": true\n }\n}\nSerá retornado o código de status 404 Not found com a mensagem \"A remessa não foi encontrada.\",\nquando o ID da remessa informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não foi encontrada.\"\n }\n}\nSerá retornado o código de status 400 Bad request com a mensagem \"A remessa não pode ser consultada.\", quando a remessa já estiver recebida ou finalizada, a seguir é exibido um exemplo da mensagem.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não pode ser consultada.\"\n }\n}\nPara detalhes sobre o cabeçalho da requisição,
\n\nPermite cancelar uma remessa
\nURL Sandbox:
\nhttps://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/remessas/{REMESSA_ID}
\nPara cancelar uma remessa é necessário enviar uma requisição DELETE informando o ID da remessa na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"info\": true\n }\n}\n\nSerá retornado o código de status 200 OK com a mensagem \"A remessa não foi encontrada.\",
quando o ID da remessa informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não foi encontrada.\"\n }\n}\n\nSerá retornado o código de status 400 Bad request com a mensagem \"A remessa consultada não pode ser cancelada. O status da(s) compra(s) não permite o cancelamento.\",
quando o status das compras vinculadas a remessa não estiverem em um status com permissão de cancelado, a seguir é exibido um exemplo do erro.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa consultada não pode ser cancelada. O status da(s) compra(s) não permite o cancelamento.\"\n }\n}\n\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite remover uma carga
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/cargas/{CARGA_ID}
\nPara remover uma carga é necessário enviar uma requisição DELETE informando o ID da carga na URL.
Para remover uma carga da remessa é necessário enviar uma requisição DELETE informando o ID da carga na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"message\": \"Carga 179 removida com sucesso!\"\n }\n}\nSerá retornado o código de status 200 OK com a mensagem \"Não foi possível localizar a remessa através da carga\",\nquando o ID da carga informado na URL não for encontrado, conforme o exemplo.
{\n \"success\": false,\n \"data\": {\n \"message\": \"Não foi possível localizar a remessa através da carga\"\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite remover uma compra da remessa
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/remessas/ID_REMESSA/compra/ID_COMPRA
\nPara remover uma compra remessa é necessário enviar uma requisição DELETE informando o ID da remessa e ID da compra na URL.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"success\": true,\n \"data\": {\n \"info\": \"Sucesso\"\n }\n}\nSerá retornado o código 404 Not Found com a mensagem: \"A remessa não foi encontrada.\", quando o ID da remessa ou ID da compra não for(em) encontrado(s). A seguir é exibido um exemplo da mensagem de erro.
\n{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não foi encontrada.\"\n }\n}\nPara detalhes sobre o cabeçalho da requisição, clique aqui
\nPermite consultar os dados de uma remessa.
\nURL Sandbox: https://api-integracao.sandbox.vipcommerce.com.br/parceiro_logistico/remessas/REMESSA_ID
\nPara consultar os dados de uma remessa é preciso enviar uma requisição GET, sendo necessário informar o ID da remessa na URL da requisição.
Será retornado o código de status 200 OK quando a requisição ocorrer com sucesso, conforme o exemplo.
{\n \"control_id\": \"a92dd5c2-4ffd-4fa9-a9ba-cd15850fd09f\",\n \"shipper\": {\n \"document\": {\n \"type\": \"cnpj\",\n \"number\": \"22209371000110\"\n }\n },\n \"shipments\": [\n {\n \"sender_origin\": {\n \"name\": \"Centro 2 LTDA\",\n \"trade_name\": \"Centro 2\",\n \"document\": {\n \"type\": \"cnpj\",\n \"number\": \"56246832000147\"\n },\n \"state_tax_id\": {\n \"is_exempt\": false,\n \"number\": \"464938228\",\n \"state\": {\n \"id\": 42\n }\n },\n \"address\": {\n \"postal_code\": \"88330657\",\n \"street\": \"Rua 10\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"city\": {\n \"name\": \"Balneário Camboriú\",\n \"state\": {\n \"abbr\": \"SC\"\n }\n },\n \"use_type\": 2,\n \"lat\": -26.9849718,\n \"long\": -48.6354662\n },\n \"email\": \"\",\n \"phones\": [\n {\n \"area\": 0,\n \"number\": 11111111111,\n \"type\": \"comercial\"\n }\n ]\n },\n \"destination\": {\n \"name\": \"Noah Mattas,PF,dois\",\n \"document\": {\n \"type\": \"cpf\",\n \"number\": \"33843626758\"\n },\n \"address\": {\n \"postal_code\": \"30493-000\",\n \"street\": \"Rua Montana\",\n \"number\": \"20\",\n \"complement\": \"\",\n \"reference\": \"teste\",\n \"neighborhood\": \"Sao Salvador\",\n \"city\": {\n \"name\": \"Belo Horizonte\",\n \"state\": {\n \"abbr\": \"MG\"\n }\n },\n \"use_type\": 1,\n \"lat\": null,\n \"long\": null\n },\n \"email\": \"noah76@tst.com\",\n \"rg\": null,\n \"phones\": [\n {\n \"area\": 0,\n \"number\": 319531504,\n \"type\": \"comercial\"\n },\n {\n \"area\": 0,\n \"number\": 7318147411,\n \"type\": \"comercial\"\n }\n ]\n },\n \"invoices\": [\n {\n \"type\": 2,\n \"icms_exemption\": false,\n \"invoice_br\": {\n \"key\": \"1484\",\n \"model\": 59,\n \"issue_date\": \"2020-10-23T17:57:45-03:00\"\n },\n \"order\": {\n \"number\": \"1484\",\n \"date\": \"2020-10-22T15:28:15-03:00\"\n },\n \"amount\": 2522.79\n }\n ],\n \"packages\": [\n {\n \"tag\": \"1484-2\",\n \"packing\": {\n \"type\": \"none\",\n \"temperature\": \"frozen\",\n \"weight\": 1,\n \"dimensions\": {\n \"l\": 1,\n \"w\": 1,\n \"h\": 1\n }\n }\n },\n {\n \"tag\": \"1484-3\",\n \"packing\": {\n \"type\": \"none\",\n \"temperature\": \"frozen\",\n \"weight\": 1,\n \"dimensions\": {\n \"l\": 1,\n \"w\": 1,\n \"h\": 1\n }\n }\n }\n ],\n \"delivery_info\": {\n \"service_type\": \"grocery\",\n \"deadline\": {\n \"dt_delivery_start\": \"2020-10-22T22:00:00-03:00\",\n \"dt_delivery_finish\": \"2022-03-31T19:04:22-03:00\"\n }\n }\n }\n ]\n}\nSerá retornado o código de status 401 Unauthorized com a mensagem \"A remessa não está associada a este usuário\", quando o usuário não estiver associado à remessa, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não está associada a este usuário.\"\n }\n}\nSerá retornado o código de status 404 Not Found com a mensagem \"A remessa não foi encontrada\", quando o id da remessa não for encontrado, conforme o exemplo abaixo.
{\n \"success\": false,\n \"data\": {\n \"error\": \"A remessa não foi encontrada.\"\n }\n}\n