Documentação do Web Service Giftty

Documento de especificação, destinado aos programadores e analistas envolvidos no processo de integração com Giftty.

Versão 1.45

Última atualização: 26/12/2023

Apresentação

Esse documento especifica todos os serviços disponíveis, para que os parceiros de Giftty possam obter e enviar informações para o sistema através do protocolo SOAP. As informações contidas nesse documento são destinadas aos programadores e analistas envolvidos no processo de integração com Giftty. Os serviços possibilitam que o cliente possa, através da parceria, consultar os produtos disponíveis, exibi-los em seu catálogo e finalizar um pedido de compras diretamente com Giftty, de forma bem simples, com integração via XML.

Resumo dos Serviços

  1. Consultar produtos
    • Obtém as informações de todos os produtos existentes na base de dados.
  2. Inserir pedido
    • Insere um novo pedido de compras no sistema, através dos dados de cliente e produtos informados.
  3. Consultar meus pedidos
    • Obtém todo o histórico de pedidos do cliente.
  4. Consultar tracking
    • Obtém o rastreamento e status do pedido.
  5. Consultar pedido parceiro
    • Obtém o código de pedido Direct Shopping através de código de pedido do parceiro.
  6. Inserir Pedido Recarga C&A
    • Insere um pedido de recarga em cartões presente C&A
  7. Consultar Link do Cartão Virtual
    • Obtém informações do pedido e o link que dá acesso ao cartão virtual.
  8. Consultar dados do Cartão Virtual
    • Obtém informações do pedido e código e PIN do Cartão virtual
  9. Consultar Estoque
    • Obtém informações de estoque disponível, por id de produto.
  10. Consultar Frete*
    • Consulta valor do frete do carrinho. *Válido somente para campanhas elegíveis.
  11. Consultar Pedidos Entregues
    • Retorna todos os pedidos entregues e finalizados no último dia.
  12. Consultar Pedidos Bounces
    • Retorna todos os pedidos virtuais com falha no envio. Os pedidos são exibidos apenas até tratamento e solução do problema.
  13. Liberar Pedido Anti Fraude
    • Confirma a liberação de um pedido retido pelo sistema anti-fraude.
  14. Reenviar Vale Virtual
    • Reenvia vale virtual para o premiado. Permite alteração do destinatário do vale virtual.
  15. Consultar Link do Cartão Virtual 2
    • Obtém informações do pedido e o link que dá acesso ao cartão virtual.
  16. Consultar dados do Cartão Virtual 2
    • Obtém informações do pedido e código e PIN do Cartão virtual.
  17. Consultar Limites e Resgates
    • Retorna limite mensal pré-definido e total de resgates dos últimos 30 dias, por Cliente ou por Projeto.

Endpoint

Os serviços estão disponíveis em:
Produção: https://dshopdesenv.com/services/giftty/server.php?wsdl
Testes: https://dshopdesenv.com/services/giftty_teste/server.php?wsdl

Ao iniciar o desenvolvimento da integração com o Web Service Giftty, deve-se utilizar o endpoint de testes. Quando em produção, deve-se utilizar o endpoint de produção. As credenciais são gerenciadas pela equipe de desenvolvimento da Giftty. Usuários cadastrados para Testes não podem utilizar o endpoint de produção. Já os usuários cadastrados para produção podem continuar utilizando o endpoint de testes em paralelo.

Controle de Versão

# Data Descrição
v1.1 Alteração no parâmetro de envio do método InserirPedido e do retorno recebido pelo método ConsultarProdutos para se adaptarem aos produtos do departamento Recarga de Celular.
v1.3 Controle de produtos retornados no serviço ConsultarProdutos de acordo com parceiro.
v1.4 Inclusão do parâmetro opcional Projeto no serviço InserirPedido.
v1.5 Inclusão do Parâmetro opcional Projeto nos serviços ConsultarTracking e ConsultarMeusPedidos.
v1.6 Inclusão dos parâmetros opcionais PedidoParceiro e Campanha no serviço InserirPedido. Inclusão do serviço ConsultarPedidoParceiro.
v1.7 Atualização dos status de resposta do serviço ConsultarTracking.
v1.8 Inclusão do serviço de recarga de cartões para parceiros credenciados.
v1.16 11/07/2017 Alteração do serviço ConsultarProdutos para aceitar Código de Projeto, limitando o catálogo retornado.
v1.17 14/07/2017 Alteração do serviço ConsultarProdutos para aceitar fabricanteId, permitindo busca por produtos utilizando marca como parâmetro.
v1.18 26/07/2017 Alteração do serviço ConsultarProdutos. Inclusão da tag precoBTD.
v1.19 27/07/2017 - Criação do serviço ConsultarFrete. Criação do serviço ConsultarFrete.
- Adição da tag produto.precoBTD no serviço ConsultarProdutos.
- Adição de status de erro em InserirPedido: "46|CPF ou e-mail bloqueado.".
v1.20 16/08/2017 Criação das tags "PrecoBTD", "taxa" e "desconto" no serviço ConsultarProdutos.
v1.21 18/08/2017 - Criação da tag "InformacaoAdicional" no serviço ConsultarProdutos.
- Alteração das regras de validação do campo nome no serviço InserirPedido.
v1.22 06/09/2017 - Criação da tag "fornecedorId" no serviço ConsultarProdutos.
- Criação da tag "fornecedorNome" no serviço ConsultarProdutos.
v1.23 02/01/2018 - Criação da tag "codItem" no serviço ConsultarTracking.
- Criação da tag "codPedido" no serviço ConsultarTracking.
- Criação da tag "codigoProduto" no serviço ConsultarTracking
v1.24 25/01/2018 - Correção das descrições e dos tamanhos de imagens fornecidas.
v1.25 01/03/2018 - Criação do serviço ConsultarPedidosEntregues
v1.26 07/03/2018 - Adicionado campo mensagem ao serviço consultarLinkPedidoParceiro
v1.27 14/03/2018 - Criação do serviço ConsultarPedidosBounce
v1.28 09/04/2018 - Adicionado campo Imagens ao serviço ConsultarProdutos
v1.29 07/05/2018 - Adicionado campo link no retorno do serviço InserirPedido
v1.30 25/10/2018 - Adicionado serviço LiberarPedidoAntiFraude
v1.31 09/11/2018 - Adicionado tipo de produto com valor variável
v1.32 09/11/2018 - Adicionado tipo de produto para recarga de cartão
v1.33 06/12/2018 - Criação do serviço ReenviarValeVirtual
v1.34 24/10/2019 - Criação do serviço consultarLinkPedidoParceiro2
v1.35 24/03/2020 - Criação dos campos telefoneCel e dddCel em EnderecoPrincipal e EnderecoEntrega no serviço InserirPedido
v1.36 28/05/2020 - Criação do campo rastreamento no retorno do serviço ConsultarTracking para pedidos de vales físicos.
v1.37 20/08/2020 - Criação dos campos de detalhes da descrição no serviço ConsultarProdutos.
v1.38 20/08/2020 - Criação do campo preço no retorno do serviço ConsultarEstoque.
v1.39 01/09/2020 - Criação do campo codigoProduto no retorno do serviço consultarLinkPedidoParceiro2.
v1.40 04/02/2021 - Campo opcional Projeto na requisição do serviço ConsultarEstoque.
v1.41 03/11/2022 - Validação de limites mensais de resgates por parceiro e por projeto no serviço InserirPedido.
- Adicionadas mensagens de erro para estouro de limite (erros 58 e 59).
v1.42 24/03/2023 - Criação do serviço 16: Consultar Dados do Cartão Virtual 2
v1.43 24/04/2023 - Adicionadas mensagens de erro para limite de resgates e valor por CPF.
v1.44 11/10/2023 - Criação do serviço 17: Consultar Limites e Resgates.
v1.45 26/12/2023 - Criação da mensagem de erro de limite de resgates diários por projeto.

Serviços

1. Consultar produtos

Método ConsultarProdutos
Descrição Serviço que retorna todos os produtos disponíveis para o parceiro. Em função da constante atualização do catálogo de produtos, é necessário que o integrador realize atualizações periódicas em seu catálogo de prêmios utilizando este serviço para a sincronização de dados.
Exemplo de entrada:

<Produtos>
    <Projeto>F25</Projeto>
    <fabricanteId>21</fabricanteId>
    <fornecedorId>33</fornecedorId>
    <Agrupar>N</Agrupar>
</Produtos>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Projeto Texto 3 Não Informa ao sistema qual catálogo se está consultando. Caso não seja informado, serão retornados todos os produtos de todos os catálogos relacionados ao parceiro.
fabricanteId Numérico Não Id de fabricante utilizado para parametrizar a busca de produtos.
fornecedorId Numérico Não Id de fornecedor utilizado para parametrizar a busca de produtos.
Agrupar Texto 1 Não Altera modelo de retorno. N para XML de retorno padrão. S para XML de retorno agrupado por produtos.
Valor Padrão: N

Código de projeto

A Giftty gera um código para cada projeto que o parceiro possui. Solicite os códigos para a nossa área comercial.

Exemplo de retorno:

<?xml version="1.0" encoding="UTF-8"?>
<Produtos>
	<Produto>
        <codigo>1159</codigo>
        <fabricanteId>7</fabricanteId>
        <fabricanteNome>Grupo Pão de Açúcar</fabricanteNome>
        <fornecedorId>73</fornecedorId>
        <fornecedorNome>Pontofrio</fornecedorNome>
        <departamentoId>2</departamentoId>
        <departamentoNome>Vale Presente</departamentoNome>
        <categoriaId>31</categoriaId>
        <categoriaNome>Varejo Eletrônico</categoriaNome>
        <preco>150,00</preco>
        <precoDe>150,00</precoDe>
        <precoBTD>160,00</precoBTD>
        <precoBTDI>162,00</precoBTDI>
        <precoBTDIsemFrete>18</precoBTDIsemFrete>
        <taxa>10,00</taxa>
        <impostosTaxa>0.00</impostosTaxa>
        <desconto>0,00</desconto>
        <produtoNome>Vale Presente Virtual Ponto Frio R$ 150</produtoNome>
        <descricao>Válido para aquisição de produtos no site www.pontofrio.com.br. O vale Presente poderá ser utilizado no valor parcial, total ou ainda complementar o pagamento com outras formas de pagamento disponíveis no site. Poderá ser utilizado um vale Presente por compra. Não será permitida a tansferência de saldo. Após a compra do vale Presente, o mesmo não poderá ser cancelado ou devolvido. O voucher será encaminhado para o email cadastrado em até 7 dias úteis. Validade: 12 meses.</descricao>
        <habilitado>S</habilitado>
        <tipoProduto>VOUCHER</tipoProduto>
        <Fotos>
            <p>https://www.dshop.com.br/lg/images/products/E29429pp.png</p>
            <m>https://www.dshop.com.br/lg/images/products/E29429p.png</m>
            <g>https://www.dshop.com.br/lg/images/products/E29429g.png</g>
        </Fotos>
        <Imagens>
            <pp>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6562pp.jpg</pp>
            <p>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6562p.jpg</p>
            <m>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6562m.jpg</m>
            <g>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6562g.jpg</g>
            <gg>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6562gg.jpg</gg>
        </Imagens>
        <Dimensoes>
            <altura>0.000</altura>
            <largura>0.000</largura>
            <profundidade>0.000</profundidade>
            <peso>0.000</peso>
        </Dimensoes>
        <frete>0.00</frete>
        <impostosFrete>0.00</impostosFrete>
        <Estoque>
            <controle_estoque>S</controle_estoque>
            <quant_estoque>0</quant_estoque>
        </Estoque>
        <InformacoesAdicionais>
            <Informacao>
                <chave>Passo 1</chave>
                <valor>Após resgatar o seu Cartão Presente Ponto Frio Virtual no catálogo de prêmios, você receberá um e-mail  com link de acesso ao seu vale, contendo o código. Para utilizar acesse o site www.pontofrio.com.br</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 2</chave>
                <valor>Localize o produto do seu interesse, clique no botão `Comprar` para inserir no carrinho de compras. Atenção!!! O seu seu Cartão Presente Ponto Frio Virtual não é um cupom de desconto, portanto não use a opção `Insira seu cupom` na área carrinho de compra.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 3</chave>
                <valor>Após finalizar a escolha dos produtos  clique em `Concluir compra`. Você deverá informar seu e-mail e completar seu cadastro com os dados pessoais e de entrega, em seguida  clique em `Continuar`.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 4</chave>
                <valor>Na área opções  de pagamento selecione `Cartão Presente`, localizado na lateral da página. No campo `Numero do cartão` digite o número do código recebido e clique em `Validar dados`. Se houver a necessidade de completar o valor da compra informe mais opções de pagamento.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 5</chave>
                <valor>Clique em `Finalizar compra` e seu pedido estará completo.</valor>
            </Informacao>
        </InformacoesAdicionais>
        <DetalhesDescricao>
            <prazo>O vale presente será entregue no endereço informado no resgate em até 30 dias. Após este prazo, caso não tenha recebido entre em contato com o atendimento da sua campanha.</prazo>
            <validade>12 meses.</validade>
            <utilizacao>O Cartão Multicash pode ser utilizado em todas as lojas físicas: Extra, Pão de Açúcar, Assaí, Compre Bem Supermercados, além de drogarias e postos de combustível do Grupo. Aceito também nas lojas parceiras Casas Bahia e Pontofrio. Nas lojas virtuais utilize seu Cartão Multicash em www.clubeextra.com.br, www.paodeacucar.com.br, www.extra.com.br, www.pontofrio.com.br e www.casasbahia.com.br. Consulte as regiões de entrega na sua cidade. Válido para modalidade de "entrega tradicional".</utilizacao>
            <descricao>Multicash é o cartão de benefícios do Grupo Pão de Açúcar, maior empresa varejista do país. Com o Cartão Multicash você pode aproveitar as melhores ofertas em todas as lojas do Grupo Pão de Açúcar e lojas parceiras. Verifique a relação completa no site www.multibeneficiosgpa.com.br. Utilização nas lojas físicas: Basta apresentar seu cartão como forma de pagamento. O crédito poderá ser utilizado no valor parcial, total ou você poderá complementar o pagamento com as formas disponíveis nas lojas. Utilização nas lojas virtuais: Basta inserir o código no campo correspondente na tela de pagamento. Para efetuar o pagamento, será necessário utilizar a opção cartão de crédito. O saldo do Cartão Multicash deverá ser suficiente para pagamento de sua compra, não é permitido a utilização de duas formas de pagamento em conjunto. Para consultar o saldo, acesse o App ou site www.multibeneficiosgpa.com.br e clique em ACESSAR MINHA CONTA. Ou através da Central de Atendimento (3004-2022). - Pão de Açúcar e Extra: até 5 (cinco) Cartões por compra nas lojas físicas e 1 (um) no site. - Casas Bahia, Pontofrio e Assaí: 2 (dois) Cartões por compra nas lojas físicas e 1 (um) no site (exceto site do Assaí). O Cartão Multicash é ao portador e recarregável. Seu saldo não poderá ser cancelado, trocado, devolvido ou ser convertido em dinheiro. Não é possível a transferência de saldo para outro Cartão Presente.</descricao>
        </DetalhesDescricao>
    </Produto>    
	<Produto>
        <codigo>769</codigo>
        <fabricanteId>7</fabricanteId>
        <fabricanteNome>Grupo Pão de Açúcar</fabricanteNome>
        <fornecedorId>74</fornecedorId>
        <fornecedorNome>Extra</fornecedorNome>
        <departamentoId>2</departamentoId>
        <departamentoNome>Vale Presente</departamentoNome>
        <categoriaId>31</categoriaId>
        <categoriaNome>Varejo Eletrônico</categoriaNome>
        <preco>100,00</preco>
        <precoDe>100,00</precoDe>
        <precoBTD>SV</precoBTD>
        <precoBTDI>SV</precoBTDI>
        <taxa>SV</taxa>
        <desconto>SV</desconto>
        <produtoNome>Vale Presente Virtual Extra R$ 100</produtoNome>
        <descricao>Válido para aquisição de produtos no site www.extra.com.br. O vale presente não é aceito para compra de alimentos ou outros itens do site deliveryextra.com.br. O vale Presente poderá ser utilizado no valor parcial, total ou ainda complementar o pagamento com outras formas de pagamento disponíveis no site. Poderá ser utilizado um vale Presente por compra. Não será permitida a tansferência de saldo. Após a compra do vale Presente, o mesmo não poderá ser cancelado ou devolvido. O voucher será encaminhado para o email cadastrado em até 7 dias úteis. Consulte regulamento no site. Validade: 12 meses.</descricao>
        <habilitado>S</habilitado>
        <tipoProduto>VOUCHER</tipoProduto>
        <Fotos>
            <p>https://www.dshop.com.br/lg/images/products/E29430pp.png</p>
            <m>https://www.dshop.com.br/lg/images/products/E29430p.png</m>
            <g>https://www.dshop.com.br/lg/images/products/E29430g.png</g>
        </Fotos>
        <Dimensoes>
            <altura>0.000</altura>
            <largura>0.000</largura>
            <profundidade>0.000</profundidade>
            <peso>0.000</peso>
        </Dimensoes>
        <frete>0.00</frete>
        <Estoque>
            <controle_estoque>N</controle_estoque>
        </Estoque>
        <InformacoesAdicionais>
            <Informacao>
                <chave>Passo 1</chave>
                <valor>Após resgatar o seu Cartão Presente Extra Virtual no catálogo de prêmios, você receberá um e-mail com link de acesso ao seu vale, contendo o código. Para utilizar acesse o site www.extra.com.br</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 2</chave>
                <valor>Localize o produto do seu interesse, clique no botão `Comprar` para inserir no carrinho de compras. Atenção!!! O seu Cartão Presente Extra Virtual não é um cupom de desconto, portanto não use a opção `Insira seu cupom` na área carrinho de compra.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 3</chave>
                <valor>Após finalizar a escolha  dos produtos  clique em `Concluir compra`. Você deverá informar seu e-mail e completar seu cadastro com os dados  pessoais e de entrega, em seguida clique em `Continuar`.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 4</chave>
                <valor>Na área opções de pagamento selecione `Cartão Presente`, localizado na lateral da página. No campo `Numero do cartão` digite o número do código recebido e clique em `Validar dados`. Se houver a necessidade de completar o valor da compra informe mais opções de pagamento.</valor>
            </Informacao>
            <Informacao>
                <chave>Passo 5</chave>
                <valor>Clique em `Finalizar compra` e seu pedido estará completo.</valor>
            </Informacao>
        </InformacoesAdicionais>
        <DetalhesDescricao>
            <prazo>O vale presente será entregue no endereço informado no resgate em até 30 dias. Após este prazo, caso não tenha recebido entre em contato com o atendimento da sua campanha.</prazo>
            <validade>12 meses.</validade>
            <utilizacao>O Cartão Multicash pode ser utilizado em todas as lojas físicas: Extra, Pão de Açúcar, Assaí, Compre Bem Supermercados, além de drogarias e postos de combustível do Grupo. Aceito também nas lojas parceiras Casas Bahia e Pontofrio. Nas lojas virtuais utilize seu Cartão Multicash em www.clubeextra.com.br, www.paodeacucar.com.br, www.extra.com.br, www.pontofrio.com.br e www.casasbahia.com.br. Consulte as regiões de entrega na sua cidade. Válido para modalidade de "entrega tradicional".</utilizacao>
            <descricao>Multicash é o cartão de benefícios do Grupo Pão de Açúcar, maior empresa varejista do país. Com o Cartão Multicash você pode aproveitar as melhores ofertas em todas as lojas do Grupo Pão de Açúcar e lojas parceiras. Verifique a relação completa no site www.multibeneficiosgpa.com.br. Utilização nas lojas físicas: Basta apresentar seu cartão como forma de pagamento. O crédito poderá ser utilizado no valor parcial, total ou você poderá complementar o pagamento com as formas disponíveis nas lojas. Utilização nas lojas virtuais: Basta inserir o código no campo correspondente na tela de pagamento. Para efetuar o pagamento, será necessário utilizar a opção cartão de crédito. O saldo do Cartão Multicash deverá ser suficiente para pagamento de sua compra, não é permitido a utilização de duas formas de pagamento em conjunto. Para consultar o saldo, acesse o App ou site www.multibeneficiosgpa.com.br e clique em ACESSAR MINHA CONTA. Ou através da Central de Atendimento (3004-2022). - Pão de Açúcar e Extra: até 5 (cinco) Cartões por compra nas lojas físicas e 1 (um) no site. - Casas Bahia, Pontofrio e Assaí: 2 (dois) Cartões por compra nas lojas físicas e 1 (um) no site (exceto site do Assaí). O Cartão Multicash é ao portador e recarregável. Seu saldo não poderá ser cancelado, trocado, devolvido ou ser convertido em dinheiro. Não é possível a transferência de saldo para outro Cartão Presente.</descricao>
        </DetalhesDescricao>
    </Produto>    
</Produtos>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
erros Numérico 1 Informa se algum erro ocorreu no processo. 0 representa sucesso e 1 representa erro.
Produto.codigo Texto 6 O código (SKU) do produto.
Produto.fabricanteId Numérico --- O ID do fabricante do produto.
Produto.fabricanteNome Texto 40 Nome do Fabricante do produto.
Produto.fornecedorId Numérico --- O ID do Fornecedor do produto.
Produto.fornecedorNome Texto 40 Nome do Fornecedor do produto.
Produto.departamentoId Numérico --- O ID do departamento do produto.
Produto.fabricanteNome Texto 40 Nome do Fabricante do produto.
Produto.departamentoId Numérico --- O ID do departamento do produto.
Produto.departamentoNome Texto 40 Departamento do produto.
Produto.categoriaId Numérico --- O ID da categoria do produto.
Produto.categoriaNome Texto 40 Categoria do produto.
Produto.preco Texto 15 Valor unitário do produto.
Produto.precoDe Texto 15 Valor anterior do produto.
Produto.precoBTD Texto 15 Valor unitário do produto já calculado com possíveis modificadores (Bônus, Taxas, Descontos, Frete etc). Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.precoBTDI Texto 15 Valor apresentado no parâmetro acima (precoBTD) acrescentando os impostos devidos. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.precoBTDIsemFrete Texto 15 Valor unitário do produto calculado com Taxa, Desconto e Imposto sobre a Taxa. Em relação ao campo anterior, este campo não inclui Frete e Imposto sobre o valor do Frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.taxa Texto --- Valor absoluto (em Reais) das taxas a serem cobradas do vale. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor). Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.impostosTaxa Texto --- Valor absoluto (em Reais) dos impostos que incidem sobre o valor absoluto da Taxa. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.desconto Texto --- Valor absoluto (em Reais) dos descontos a serem aplicados no vale. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.produtoNome Texto --- Nome do produto
Produto.descricao Texto --- Descrição completa do produto.
Produto.habilitado Numérico 1 Informa se o produto está habilitado para vendas. O valor 1 representa habilitado e o valor 0 representa desabilitado.
Produto.tipoProduto Texto 1 Informa o tipo de produto. Tipos possíveis na tabela de valores pré-definidos abaixo.
Produto.esgotado Numérico 1 Informa se o produto está esgotado. O valor 1 representa esgotado e o valor 0 representa disponível.
Produto.Fotos.p Texto --- Localização da imagem 100x84px do produto.
Produto.Fotos.m Texto --- Localização da imagem 160x134px do produto.
Produto.Fotos.g Texto --- Localização da imagem 229x192px do produto.
Produto.Imagens.pp Texto --- Localização da imagem jpg 80x80px do produto. Caso a imagem não esteja disponível, o item não será exibido.
Produto.Imagens.p Texto --- Localização da imagem jpg 140x140px do produto. Caso a imagem não esteja disponível, o item não será exibido.
Produto.Imagens.m Texto --- Localização da imagem jpg 200x200px do produto. Caso a imagem não esteja disponível, o item não será exibido.
Produto.Imagens.g Texto --- Localização da imagem jpg 500x500px do produto. Caso a imagem não esteja disponível, o item não será exibido.
Produto.Imagens.gg Texto --- Localização da imagem jpg 1000x1000px do produto. Caso a imagem não esteja disponível, o item não será exibido.
Produto.Dimensoes.altura Texto 15 Informações da altura bruta do produto.
Produto.Dimensoes.largura Texto 15 Informações da largura bruta do produto.
Produto.Dimensoes.profundidade Texto 15 Informações da profundidade bruta do produto.
Produto.frete Texto 15 Valor do frete (em reais) definido para o produto. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.impostosFrete Texto 15 Valor (em reais) dos impostos que incidem sobre o valor do frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
Produto.peso Texto 15 Peso bruto do produto.
Fretes.siglaEstado.capital Numérico --- Valor do frete do produto para entrega na capital do estado.
Fretes.siglaEstado.interior Numérico --- Valor do frete do produto para entrega no interior do estado.
Estoque.controle_estoque Texto 1 Informa "S" quando existe um estoque de produtos (cartões pré-carregados) e "N" quando não existe estoque (cargas, cartões físicos e virtuais);
Estoque.quant_estoque Numérico --- Existe apenas quando existe um estoque de produtos, informando a quantidade dele em estoque. Ausente para produtos onde Estoque.controle_estoque = "N".
InformacoesAdicionais.Informacao.chave Texto --- Título do bloco de informações adicionais
InformacoesAdicionais.Informacao.valor Texto --- Conteúdo do bloco de informações adicionais.
DetalhesDescricao.prazo Texto --- Prazo de entrega do produto. Excerto do campo descricao
DetalhesDescricao.validade Texto --- Validade do vale presente. Excerto do campo descricao
DetalhesDescricao.utilizacao Texto --- Forma de utilização do vale presente. Excerto do campo descricao
DetalhesDescricao.descricao Texto --- Excerto do campo descricao, sem informações de prazo, validade e forma de utilização.
Exemplo de retorno agrupado:

<?xml version="1.0" encoding="UTF-8"?>
<produtos>
    <produto>
        <titulo>Cartão Multicash Assaí</titulo>
        <skus>
            <sku>
                <codigo>2220</codigo>
                <produtonome>Cartão Multicash Assaí - R$ 50</produtonome>
                <preco>50.00</preco>
                <frete>19.40</frete>
                <desconto>0</desconto>
                <taxa>0</taxa>
                <precobtd>69.4</precobtd>
                <precobtdi>74.14</precobtdi>
                <precobtdisemfrete>50</precobtdisemfrete>
                <impostostaxa>0.00</impostostaxa>
                <impostosfrete>4.74</impostosfrete>
                <estoque>
                    <controleestoque>N</controleestoque>
                </estoque>
            </sku>
            <sku>
                <codigo>3958</codigo>
                <produtonome>Cartão Multicash Assaí - R$ 100</produtonome>
                <preco>100.00</preco>
                <frete>19.40</frete>
                <desconto>0</desconto>
                <taxa>0</taxa>
                <precobtd>119.4</precobtd>
                <precobtdi>124.14</precobtdi>
                <precobtdisemfrete>100</precobtdisemfrete>
                <impostostaxa>0.00</impostostaxa>
                <impostosfrete>4.74</impostosfrete>
                <estoque>
                    <controleestoque>N</controleestoque>
                </estoque>
            </sku>
        </skus>
        <descricao>Multicash é o cartão de benefícios do Grupo Pão de Açúcar, maior empresa varejista do país.  Com o Cartão Multicash Assaí você encontra mais de sete mil itens de grandes marcas nacionais e importadas de mercearia, alimentos, perecíveis, embalagens, bazar, higiene, bebidas e limpeza.  Acesse o site www.assai.com.br e encontre a loja mais próxima.  Para utilizar, apresente o Cartão Multicash Assaí nas lojas do Grupo Pão de Açúcar como forma de pagamento. Você poderá utilizar até dois Cartões Multicash por compra nas lojas Assaí. Não é possível efetuar compras no site da marca. Apresente o Cartão Multicash Assaí como forma de pagamento. O crédito poderá ser utilizado no valor parcial, total ou ainda complementar o pagamento disponível na loja. O Cartão Multicash Assaí é ao portador e não é recarregável. Seu saldo não poderá ser cancelado, trocado, devolvido ou ser convertido em dinheiro. O Cartão Multicash é único e intransferível. Não é possível a transferência de saldo para outro Cartão Multicash. Para consultar o saldo, acesse o site www.multibeneficiosgpa.com.br e clique em ACESSAR MINHA CONTA. O Cartão Multicash Assaí será enviado ao endereço cadastrado em até 30 dias após a confirmação do resgate. Em caso de não recebimento após o prazo de entrega informado, entre em contato com a central de atendimento da sua campanha.  Validade: 12 meses.</descricao>
        <fabricanteid>179</fabricanteid>
        <fabricantenome>Multicash</fabricantenome>
        <fornecedorid>277</fornecedorid>
        <fornecedornome>Multicash Assaí</fornecedornome>
        <departamentoid>2</departamentoid>
        <departamentonome>Vale Presente</departamentonome>
        <categoriaid>150</categoriaid>
        <categorianome>Hipermercado e Varejo</categorianome>
        <tipoproduto>FISICO</tipoproduto>
        <imagenspng>
            <p>https://www.dshop.com.br/lg/images/products/E31383pp.png</p>
            <m>https://www.dshop.com.br/lg/images/products/E31383p.png</m>
            <g>https://www.dshop.com.br/lg/images/products/E31383g.png</g>
        </imagenspng>
        <imagensjpg>
            <pp>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6321pp.jpg</pp>
            <p>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6321p.jpg</p>
            <m>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6321m.jpg</m>
            <g>http://www.dshopdesenv.com/sas2012/v2/uploads/produtos/ws6321g.jpg</g>
        </imagensjpg>
        <informacoesadicionais>
            <informacao>
                <chave>Passo 1</chave>
                <valor>Após resgatar o seu Cartão Multicash no catálogo de prêmios, você receberá um cartão físico pelo correio contendo o código. Para utilizar acesse o sites da marca GPA.                                                                                                                                                </valor>
            </informacao>
            <informacao>
                <chave>Passo 2</chave>
                <valor>Após localizar o produto do seu interesse, clique no botão Comprar para inserir no carrinho de compras. Atenção!!! O seu Cartão Multicash não é um cupom de desconto, portanto não use a opção “Insira seu cupom” na área carrinho de compra.                                                                                                                                                </valor>
            </informacao>
            <informacao>
                <chave>Passo 3</chave>
                <valor>Após finalizar a escolha  dos produtos clique em “Concluir compra. Você deverá informar seu e-mail e completar seu cadastro com os dados pessoais e de entrega, em seguida  clique em “Continuar.                                                                                                                                                </valor>
            </informacao>
            <informacao>
                <chave>Passo 4</chave>
                <valor>Na área opções de pagamento selecione “Cartão Presente, localizado na lateral da página.                                                                                                                                                </valor>
            </informacao>
            <informacao>
                <chave>Passo 5</chave>
                <valor>No campo “Numero do cartão digite o número do verso do cartão físico e o PIN no campo “código de segurança”. Clique em “Validar dados.                                                                                                                                              </valor>
            </informacao>
            <informacao>
                <chave>Passo 6</chave>
                <valor>Clique em Finalizar compra e seu pedido está completo.                                                                                                                                                </valor>
            </informacao>
        </informacoesadicionais>
        <DetalhesDescricao>
            <prazo>Consulte as regras da sua campanha sobre a forma de disponibiliza??o do vale presente.</prazo>
            <validade>12 meses.</validade>
            <utilizacao>
                O Cart?o Presente Havaianas ? v?lido para todas as lojas f?sicas no Brasil e no site da marca.
            </utilizacao>
            <descricao>
                As Havaianas, considerada a marca revolucion?ria de sand?lias no Brasil, oferece al?m de cal?ados, uma linha exclusiva de 
                ?culos e acess?rios. Com o Cart?o Presente Havaianas voc? tem acesso a uma grande variedade de sand?lias, alpargatas, 
                acess?rios, t?nis, galochas e muito mais para os p?blicos feminino, masculino e infantil! Presenteie com o ver?o brasileiro 
                em qualquer ?poca do ano. Acesse o site www.havaianas.com.br e aproveite.  ? poss?vel utilizar quantos Cart?es quiser por 
                compra.  O cr?dito do seu Cart?o Presente Havaianas poder? ser utilizado no valor total ou ainda complementar o pagamento 
                com as formas dispon?veis nas lojas e no site. Este Cart?o Presente Havaianas ? ao portador e n?o ? recarreg?vel. Seu 
                saldo n?o poder? ser cancelado, trocado, devolvido ou ser convertido em dinheiro. O Cart?o Presente ? ?nico e 
                intransfer?vel. N?o ? poss?vel a transfer?ncia de saldo para outro Cart?o Presente.
            </descricao>
        </DetalhesDescricao>
    </produto>
</produtos>
Descrição dos parâmetros de retorno agrupado:
Nome Tipo Tamanho Observações
erros Numérico 1 Informa se algum erro ocorreu no processo. Campo ausente representa sucesso e campo presente com valor 1 representa erro.
titulo Texto --- Nome do produto
skus.sku.codigo Texto 6 O código (SKU) do produto.
skus.sku.produtonome Texto --- Nome específico do produto
skus.sku.preco Texto --- Valor unitário do produto.
skus.sku.frete Texto --- Valor do frete (em reais) definido para o produto. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.desconto Texto --- Valor absoluto (em Reais) dos descontos a serem aplicados no vale. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.taxa Texto --- Valor absoluto (em Reais) das taxas a serem cobradas do vale. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor). Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.precobtd Texto --- Valor unitário do produto já calculado com possíveis modificadores (Bônus, Taxas, Descontos, Frete etc). Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.precobtdi Texto --- Valor apresentado no parâmetro acima (precoBTD) acrescentando os impostos devidos. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.precobtdisemfrete Texto --- Valor unitário do produto calculado com Taxa, Desconto e Imposto sobre a Taxa. Em relação ao campo anterior, este campo não inclui Frete e Imposto sobre o valor do Frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.impostostaxa Texto --- Valor absoluto (em Reais) dos impostos que incidem sobre o valor absoluto da Taxa. Não inclui valor de frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.impostosfrete Texto --- Valor (em reais) dos impostos que incidem sobre o valor do frete. Caso não seja possível o cálculo, retornará a string "SV" (sem valor).
skus.sku.estoque.controleestoque Texto --- Informa "S" quando existe um estoque de produtos (cartões pré-carregados) e "N" quando não existe estoque (cargas, cartões físicos e virtuais);
skus.sku.estoque.quantidadeestoque Numérico --- Existe apenas quando existe um estoque de produtos, informando a quantidade dele em estoque. Ausente para produtos onde Estoque.controle_estoque = "N".
descricao Texto --- Descrição completa do produto.
fabricanteid Numérico --- O ID do fabricante do produto.
fabricantenome Texto 40 Nome do Fabricante do produto.
fornecedorid Numérico --- O ID do Fornecedor do produto.
fornecedornome Texto 40 Nome do Fornecedor do produto.
departamentoid Numérico --- O ID do departamento do produto.
departamentonome Texto 40 Nome do Fabricante do produto.
categoriaid Numérico --- O ID da categoria do produto.
categorianome Texto 40 Categoria do produto.
tipoproduto Texto --- Informa o tipo de produto. Tipos possíveis na tabela de valores pré-definidos abaixo.
imagenspng.p Texto --- Localização da imagem 100x84px do produto.
imagenspng.m Texto --- Localização da imagem 160x134px do produto.
imagenspng.g Texto --- Localização da imagem 229x192px do produto.
imagensjpg.pp Texto --- Localização da imagem jpg 80x80px do produto. Caso a imagem não esteja disponível, o item não será exibido.
imagensjpg.p Texto --- Localização da imagem jpg 140x140px do produto. Caso a imagem não esteja disponível, o item não será exibido.
imagensjpg.m Texto --- Localização da imagem jpg 200x200px do produto. Caso a imagem não esteja disponível, o item não será exibido.
imagensjpg.g Texto --- Localização da imagem jpg 500x500px do produto. Caso a imagem não esteja disponível, o item não será exibido.
imagensjpg.gg Texto --- Localização da imagem jpg 1000x1000px do produto. Caso a imagem não esteja disponível, o item não será exibido.
informacoesadicionais.informacao.chave Texto --- Título do bloco de informações adicionais. A tag informacoesadicionais é opcional, de acordo com o produto.
informacoesadicionais.informacao.valor Texto --- Conteúdo do bloco de informações adicionais. A tag informacoesadicionais é opcional, de acordo com o produto.
DetalhesDescricao.prazo Texto --- Prazo de entrega do produto. Excerto do campo descricao
DetalhesDescricao.validade Texto --- Validade do vale presente. Excerto do campo descricao
DetalhesDescricao.utilizacao Texto --- Forma de utilização do vale presente. Excerto do campo descricao
DetalhesDescricao.descricao Texto --- Excerto do campo descricao, sem informações de prazo, validade e forma de utilização.
Tabela de valores pré-definidos
Parâmetro Valores
Produto.tipoProduto FISICO
VOUCHER - para vales virtuais,
RECARGA - recarga de vale, é necessário informar o código do vale a ser recarregado
VIRTUAL - VALOR DEFINIR - vale virtual sem valor definido, é necessário informar o valor a ser resgatado
FISICO - VALOR DEFINIR - vale físico sem valor definido, é necessário informar o valor a ser resgatado

2. Inserir Pedido

Método InserirPedido
Parâmetros a serem enviados: String xmlDados
Exemplo de entrada:

<Pedido>
    <PedidoParceiro>101443</PedidoParceiro>
    <Campanha>SUPER PREMIOS</Campanha>
    <Projeto>I15</Projeto>
    <DadosPessoais>
        <nome>JOSE MIRANDA</nome>
        <razaoSocial></razaoSocial>
        <tipoPessoa>FISICA</tipoPessoa>
        <cpf>12345678901</cpf>
        <cnpj></cnpj>
        <ie></ie>
        <email>JOSE.MIRANDA@GMAIL.COM</email>
    </DadosPessoais>
    <Enderecos>
        <EnderecoPrincipal>
            <logradouro>AVENIDA BRASIL</logradouro>
            <numero>743</numero>
            <complemento>APTO 101</complemento>
            <bairro>VILA BRASIL</bairro>
            <cidade>SAO PAULO</cidade>
            <estado>SP</estado>
            <cep>12345000</cep>
            <ddd>11</ddd>
            <telefone>21355700</telefone>
            <dddCel>11</dddCel>
            <telefoneCel>996549126</telefoneCel>
        </EnderecoPrincipal>
        <EnderecoEntrega>
            <logradouro>AVENIDA BRASIL</logradouro>
            <numero>743</numero>
            <complemento>APTO 101</complemento>
            <bairro>VILA BRASIL</bairro>
            <cidade>SAO PAULO</cidade>
            <estado>SP</estado>
            <cep>12345000</cep>
            <ddd>11</ddd>
            <telefone>21355700</telefone>
            <dddCel>11</dddCel>
            <telefoneCel>996549126</telefoneCel>
        </EnderecoEntrega>
    </Enderecos>
    <DadosPagamento>
        <formaPagamento>FATURAMENTO</formaPagamento>
    </DadosPagamento>
    <Produtos>
        <Produto>
            <codigo>576</codigo>
            <quantidade>1</quantidade>
        </Produto>
    </Produtos>
</Pedido>
Exemplo de cartão de crédito como forma de pagamento:

    <DadosPagamento>
        <formaPagamento>MASTERCARD</formaPagamento>
        <numCartao>0123456789012345</numCartao>
        <validade>10/2018</validade>
        <bandeira>mastercard</bandeira>
        <nomeTitular>John Doe</nomeTitular>
        <cpfTitular>32403980870</cpfTitular>
        <codSeguranca>123</codSeguranca>
        <porcentagemPagamento>50</porcentagemPagamento>
    </DadosPagamento>
Exemplo de pedido com cartão de valor variável:

    <Produtos>
        <Produto>
            <codigo>8541</codigo>
            <quantidade>1</quantidade>
            <valor>26,59</valor>
        </Produto>
    </Produtos>
Exemplo de pedido de recarga de cartão:

    <Produtos>
        <Produto>
            <codigo>8540</codigo>
            <quantidade>1</quantidade>
            <codigoCartao>5290539513574569</codigoCartao>
        </Produto>
    </Produtos>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
PedidoParceiro Texto 15 N Campo obrigatório. Recebe pedido do parceiro para consulta posterior
Campanha Texto 15 N Campo obrigatório. Recebe campanha do parceiro para consulta posterior.
Projeto Texto 3 N Campo obrigatório. Indica projeto ou campanha. Caso o produto não esteja relacionado a este catálogo específico, o pedido será negado.
DadosPessoais.Nome Texto 40 S Nome completo do cliente final. Deve haver pelo menos dois nomes (nome e sobrenome) para aceitação.
DadosPessoais.razaoSocial Texto 40 N Razão Social do cliente (Pessoa Jurídica). É obrigatório apenas quando o cliente for Pessoa Jurídica.
DadosPessoais.tipoPessoa Texto 8 S Informa se o cliente final é Pessoa Física ou jurídica. Verificar tabela de valores pré-definidos1.
DadosPessoais.cpf Texto 11 N CPF do cliente final. Devem ser enviados apenas números (sem pontos e digito). É obrigatório apenas quando o cliente for Pessoa Física.
DadosPessoais.cnpj Texto 14 N CNPJ do cliente final. Devem ser enviados apenas números (sem pontos, barra e dígito). É obrigatório apenas quando o cliente for Pessoa Jurídica.
DadosPessoais.ie Texto 12 N Inscrição Estadual do cliente final. Devem ser enviados apenas números (sem pontos e dígito).
DadosPessoais.Email Texto 40 S Email do cliente final.
DadosPessoais.sexo Texto 1 S Sexo do cliente final. Verificar tabela de valores pré-definidos2.
Enderecos.EnderecoPrincipal.logradouro Texto 40 S Logradouro da residência, ou endereço de cobrança do cliente final. Apenas Logradouro, sem número, complementos etc.
Enderecos.EnderecoPrincipal.numero Texto 6 S Número da residência, ou endereço de cobrança do cliente final.
Endereco.EnderecoPrincipal.complemento Texto 15 N Complemento do endereço residencial ou de cobrança do cliente final.
Endereco.EnderecoPrincipal.bairro Texto 20 S Bairro do endereço residencial ou de cobrança do cliente final.
Endereco.EnderecoPrincipal.cidade Texto 25 S Cidade do endereço residencial ou de cobrança do cliente final.
Endereco.EnderecoPrincipal.Estado Texto 2 S UF do endereço residencial ou de cobrança do cliente final.
Endereco.EnderecoPrincipal.cep Texto 8 S CEP do endereço residencial ou de cobrança do cliente final. Devem ser enviados apenas números (sem traço).
Endereco.EnderecoPrincipal.ddd Numérico 2 S DDD do telefone residencial ou de cobrança do cliente final.
Endereco.EnderecoPrincipal.telefone Numérico 9 S Telefone residencial ou de cobrança do cliente final. Devem ser enviados apenas números (sem traço).
Endereco.EnderecoPrincipal.dddCel Numérico 2 N DDD do telefone celular do cliente final.
Endereco.EnderecoPrincipal.telefoneCel Numérico 9 N Telefone celular do cliente final.
Enderecos.EnderecoEntrega.logradouro Texto 40 N Logradouro do endereço de entrega do cliente final. Apenas Logradouro, sem número, complementos etc. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Enderecos.EnderecoEntrega.numero Texto 6 N Número do endereço de entrega do cliente final. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco.EnderecoEntrega.complemento Texto 15 N Complemento do endereço de entrega do cliente final.
Endereco.EnderecoEntrega.bairro Texto 20 S Bairro do endereço de entrega do cliente final. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco. EnderecoEntrega.cidade Texto 25 S Cidade do endereço de entrega do cliente final. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco. EnderecoEntrega.Estado Texto 2 S UF do endereço de entrega do cliente final. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco. EnderecoEntrega.cep Texto 8 S CEP do endereço de entrega do cliente final. Devem ser enviados apenas números (sem traço). Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco. EnderecoEntrega.ddd Numérico 2 S DDD do telefone onde será feita a entrega. Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco. EnderecoEntrega.telefone Numérico 9 S Telefone residencial de onde será feita a entrega. Devem ser enviados apenas números (sem traço). Obrigatório apenas quando o endereço de entrega for diferente do endereço principal. Se não for enviado, o endereço de entrega considerado será o endereço principal.
Endereco.EnderecoEntrega.dddCel Numérico 2 N DDD do telefone celular do cliente final. Utilizado para vales em que exista envio de SMS.
Endereco.EnderecoEntrega.telefoneCel Numérico 9 NS Telefone celular do cliente final. Utilizado para vales em que exista envio de SMS.
DadosPagamento.formaPagamento Texto 10 S Forma de pagamento desejada. Verificar tabela de valores pré-definidos3.
DadosPagamento.numCartao Numérico 16 N Número do cartão de crédito. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito.
DadosPagamento.validade Numérico 4 N Data de validade do cartão de crédito. Deve ser enviada no formato mmaa. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito.
DadosPagamento.bandeira Texto 10 N Bandeira do cartão de crédito. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito. Verificar tabela de valores pré-definidos4.
DadosPagamento.nomeTitular Texto 24 N Nome do titular do cartão de crédito. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito.
DadosPagamento.cpfTitular Numérico 11 N CPF do titular do cartão de crédito. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito.
DadosPagamento.codSeguranca Numérico 4 N Digito verificador (segurança) do cartão de crédito. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito.
DadosPagamento.porcentagemPagamento Numérico 2 N Porcentagem a ser cobrada do cartão de crédito. Este campo não é obrigatório. Utilização deste campo mediante negociação comercial.
DadosPagamento.numParcelas Numérico 2 N Número de parcelas desejada para pagamento da compra. Informação obrigatória apenas quando o pagamento for feito com cartão de crédito. Em outras formas de pagamento, essa informação será ignorada.
Produtos.Produto.codigo Texto 6 S Código (SKU) do produto desejado.
Produtos.Produto.quantidade Numérico 2 S Quantidade desejada do produto.
Produtos.Produto.ddd Numérico 2 N O DDD do telefone que irá receber a recarga. Informação obrigatória apenas quando o produto for do departamento Recarga de Celular.
Produtos.Produto.telefone Numerico 9 N O Número do telefone que irá receber a recarga. Informação obrigatória apenas quando o produto for do departamento Recarga de Celular.
Produtos.Produto.valor Numerico 10 N O valor do vale, nos casos em que o vale tiver valor variável. Apenas números. Sem separador de milhares. Vírgula (,) como separador decimal.
Produtos.Produto.codigoCartao Texto 30 N Vale a ser recarregado (para produtos de tipo recarga). Inserir apenas o código (letras e números), sem espaços, traços, pontos ou qualquer outro caracter.
Tabela de valores pré-definidos
Parâmetro Valores
DadosPessoais.tipoPessoa FISICA, JURIDICA
DadosPessoais.sexo F, M
DadosPagamento.formaPagamento BOLETO, FATURAMENTO, VISA, MASTERCARD, DINERS, AMEX, ELO
DadosPagamento.Bandeira VISA, MASTERCARD, DINERS, AMEX, ELO
Exemplo de retorno:

<?xml version="1.0" encoding="utf-8"?>
<Pedido>
    <erros>0</erros>
    <Informacoes>
        <codPedido>9424819</codPedido>
        <valorProdutos>50.00</valorProdutos>
        <valorFrete />
        <valorTotal>50.00</valorTotal>
    </Informacoes>
    <Produtos>
        <Produto>
            <codigo>576</codigo>
            <valor>50.00</valor>
            <quantidade>1</quantidade>
            <Cartoes>
                <codigo>4391d778473dc17a9c6fe9eac51182080cd7023d3e6d67ab40ff45066c699863</codigo>
                <pin>e3d3a82174aa93a06545222515fedfb6</pin>
                <qr_code>e3d3a82174aa93a06545222515fedfb6</qr_code>
                <link>https://giftty.com.br/cea/cartao.php?8e7ee9b50b48be2b02231b9bd3509b7c43144bc3ffc2d4acd0e8e76acb929cddc9a8191b0de51fc14c7a998168b46a52</link>
            </Cartoes>
        </Produto>
    </Produtos>
</Pedido>


Exemplo de retorno com mais de um vale imediato:

<Pedido>
	<erros>0</erros>
	<Informacoes>
		<codPedido>3450900</codPedido>
		<valorProdutos>970.00</valorProdutos>
		<valorFrete/>
		<valorTotal>970.00</valorTotal>
	</Informacoes>
	<Produtos>
		<Produto>
			<codigo>2583</codigo>
			<valor>200.00</valor>
			<quantidade>1</quantidade>
			<Cartoes>
				<codigo>a1745a0fe43c2101e53aea80cc2db931</codigo>
				<pin>fbe1dcfa9f07d0d41f53e233c87a01ed</pin>
				<qr_code>fbe1dcfa9f07d0d41f53e233c87a01ed</qr_code>
				<link>1197cff93b19b8f336483165e8167d92</link>
			</Cartoes>
		</Produto>
		<Produto>
			<codigo>2583</codigo>
			<valor>200.00</valor>
			<quantidade>1</quantidade>
			<Cartoes>
				<codigo>58e75e26e6026b0a843389629017886c</codigo>
				<pin>fbe1dcfa9f07d0d41f53e233c87a01ed</pin>
				<qr_code>fbe1dcfa9f07d0d41f53e233c87a01ed</qr_code>
				<link>1197cff93b19b8f336483165e8167d92</link>
			</Cartoes>
		</Produto>
	</Produtos>
</Pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Informacoes.codPedido Numérico 7 O código de pedido gerado no sistema.
Informacoes.valorProdutos Texto 15 Soma do valor de todos os produtos do pedido.
Informacoes.valorFrete Texto 15 Valor total do frete.
Informacoes.valorTotal Texto 15 Soma do valor total dos produtos com o valor do frete.
Produtos.Produto.codigo Texto 6 Código (SKU) do produto solicitado.
Produtos.Produto.valor Texto 15 Valor total do produto.
Produtos.Produto.quantidade Numérico 2 Quantidade solicitada do produto.
Produtos.Produto.Cartoes.codigo Texto --- Código do cartão. Essa informação é exibida apenas para cartões pré-carregados e com estoque. Ausente nos Cartões físicos e virtuais com carga posterior. Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
Produtos.Produto.Cartoes.pin Texto --- Pin do cartão. Essa informação é exibida apenas para cartões pré-carregados e com estoque. Ausente nos Cartões físicos e virtuais com carga posterior. Nem todos os cartões pré-carregados precisam de Pin. Nesses casos, o campo Pin é vazio. Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
Produtos.Produto.Cartoes.qr_code Texto --- QR Code do código virtual. Essa informação é exibida apenas para cartões pré-carregados e com estoque. Ausente nos Cartões físicos e virtuais com carga posterior. Nem todos os cartões pré-carregados precisam de QR Code. Nesses casos, o campo QR Code é vazio. Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude. O QR Code é enviado apenas em vales em que o vale exige um QR Code e o código do QR Code é diferente do código principal do vale.
Produtos.Produto.Cartoes.link Texto --- Link para visualização do cartão. Essa informação é exibida apenas para cartões pré-carregados e com estoque. Ausente nos Cartões físicos e virtuais com carga posterior. Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
Tabela de erros:
Código Mensagem
00 00|Acesso Restrito. Entre em contato com o Departamento de TI
01 01|Dados Pessoais Ausentes
02 02|Dados de Endereço Ausentes
03 03|Dados de Endereço Principal Ausentes
04 04|Dados de Pagamento Ausentes
05 05|Dados de Produtos Ausentes
06 06|Código de Produto Ausente
07 07|Campo Tipo Pessoa em Dados Pessoais é Inválido ou Ausente
08 08|Campo Nome em Dados Pessoais é Inválido ou Ausente
09 09|Campo CPF em Dados Pessoais é Inválido ou Ausente
10 10|Campo Email em Dados Pessoais é Inválido ou Ausente
11 11|Campo Razão Social em Dados Pessoais é Inválido ou Ausente
12 12|Campo CNPJ em Dados Pessoais é Inválido ou Ausente
13 13|Campo Logradouro em Endereço Principal é Inválido ou Ausente
14 14|Campo Bairro em Endereço Principal é Inválido ou Ausente
15 15|Campo Cidade em Endereço Principal é Inválido ou Ausente
16 16|Campo Estado em Endereço Principal é Inválido ou Ausente
17 17|Campo CEP em Endereço Principal é Inválido ou Ausente
18 18|Campo DDD em Endereço Principal é Inválido ou Ausente
19 19|Campo Telefone em Endereço Principal é Inválido ou Ausente
20 20|Campo Logradouro em Endereço de Entrega Ausente
21 21|Campo Bairro em Endereço de Entrega Ausente
22 22|Campo Cidade em Endereço de Entrega Ausente
23 23|Campo Estado em Endereço de Entrega Ausente
24 24|Campo CEP em Endereço de Entrega Ausente
25 25|Campo Tipo de Logradouro em Endereço de Entrega Ausente
26 26|Campo Logradouro em Endereço de Entrega Ausente
27 27|Campo Bairro em Endereço de Entrega Ausente
28 28|Campo Cidade em Endereço de Entrega Ausente
29 29|Campo Estado em Endereço de Entrega Ausente
30 30|Campo CEP em Endereço de Entrega Ausente
31 31|Dados de Produtos Ausentes
32 32|Campo Código de Produto Inválido ou Ausente
33 33|Campo Quantidade de Itens Inválido ou Ausente
34 34|O código de produto informado é inválido
35 35|A quantidade de produtos informada é inválida
36 36|Pedido de Recarga sem DDD
37 37|Pedido de Recarga sem Telefone
38 38|Um ou mais produtos possuem informações inválidas
39 39|O CEP de entrega não é um CEP válido
40 40|Cartão Virtual C&A com quantidade maior que um
41 41|Erro ao Inserir o Pedido
42 42|A quantidade de produtos é maior do que o estoque disponível
43 43|A quantidade de produtos é maior do que o estoque disponível
44 44|Ocorreu um erro. Tente novamente em alguns instantes.
45 45|Produto não pertence ao catálogo informado.
46 46|CPF ou e-mail bloqueado.
47 47|Não autorizado.
48 48|O campo valor é obrigatório para este produto
49 49|Pedido não atinge valor mínimo para o produto
50 50|Pedido ultrapassa o valor máximo para o produto
51 51|Dados inconsistentes com o cadastro do produto. Entrar em contato com o departamento de TI.
52 52|Valor incompatível com o produto
53 53|O campo codigoCartao é obrigatório para este produto
54 54|Código de cartão inválido
55 55|Campo Complemento em Endereço Principal ultrapassa limite definido
56 56|Campo Complemento em Endereço de Entrega ultrapassa limite definido
57 57|Pedido Repetido (Opcional. Apenas para parceiros que optarem pela verificação de pedidos duplicados).
58 58|Resgate ultrapassa limite mensal do parceiro
59 59|Resgate ultrapassa limite mensal do projeto ZZZ
60 60|Quantidade máxima por CPF excedida.
(Quando houver limite definido)
61 61|Valor máximo por CPF excedido.
(Quando houver limite definido)
62 62|Resgate ultrapassa limite diário do projeto
(Quando houver limite definido)
Exemplo de retorno de erro:

<Pedido>
    <erros>1</erros>
    <mensagem>05|Dados de Produtos Ausentes</mensagem>
</Pedido>

3. Consultar Meus Pedidos

Método ConsultarMeusPedidos
Descrição Ao enviar o número do CPF do cliente e o código do projeto (fornecido pela Giftty), os dados do pedido são retornados.
Parâmetros a serem enviados String documento
Exemplo de entrada:

<Pedidos>
    <documento>03105649855</documento>
    <projeto>X95</projeto>
</Pedidos>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
documento Numérico 14 Sim O número do CPF ou CNPJ do cliente. Somente números (sem espaços, pontos, dígitos e barras).
projeto Alpha 3 Sim Código da campanha gerado pela Giftty.
Exemplo de retorno:

<?xml version="1.0" encoding="utf-8"?>
<Pedidos>
    <Pedido>
        <codPedido>9256457</codPedido>
        <data>30/08/2017</data>
        <Produtos>
            <item>6557044</item>
            <produto>CARTAO PRESENTE CEA TINTURADO</produto>
        </Produtos>
    </Pedido>
    <Pedido>
        <codPedido>9256456</codPedido>
        <data>30/08/2017</data>
        <Produtos>
            <item>6557043</item>
            <produto>CARTAO PRESENTE CEA TINTURADO</produto>
        </Produtos>
    </Pedido>
</Pedidos>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Pedido.codPedido Numérico 7 O código de pedido gerado no sistema.
Pedido.data Texto 10 A data de criação do Pedido.
Pedido.Produtos.produto Texto --- O nome do produto integrante do pedido.
Pedido Produtos.item Numérico 7 O código de item do pedido gerado no sistema.

4. Consultar Tracking

Método ConsultarTracking
Descrição Obtém o status de entrega do pedido. Consulta por codPedido ou codItem (item do Pedido). Campo código de projeto é opcional. Caso sejam enviados os dois códigos, a consulta retornará o Item do Pedido.
Parâmetros a serem enviados String "codigo"
Exemplo de Consulta por codPedido:

<Tracking>
    <codItem/>
    <codPedido>1872058</codPedido>
</Tracking>
Exemplo de Consulta por codItem:

<Tracking>
    <codItem>1172474</codItem>
    <codPedido/>
</Tracking>
Exemplo de Consulta com código de projeto:

<Tracking>
    <codItem>1172474</codItem>
    <projeto>F37</projeto>
</Tracking>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Tracking.codPedido Numérico 7 Sim O código de pedido gerado no sistema.
Tracking.codItem Numérico 7 Sim O código de item do pedido gerado no sistema.
Tracking.projeto Texto 3 Não Campo opcional. Parceiros que enviam pedidos com o campo opcional no serviço InserirPedido, devem enviar o mesmo código na hora de recuperar o tracking.
Exemplo de retorno:

<?xml version="1.0" encoding="UTF-8"?>
<Tracking>
    <Itens>
        <Item>
            <codPedido>2439307</codPedido>
            <codItem>1758956</codItem>
            <nome>Vale Presente O Boticario</nome>
            <codigoProduto>3472</codigoProduto>
            <status>Pedido entregue.</status>
            <dataPedido>05/07/2017</dataPedido>
            <dataEmbarque>Pedido embarcado em 11/07/2017</dataEmbarque>
            <dataRecebimento>13/07/2017</dataRecebimento>
            <rastreamento>AB98765432165</rastreamento>
            <observacoes>Entrega realizada com sucesso.</observacoes>
        </Item>
        <Item>
            <codPedido>2439307</codPedido>
            <codItem>1758957</codItem>
            <nome>VALE COMBUSTIVEL GOOD CARD</nome>
            <codigoProduto>3473</codigoProduto>
            <status>Pagamento efetuado e confirmado.</status>
            <dataPedido>05/07/2017</dataPedido>
            <dataEmbarque>Alocando produto.</dataEmbarque>
            <dataRecebimento>---</dataRecebimento>
            <rastreamento>AB98765432183</rastreamento>
            <observacoes>Aguardando embarque.</observacoes>
        </Item>	
    </Itens>
</Tracking>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Item.codItem Texto --- Identificação do item do pedido.
Item.codPedido Texto --- Identificação do pedido.
Item.nome Texto --- O nome do produto integrante do pedido.
Item.codigoProduto Texto --- Código (SKU) identificador do produto.
Item.status Texto --- O status atual do item no sistema.
Item.dataPedido Texto 10 A data de criação do pedido.
Item.dataEmbarque Texto --- A data de separação e empacotamento do item na logística.
Item.dataRecebimento Texto --- A data em que o cliente recebeu o item.
Item.rastreamento Texto --- Código de rastreamento do item enviado. Não disponível para vales virtuais.
Item.observacoes Texto --- Possíveis observações inseridas pelo atendimento, logística, financeiro sobre o item do pedido.
Status de resposta
Aguardando confirmação de pagamento de boleto.
Processando o pagamento.
Pagamento efetuado e confirmado.
Problema no processamento: confirmar endereço de entrega.
Problema no processamento: aguardando documentação ou informação adicional.
Pedido em rota de entrega.
Pedido entregue.
Pedido cancelado em dd/mm/yyyy.
Pedido suspenso.

5. Consultar Pedido Parceiro

Método ConsultarPedidoParceiro
Descrição Retorna dados do pedido do parceiro. Desejável que o parceiro realize esta consulta após Inserir Pedido, para confirmação da entrada do pedido.
Parâmetros a serem enviados String pedido
Exemplo de entrada:

<Pedido>
  <PedidoParceiro>123456</PedidoParceiro>
  <Campanha>Teste</Campanha>
</Pedido>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
PedidoParceiro Texto --- Sim Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Sim Identificação de Campanha enviada no serviço InserirPedido
Exemplo de retorno:

<Pedido>
  <codPedido>1885071</codPedido>
  <dataHora>2017-07-11 11:40:15</dataHora>
  <PedidoParceiro>123456</PedidoParceiro>
  <Campanha>Teste</Campanha>
</Pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
codPedido Texto --- Código de Pedido no sistema DirectShopping.
dataHora TimeStamp --- Data e Hora em que o pedido foi enviado ao serviço InserirPedido.
PedidoParceiro Texto --- Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Identificação de Campanha enviada no serviço InserirPedido
Exemplo de retorno com falha:

<Pedido>
  <erros>1</erros>
  <mensagem>Pedido não registrado!</mensagem>
</Pedido>

6. Inserir Pedido Recarga C&A

Método InserirPedidoRecargaCea
Descrição Solicita uma carga adicional a um cartão já emitido para o parceiro.
Parâmetros a serem enviados String xmlDados
Restrições Serviço disponível apenas para parceiros credenciados.
Exemplo de entrada:

<Pedido>
  <chave>5853cc7a1a8z2673ba641c0b7ad932197a0aea93</chave>
  <Itens>
    <Item>
      <numCartao>010000000053181032</numCartao>
      <valor>200</valor>
      <idPedido>641000005</idPedido>
    </Item>
  </Itens>
</Pedido>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
chave Texto 40 S Hash utilizado para identificação do parceiro.
numCartao Texto 17 S O número do cartão a ser carregado. São considerados apenas os 17 caracteres à direita.
valor Decimal S Valor da recarga. Decimais devem ser separados por . (ponto).
idPedido Texto 15 S Número de pedido do parceiro. Utilizado para controle de duplicidade do pedido.
Exemplo de retorno:

<?xml version="1.0" encoding="utf-8"?>
<pedido>
  <erros>0</erros>
  <Itens>
    <Item>
      <codPedido>2019040</codPedido>
      <numCartao>010000000053181032</numCartao>
      <valor>200</valor>
    </Item>
    <Item>
      <codPedido>2019041</codPedido>
      <numCartao>010000000053185694</numCartao>
      <valor>500</valor>
    </Item>
  </Itens>
</pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
erros Numérico 1 Informa se algum erro ocorreu no processo. 0 representa sucesso e 1 representa erro.
codPedido Numérico 7 Informa o código do pedido gerado na Direct Shopping.
numCartao Texto 17 Confirmação da numeração do cartão carregado.
valor Decimal Confirmação do valor do cartão carregado.
Tabela de erros:
Código do erro Mensagem enviada
00 Acesso Restrito. Entre em contato com o Departamento de TI!
01 Informações insuficientes para a criação do Pedido. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento.
02 Número de pedido 01234567 duplicado.
03 Um ou mais itens são inválidos. Cartão já utilizado. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento.
04 Um ou mais itens são inválidos. Cartão já utilizado. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento.
05 Um ou mais itens são inválidos. Tentativa de recarga duplicada. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento. - Cartão: 01234567890123456
06 Um ou mais itens são inválidos. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento . - Cartão: 01234567890123456
07 Um ou mais itens são inválidos. Cartão já utilizado. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento. - Cartão: 01234567890123456

8. Consultar Dados do Cartão Virtual

Método consultarDadosCartaoPedidoParceiro
Descrição Retorna todos os dados do pedido realizado, incluindo o código do cartão.
Parâmetros a serem enviados String pedido
Restrições Somente para parceiros credenciados.
Exemplo de entrada:

<Pedido>
  <Chave>5853cc7a1a8z2673ba641c0b7ad932197a0aea93</Chave>
  <PedidoParceiro>111222</PedidoParceiro>
  <Campanha>TESTE</Campanha>
</Pedido>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Chave Texto 40 Sim Hash utilizado para identificação do parceiro.
PedidoParceiro Texto --- Sim Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Sim Identificação de Campanha enviada no serviço InserirPedido
Exemplo de retorno:

<Pedido>
  <codPedido>2221346</codPedido>
  <dataHora>2015-02-28 12:00:00</dataHora>
  <pedidoParceiro>111222</pedidoParceiro>
  <campanha>TESTE</campanha>
  <produto>Virtual CEA</produto>
  <valor>1.00</valor>
  <frete>0.00</frete>
  <codigo>cbec7bb928345b6519c45864619cf65a8fd57562</codigo>
  <pin/>
  <qr_code/>
</Pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
codPedido Texto --- Código de Pedido no sistema DirectShopping.
dataHora TimeStamp --- Data e Hora em que o pedido foi enviado ao serviço InserirPedido.
PedidoParceiro Texto --- Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Identificação de Campanha enviada no serviço InserirPedido
Produto Texto --- Nome do item do pedido
Valor Decimal --- Valor do item do pedido (sem fretes ou taxas)
Frete Decimal --- Valor do frete do item do pedido
codigo Texto --- Código do cartão Virtual. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 111222 e a campanha TESTE sempre trará um código válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
pin Texto --- PIN do cartão Virtual. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado;
- Cartão não exige PIN.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 222333 e a campanha TESTE sempre trará um código com PIN válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
qr_code Texto --- QR Code do cartão Virtual. Utilizado apenas em vales em que o vale exige um QR Code e o valor gerador é diferente do código principal do vale. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado;
- Cartão não exige PIN.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 222333 e a campanha TESTE sempre trará um código com PIN válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
Exemplo de retorno com falha:

<Pedido>
  <erros>1</erros>
  <mensagem>Pedido não registrado!</mensagem>
</Pedido>

9. Consultar Estoque

Método ConsultarEstoque
Descrição Retorna a posição de estoque do cartão.
Parâmetros a serem enviados String ConsultarEstoque
Restrições Somente para parceiros credenciados.
Exemplo de entrada:

<Consulta>
  <chave>5853cc7a1a8z2673ba641c0b7ad932197a0aea93</chave>
  <Produto>593</Produto>
</Consulta>
Exemplo de entrada com projeto:

<Consulta>
  <chave>5853cc7a1a8z2673ba641c0b7ad932197a0aea93</chave>
  <Projeto>ZAX</Projeto>
  <Produto>593</Produto>
</Consulta>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
chave Texto --- Sim Chave do parceiro para identificação. Fornecido pela Giftty.
Projeto Texto --- Não Campo opcional, indicado apenas para contratos com particularidades específicas. Indica para qual projeto a consulta se destina.
Produto Texto --- Sim Id do produto a ser consultado.
Exemplo de retorno:

<Estoque>
  <Item>
    <produto>593</produto>
    <quantidade>1</quantidade>
    <preco>150.00</preco>
  </Item>
</Estoque>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
produto Texto --- Id do produto consultado
quantidade Texto --- Quantidade de cartões disponíveis do id especificado
preco Texto --- Preco do produto consultado

10. Consultar Frete

Método ConsultarFrete
Descrição Recebe o carrinho de compras e retorna o valor total de frete.
Parâmetros a serem enviados String ConsultarFrete
Restrições Somente para parceiros credenciados ou campanhas elegíveis.

Serviço Consultar Frete

Este serviço serve a casos específicos em que o preço do frete é definido de acordo com o tamanho e valor do pacote a ser enviado ao premiado.
Consulte a área de desenvolvimento da Giftty sobre a necessidade de integração com este serviço específico.

Exemplo de entrada:

<Produtos>
  <Produto>
    <codigo>91</codigo>
    <quantidade>4</quantidade>
  </Produto>
  <Produto>
    <codigo>100</codigo>
    <quantidade>6</quantidade>
  </Produto>
</Produtos>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
código Texto --- Sim Código (SKU) do produto desejado.
quantidade Texto --- Sim Quantidade desejada do produto.
Exemplo de retorno:

<?xml version="1.0" encoding="utf-8"?>
<Produtos>
  <Produto>
    <codigo>91</codigo>
    <quantidade>4</quantidade>
  </Produto>
  <Produto>
    <codigo>100</codigo>
    <quantidade>6</quantidade>
  </Produto>
  <FreteTotal>68,00</FreteTotal>
</Produtos>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
código Texto --- Código (SKU) do produto desejado.
quantidade Texto --- Quantidade desejada do produto.
FreteTotal Número Valor total do frete, calculado de acordo com a quantidade de ?pacotes necessários? e o frete fixo combinado.

11. Consultar Pedidos Entregues

Método ConsultarPedidosEntregues
Descrição Obtém tracking de todos os pedidos entregues nas últimas 24 horas.
Parâmetros a serem enviados String "codigo"
Exemplo de Consulta por projeto:

<Tracking>
        <projeto>F69</projeto>
</Tracking>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Tracking.projeto Texto 3 Sim Código do Projeto
Exemplo de retorno:

<?xml version="1.0" encoding="UTF-8"?>
<Tracking>
    <Itens>
        <Item>
            <codPedido>2439307</codPedido>
            <codItem>1758956</codItem>
            <nome>Vale Presente O Boticario</nome>
            <codigoProduto>3472</codigoProduto>
            <status>Pedido entregue.</status>
            <dataPedido>05/07/2017</dataPedido>
            <dataEmbarque>Pedido embarcado em 11/07/2017</dataEmbarque>
            <dataRecebimento>13/07/2017</dataRecebimento>
            <observacoes>Entrega realizada com sucesso.</observacoes>
        </Item>
        <Item>
            <codPedido>2439307</codPedido>
            <codItem>1758957</codItem>
            <nome>VALE COMBUSTIVEL GOOD CARD</nome>
            <codigoProduto>3473</codigoProduto>
            <status>Pagamento efetuado e confirmado.</status>
            <dataPedido>05/07/2017</dataPedido>
            <dataEmbarque>Alocando produto.</dataEmbarque>
            <dataRecebimento>---</dataRecebimento>
            <observacoes>Aguardando embarque.</observacoes>
        </Item>	
    </Itens>
</Tracking>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Item.codItem Texto --- Identificação do item do pedido.
Item.codPedido Texto --- Identificação do pedido.
Item.nome Texto --- O nome do produto integrante do pedido.
Item.codigoProduto Texto --- Código (SKU) identificador do produto.
Item.status Texto --- O status atual do item no sistema.
Item.dataPedido Texto 10 A data de criação do pedido.
Item.dataEmbarque Texto --- A data de separação e empacotamento do item na logística.
Item.dataRecebimento Texto --- A data em que o cliente recebeu o item.
Item.observacoes Texto --- Possíveis observações inseridas pelo atendimento, logística, financeiro sobre o item do pedido.
Status de resposta
Aguardando confirmação de pagamento de boleto.
Processando o pagamento.
Pagamento efetuado e confirmado.
Problema no processamento: confirmar endereço de entrega.
Problema no processamento: aguardando documentação ou informação adicional.
Pedido em rota de entrega.
Pedido entregue.
Pedido cancelado em dd/mm/yyyy.
Pedido suspenso.

12. Consultar Pedidos Bounce

Método ConsultarPedidosBounce
Descrição Retorna todos os pedidos virtuais com falha no envio. Os pedidos são exibidos apenas até tratamento e solução do problema.
Parâmetros a serem enviados String "codigo"
Exemplo de Consulta por projeto:

<Tracking>
        <projeto>F69</projeto>
</Tracking>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Tracking.projeto Texto 3 Sim Código do Projeto
Exemplo de retorno:

<?xml version="1.0" encoding="UTF-8"?>
<Tracking>
    <Itens>
        <Item>
            <codPedido>2552206</codPedido>
            <codItem>1898259</codItem>
            <nome>VALE PRESENTE VIRTUAL SARAIVA</nome>
            <codigoProduto>3557</codigoProduto>
            <status>soft-bounced</status>
            <dataPedido>07/03/2018</dataPedido>
            <dataEmbarque>Pedido embarcado em 09/03/2018</dataEmbarque>
            <observacoes>invalid_domain</observacoes>
            <email>direct@JBSEG.COM.BR</email>
        </Item>
        <Item>
            <codPedido>2559783</codPedido>
            <codItem>1912385</codItem>
            <nome>VALE PRESENTE VIRTUAL NETSHOES</nome>
            <codigoProduto>3534</codigoProduto>
            <status>bounced</status>
            <dataPedido>12/03/2018</dataPedido>
            <dataEmbarque>Pedido embarcado em 14/03/2018</dataEmbarque>
            <observacoes>bad_mailbox - smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.</observacoes>
            <email>direct-shopping@gmail.com</email>
        </Item>
        <Item>
            <codPedido>2512348</codPedido>
            <codItem>1123452</codItem>
            <nome>VALE PRESENTE VIRTUAL OUTBACK</nome>
            <codigoProduto>3716</codigoProduto>
            <status>bounced</status>
            <dataPedido>12/03/2018</dataPedido>
            <dataEmbarque>Pedido embarcado em 14/03/2018</dataEmbarque>
            <observacoes>bad_mailbox - smtp;550 5.1.1 unknown or illegal alias: direct.shopping@superig.com.br</observacoes>
            <email>direct.shopping@superig.com.br</email>
        </Item>
    </Itens>
</Tracking>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Item.codItem Texto --- Identificação do item do pedido.
Item.codPedido Texto --- Identificação do pedido.
Item.nome Texto --- O nome do produto integrante do pedido.
Item.codigoProduto Texto --- Código (SKU) identificador do produto.
Item.status Texto --- O status atual do item no sistema.
Item.dataPedido Texto 10 A data de criação do pedido.
Item.dataEmbarque Texto --- A data de separação e empacotamento do item na logística.
Item.observacoes Texto --- Detalhamento do tipo de bounce Todas as informações repassadas pelo servidor a respeito da falha do envio.
Item.email Texto --- Email do destinatário do vale.
Status de resposta
bounced
soft-bounced
rejected
Observações
bad_mailbox
general
invalid_domain
mailbox_full

13. Liberar Pedido Anti Fraude

Método LiberarPedidoAntiFraude
Descrição Confirma a liberação de um pedido retido pelo sistema anti-fraude.
Parâmetros a serem enviados String "xmlDados"
Exemplo de Requisição:

<Pedido>
    <codPedido>2807032</codPedido>
</Pedido>
Descrição dos parâmetros de entrada:
codPedido
codPedido Texto 3 Sim Pedido gerado anteriormente no serviço InserirPedido.
Exemplo de retorno:

<?xml version="1.0" encoding="utf-8"?>
<Pedido>
    <erros>0</erros>
    <Informacoes>
        <codPedido>2807032</codPedido>
        <valorProdutos>50.00</valorProdutos>
    </Informacoes>
    <Produtos>
        <Produto>
            <codigo>107</codigo>
            <valor>50.00</valor>
            <quantidade>1</quantidade>
        </Produto>
    </Produtos>
</Pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
Informacoes.codPedido Numérico 7 O código de pedido gerado no sistema.
Informacoes.valorProdutos Texto 15 Soma do valor de todos os produtos do pedido.
Informacoes.valorFrete Texto 15 Valor total do frete.
Informacoes.valorTotal Texto 15 Soma do valor total dos produtos com o valor do frete.
Produtos.Produto.codigo Texto 6 Código (SKU) do produto solicitado.
Produtos.Produto.valor Texto 15 Valor total do produto.
Produtos.Produto.quantidade Numérico 2 Quantidade solicitada do produto.

14. Reenviar Vale Virtual

Método ReenviarValeVirtual
Descrição Reenvia vale virtual para o premiado. Permite alteração do destinatário do vale virtual..
Parâmetros a serem enviados String "xmlDados"
Exemplo de Requisição:


<Pedido>
    <chave>5853cc7a1a8a2673ba641c0b7ad972197a0aea23</chave>
    <codItem>2147483646</codItem>
    <email>rudney@dshop.com.br</email>
</Pedido>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
chave Texto --- Sim Chave do parceiro para identificação. Fornecido pela Giftty.
codPedido Numérico 7 Não Número do pedido gerado anteriormente no serviço InserirPedido. Caso este parâmetro esteja presente, não enviar o parâmetro codItem.
codItem Numérico 7 Não Item de um pedido gerado anteriormente. Pode ser recuperado através do serviço Meus Pedidos. Caso este parâmetro esteja presente, não enviar o parâmetro codPedido.
email Texto --- Não Novo e-mail do destinatário do vale virtual. Caso este parâmetro não seja utilizado ou esteja vazio, o destinatário do vale presente não será alterado.

Parâmetro codPedido

Caso tenha sido utilizada o parâmetro codPedido e o pedido em questão possuir mais de um vale virtual, todos os vales virtuais do pedido serão reenviados. Caso precise reenviar apenas um único vale virtual, utilize o parâmetro codItem

Exemplo de retorno:


<Pedido>   
    <codPedido>9464088</codPedido>   
    <Itens>       
        <codItem>2147483646</codItem>
    </Itens>
</Pedido>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
codPedido Numérico 7 Confirmação do pedido reenviado.
Itens.codPedido Numérico 7 Itens do pedido que foram reenviados. Caso tenha sido utilizado o parâmetro codPedido na requisição, serão reenviados todos os vales virtuais presentes no pedido. Todos os itens listados no parâmetro Itens tiveram seu reenvio confirmado.

16. Consultar Dados do Cartão Virtual 2

Método consultarDadosCartaoPedidoParceiro2
Descrição Retorna todos os dados do pedido realizado, incluindo o código do cartão.
Parâmetros a serem enviados String pedido
Restrições Somente para parceiros credenciados.
Exemplo de entrada:

<Pedido>
  <Chave>5853cc7a1a8z2673ba641c0b7ad932197a0aea93</Chave>
  <PedidoParceiro>111222</PedidoParceiro>
  <Campanha>TESTE</Campanha>
</Pedido>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Chave Texto 40 Sim Hash utilizado para identificação do parceiro.
PedidoParceiro Texto --- Sim Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Sim Identificação de Campanha enviada no serviço InserirPedido
Exemplo de retorno:

<Pedidos>
	<Pedido>
		<codPedido>99945698</codPedido>
		<codItem>990396057</codItem>
		<dataHora>2023-03-12 23:57:10</dataHora>
		<pedidoParceiro>ABCDEFGH</pedidoParceiro>
		<campanha>ABC</campanha>
		<produto>Crédito de Combustível Shell Box</produto>
		<valor>15.00</valor>
		<frete></frete>
		<codigo>6d60e7abcdefghij4f7dd0d4b98fa</codigo>
		<pin>9e9967972087abcdefghij0e633bcce6</pin>
		<qr_code>9e99679abcdefghij61e500e633bcce6</qr_code>
	</Pedido>
	<Pedido>
		<codPedido>99945699</codPedido>
		<codItem>990396058</codItem>
		<dataHora>2023-03-12 23:57:10</dataHora>
		<pedidoParceiro>ZYXWVUTSR</pedidoParceiro>
		<campanha>ABC</campanha>
		<produto>Crédito de Combustível Shell Box</produto>
		<valor>10.00</valor>
		<frete></frete>
		<codigo>02e82babcdefghij9e0846b8f0bc3d6c</codigo>
		<pin>9e99679720abcdefghij500e633bcce6</pin>
		<qr_code>9e9967abcdefghije61e500e633bcce6</qr_code>
	</Pedido>
</Pedidos>>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
codPedido Texto --- Código de Pedido no sistema DirectShopping.
codItem Texto --- Código de item no sistema DirectShopping.
dataHora TimeStamp --- Data e Hora em que o pedido foi enviado ao serviço InserirPedido.
PedidoParceiro Texto --- Código de Pedido do Parceiro enviado no serviço InserirPedido
Campanha Texto --- Identificação de Campanha enviada no serviço InserirPedido
Produto Texto --- Nome do item do pedido
Valor Decimal --- Valor do item do pedido (sem fretes ou taxas)
Frete Decimal --- Valor do frete do item do pedido
codigo Texto --- Código do cartão Virtual. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 111222 e a campanha TESTE sempre trará um código válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
pin Texto --- PIN do cartão Virtual. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado;
- Cartão não exige PIN.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 222333 e a campanha TESTE sempre trará um código com PIN válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
qr_code Texto --- QR Code do cartão Virtual. Utilizado apenas em vales em que o vale exige um QR Code e o valor gerador é diferente do código principal do vale. Essa informação pode vir em branco nos casos:
- Carga em processamento;
- Pedido cancelado;
- Cartão não exige PIN.
Esse serviço somente fornece informações de pedidos que efetivamente entraram em nosso sistema e foram processados. É possível que em ambiente de testes, ainda não haja nenhum pedido real de cartões virtuais. Para testes, o código de parceiro 222333 e a campanha TESTE sempre trará um código com PIN válido, que pode ser usado como parâmetro durante o desenvolvimento da integração.
Como o cartão é ao portador, implementamos a criptografia AES-128 CBC1 para transmitir essa informação de modo seguro com o intuito da prevenção à fraude.
Exemplo de retorno com falha:

<Pedido>
  <erros>1</erros>
  <mensagem>Pedido não registrado!</mensagem>
</Pedido>

17. Consultar Limites e Resgates

Método consultarLimitesResgates
Descrição Retorna limite mensal pré-definido e total de resgates dos últimos 30 dias, por Cliente ou por Projeto.

OBS: Os valores resgatados são totalizados periodicamente, algumas vezes ao dia. O valor retornado pode não ser o mais atualizado.
Parâmetros a serem enviados String dados
Restrições Somente para parceiros credenciados.
Exemplo de entrada:

<Dados>
    <Projeto>ZZZ</Projeto>
    <Chave>6f3a3cd53647727c07241b5a511dd429dd98db1a</Chave>
</Dados>
Descrição dos parâmetros de entrada:
Nome Tipo Tamanho Obrigatório Observações
Chave Texto 40 Sim Hash utilizado para identificação do parceiro.
Projeto Texto --- Não Retorna o limite mensal pré-definido para um projeto específico. Também retorna os resgates totais apenas desse projeto. Se esse campo não for enviado, ou estiver vazio, retornaremos o limite pré-definido para o cliente (se definido) e o total de resgates dos últimos 30 dias, totalizando todos os projetos.
Exemplo de retorno:

<Dados>
    <limite>0,00</limite>
    <resgates>50,00</resgates>
</Dados>
Descrição dos parâmetros de retorno:
Nome Tipo Tamanho Observações
limite Número --- Limite pré-definido para resgates.
resgates Número --- Total de resgates realizados nos últimos 30 dias (para o cliente ou para o projeto, de acordo com parâmetros enviados).
Exemplo de retorno com falha:

<Dados>
    <erros>1</erros>
    <mensagem>Informações insuficientes para a consulta do Limites. Por favor, verifique as informações obrigatórias no Manual de Desenvolvimento.</mensagem>
</Dados>

Criptografia

Informações sobre campos criptografados

A criptografia AES-128 CBC permite que o destinatário de uma informação restaure-a através de uma chave, conhecida somente por ele.

O processo de criptografia se resume a:

  • Obter a informação que se deseja criptografar;
  • Criptografar através de um algoritmo;
  • Obter o dado binário resultante desse processo;
  • Converter para uma informação hexadecimal.

Em PHP, a função "openssl_encrypt" faz, de forma simples, a criptografia dos dados:


<php
$dado_a_criptografar = bin2hex( $dado_a_criptografar_bin );
$dado_criptografado = openssl_encrypt(	$dado_a_criptografar, 
										'AES-128-CBC', 
										'23d854ce7364b4f7', 
										OPENSSL_RAW_DATA, 
										'23d854ce7364b4f7' );
?>

O dado recebido é um hexadecimal que representa a informação a ser restaurada.

Para restaurar a informação recebida, devem ser feitos os seguintes procedimentos:

  • Converter o dado recebido para uma informação binária;
  • Usar algoritmo capaz de restaurar dados criptografados em AES-128 CBC;
  • Obter os 16 primeiros caracteres da sua chave de acesso ao serviço;
  • Utilizar esses caracteres como "chave" e "IV" (Initialization Vector).

Em PHP, usamos a função "openssl_decrypt", que realiza a restauração dos dados:


<?php
$dado_criptografado = hex2bin( $dado_criptografado_hex );
$dado_restaurado = openssl_decrypt( $dado_criptografado,
                                    'AES-128-CBC',
                                    '23d854ce7364b4f7',
                                    OPENSSL_RAW_DATA,
                                    '23d854ce7364b4f7');
?>

A chave (password) mostrada na imagem tem propósito apenas ilustrativo. Será definida uma nova chave para cada campanha.

Links adicionais:

Recomendações

Seguem algumas recomendações para o desenvolvimento da integração:

CDATA

Todo o código XML a ser enviado para o web service Giftty deve ser encapsuplado utilizando Character Data (CDATA). Ex: 

<![CDATA[ seu trecho de código XML ]]>
As respostas em XML no serviço sempre são encapsuladas por CDATA.

Encoding

O serviço realiza o encoding para UTF8 dos textos. É necessário realizar o decode dos textos para exibir as acentuações corretamente.
Ex: Em php, utilizar utf8_decode: 

utf8_decode

Documentação WS Giftty para desenvolvedores.