COMEÇANDO
A API (Application Programming Interface) permite a sistematização remota de diversas
tarefas realizadas regularmente pelos usuários através do site administrativo da loja virtual.
Com esta API é possÃvel integrar aplicativos externos tais como ERPs, CRMs, sistemas de BI,
gateways de pagamento etc, e através destes aplicativos executar métodos da API para
gerenciamento de produtos e pedidos, obter dados de relatórios e executar utilitários da Loja
virtual.
O acesso à API ocorre sempre através do protocolo HTTPS (porta 443). A execução de cada
método inicia-se através de uma solicitação enviada via FORM POST e termina em seguida com
uma única resposta em XML.
A resposta à execução de cada método é sÃncrona e pode ocorrer de forma quase imediata ou
pode demorar até alguns minutos, dependendo do método e da quantidade de registros lidos
ou alterados.
Para utilizar essa API você precisa ter uma loja virtual na plataforma Loja Mestre, estar com o módulo de API ativo ou contratado e ter o token de sua loja virtual.
CaracterÃsticas da solução
A API foi desenvolvida com tecnologia XML e JSON, que é padrão de mercado e independe da
tecnologia utilizada por nossos clientes. Dessa forma, é possÃvel integrar-se utilizando as mais
variadas linguagens de programação, tais como: ASP, ASP.Net, Java, PHP, Ruby, Python, etc.
Entre outras caracterÃsticas, destacam-se:
- Ausência de aplicativos proprietários: Não é necessário instalar aplicativos no
ambiente da loja virtual em nenhuma hipótese.
- Simplicidade: o protocolo utilizado é puramente o HTTPS, sem necessidade do uso de
SOAP.
- Facilidade de credenciamento: o tratamento das credenciais do lojista (token de
acesso) trafega na mensagem, em campos comuns do XML, sem necessidade de
atributos especiais, como por exemplo, SOAP Header.
- Segurança: a troca de informações se dá sempre entre a aplicação da Loja e da Loja
Virtual, ou seja, sem o browser do comprador.
- Multiplataforma: a integração é realizada através de Web Service, em um único
Endpoint.
Considerações sobre a integração
Todas as requisições a Web Service da Loja Virtual devem conter o nó de autenticação
do lojista, composto pelo código do token.
- O cadastro da loja deve estar ativo junto ao nosso provedor.
- Deve-se definir um timeout adequado nas requisições HTTP à Loja Virtual; recomendamos 30 segundos.
POST /servicos/ecommwsec.do HTTP/1.1
Host: https://www.seudominio.com.br/Api.asp
Content-Type: application/x-www-form-urlencoded
Content-Length: length
Formato=xml
mensagem=
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicaotransacao>
<Authentication>
<Token>1234567890</Token>
<Comando>EA</Comando>
</Authentication>
<Produtos>
<Produto>
<CodeProduto>1234</CodeProduto>
<MetodoEstoque>increase</MetodoEstoque>
<EstoqueProduto>+1</EstoqueProduto>
</Produto>
</Produtos>
</requisicao-transacao>
End Point
A integração é realizada através de serviços disponibilizados como Web Services. O modelo
empregado é bastante simples: Há uma única URL (endpoint) que recebe os POSTS via HTTPS
e, dependendo do formato do XML enviado, uma determinada operação é realizada.
A comunicação se inicia através de um FORM POST para o seguinte endereço:
https://www.seudominio.com.br/Api.asp
Campos Obrigatórios
Token: O código está localizado em administração> Integrações
Comando: O comando informa qual a ação desejada na chamada à API.
Valores dos campos:
Os valores de campos especificos se encontram no anexo 1 da API.
Na administração da loja virtual acesse:
Suporte > Manuais da loja virtual > Anexo 1 Valores dos campos
Autenticação
Como cada loja virtual terá seu End Point único e exclusivo para requisitos de segurança é necessário apenas infomrar sempre em cada comando o Token.
O seu Token estará visÃvel na sua loja virtual no caminho:
Menu Administração >> Integrações
logo no começo da página.
Certifique-se que sua loja tenha a API ativa.
Exemplo de uso com a linguagem PHP
Ao lado temos um exemplo de disparo contra a API da Loja Mestre utilizando a linguem PHP e a função CURL.
<?php
date_default_timezone_set( 'America/Sao_Paulo' );
$url = "https://www.dominio.com.br/Api.asp?mensagem=";
$stringxml="<requisicaotransacao><Authentication><Token>1234567890</Token><Comando>VR</Comando></Authentication><Records><Record><DateStart>10/09/2017</DateStart><DateEnd>19/09/2017</DateEnd></Record></Records></requisicao-transacao>";
$postcompleto = $url.$stringxml;
$headers = array();
$headers[] = "Accept: application/xml";
$headers[] = "Content-Type:application/xml;charset=UTF-8";
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $stringxml);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_URL, $postcompleto);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
$result = curl_exec($ch);
// Se der algum erro de conexão por este comando irá exibir
if(curl_error($ch)) { echo 'error:' . curl_error($ch); }
curl_close($ch);
// converte o resultado em XML
$xml = simplexml_load_string($result);
$num_venda = $xml->Venda->info->{'NumeroCompra'};
echo "<br />$num_venda";
foreach ($xml->Venda as $venda)
{
echo $venda->Info->Data ."<b> - ". $venda->Info->NumeroCompra ."</b><br />";
foreach ($venda->Produtos as $produtos)
{
echo $produtos->Produto->Nome ."<br />";
}
}
?>
Exemplo de uso com a linguagem ASP
Ao lado temos um exemplo de disparo contra a API da Loja Mestre utilizando a linguem ASP e componente XmlHttp.
<%
url=https://www.dominio.com.br/api.asp?mensagem=
token="1234567890"
comando="VR"
entrada = "<?xml version=""1.0"" encoding=""ISO-8859-1""?>"
entrada = entrada & "<requisicao-transacao>"
entrada = entrada & "<Authentication>"
entrada = entrada & "<Token>"&token&"</Token>"
entrada = entrada & "<Comando>"&comando&"</Comando>"
entrada = entrada & "</Authentication>"
entrada = entrada & "<Records>"
entrada = entrada & "<Record>"
entrada = entrada & "<DateStart>10/09/2017</DateStart>"
entrada = entrada & "<DateEnd>19/09/2017</DateEnd>"
entrada = entrada & "</Record>"
entrada = entrada & "</Records>"
entrada = entrada & "</requisicao-transacao>"
Set XmlHttp = Server.CreateObject("WinHttp.WinHttpRequest.5.1")
XmlHttp.SetTimeouts 3000, 3000, 3000, 3000
XmlHttp.open "post", url&entrada,false
XmlHttp.send
return = XmlHttp.responseText
set XmlHttp = nothing
Response.write return
%>
Alteração de Estoque
Comando EA
Essa função permite enviar para a loja virtual o estoque atualizado a partir do sistema do
lojista.
CodeProduto: Obrigatório. Deve ser o mesmo código cadastrado na versão do produto
Adicionais Funções para o MetodoEstoque:
increase: O sistema irá adicionar ou diminuir do estoque atual da loja. Deverá vir
acompanhado do sinal + para aumentar ou - para diminuir do estoque (+5 ou -3).
update: O sistema irá alterar o valor atual do estoque da loja virtual para o novo valor
indicado.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>EA</Comando>
</Authentication>
<Produtos>
<Produto>
<CodeProduto>000001</CodeProduto>
<MetodoEstoque>increase</MetodoEstoque>
<EstoqueProduto>+41</EstoqueProduto>
</Produto>
<Produto>
<CodeProduto>000002</CodeProduto>
<MetodoEstoque>update</MetodoEstoque>
<EstoqueProduto>42</EstoqueProduto>
</Produto>
</Produtos>
</requisicao-transacao>
CAMPOS
Campo | Requerido | Tipo | Descrição |
---|---|---|---|
CodeProduto | Obrigatório | String | SKU da versão |
MetodoEstoque | Obrigatório | String | increase ou update |
EstoqueProduto | Obrigatório | Inteiro | soma ou novo valor. |
Report de estoque
Comando ER
Essa função permite consultar o estoque da loja virtual.
Resposta do servidor
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>ER</Comando>
</Authentication>
</requisicao-transacao>
<?xml version="1.0" encoding="iso-8859-1"?>
<Produtos>
<Produto>
<Codigo>9788560544387</Codigo>
<Quantidade>29</Quantidade>
<Nome>1808</Nome>
</Produto>
</Produtos>
Report de produtos
Comando PR
Essa função retornará os produtos e versões cadastradas na loja virtual.
Resposta do servidor
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PR</Comando>
</Authentication>
</requisicao-transacao>
<?xml version="1.0" encoding="iso-8859-1"?>
<Produtos>
<Produto>
<ID>85</ID>
<P_ID_ERP>0000-1111-2222-3333</P_ID_ERP>
<NomeProduto><![CDATA[Brasileirinho - Grandes Encontros]]></NomeProduto>
<Autor><![CDATA[Brasileirinho - Grandes Encontros]]></Autor>
<URL><![CDATA[http://www.shopstarrett.com.br/produtos.asp?produto=13686&categoria=1340&inf=149&a1=Discos&a2=Discos+de+vinil&nome=Tim-MaiaRenascer]]></URL>
<URLSegura><![CDATA[https://www.shopstarrett.com.br/produtos.asp?produto=13686&categoria=1340&inf=149&a1=Discos&a2=Discos+de+vinil&nome=Tim-MaiaRenascer]]></URLSegura>
<URLAmigavel><![CDATA[http://www.shopstarrett.com.br/Tim-MaiaRenascer~13686~1340&~149~Discos~Tim_Maia]]></URLAmigavel>
<URLAmigavelSegura><![CDATA[https://www.shopstarrett.com.br/Tim-MaiaRenascer~13686~1340&~149~Discos~Tim_Maia]]></URLAmigavelSegura>
<Fabricante>Unidisc</Fabricante>
<IDFabricante>03</IDFabricante>
<NCM>0000000000</NCM>
<CEST>0000000000</CEST>
<VisivelNaLoja>1</VisivelNaLoja>
<VisivelXML>0</VisivelXML>
<ExibeML>0</ExibeML>
<DescricaoML><![CDATA[ótimo Produto]]</DescricaoML>
<TipoProducao>Própria</TipoProducao>
<MetaDescription>Brasileirinho - Grandes </MetaDescription>
<MetaKeywords><![CDATA[Cd, DVD]]></MetaKeywords>
<FlagPromocao>0</FlagPromocao>
<FlagLancamento>0</FlagLancamento>
<FrontSemFlag>0</FrontSemFlag>
<OrdenacaoVitrine>8</OrdenacaoVitrine>
<Categoria>1</Categoria>
<Nome_Categoria>Vinhos</Nome_Categoria>
<SubCategoria>3</SubCategoria>
<Nome_SubCategoria>Chile</SubCatNome_SubCategoria>
<PackTipo>Cubagem</PackTipo>
<PackMix>s</PackMix>
<PerfilProduto>VAD</PerfilProduto>
<Img1>brasileirinho box novo peq.jpg</Img1>
<Img1Ampliada>brasileirinho1.jpg</Img1Ampliada>
<Img2>brasileirinho box novo peq.jpg</Img2>
<Img2Ampliada>brasileirinho1.jpg</Img2Ampliada>
<Img3>brasileirinho box novo peq.jpg</Img3>
<Img3Ampliada>brasileirinho1.jpg</Img3Ampliada>
<Img4>brasileirinho box novo peq.jpg</Img4>
<Img4Ampliada>brasileirinho1.jpg</Img4Ampliada>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ID>79</V_ID>
<V_ID_ERP>0000-1111-2222-5555</V_ID_ERP>
<V_Max_Sale>5</V_Max_Sale>
<V_ProdutoID>85</V_ProdutoID>
<V_Nome><![CDATA[Brasileirinho - Simples]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_ MinimoCompra >
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>P</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes> Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto> Ganhe um chaveiro</V_PromoTexto>
<V_Image></V_Image>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
<Versao>
<V_Codigo>7898085051321</V_Codigo>
<V_ID>80</V_ID>
<V_ID_ERP>0000-1111-2222-6666</V_ID_ERP>
<V_Max_Sale>80</V_Max_Sale>
<V_ProdutoID>85</V_ProdutoID>
<V_Nome><![CDATA[Brasileirinho Ouro]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Preco>19,91</V_Preco>
<V_PrecoRiscado>24,90</V_PrecoRiscado>
<V_Custo>9,90</V_Custo>
<V_Indexador>1</V_Indexador>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de MÃdia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper</V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro</V_PromoTexto>
<V_Image>/produtos/</V_Image>
</Versao>
</Versoes>
</Produto>
</Produtos>
Report de produto individual
Comando PRI
Essa função retornará o produto e versões cadastradas na loja virtual.
Resposta do servidor
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PRI</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Record>
<IDProduto > 1201471120117 </IDProduto>
</Record>
</Records>
Report de produto individual por ID do ERP
Comando PRIERP
Essa função retornará o produto e versões cadastradas na loja virtual.
Resposta do servidor
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PRIERP</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Record>
<P_ID_ERP>0000-1111-2222-3333</P_ID_ERP>
</Record>
</Records>
<?xml version="1.0" encoding="iso-8859-1"?>
<Produtos>
<Produto>
<ID>85</ID>
<P_ID_ERP>0000-1111-2222-4444</P_ID_ERP>
<NomeProduto><![CDATA[Brasileirinho - Encontros]]></NomeProduto>
<Autor><![CDATA[Branca Alves de Melo]]></Autor>
<Fabricante>Unidisc</Fabricante>
<IDFabricante>03</IDFabricante>
<NCM>0000000000</NCM>
<CEST>0000000000</CEST>
<VisivelNaLoja>1</VisivelNaLoja>
<VisivelXML>0</VisivelXML>
<ExibeML>0</ExibeML>
<DescricaoML><![CDATA[ótimo Produto]]</DescricaoML>
<TipoProducao>Própria</TipoProducao>
<MetaDescription>Brasileirinho - Grandes</MetaDescription>
<MetaKeywords><![CDATA[Cd, DVD]]></MetaKeywords>
<FlagPromocao>0</FlagPromocao>
<FlagLancamento>0</FlagLancamento>
<FrontSemFlag>0</FrontSemFlag>
<OrdenacaoVitrine>8</OrdenacaoVitrine>
<Categoria>1</Categoria>
<Nome_Categoria>Vinhos</Nome_Categoria>
<SubCategoria>3</SubCategoria>
<Nome_SubCategoria>Chile</SubCatNome_SubCategoria>
<PackTipo>Cubagem</PackTipo>
<PackMix>s</PackMix>
<PerfilProduto>VAD</PerfilProduto>
<Img1>brasileirinho box novo peq.jpg</Img1>
<Img1Ampliada>brasileirinho1.jpg</Img1Ampliada>
<Img2>brasileirinho box novo peq.jpg</Img2>
<Img2Ampliada>brasileirinho1.jpg</Img2Ampliada>
<Img3>brasileirinho box novo peq.jpg</Img3>
<Img3Ampliada>brasileirinho1.jpg</Img3Ampliada>
<Img4>brasileirinho box novo peq.jpg</Img4>
<Img4Ampliada>brasileirinho1.jpg</Img4Ampliada>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ID>79</V_ID>
<V_ID_ERP>0000-1111-2222-5555</V_ID_ERP>
<V_Max_Sale>79</V_Max_Sale>
<V_ProdutoID>85</V_ProdutoID>
<V_Nome><![CDATA[Brasileirinho Simples]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_ MinimoCompra >
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>P</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes> Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto> Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Image></V_Image>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
<Versao>
<V_Codigo>7898085051321</V_Codigo>
<V_ID>80</V_ID>
<V_ID_ERP>0000-1111-2222-6666</V_ID_ERP>
<V_Max_Sale>80</V_Max_Sale>
<V_ProdutoID>85</V_ProdutoID>
<V_Nome><![CDATA[Brasileirinho - Ouro]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Preco>19,91</V_Preco>
<V_PrecoRiscado>24,90</V_PrecoRiscado>
<V_Custo>9,90</V_Custo>
<V_Indexador>1</V_Indexador>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de MÃdia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper</V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo!</V_PromoTexto>
<V_Image>/produtos/</V_Image>
</Versao>
</Versoes>
</Produto>
</Produtos>
Referências:
Frete Grátis: 0 para sim / 1 para não
Garantia: 0 para sim / 1 para não
Tempo de Garantia: prazo em dias
Report de produto individual por SKU
Comando PRV
Essa função retornará somente as versões cadastradas, buscando pelo SKU (código da versão).
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PRV</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Record>
<V_CodeNumber > 1201471120117 </V_CodeNumber>
</Record>
</Records>
Report de produto individual por ID da versão
Comando PRVID
Essa função retornará somente as versões cadastradas pelo ID da versão no banco de dados da loja.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PRVID</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Record>
<V_ID > 1201471120117 </V_ID>
</Record>
</Records>
Report de produto individual por ID do ERP da versão
Comando PRVERP
Essa função retornará somente as versões cadastradas pelo ID do ERP da versão no banco de dados da loja.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PRVERP</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Record>
<V_ID_ERP>0000-1111-2222-3333</V_ID_ERP>
</Record>
</Records>
Inserção de produtos
Comando PI
Essa função irá inserir o produto e versões na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PI</Comando>
</Authentication>
<Produtos>
<Produto>
<ProdutoID>85</ProdutoID>
<P_ID_ERP>0</P_ID_ERP>
<NomeProduto><![CDATA[Brasileirinho - Encontros]]></NomeProduto>
<Autor><![CDATA[Branca Alves de Melo]]></Autor>
<Fabricante>Unidisc</Fabricante>
<IDFabricante>03</IDFabricante>
<NCM>0000000000</NCM>
<CEST>0000000000</CEST>
<VisivelNaLoja>1</VisivelNaLoja>
<VisivelXML>0</VisivelXML>
<ExibeML>0</ExibeML>
<DescricaoML><![CDATA[Produto especial para o Mercado Livre]]></DescricaoML>
<TipoProducao>Própria</TipoProducao>
<MetaDescription>Brasileirinho - Grandes </MetaDescription>
<MetaKeywords><![CDATA[Cd, DVD]]></MetaKeywords>
<Comentarios><![CDATA[Documentário musical]]></Comentarios>
<Descricao><![CDATA[O filme gira em torno ...]]></Descricao>
<FlagPromocao>0</FlagPromocao>
<FlagLancamento>0</FlagLancamento>
<FrontSemFlag>0</FrontSemFlag>
<OrdenacaoVitrine>8</OrdenacaoVitrine>
<SubCategoria>3</SubCategoria>
<PackTipo>Cubagem</PackTipo>
<PackMix>s</PackMix>
<PerfilProduto>VAD</PerfilProduto>
<Img1>brasileirinho.jpg</Img1>
<Img1Ampliada>brasileirinho-amp.jpg</Img1Ampliada>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ProdutoID>85</V_ProdutoID>
<V_ID_ERP>85</V_ID_ERP>
<V_Max_Sale>5</V_Max_Sale>
<V_Nome><![CDATA[Brasileirinho - Simples]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>P</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Image>box.jpg</V_Image>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
</Versoes>
</Produto>
</Produtos>
</requisicao-transacao>
Notas
As imagens para os produtos e as versões quando informadas nas tags que estão em um
servidor https (https://www.dominio.com.br/xxx.jpg) serão transferidas automaticamente
para a sua loja virtual.
01 produto com suas versões devem ser enviados por vêz.
- O ID do novo produto será retornado através da tag novoID
- O ID das versões será retornada através da tag V_ID
A tag V_ProdutoID deve possuir o mesmo código do produto em ProdutoID
na versão.
Caso seja necessário incluir apenas uma versão para um produto já existente utilize o comando VI
Referências:
Frete Grátis: 0 para sim / 1 para não
Garantia: 0 para sim / 1 para não
Tempo de Garantia: prazo em dias
Inserção de versão para um produto
Comando VI
Essa função irá inserir uma versão de produto na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VI</Comando>
</Authentication>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ProdutoID>85</V_ProdutoID>
<V_ID_ERP>85</V_ID_ERP>
<V_Max_Sale>5</V_Max_Sale>
<V_Nome><![CDATA[Brasileirinho - Encontros Ouro]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>P</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Image>box.jpg</V_Image>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
</Versoes>
</requisicao-transacao>
Notas
O ID das versões será retornada através da tag V_ID
A tag V_ProdutoID deve possuir o mesmo código do produto em ProdutoID
na versão.
Frete Grátis: 0 para sim / 1 para não
Garantia: 0 para sim / 1 para não
Tempo de Garantia: prazo em dias
Alteração de produtos
Comando PA
Essa função irá alterar as informações do produto na loja virtual. Este comando não serve para atualização de estoque e preços.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PA</Comando>
</Authentication>
<Produtos>
<Produto>
<ProdutoID>85</ProdutoID>
<P_ID_ERP>0</P_ID_ERP>
<NomeProduto><![CDATA[Brasileirinho - Grandes Encontros]]></NomeProduto>
<Autor><![CDATA[Branca Alves de Melo]]></Autor>
<Fabricante>Unidisc</Fabricante>
<IDFabricante>03</IDFabricante>
<NCM>1111111111</NCM>
<CEST>0000000000</CEST>
<VisivelNaLoja>1</VisivelNaLoja>
<VisivelXML>0</VisivelXML>
<ExibeML>0</ExibeML>
<TipoProducao>Própria</TipoProducao>
<MetaDescription>Brasileirinho - Grandes Encontros do Choro</MetaDescription>
<MetaKeywords><![CDATA[Cd, DVD]]></MetaKeywords>
<Comentarios><![CDATA[Documentário musical ...]]></Comentarios>
<Descricao><![CDATA[O filme gira ...]]></Descricao>
<DescricaoML><![CDATA[Produto especial para o MercadoLivre]]></DescricaoML>
<FlagPromocao>0</FlagPromocao>
<FlagLancamento>0</FlagLancamento>
<FrontSemFlag>0</FrontSemFlag>
<OrdenacaoVitrine>8</OrdenacaoVitrine>
<SubCategoria>3</SubCategoria>
<PackTipo>Cubagem</PackTipo>
<PackMix>s</PackMix>
<PerfilProduto>VAD</PerfilProduto>
</Produto>
<Produto>
<ProdutoID>81</ProdutoID >
<NomeProduto><![CDATA[Grandes nome do Século]]></NomeProduto>
<Fabricante>Unidisc</Fabricante>
<IDFabricante>03</IDFabricante>
<NCM>1111111111</NCM>
<VisivelNaLoja>1</VisivelNaLoja>
<VisivelXML>0</VisivelXML>
<ExibeML>0</ExibeML>
<TipoProducao>Própria</TipoProducao>
<MetaDescription>Brasileirinho - Grandes Encontros </MetaDescription>
<MetaKeywords><![CDATA[Cd, DVD]]></MetaKeywords>
<Comentarios><![CDATA[Documentário musical ...]]></Comentarios>
<Descricao><![CDATA[O filme gira ...]]></Descricao>
<DescricaoML><![CDATA[Produto especial para o MercadoLivre]]></DescricaoML>
<FlagPromocao>0</FlagPromocao>
<FlagLancamento>0</FlagLancamento>
<FrontSemFlag>0</FrontSemFlag>
<OrdenacaoVitrine>8</OrdenacaoVitrine>
<SubCategoria>3</SubCategoria>
<PackTipo>Cubagem</PackTipo>
<PackMix>s</PackMix>
<PerfilProduto>VAD</PerfilProduto>
</Produto>
</Produtos>
</requisicao-transacao>
Notas
As imagens para os produtos e as versões quando informadas nas tags que estão em um
servidor https (https://www.dominio.com.br/xxx.jpg) serão transferidas automaticamente
para a sua loja virtual.
Somente 1 produto deve ser enviados por vêz.
O ID do novo produto será retornado através da tag novoID
Alteração de versão através do SKU
Comando VU
Essa função irá alterar as informações da versão na loja virtual, identificando o produto pelo SKU da versão.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VU</Comando>
</Authentication>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ProdutoID>85</V_ProdutoID>
<V_ID_ERP>0</V_ID_ERP>
<V_Max_Sale>0</V_Max_Sale>
<V_Nome><![CDATA[Brasileirinho - Ouro]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>Azul</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
<Versao>
<V_Codigo>001001002</V_Codigo>
<V_ProdutoID>86</V_ProdutoID>
<V_Nome><![CDATA[Sucessos da década - simples]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> Bivolt</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
</Versoes>
</requisicao-transacao>
Notas
A versão será atualizada pelo código da tag V_Codigo
Frete Grátis: 0 para sim / 1 para não
Garantia: 0 para sim / 1 para não
Tempo de Garantia: prazo em dias
Alteração de versão através do ID da Versão
Comando VUID
Essa função irá alterar as informações da versão na loja virtual, identificando o produto pelo ID da versão no banco de dados.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VUID</Comando>
</Authentication>
<Versoes>
<Versao>
<V_Codigo>7898085051320</V_Codigo>
<V_ID>123</V_ID>
<V_ProdutoID>85</V_ProdutoID>
<V_ID_ERP>0</V_ID_ERP>
<V_Max_Sale>0</V_Max_Sale>
<V_Nome><![CDATA[Brasileirinho - Ouro]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<nome_cor>Azul</nome_cor>
<nome_tamanho>Azul</nome_tamanho>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
<Versao>
<V_Codigo>001001002</V_Codigo>
<V_ID>124</V_ID>
<V_ProdutoID>86</V_ProdutoID>
<V_Nome><![CDATA[Sucessos da década - simples]]></V_Nome>
<V_DataCadastro>10/10/2014</V_DataCadastro>
<V_Localizacao>Corredor 1</V_Localizacao>
<V_Disponibilidade>0</V_Disponibilidade>
<V_Estoque>997</V_Estoque>
<V_Condicao>Novo / Usado</V_Condicao>
<V_MinimoCompra>0</V_MinimoCompra>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
<V_Custo>12,90</V_Custo>
<V_Indexador>1</V_Indexador>
<V_Medida>Un</V_Medida>
<V_DescontoAtacado>0</V_DescontoAtacado>
<V_DescontoDistribuidor>1</V_DescontoDistribuidor>
<V_DescontoVarejo>1</V_DescontoVarejo>
<V_PesoBruto>150</V_PesoBruto>
<V_GtinEan>7898888880011</V_GtinEan>
<V_GtinEanEmbalagem>7898888880011</V_GtinEanEmbalagem>
<V_frete_gratis >1</V_frete_gratis>
<V_tipo_garantia>Sem garantia</V_tipo_garantia>
<V_tempo_garantia>30</V_tempo_garantia>
<V_Largura>13</V_Largura>
<V_Altura>2</V_Altura>
<V_Profundidade>19</V_Profundidade>
<V_VariacaoNome>Tipo de Midia</V_VariacaoNome>
<V_Variacoes>Box acrÃlico, Box paper </V_Variacoes>
<V_PromoTexto>Ganhe um chaveiro exclusivo !</V_PromoTexto>
<V_Sabor> Chocolate</V_Sabor>
<V_Voltagem> 110V</V_Voltagem>
<V_Volumetria>50 ml</V_Volumetria>
</Versao>
</Versoes>
</requisicao-transacao>
Notas
A versão será atualizada pelo código da tag V_ID
Frete Grátis: 0 para sim / 1 para não
Garantia: 0 para sim / 1 para não
Tempo de Garantia: prazo em dias
Alteração de Preços e Estoques através do SKU
Comando VO
Essa função irá alterar SOMENTE o preço e estoque da versão na loja virtual, identificando a versão pelo SKU.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VO</Comando>
</Authentication>
<Versoes>
<Versao>
<V_Codigo>12345678</V_Codigo>
<V_Estoque>997</V_Estoque>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
</Versao>
<Versao>
<V_Codigo>87654321</V_Codigo>
<V_Estoque>997</V_Estoque>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
</Versao>
</Versoes>
</requisicao-transacao>
Notas
A versão será atualizada pelo código da tag V_Codigo
Para o estoque não ser atualizado envie a tag V_Estoque sem conteúdo
Para o preço não ser atualizado envie a tag V_Preco sem conteúdo
Alteração de Preços e Estoques através do ID da versão
Comando VOID
Essa função irá alterar SOMENTE o preço e estoque da versão na loja virtual, identificando a versão pelo ID da verão no banco de dados.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VOID</Comando>
</Authentication>
<Versoes>
<Versao>
<V_ID>123</V_ID>
<V_Codigo>12345678</V_Codigo>
<V_Estoque>997</V_Estoque>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
</Versao>
<Versao>
<V_ID>124</V_ID>
<V_Codigo>87654321</V_Codigo>
<V_Estoque>997</V_Estoque>
<V_Preco>34,91</V_Preco>
<V_PrecoRiscado>39,90</V_PrecoRiscado>
</Versao>
</Versoes>
</requisicao-transacao>
Notas
A versão será atualizada pelo código da tag V_ID
Para o estoque não ser atualizado envie a tag V_Estoque sem conteúdo
Para o preço não ser atualizado envie a tag V_Preco sem conteúdo
Alteração de produto visÃvel na loja por ID do produto
Comando PVU
Essa função irá alterar se o produto está visÃvel ou não na loja virtual por ID do produto.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PVU</Comando>
</Authentication>
<Produtos>
<Produto>
< ID_Produto >123</ID_Produto >
< Visivel>1</Visivel>
</Produto >
< Produto >
< ID_Produto >122</ID_Produto >
< Visivel>0</Visivel>
</Produto >
</Produtos>
</requisicao-transacao>
Notas
Tag Visivel = 1 para SIM, 0 para Não.
Alteração do ID da versão do ERP através do SKU
Comando VIDERP
Essa função irá alterar O ID do produto do ERP na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VIDERP</Comando>
</Authentication>
<Versoes>
<Versao>
<V_Codigo >123</V_Codigo >
<V_ID_ERP>111-222-3333-4444</V_ID_ERP>
</Versao >
< Versao >
<V_Codigo>456</V_Codigo>
<V_ID_ERP>111-222-3333-3333</V_ID_ERP>
</Versao >
</Versoes>
</requisicao-transacao>
Alteração do ID do produto na loja virtual
Comando PIDERP
Essa função irá alterar O ID do produto do ERP na loja virtual atraves do ID do produto.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VIDERP</Comando>
</Authentication>
<Produtos>
<Produto>
<P_ID>1</P_ID>
<P_ID_ERP >111-222-3333-4444</ID_Produto>
</Produto>
<Produto>
<P_ID_ERP>1111-2222-6666-9999</ID_Produto >
<P_ID>0</Visivel>
</Produto >
</Produtos>
</requisicao-transacao>
Alteração de produto visÃvel na loja por ID do ERP
Comando PVU
Essa função irá alterar se o produto está visÃvel ou não na loja virtual atraves do ID do ERP.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PVUE</Comando>
</Authentication>
<Produtos>
<Produto>
< P_ID_ERP >111-222-3333-4444</ID_Produto >
< Visivel>1</Visivel>
</Produto >
< Produto >
< P_ID_ERP >1111-2222-6666-9999</ID_Produto >
< Visivel>0</Visivel>
</Produto >
</Produtos>
</requisicao-transacao>
Notas
Tag Visivel = 1 para SIM, 0 para Não.
Exclusão de produtos
Comando PE
Essa função permite exlcuir um produto da loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PE</Comando>
</Authentication>
<Records>
<Record>
<IDProduto>537</IDProduto>
</Record>
</Records>
</requisicao-transacao>
Notas
Se não for localizada nenhum produto com o ID solicitado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Prod</erro>
<resultado>Nenhum produto foi localizado com o ID informado</resultado>
</Transacao>
</requisicao-transacao>
Exclusão de versão
Comando PVE
Essa função permite exlcuir a versão de um produto da loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PVE</Comando>
</Authentication>
<Records>
<Record>
<sku>1234567890</ sku>
</Record>
</Records>
</requisicao-transacao>
Notas
Se não for localizada nenhum produto com o SKU solicitado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Prod</erro>
<resultado>Nenhuma versão do produto foi localizado com o SKU informado</resultado>
</Transacao>
</requisicao-transacao>
Inserção / alteração de fotos de produtos
Comando IMGI
Essa função permite inserir e alterar as 4 imagens normais e as 4 ampliadas no sistema
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>IMGI</Comando>
</Authentication>
<Imagens>
<Imagem>
<ProdutoID>001</ProdutoID>
<Img1>http://www...</Img1>
<Img1Ampliada>http://www...</Img1Ampliada>
<Img2>http://www...</Img2>
<Img2Ampliada>http://www...</Img2Ampliada>
<Img3> http://www...</Img3>
<Img3Ampliada>http://www...</Img3Ampliada>
<Img4>http://www...</Img4>
<Img4Ampliada>http://www...</Img4Ampliada>
</Imagem>
<Imagem>
<ProdutoID>002</ProdutoID>
<Img1>http://www...</Img1>
<Img1Ampliada>http://www...</Img1Ampliada>
<Img2>http://www...</Img2>
<Img2Ampliada>http://www...</Img2Ampliada>
<Img3> http://www...</Img3>
<Img3Ampliada>http://www...</Img3Ampliada>
<Img4>http://www...</Img4>
<Img4Ampliada>http://www...</Img4Ampliada>
</Imagem>
</Imagens>
</requisicao-transacao>
Report de cores
Comando CLR
Essa função retornará as cores cadastradas na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CLR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
<Records>
<Cores>
<id_cor>4</id_cor>
<nome_cor>Vermelho</nome_cor>
<htmlcode_cor>FF0000</htmlcode_cor>
</Cores >
</Records>
Se não houver nenhuma cor será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Color</erro>
<resultado>Não há nenhuma cor para retornar</resultado>
</Transacao>
</requisicao-transacao>
Inserção de Cores
Comando CLI
Essa função permite a inserção de cores na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CLI</Comando>
</Authentication>
<Records>
<Record>
<nome_cor>Azul</nome_cor>
<htmlcode_cor>269AFF</htmlcode_cor>
</Record>
<Record>
<nome_cor>Verde</nome_cor>
<htmlcode_cor>5EFF19</htmlcode_cor>
</Record>
</Records>
</requisicao-transacao>
Report de Tamanhos
Comando TR
Essa função retornará os tamanhos cadastradas na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>TR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
<Records>
<tamanhos>
<id_tamanho>4</id_tamanho>
<nome_tamanho>Azul</nome_tamanho>
</tamanhos >
</Records>
Se não houver nenhum tamanho será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Size</erro>
<resultado>Não há nenhum tamanho para retornar</resultado>
</Transacao>
</requisicao-transacao>
Inserção de Tamanhos
Comando TI
Essa função permite a inserção de tamanhos na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>TI</Comando>
</Authentication>
<Records>
<Record>
<nome_tamanho>P</nome_tamanho>
</Record>
<Record>
<nome_tamanho>M</nome_tamanho>
</Record>
<Record>
<nome_tamanho>G</nome_tamanho>
</Record>
</Records>
</requisicao-transacao>
SAR – Report de sabores
Comando SAR
Essa função retornará os sabores cadastradas na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SAR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
<Records>
<sabores>
<id_sabor>1</id_sabor>
<nome_sabor>Chocolate</nome_sabor>
</sabores >
</Records>
Se não houver nenhum tamanho será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Flavor</erro>
<resultado>Não há nenhum sabor para retornar</resultado>
</Transacao>
</requisicao-transacao>
Inserção de sabores
Comando SAI
Essa função permite a inserção de sabores na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SAI</Comando>
</Authentication>
<Records>
<Record>
<nome_sabor>Chocolate</nome_sabor>
</Record>
<Record>
<nome_sabor>Morango</nome_sabor>
</Record>
</Records>
</requisicao-transacao>
Inserção / alteração de imagem na versão
Comando IMGVI
Essa função permite a Inserção / alteração de imagem na versão.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>IMGVI</Comando>
</Authentication>
<Imagens>
<Imagem>
<V_Sku>4707904</V_Sku>
<Img>url da imagem</Img>
</Imagem>
</Imagens>
</requisicao-transacao>
Report de categorias e subcategorias
Comando CR
Essa função retornará as categorias e sub-categorias cadastradas nas loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
<Records>
<Categoria>
<Cat_ID>4</Cat_ID>
<Cat_Nome><![CDATA[Box & Coleções]]></Cat_Nome>
<SubCategoria>
<CatRaiz_ID>4</CatRaiz_ID>
<SubCat_ID>18</SubCat_ID>
<SubCat_Nome><![CDATA[Box]]></SubCat_Nome>
<SubCat_Keywords><![CDATA[box sempre]]></SubCat_Keywords>
</SubCategoria>
</Categoria>
</Records>
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Cat</erro>
<resultado>Não há nenhuma categoria para retornar</resultado>
</Transacao>
</requisicao-transacao>
Inserção de Categorias
Comando CI
Essa função permite a inserção de categorias na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CI</Comando>
</Authentication>
<Records>
<Record>
<Cat_Nome><![CDATA[Rações]]></Cat_Nome>
</Record>
<Record>
<Cat_Nome><![CDATA[Potes]]></Cat_Nome>
</Record>
</Records>
</requisicao-transacao>
Inserção de Sub-Categorias
Comando SI
Essa função permite a inserção de sub-categorias na loja virtual.
Deverá obrigatoriamente conter o Cat_ID (ID da categoria principal)
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SI</Comando>
</Authentication>
<Records>
<Record>
<Cat_ID>29</Cat_ID>
<SubCat_Nome><![CDATA[Rações para gato]]></ SubCat_Nome>
<SubCat_Keywords><![CDATA[Ração, gato]]></SubCat_Keywords>
</Record>
<Record>
<Cat_ID>29</Cat_ID>
<SubCat_Nome><![CDATA[Racões para cachorro]]></ SubCat_Nome>
<SubCat_Keywords><![CDATA[Ração, cachorro]]></SubCat_Keywords>
</Record>
</Records>
</requisicao-transacao>
Report de vendas por periodo
Comando VR
Essa função retornará as vendas de um intervalo entre datas.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VR</Comando>
</Authentication>
<Records>
<Record>
<DateStart>10/07/2104</DateStart>
<DateEnd>11/07/2104</DateEnd>
<PedidoIntegrado></PedidoIntegrado>
<Status>Novo Pedido</Status>
</Record>
</Records>
</requisicao-transacao>
Notas:
O intervalo máximo permitido para retorno das vendas é de 10 dias
DateStart: Data inicial para report das vendas
DateEnd: Data final para report das vendas
Ao solicitar um relatório de vendas por perÃodo poderá ser solicitado somente os pedidos que
foram integrados ou não integrados.
Para solicitar os pedidos integrados no ERP informe:
PedidoIntegrado = True
Para solicitar os pedidos não integrados no ERP informe:
PedidoIntegrado = False
Para solicitar os pedidos integrados e não integrados no ERP envie a tag vazia
Para marcar um pedido como integrado, utilize o comando VA.
Status:
Para solicitar os pedidos por status no ERP informe a tag Status:
Status: Novo Pedido
Resposta
<?xml version="1.0" encoding="iso-8859-1"?><Vendas>
<Venda>
<Info>
<Data>11/07/2014 20:11:07</Data>
<NumeroCompra>1201471120117</NumeroCompra>
<Plataforma_ecommerce>Nome da plataforma</Plataforma_ecommerce>
<UTM_source>Google</CNPJ_Plataforma_ecommerce>
<UTM_medium>CPC</CNPJ_Plataforma_ecommerce>
<UTM_campaign>Coleção Verão</CNPJ_Plataforma_ecommerce>
<CNPJ_Plataforma_ecommerce>00000000000000</CNPJ_Plataforma_ecommerce>
<PedidoIntegrado>True</PedidoIntegrado>
<PedidoERP>1234</PedidoERP>
<NotaFiscal>000001</NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
<UltimaAlteracao>12/07/2014</UltimaAlteracao>
<SituacaoDoPedido>Novo Pedido</SituacaoDoPedido>
<Rastreamento>PG482735996BR </Rastreamento>
<DiaDaPostagem>12/07/2014</DiaDaPostagem>
<PrazoDeEntrega>Dia da postagem + 5 dias úteis</PrazoDeEntrega>
<EmailComprador><![CDATA[email@email.com]]></EmailComprador>
<IP>127.1.1.1</IP>
<SubTotalPedido>R$ 48,81</SubTotalPedido>
<descontoprogressivo>R$ 0,00</ descontoprogressivo>
<DiferencialICMS>4,44</DiferencialICMS>
<DescontoConcedido>R$ 0,00</DescontoConcedido>
<DescontoCupom></DescontoCupom>
<CodigoCupom></CodigoCupom>
<FretePedido>R$ 12,34</FretePedido>
<TotalPedido>R$ 61,15</TotalPedido>
<MeioTransporte><![CDATA[Correios - Sedex]]></MeioTransporte>
<Parcelas>0</Parcelas>
<FormaDePagamento><![CDATA[Boleto]]></FormaDePagamento>
<DataEfetivaPagamento>11/07/2014</DataEfetivaPagamento>
<IDComprador>100</IDComprador>
<NomeComprador><![CDATA[Mario Andrade]]></NomeComprador>
<RuaComprador><![CDATA[Rua José da Silva]]></RuaComprador>
<NumeroRuaComprador><![CDATA[195]]></NumeroRuaComprador>
<ComplementoEnderecoComprador><![CDATA[Casa]]></ComplementoEnderecoComprador>
<BairroComprador><![CDATA[Centro]]></BairroComprador>
<CidadeComprador><![CDATA[Curitiba]]></CidadeComprador>
<EstadoComprador><![CDATA[PR]]></EstadoComprador>
<CepComprador><![CDATA[81000000]]></CepComprador>
<PaisComprador>BRA</PaisComprador>
<DDDComprador><![CDATA[41]]></DDDComprador>
<TelefoneComprador><![CDATA[88889999]]></TelefoneComprador>
<DDDCelularComprador><![CDATA[41]]></DDDCelularComprador>
<TelefoneCelularComprador><![CDATA[88889999]]></TelefoneCelularComprador>
<CPFComprador><![CDATA[12345678912]]></CPFComprador>
<RGComprador><![CDATA[1234567]]></RGComprador>
<NascimentoComprador><![CDATA[16/01/1971]]></NascimentoComprador>
<PerfilComprador>V<PerfilComprador>
<contribuinte_icms>Sim</contribuinte_icm>
<tipodecliente>Consumidor Final< tipodecliente >
<ramodeatividade>Comércio< / ramodeatividade >
<optante_simples_nacional>Sim</ optante_simples_nacional >
<ObsVenda><![CDATA[Desejo que reforçem a embalagem]]></ObsVenda>
<EmbaladoPresente>Sim</EmbaladoPresente>
<NomeEntrega><![CDATA[José da Silva]]></NomeEntrega>
<RuaEntrega><![CDATA[Rua Sargento Tainha]]></RuaEntrega>
<NumeroEntrega><![CDATA[890]]></NumeroEntrega>
<ComplementoEntrega><![CDATA[Apto 210]]></ComplementoEntrega>
<BairroEntrega><![CDATA[Centro]]></BairroEntrega>
<CidadeEntrega><![CDATA[Curitiba]]></CidadeEntrega>
<EstadoEntrega><![CDATA[PR]]></EstadoEntrega>
<CepEntrega><![CDATA[81000111]]></CepEntrega>
<PaisEntrega><![CDATA[Brasil]]></PaisEntrega>
<DDDEntrega><![CDATA[41]]></DDDEntrega>
<TelefoneEntrega><![CDATA[88887777]]></TelefoneEntrega>
</Info>
<Produtos>
<Produto>
<Nome><![CDATA[Angela Ro Ro - Escândalo]]></Nome>
<Versao><![CDATA[Angela Ro Ro - Escândalo]]></Versao>
<Codigo>7892141640305</Codigo>
<Valor>R$ 19,71</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 19,71</Total>
</Produto>
<Produto>
<Nome><![CDATA[Carmen Miranda - Hoje]]></Nome>
<Versao><![CDATA[Carmen Miranda - Hoje]]></Versao>
<Codigo>7898324759611</Codigo>
<Valor>R$ 24,66</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 24,66</Total>
</Produto>
</Produtos>
</Venda>
</Vendas>
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o perÃodo informado</resultado>
</Transacao>
</requisicao-transacao>
Report de vendas por número do pedido
Comando VN
Essa função retornará apenas a venda com o número do pedido informado.
Para este comando o sistema disponibiliza a TAG o sistema disponibiliza a TAG StatusPagamentoOperadora que retorna o status do pagamento fornecido pela operadora utilizada.
A partir dessa informação, o integrador poderá alterar o status do pedido, por exemplo, de Novo Pedido para Pagamento Recebido no pedido do cliente.
Recomendações:Para fins de integração recomenda-se monitorar os 100 primeiros pedidos (api x operadora) e depois aleatoriamente. A informação prestada não é de responsabilidade da desenvolvedora da loja virtual sendo dependente de disponibilidade dos endpoints das operadoras, notificações dos gateways através dos webhooks e também das transações canceladas, chargebacks ou aprovados tardiamente.
<requisicao-transacao>
<Authentication>
<Token> 1201471120117</Token>
<Comando>VN</Comando>
</Authentication>
<Records>
<Record>
< NumPedido > 1201471120117 </ NumPedido >
</Record>
</Records>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?><Vendas>
<Venda>
<Info>
<Data>11/07/2014 20:11:07</Data>
<NumeroCompra>1201471120117</NumeroCompra>
<Plataforma_ecommerce>Nome da plataforma</Plataforma_ecommerce>
<CNPJ_Plataforma_ecommerce>00000000000000</CNPJ_Plataforma_ecommerce>
<UTM_source>Google</CNPJ_Plataforma_ecommerce>
<UTM_medium>CPC</CNPJ_Plataforma_ecommerce>
<UTM_campaign>Coleção Verão</CNPJ_Plataforma_ecommerce>
<PedidoIntegrado>True</PedidoIntegrado>
<PedidoERP>1234</PedidoERP>
<NotaFiscal>000001</NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
<UltimaAlteracao>12/07/2014</UltimaAlteracao>
<SituacaoDoPedido>Novo Pedido</SituacaoDoPedido>
<Rastreamento>PG482735996BR </Rastreamento>
<DiaDaPostagem>12/07/2014</DiaDaPostagem>
<PrazoDeEntrega>Dia da postagem + 5 dias úteis</PrazoDeEntrega>
<EmailComprador><![CDATA[email@email.com]]></EmailComprador>
<IP>127.1.1.1</IP>
<SubTotalPedido>R$ 48,81</SubTotalPedido>
<descontoprogressivo>R$ 0,00</ descontoprogressivo>
<DiferencialICMS>4,44</DiferencialICMS>
<DescontoConcedido>R$ 0,00</DescontoConcedido>
<DescontoCupom></DescontoCupom>
<CodigoCupom></CodigoCupom>
<FretePedido>R$ 12,34</FretePedido>
<TotalPedido>R$ 61,15</TotalPedido>
<MeioTransporte><![CDATA[Correios - Sedex]]></MeioTransporte>
<Parcelas>0</Parcelas>
<FormaDePagamento><![CDATA[Boleto]]></FormaDePagamento>
<DataEfetivaPagamento>11/07/2014</DataEfetivaPagamento>
<IDComprador>100</IDComprador>
<NomeComprador><![CDATA[Mario Andrade]]></NomeComprador>
<RuaComprador><![CDATA[Rua José da Silva]]></RuaComprador>
<NumeroRuaComprador><![CDATA[195]]></NumeroRuaComprador>
<ComplementoEnderecoComprador><![CDATA[Casa]]></ComplementoEnderecoComprador>
<BairroComprador><![CDATA[Centro]]></BairroComprador>
<CidadeComprador><![CDATA[Curitiba]]></CidadeComprador>
<EstadoComprador><![CDATA[PR]]></EstadoComprador>
<CepComprador><![CDATA[81000000]]></CepComprador>
<PaisComprador>BRA</PaisComprador>
<DDDComprador><![CDATA[41]]></DDDComprador>
<TelefoneComprador><![CDATA[88889999]]></TelefoneComprador>
<DDDCelularComprador><![CDATA[41]]></DDDCelularComprador>
<TelefoneCelularComprador><![CDATA[88889999]]></TelefoneCelularComprador>
<CPFComprador><![CDATA[12345678912]]></CPFComprador>
<RGComprador><![CDATA[1234567]]></RGComprador>
<NascimentoComprador><![CDATA[16/01/1971]]></NascimentoComprador>
<PerfilComprador>V<PerfilComprador>
<contribuinte_icms>Sim</contribuinte_icm>
<tipodecliente>Consumidor Final< tipodecliente >
<ramodeatividade>Comércio< / ramodeatividade >
<optante_simples_nacional>Sim</ optante_simples_nacional >
<ObsVenda><![CDATA[Desejo que reforçem a embalagem]]></ObsVenda>
<EmbaladoPresente>Sim</EmbaladoPresente>
<NomeEntrega><![CDATA[José da Silva]]></NomeEntrega>
<RuaEntrega><![CDATA[Rua Sargento Tainha]]></RuaEntrega>
<NumeroEntrega><![CDATA[890]]></NumeroEntrega>
<ComplementoEntrega><![CDATA[Apto 210]]></ComplementoEntrega>
<BairroEntrega><![CDATA[Centro]]></BairroEntrega>
<CidadeEntrega><![CDATA[Curitiba]]></CidadeEntrega>
<EstadoEntrega><![CDATA[PR]]></EstadoEntrega>
<CepEntrega><![CDATA[81000111]]></CepEntrega>
<PaisEntrega><![CDATA[Brasil]]></PaisEntrega>
<DDDEntrega><![CDATA[41]]></DDDEntrega>
<TelefoneEntrega><![CDATA[88887777]]></TelefoneEntrega>
</Info>
<Produtos>
<Produto>
<Nome><![CDATA[Angela Ro Ro - Escândalo]]></Nome>
<Versao><![CDATA[Angela Ro Ro - Escândalo]]></Versao>
<Codigo>7892141640305</Codigo>
<Valor>R$ 19,71</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 19,71</Total>
</Produto>
<Produto>
<Nome><![CDATA[Carmen Miranda - Hoje]]></Nome>
<Versao><![CDATA[Carmen Miranda - Hoje]]></Versao>
<Codigo>7898324759611</Codigo>
<Valor>R$ 24,66</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 24,66</Total>
</Produto>
</Produtos>
</Venda>
</Vendas>
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Report de vendas por status do pedido
Comando VNs
Essa função retornará apenas a venda com o status do pedido requerido.
<requisicao-transacao>
<Authentication>
<Token> 1201471120117</Token>
<Comando>VNS</Comando>
</Authentication>
<Records>
<Record>
<Status>Novo pedido</Status >
</Record>
</Records>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?><Vendas>
<Venda>
<Info>
<Data>11/07/2014 20:11:07</Data>
<NumeroCompra>1201471120117</NumeroCompra>
<PedidoIntegrado>True</PedidoIntegrado>
<PedidoERP>1234</PedidoERP>
<NotaFiscal>000001</NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
<UltimaAlteracao>12/07/2014</UltimaAlteracao>
<SituacaoDoPedido>Novo Pedido</SituacaoDoPedido>
<Rastreamento>PG482735996BR </Rastreamento>
<DiaDaPostagem>12/07/2014</DiaDaPostagem>
<PrazoDeEntrega>Dia da postagem + 5 dias úteis</PrazoDeEntrega>
<EmailComprador><![CDATA[email@email.com]]></EmailComprador>
<IP>127.1.1.1</IP>
<SubTotalPedido>R$ 48,81</SubTotalPedido>
<descontoprogressivo>R$ 0,00</ descontoprogressivo>
<DiferencialICMS>4,44</DiferencialICMS>
<DescontoConcedido>R$ 0,00</DescontoConcedido>
<DescontoCupom></DescontoCupom>
<CodigoCupom></CodigoCupom>
<FretePedido>R$ 12,34</FretePedido>
<TotalPedido>R$ 61,15</TotalPedido>
<MeioTransporte><![CDATA[Correios - Sedex]]></MeioTransporte>
<Parcelas>0</Parcelas>
<FormaDePagamento><![CDATA[Boleto]]></FormaDePagamento>
<DataEfetivaPagamento>11/07/2014</DataEfetivaPagamento>
<IDComprador>100</IDComprador>
<NomeComprador><![CDATA[Mario Andrade]]></NomeComprador>
<RuaComprador><![CDATA[Rua José da Silva]]></RuaComprador>
<NumeroRuaComprador><![CDATA[195]]></NumeroRuaComprador>
<ComplementoEnderecoComprador><![CDATA[Casa]]></ComplementoEnderecoComprador>
<BairroComprador><![CDATA[Centro]]></BairroComprador>
<CidadeComprador><![CDATA[Curitiba]]></CidadeComprador>
<EstadoComprador><![CDATA[PR]]></EstadoComprador>
<CepComprador><![CDATA[81000000]]></CepComprador>
<PaisComprador>BRA</PaisComprador>
<DDDComprador><![CDATA[41]]></DDDComprador>
<TelefoneComprador><![CDATA[88889999]]></TelefoneComprador>
<DDDCelularComprador><![CDATA[41]]></DDDCelularComprador>
<TelefoneCelularComprador><![CDATA[88889999]]></TelefoneCelularComprador>
<CPFComprador><![CDATA[12345678912]]></CPFComprador>
<RGComprador><![CDATA[1234567]]></RGComprador>
<NascimentoComprador><![CDATA[16/01/1971]]></NascimentoComprador>
<PerfilComprador>V<PerfilComprador>
<contribuinte_icms>Sim</contribuinte_icm>
<tipodecliente>Consumidor Final< tipodecliente >
<ramodeatividade>Comércio< / ramodeatividade >
<optante_simples_nacional>Sim</ optante_simples_nacional >
<ObsVenda><![CDATA[Desejo que reforçem a embalagem]]></ObsVenda>
<EmbaladoPresente>Sim</EmbaladoPresente>
<NomeEntrega><![CDATA[José da Silva]]></NomeEntrega>
<RuaEntrega><![CDATA[Rua Sargento Tainha]]></RuaEntrega>
<NumeroEntrega><![CDATA[890]]></NumeroEntrega>
<ComplementoEntrega><![CDATA[Apto 210]]></ComplementoEntrega>
<BairroEntrega><![CDATA[Centro]]></BairroEntrega>
<CidadeEntrega><![CDATA[Curitiba]]></CidadeEntrega>
<EstadoEntrega><![CDATA[PR]]></EstadoEntrega>
<CepEntrega><![CDATA[81000111]]></CepEntrega>
<PaisEntrega><![CDATA[Brasil]]></PaisEntrega>
<DDDEntrega><![CDATA[41]]></DDDEntrega>
<TelefoneEntrega><![CDATA[88887777]]></TelefoneEntrega>
</Info>
<Produtos>
<Produto>
<Nome><![CDATA[Angela Ro Ro - Escândalo]]></Nome>
<Versao><![CDATA[Angela Ro Ro - Escândalo]]></Versao>
<Codigo>7892141640305</Codigo>
<Valor>R$ 19,71</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 19,71</Total>
</Produto>
<Produto>
<Nome><![CDATA[Carmen Miranda - Hoje]]></Nome>
<Versao><![CDATA[Carmen Miranda - Hoje]]></Versao>
<Codigo>7898324759611</Codigo>
<Valor>R$ 24,66</Valor>
<Quantidade>1</Quantidade>
<Total>R$ 24,66</Total>
</Produto>
</Produtos>
</Venda>
</Vendas>
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o status informado</resultado>
</Transacao>
</requisicao-transacao>
Status do pagamento na operadora
Comando VSG
Essa função permite a consulta da situação do pagamento na operadora (aprovado, negado, etc…)
<requisicao-transacao>
<Authentication>
<Token> 1201471120117</Token>
<Comando>VSG</Comando>
</Authentication>
<Records>
<Record>
< NumPedido > 1201471120117 </ NumPedido >
</Record>
</Records>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?><Vendas>
<Venda>
<Info>
<NumeroCompra>1201471120117</NumeroCompra>
vn"<Plataforma_ecommerce>Nome da plataforma</Plataforma_ecommerce>
<CNPJ_Plataforma_ecommerce>00000000000000</CNPJ_Plataforma_ecommerce>
<PedidoERP>1234</PedidoERP>
<FormaDePagamento><![CDATA[PayPal Plus]]></FormaDePagamento>
<Status_na_operadora>Aprovado</Status_na_operadora>
<Status_na_lojavirtual>Novo Pedido</Status_na_lojavirtual>
</Venda>
</Vendas>
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Exclusão de venda
Comando Ve
Essa função permite excluir uma venda da loja virtual.
Como é um comando perigoso, somente é possÃvel exclusão informando o numero da venda.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VE</Comando>
</Authentication>
<Records>
<Record>
<NumPedido>02012811131</ NumPedido>
</Record>
</Records>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Alteração e inserção de Nota Fiscal e rastreamento de uma ou mais vendas
Comando VA
Essa função permite enviar para a loja virtual alterações na venda para alguns itens.
Ao alterar um pedido envie a informação True ou False.
Envie True para informar no sistema da loja virtual que o pedido foi integrado no ERP
Envie False para informar no sistema da loja virtual que o pedido ainda não foi integrado no ERP
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VA</Comando>
</Authentication>
<Vendas>
<Venda>
<NumPedido>123456</NumPedido>
<PedidoIntegrado>True</PedidoIntegrado>
<NotaFiscal>0001</ NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
<Rastreamento>123456</ Rastreamento>
<DiaDaPostagem>10/01/2014</ DiaDaPostagem>
<DataEfetivaPagamento>09/01/2014</ DataEfetivaPagamento>
</Venda>
<Venda>
<NumPedido>1234567</NumPedido>
<PedidoIntegrado>True</PedidoIntegrado>
<NotaFiscal>0002</ NotaFiscal>
<Rastreamento>1234567</ Rastreamento>
<DiaDaPostagem>9/01/2014</ DiaDaPostagem>
<DataEfetivaPagamento>8/01/2014</ DataEfetivaPagamento>
</Venda>
</Vendas>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Alteração do status de uma venda
Comando VS
Para cada venda realizada e para que somente o status possa ser alterado envie o novo status.
Deverá ser utilizado um status já existente no sistema da loja virtual
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>VS</Comando>
</Authentication>
<Vendas>
< Venda>
<NumPedido>123456</NumPedido>
<Status>Pagamento não autorizado pela operadora.</Status>
</Venda>
</Vendas>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Alteração e inserção do rastreamento de uma ou mais vendas
Comando RU
Para cada venda realizada e para que somente o código de rastreamento possa ser alterado
envie o código do objeto.
Ao alterar um pedido sinalize na tag PedidoIntegrado como True ou False.
Isso sinaliza que você já capturou esta venda.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>RU</Comando>
</Authentication>
<Vendas>
<Venda>
<NumPedido>123456</NumPedido>
<Rastreamento>XX0000000000X</ Rastreamento>
<DiaDaPostagem>10/01/2019</ DiaDaPostagem>
</Venda>
<Venda>
<NumPedido>1234567</NumPedido>
<Rastreamento>XX0000000000X</ Rastreamento>
<DiaDaPostagem>10/01/2019</ DiaDaPostagem>
</Venda>
</Vendas>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Alteração ou inserção da Nota Fiscal de uma ou mais vendas
Comando NFI
Essa função permite enviar para a loja virtual alterações na venda para alguns itens.
Ao alterar um pedido sinalize na tag PedidoIntegrado como True ou False.
Isso sinaliza que você já capturou esta venda.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>NFI</Comando>
</Authentication>
<Vendas>
<Venda>
<NumPedido>123456</NumPedido>
<PedidoIntegrado>True</PedidoIntegrado>
<NotaFiscal>0001</ NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
</Venda>
<Venda>
<NumPedido>1234567</NumPedido>
<PedidoIntegrado>True</PedidoIntegrado>
<NotaFiscal>0001</ NotaFiscal>
<NotaFiscalChave>000011112222333344445555<NotaFiscalChave>
<NotaFiscalSerie>1A<NotaFiscalSerie>
<NotaFiscalURL>https://<NotaFiscalURL>
</Venda>
</Vendas>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Alteração para pedido integrado ou não integrado no ERP
strong>Comando PEIN
Essa função permite alterar um pedido de integrado para não integrado ou vice versa no ERP.
Envie True para informar no sistema da loja virtual que o pedido foi integrado no ERP
Envie False para informar no sistema da loja virtual que o pedido ainda não foi integrado no ERP
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>PEIN</Comando>
</Authentication>
<Vendas>
<Venda>
<NumPedido>123456</NumPedido>
<PedidoIntegrado>True</PedidoIntegrado>
<PedidoERP>0001</PedidoERP>
</Venda>
<Venda>
<NumPedido>1234567</NumPedido>
<PedidoIntegrado>False</PedidoIntegrado>
<PedidoERP>0002</PedidoERP>
</Venda>
</Vendas>
</requisicao-transacao>
Resposta
Se não houver nenhum dado será retornado:
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Sale</erro>
<resultado>Não há nenhuma venda para o pedido informado</resultado>
</Transacao>
</requisicao-transacao>
Retorno de XML da Venda sem API
Para cada venda realizada o sistema da loja virtual gera uma XML que é gravada no ato da
compra.
Essa XML não possui as informações atualizadas posteriomente e pode ser capturada
no endereço: https://www.seudominio.com.br/xmlvendas/numerodavenda.xml
Para realizar uma consulta da XML complete atualizada utilize o comando VN (veja item 5)
<?xml version="1.0" encoding="iso-8859-1"?>
<Vendas>
<Venda>
<data>3/7/2014</data>
<numerocompra>3201473114454</numerocompra>
<ip>127.0.0.1</ip>
<subtotalpedido>R$ 148,50</subtotalpedido>
<descontoprogressivo>R$ 0,00</ descontoprogressivo >
<diferencialicms>R$ 14,85</diferencialicms>
<descontoconcedido>R$ 0,00</descontoconcedido>
<descontocupom>R$ 0,00</descontocupom>
<codigocupom></codigocupom>
<fretepedido>R$ 28,80</fretepedido>
<totalpedido>R$ 192,15</totalpedido>
<totalpedido_btc>0,00172986</totalpedido_btc>
<cotacao_btc>R$ 18.599,90</cotacao_btc>
<meiotransporte>Correios PAC - Encomenda Norma</meiotransporte>
<parcelas>1</parcelas>
<formadepagamento>Depósito Bancário</formadepagamento>
<nomecomprador><![CDATA[João da Silva]]></nomecomprador>
<ruacomprador>Rua Capitão Maria Sobrinho Taschner ]]></ruacomprador>
<numeroruacomprador><![CDATA[195]]></ numeroruacomprador >
<complementoenderecocomprador>sobrado</complementoenderecocomprador>
<bairrocomprador><![CDATA[Portão]]></bairrocomprador>
<cidadecomprador><![CDATA[Curitiba]]></cidadecomprador>
<estadocomprador><![CDATA[PR]]></estadocomprador>
<cepcomprador><![CDATA[81000000]]></cepcomprador>
<paiscomprador>BRA</paiscomprador>
<dddcomprador><![CDATA[41]]></dddcomprador>
<telefonecomprador><![CDATA[22221111]]></telefonecomprador>
<dddcelularcomprador><![CDATA[41]]></dddcelularcomprador>
<telefonecelularcomprador><![CDATA[11112222]]></telefonecelularcomprador>
<cpfcomprador><![CDATA[11122233344]]></cpfcomprador>
<rgcomprador><![CDATA[1112223]]></rgcomprador>
<emailcomprador><![CDATA[email@email.com.br]]></emailcomprador>
<aniversariocomprador><![CDATA[16/01/1971]]></aniversariocomprador>
<perfilcomprador>V</Perfilcomprador>
<contribuinte_icms>Sim</contribuinte_icms>
<tipodecliente>Consumidor Final</tipodecliente>
<ramodeatividade>Comércio</ramodeatividade>
<optante_simples_nacional>Sim</optante_simples_nacional>
<contato_principal_empresa>José da Silva</contato_principal_empresa>
<obsvenda></obsvenda>
<produto><![CDATA[Em Teu Nome...]]></produto>
<ncm>84717029</ncm>
<tipo>Un</tipo>
<versao><![CDATA[Em Teu Nome Blue Double Pack 36 ]]></versao>
<codigo>0001</codigo>
<valor>R$ 148,50</valor>
<quantidade>1</quantidade>
<total>R$ 148,50</total>
<nomeentrega>José da Silva</nomeentrega>
<ruaentrega>Rua Tubarão</ruaentrega>
<numeroentrega>100</numeroentrega>
<complementoentrega>Casa</complementoentrega>
<bairroentrega>Centro</bairroentrega>
<cidadeentrega>Curitiba</cidadeentrega>
<estadoentrega>PR</estadoentrega>
<cepentrega>80000000</cepentrega>
<paisentrega>BRA</paisentrega>
<dddentrega>41</dddentrega>
<telefoneentrega>99999999</telefoneentrega>
</Venda>
</Vendas>
Report de clientes por perÃodo
Comando DR
Essa função retornará os clientes cadastrados dentro de um intervalo entre duas datas.
O intervalo máximo permitido para retorno dos cadastros são 7 dias
DateStart: Data inicial para report dos cadastros
DateEnd: Data final para report dos cadastros
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>DR</Comando>
</Authentication>
<Records>
<Record>
<DateStart>10/07/2104</DateStart>
<DateEnd>11/07/2104</DateEnd>
</Record>
</Records>
</requisicao-transacao>
Report de clientes por ID ou Email
Comando DR
Essa função retornará o cliente cadastrado por atraves do ID ou Email (Informe somente uma das duas tags).
ID: ID do cadastro
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>DRC</Comando>
</Authentication>
<Records>
<Record>
<ID>654</ID>
<EMAIL>654</EMAIL>
</Record>
</Records>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
Se não houver nenhum dado será retornado:
<Records>
<Record>
<Cliente>
<ID>2955</ID>
<vendedor_contratado>sim</vendedor_contratado>
<vendedor_codigo>JOSILVA</vendedor_codigo>
<vendedor_ativo>sim</vendedor_ativo>
<vendedor_comissao>3.5</vendedor_comissao>
<DataDoCadastro>04/06/2014 15:06:13</DataDoCadastro>
<IP>127.0.01</IP>
<DataNascimento>04/02/1971</DataNascimento>
<UltimaAlteracao>17/04/2014 11:36:49</UltimaAlteracao>
<Perfil>V</Perfil>
<contribuinte_icms>Sim</contribuinte_icms>
<tipodecliente>Consumidor Final</tipodecliente>
<ramodeatividade>Comércio</ramodeatividade>
<optante_simples_nacional>Sim</optante_simples_nacional>
<Senha>123456</Senha>
<Email>suporte@minhaloja.com.br</Email>
<Bloqueado>desbloqueado</Bloqueado>
<Limitemaximo>n</Limitemaximo>
<AceitaMailing>on</AceitaMailing>
<AceitaSMS>1</AceitaSMS>
<CpfCnpj>01087801000105</CpfCnpj>
<Identidade>42704490</Identidade>
<NomeCompleto>Mike Mareen</NomeCompleto>
<Endereco>Rua José da Silva</Endereco>
<EnderecoNumero>111</EnderecoNumero>
<EnderecoComplemento>Casa</EnderecoComplemento>
<EnderecoBairro>Centro</EnderecoBairro>
<EnderecoCidade>Curitiba</EnderecoCidade>
<EnderecoEstado>PR</EnderecoEstado>
<EnderecoPais>Brasil</EnderecoPais>
<EnderecoCEP>80000000</EnderecoCEP>
<DDDTelefone>41</DDDTelefone>
<Telefone>11112233</Telefone>
<DDDCelular>41</DDDCelular>
<Celular>44445566</Celular>
<Vendedor><![CDATA[300]]></Vendedor >
<Pontos><![CDATA[1000]]></Pontos>
<Sexo>m</Sexo>
<Observacoes><![CDATA[Entrega pela manhã]]></Observacoes>
<perfil>V</perfil><br /><br />
<tipo_de_cliente>Consumidor</tipo_de_cliente><br />
<contribuinte_do_icms>Sim</contribuinte_do_icms><br />
<ramo_de_atividade>Comércio</ramo_de_atividade><br />
<optante_simples_nacional>Sim</optante_simples_nacional><br />
<whatsapp_ddi>41</whatsapp_ddi><br />
<whatsapp_telefone>988887777</whatsapp_telefone><br />
</Cliente>
</Record>
</Records>
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Client</erro>
<resultado>Não há nenhum cadastro para o perÃodo informado</resultado>
</Transacao>
</requisicao-transacao>
Report de clientes alterados por perÃodo
Comando DRU
A invocação do comando DRU irá retornar os clientes que tiveram seus cadastros alterados no intervalo entre duas datas.
O intervalo máximo permitido para retorno dos cadastros são 7 dias
DateStart: Data inicial para report dos cadastros
DateEnd: Data final para report dos cadastros
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>DRU</Comando>
</Authentication>
<Records>
<Record>
<DateStart>10/07/2104</DateStart>
<DateEnd>11/07/2104</DateEnd>
</Record>
</Records>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
Se não houver nenhum dado será retornado:
<Records>
<Record>
<Cliente>
<ID>2955</ID>
<vendedor_contratado>sim</vendedor_contratado>
<vendedor_codigo>JOSILVA</vendedor_codigo>
<vendedor_ativo>sim</vendedor_ativo>
<vendedor_comissao>3.5</vendedor_comissao>
<DataDoCadastro>04/06/2014 15:06:13</DataDoCadastro>
<IP>127.0.01</IP>
<DataNascimento>04/02/1971</DataNascimento>
<UltimaAlteracao>17/04/2014 11:36:49</UltimaAlteracao>
<Perfil>V</Perfil>
<contribuinte_icms>Sim</contribuinte_icms>
<tipodecliente>Consumidor Final</tipodecliente>
<ramodeatividade>Comércio</ramodeatividade>
<optante_simples_nacional>Sim</optante_simples_nacional>
<Senha>123456</Senha>
<Email>suporte@minhaloja.com.br</Email>
<Bloqueado>desbloqueado</Bloqueado>
<Limitemaximo>n</Limitemaximo>
<AceitaMailing>on</AceitaMailing>
<AceitaSMS>1</AceitaSMS>
<CpfCnpj>01087801000105</CpfCnpj>
<Identidade>42704490</Identidade>
<NomeCompleto>Mike Mareen</NomeCompleto>
<Endereco>Rua José da Silva</Endereco>
<EnderecoNumero>111</EnderecoNumero>
<EnderecoComplemento>Casa</EnderecoComplemento>
<EnderecoBairro>Centro</EnderecoBairro>
<EnderecoCidade>Curitiba</EnderecoCidade>
<EnderecoEstado>PR</EnderecoEstado>
<EnderecoPais>Brasil</EnderecoPais>
<EnderecoCEP>80000000</EnderecoCEP>
<DDDTelefone>41</DDDTelefone>
<Telefone>11112233</Telefone>
<DDDCelular>41</DDDCelular>
<Celular>44445566</Celular>
<Vendedor><![CDATA[300]]></Vendedor >
<Pontos><![CDATA[1000]]></Pontos>
<Sexo>m</Sexo>
<Observacoes><![CDATA[Entrega pela manhã]]></Observacoes>
<perfil>V</perfil><br /><br />
<tipo_de_cliente>Consumidor</tipo_de_cliente><br />
<contribuinte_do_icms>Sim</contribuinte_do_icms><br />
<ramo_de_atividade>Comércio</ramo_de_atividade><br />
<optante_simples_nacional>Sim</optante_simples_nacional><br />
<whatsapp_ddi>41</whatsapp_ddi><br />
<whatsapp_telefone>988887777</whatsapp_telefone><br />
</Cliente>
</Record>
</Records>
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Client</erro>
<resultado>Não há nenhum cadastro para o perÃodo informado</resultado>
</Transacao>
</requisicao-transacao>
Report de fabricantes
Comando FR
Essa função retornará as marcas e fabricantes cadastrados na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>FR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
Se não houver nenhum dado será retornado:
<Records>
<Fabricantes>
<Fab_ID>4</Fab_ID>
<Fab_Nome><![CDATA[Nike]]></Fab_Nome>
<Fab_Fabricante><![CDATA[Alpargatas]]></Fab_Nome>
</ Fabricantes >
</Records>
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Fab</erro>
<resultado>Não há nenhum fabricante para retornar</resultado>
</Transacao>
</requisicao-transacao>
Inserção de Clientes
Comando DRI
Essa função permite a inserção de clientes na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CI</Comando>
</Authentication>
<Records>
<Record>
<code_vendedor><![CDATA[josilva05]]></code_vendedor>
<nome_completo><![CDATA[João da Silva]]></nome_completo>
<senha><![CDATA[12345678]]></senha>
<email><![CDATA[joao@silva.com]]></email>
<sexo><![CDATA[m]]></sexo>
<endereco><![CDATA[Rua Direita]]></endereco>
<endereco_numero><![CDATA[11]]></endereco_numero>
<complemento><![CDATA[Casa 2]]></complemento>
<bairro><![CDATA[Centro]]></bairro>
<cep><![CDATA[81030370]]></cep>
<cidade><![CDATA[Curitiba]]></cidade>
<estado><![CDATA[PR]]></estado>
<pais><![CDATA[Brasil]]></pais>
<cpf_cnpj><![CDATA[59278595004]]></cpf_cnpj>
<rg_ie><![CDATA[4.111.222-PR]]></rg_ie>
<dddtelefone1><![CDATA[41]]></dddtelefone1>
<telefone1><![CDATA[33334455]]></ telefone1>
<data_nascimento><![CDATA[30/12/1970]]></data_nascimento>
<dddtelefone2><![CDATA[41]]></dddtelefone2>
<telefone2><![CDATA[22223344]]></telefone2>
<pontos>0</pontos>
<perfil>V</perfil>
<tipo_de_cliente>Consumidor</tipo_de_cliente>
<contribuinte_do_icms>Sim</contribuinte_do_icms>
<ramo_de_atividade><![CDATA[Comércio]]></ramo_de_atividade>
<optante_simples_nacional><![CDATA[Sim]]></optante_simples_nacional>
<whatsapp_ddi>41</whatsapp_ddi>
<whatsapp_telefone>98765432</whatsapp_telefone>
</Record>
<Record>
<code_vendedor><![CDATA[mariorocha]]></code_vendedor>
<nome_completo><![CDATA[João da Silva]]></nome_completo>
e assim por diante para mais de um cadastro
</Record>
</Records>
</requisicao-transacao>
Inserção de fabricantes
Comando FI
Essa função permite a inserção de marcas e fabricantes na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>FI</Comando>
</Authentication>
<Records>
<Record>
<Fab_Nome><![CDATA[Adidas]]></Fab_Nome>
<Fab_Fabricante><![CDATA[Alpargatas]]></Fab_Fabricante>
</Record>
<Record>
<Fab_Nome><![CDATA[Nike]]></Fab_Nome>
<Fab_Fabricante><![CDATA[Alpargatas]]></Fab_Fabricante>
</Record>
</Records>
</requisicao-transacao>
Report de Status
Comando SR
Essa função retornará os status cadastrados na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SR</Comando>
</Authentication>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
Se não houver nenhum dado será retornado:
<Records>
<Status>
<ID>1</ID >
<Status><![CDATA[Aguardando pagamento]]></ Status>
<StatusTexto><![CDATA[Estamos aguardando o pagamento ser confirmado para oenvio do seu pedido]]></ StatusTexto>
<StatusColor><![CDATA[#000000]]></ StatusColor>
</ Status >
</Records>
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<erro>Var_No_Record</erro>
<resultado>Não há nenhum status para retornar</resultado>
</Transacao>
</requisicao-transacao>
Alteração de Clientes
Comando DRA
Essa função permite a alteração de cliente na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>CI</Comando>
</Authentication>
<Records>
<Record>
<id><![CDATA[João da Silva]]></id>
<code_vendedor><![CDATA[josilva05]]></code_vendedor>
<nome_completo><![CDATA[João da Silva]]></nome_completo>
<senha><![CDATA[12345678]]></senha>
<email><![CDATA[joao@silva.com]]></email>
<sexo><![CDATA[m]]></sexo>
<endereco><![CDATA[Rua Direita]]></endereco>
<endereco_numero><![CDATA[11]]></endereco_numero>
<complemento><![CDATA[Casa 2]]></complemento>
<bairro><![CDATA[Centro]]></bairro>
<cep><![CDATA[81030370]]></cep>
<cidade><![CDATA[Curitiba]]></cidade>
<estado><![CDATA[PR]]></estado>
<pais><![CDATA[Brasil]]></pais>
<cpf_cnpj><![CDATA[59278595004]]></cpf_cnpj>
<rg_ie><![CDATA[4.111.222-PR]]></rg_ie>
<dddtelefone1><![CDATA[41]]></dddtelefone1>
<telefone1><![CDATA[33334455]]></ telefone1>
<data_nascimento><![CDATA[30/12/1970]]></data_nascimento>
<dddtelefone2><![CDATA[41]]></dddtelefone2>
<telefone2><![CDATA[22223344]]></telefone2>
<pontos>0</pontos>
<perfil>V</perfil>
<tipo_de_cliente>Consumidor</tipo_de_cliente>
<contribuinte_do_icms>Sim</contribuinte_do_icms>
<ramo_de_atividade><![CDATA[Comércio]]></ramo_de_atividade>
<optante_simples_nacional><![CDATA[Sim]]></optante_simples_nacional>
<whatsapp_ddi>41</whatsapp_ddi>
<whatsapp_telefone>98765432</whatsapp_telefone>
</Record>
</Records>
</requisicao-transacao>
- Consulta código do municÃpio
Comando IBGE
Essa função retornará o código do municÃpio (fonte IBGE) através do CEP
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>IBGE</Comando>
<Cep>IBGE</Cep>
</Authentication>
</requisicao-transacao>
Inserção de vendedores
Comando SLRI
Essa função permite a inserção de vendedores na loja virtual. Para o cadastro completo primeiro crie o cadastro do cliente (comando DRI). O email do cadastro do novo vendedor será vinculado ao cadastro completo. O código do vendedor deve ser composto somente por letras e números.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SLRI</Comando>
</Authentication>
<Records>
<Record>
<vendedor><![CDATA[Mario Santanna]]></vendedor>
<codigo><![CDATA[masantana]]></codigo>
<email><![CDATA[joaosilva@gmail.com]]></email>
<comissao><![CDATA[3,9]]></comissao>
<ativo><![CDATA[0]]></ativo>
</Record>
<Record>
<vendedor><![CDATA[João da Silva]]></vendedor>
<codigo><![CDATA[josilva05]]></codigo>
<email><![CDATA[joaosilva@gmail.com]]></email>
<comissao><![CDATA[4,5]]></comissao>
<ativo><![CDATA[1]]></ativo>
</Record>
</Records>
</requisicao-transacao>
Report de vendedores
Comando SLR
Essa função retornará os vendedores cadastrados na loja virtual.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SLR</Comando>
</Authentication>
</requisicao-transacao>
<Records>
<Vendedor>
<vendedor>Mario Santanna</vendedor>
<codigo>masantana</codigo>
<email>joaosilva@gmail.com</email>
<comissao>3,9</comissao>
<ativo>0</ativo>
</Vendedor>
</Records>
Consulta PLP’s SIGEP WEB
Comando SIGEPLP
Essa função retornará as PLP’s e os pedidos gerados nos últimos 7 dias e processados pelo SARA com o valor cobrado na loja e o valor faturado pelo Correios.
O intervalo entre as datas deve ser no máximo 7 dias
A consulta é realizada no web service do Correios, logo, poderá haver lentidão no processamento.
<requisicao-transacao>
<Authentication>
<Token>1234567890</Token>
<Comando>SIGEPLP</Comando>
</Authentication>
<Records>
< Record>
< DateStart >04/03/2020</ DateStart >
< DateEnd >11/03/2020 </ DateEnd >
</ Record>
</ Record>
</requisicao-transacao>
Resposta
<?xml version="1.0" encoding="iso-8859-1"?>
Se não houver nenhum dado será retornado:
<Records>
<PLP><data>04/03/2020</data>
<numeroplp>289814943</numeroplp>
<quantobjetos>1</quantobjetos>
<status>PLP Fechada</status>
<PEDIDO>
<status_sara>processado pelo SARA</status_sara>
<numpedido>203415172144</numpedido>
<numobjeto>OI929137557BR</numobjeto>
<servico>04162</serviço>
<peso>40</peso>
<datacaptacao>04/03/2020 16:47:00</datacaptacao>
<comprovante>1788169113</comprovante>
<valorcorreios>17.54</valorcorreios>
<valorloja>19.04</valorloja>
</PEDIDO>
</PLP>
</Records>
<?xml version="1.0" encoding="ISO-8859-1"?>
<requisicao-transacao>
<Transacao>
<resultado>>Não há nenhuma PLP para o perÃodo informado</resultado>
</Transacao>
</requisicao-transacao>
Melhores Práticas
Seguem algumas dicas para melhor utilização da API:
1) Existe um limite de até 120 chamadas à API por hora.
Erros de socket irão ocorrer se excedidos
2) Nos métodos para a alteração e visualização realize as chamadas dentro da sua necessidade para evitar timeouts.
3) Os reports da sua loja virtual podem ser acessados via XML. Frequentemente incluÃmos novos
campos nas dezenas de reports sem aviso prévio. Por esta razão, os sistemas integrados
ao nosso sistema não devem ser afetados por estas inclusões de campos, independente da posição.
Testes:
Ao realizar a integração solicite ao seu programador o relatório dos testes efetuados antes de
colocar em produção.
Exemplo: Ao realizar o envio de um lote de atualização de estoque, verificar se os produtos
foram atualizados no sistema. Uma forma simples é verificar o primeiro sku, dois aleatórios do
meio e o ultimo SKU enviado no post form. Se os últimos SKU’s não foram atualizados o lote de
envio deverá ser diminuÃdo e um novo teste ser realizado ate equalizar uma quantidade de
envio dentro dos limites do servidor.
Uma programação bem feita de leitura de XML não deve ser "amarrada" com relação Ã
posição do campo, dentro da mesma hierarquia. Se acrescentarmos campos antes ou depois
do campo desejado, sem alterar a estrutura do XML, seu programa deve ser capaz de acessar
normalmente os nós pré-existentes.
O XML não deve ser lido como uma grande "string". Ao invés disto, seu programa deve
manipular o XML como uma estrutura hierárquica, com acesso direto e individualizado a
qualquer nó, independente dos nós anteriores e posteriores. Uma sugestão é utilizar objeto
para leitura e "parse" do XML, como por exemplo, o Microsoft.XMLDOM, que usamos em
nosso sistema.
Atualizações e Updates da API
05.05.2021
Comando PI:
Nova tag: V_Max_Sale Para inserção da quantidade maxima para venda
Comando PA:
Nova tag: V_Max_Sale Para alteração da quantidade maxima para venda
Comando VI:
Nova tag: V_Max_Sale Para inserção da quantidade maxima para venda
Comando VU:
Nova tag: V_Max_Sale Para alteração da quantidade maxima para venda
Comando VUID:
Nova tag: V_Max_Sale Para alteração da quantidade maxima para venda
22.04.2021
Comando VR:
Nova tag: Status: Para solicitação do report por status
12.03.2021
Comandos VR, VN, VNS e VSG:
Nova tag: Plataforma_ecommerce - informa a plataforma de de origem do pedido
Nova tag: CNPJ_Plataforma_ecommerce - informa o CNPJ da plataforma de origem do pedido
11.02.2021
Novo Comando IMGVI:
Para Inserção / alteração de imagem na versão
22.02.2021
Novo Comando VSG:
Para consulta do status do pagamento na operadora
18.01.2021
Comando PI:
Nova tag: P_ID_ERP Para inserção do ID de produto do ERP
Comando PA:
Nova tag: P_ID_ERP Para alteração do ID do produto do ERP
Comando VI:
Nova tag: V_ID_ERP Para inserção do ID da versão do ERP
Comando VU:
Nova tag: V_ID_ERP Para alteração do ID da versão do ERP
Comando VUID:
Nova tag: V_ID_ERP Para alteração do ID da versão do ERP
14.01.2021
Comando FI:
Nova tag: Fab_Fabricante Para inseração do nome do fabricante
Comando FR:
Nova tag: Fab_Fabricante Para reportar o nome do fabricante
07.09.2020
Novo comando:
DRA: Alteração de cliente na loja virtual
SLR: Report de vendedores cadastrado
SLRI: Inserção de vendedor
04.09.2020
Novas tags no retorno dos comandos DR e DRU:
<perfil>V</perfil>
<tipo_de_cliente>Consumidor</tipo_de_cliente>
<contribuinte_do_icms>Sim</contribuinte_do_icms>
<ramo_de_atividade>Comêrcio</ramo_de_atividade>
<optante_simples_nacional>Sim</optante_simples_nacional>
<whatsapp_ddi>41</whatsapp_ddi>
<whatsapp_telefone>988887777</whatsapp_telefone>
04.09.2020
Novo comando:
DRI: Inserção de clientes na loja virtual
25.08.2020
Novo comando:
PEIN - Alteração para pedido integrado ou não integrado no ERP
24.08.2020
Novas tags no retorno dos comandos PA, PRI, PR, PI e PA:
< PerfilProduto>: Informa para qual perfil o produto estará com visualização disponivel
Valores:
VAD: Varejo, Atacado e Distribuidor
VXX: Somente Varejo
XAX: Somente Atacado
XXD: Somente Distribuidor
VAX: Somente Varejo e Atacado
VXD: Somente Varejo e Distribuidor
XAD: Somente Atacado e Distribuidor
08.06.2020
Novas tags para o comando PRV, PRVID, PRI, PR, PI, VI, VU e VUID:
<V_tipo_garantia>: Sinaliza o sabor de um produto
<V_tempo_garantia >: Sinaliza a voltagem de um produto: 110V, 220V, 330V ou Bilvolt
<V_Volumetria >: Sinaliza o volume de um produto, exemplo: 50 ml
Novos comandos:
SAR: Report de sabores
SAI: Inserção de sabores
01.04.2020
Novas tags para o comando PRV, PRVID, PRI, PR, PI, VI, VU e VUID:
<V_tipo_garantia>: Sinaliza o tipo de garantia: Sem garantia, Garantia do vendedor ou
Garantia de fábrica
<V_tempo_garantia >: Sinaliza o tempo da garantia em dias: 30, 60, 90 etc
16.03.2020
Novas tags para o comando PRV, PRVID, PRI, PR, PI, VI, VU e VUID:
<V_frete_gratis>: Sinaliza frete grátis para a versão do produto
05.03.2020
Consulta SARA Sigep Web
10.07.2019
Retorno em JSON para os comandos de report
08.07.2019
Novas tags para o comando PR e PRI:
<Categoria>: ID da categoria principal
<Nome_Categoria>: Nome da categoria principal
<Nome_SubCategoria>>: Nome da sub- categoria
05.07.2019
Novos comandos:
PVU- Alteração de produto visÃvel/invisÃvel na loja
27.03.2019
Novos comandos:
CLR - Report de cores
CLI - Inserção de cores
TR - Report de tamanhos
TI - Inserção de tamanhos
Novas tags: <nome_cor> e <nome_tamanho>
DisponÃveis nos comandos:
PRV - Report por código de versão
PRVID - Report por código de versão
PI - Report por código de versão
PR - Report de produtos
PRI - Report individual por produto
Envio de novas tags nas xml’s: <nome_cor> e <nome_tamanho>
DisponÃveis nos comandos:
PI - Inserção de produto
VI - Inserção de versão
VU - Inserção de versão
VUID - Inserção de versao
12.03.2019
CLR - Report de cores
CLI - Inserção de cores
TR - Report de tamanhos
TI - Inserção de tamanhos
12.03.2019
VR, VN e VNS – Nova tag <descontoprogressivo>
XML individual da venda: Nova tag <descontoprogressivo>
06.10.2018
RU – Alteração e inserção do rastreamento de uma ou mais vendas
NFI - Alteração e inserção da Nota Fiscal de uma ou mais vendas
18.05.2018
Inclusão das tags <NotaFiscalChave>, <NotaFiscalSerie> e <NotaFiscalURL> para os comando
VR, VN, VNS e VA
04.05.2018
Inclusão da tag <PedidoERP> para os comandos: VA, VR, VN e VNS
13.03.2018
VNS - Report de vendas por status de pedido
SR - Report de status
26.09.2017
Comando IBGEC:
Consulta do código do municÃpio (base IBGE)
Inclusão das tags para os comandos VN, VR DR e DRU:
<contato_principal_empresa> José da Silva</contato_principal_empresa>
25.09.2017
Inclusão das tags para os comandos DR e DRU
<contribuinte_icms>Sim</contribuinte_icms>
Opções: Sim, Não e Isento.
<tipodecliente>Consumidor Final</tipodecliente>
Opções: Consumidor Final, Revendedor, Solidário, Produtor Rural e Exportação.
<ramodeatividade>Comércio</ramodeatividade>
Opções: Comércio, Indústria, Prestação de Serviços e Empresa Pública.
<optante_simples_nacional>Sim</optante_simples_nacional>
Opções: Sim e Não.
Inclusão das tags para os comandos VN e VR
<PerfilComprador>V</PerfilComprador>
Opções: (A/V/C) : Atacado /Varejo / Distribuidor
<contribuinte_icms>Sim</contribuinte_icms>
Opções: Sim, Não e Isento.
<tipodecliente>Consumidor Final</tipodecliente>
Opções: Consumidor Final, Revendedor, Solidário, Produtor Rural e Exportação.
<ramodeatividade>Comércio</ramodeatividade>
Opções: Comércio, Indústria, Prestação de Serviços e Empresa Pública.
<optante_simples_nacional>Sim</optante_simples_nacional>
Opções: Sim e Não.