Os próximos passos irão detalhar a sequência lógica de integração com a API do Marketplace da Via Varejo. Algumas informações podem ser úteis antes de iniciar as integrações, como:
Importação de produtos com a API V4
Através da API versão 4 modificamos o fluxo de integração de ofertas no marketplace com o intuito de aumentar a qualidade das informações do produto, melhorando os motores de busca, experiência do usuário e tempo para catalogação.
Diversos conceitos presentes nas versões anteriores foram remodelados como, por exemplo, o conceito de carga. O conceito de carga é um agrupamento de itens (SKUs) enviado para o cadastro na Via Varejo que somente é efetivado caso todos os SKUs estejam válidos, ou seja, se a carga possuir 1000 SKUs e 1 estiver inválido, toda a carga será cancelada. Logo, estamos ignorando os 999 SKUs pois um está inválido. Nessa nova versão, o conceito foi alterado para que cada operação seja feita por SKU, mesmo que você envie um lote maior, visando o cadastro rápido e efetivo.
Cadastro de produto simples
O cadastro de produto simples é feito com somente um SKU (Stock keeping Unit). Ou seja, não há variação de um produto simples.
Cadastro de produto variante
O cadastro de um produto variante possui duas ou mais variações. As variações são necessárias quando o produto necessita de uma escolha como, por exemplo, o tamanho de uma camisa (P, M e G).
Confira abaixo como trabalhar com a nossas APIs (Documentação técnica logo abaixo).
• Clique aqui para conferir o guia de boas práticas de uso da API V4.
• Clique aqui para conferir como trabalhar com nossa árvore de categorias da API V3.
• Clique aqui para conferir como cadastrar um produto com única variante ou mais pela API V4.
Controle dos itens de venda
API utilizada para alteração de ofertas dos produtos com status 'Ficha Integrada', ou seja, de produtos cadastrados e aprovados do marketplace.
Após o envio e aprovação da ficha (Ficha Integrada), os produtos deverão ser listados como itens de venda para serem ofertados nas 3 bandeiras (Casas Bahia, Ponto Frio e Extra.com). Para realizar a manutenção da oferta, basta seguir os itens abaixo:
Atualização de preços;
Atualização de estoques;
Atualização de status do produto (ativo e inativo), disponibilizando ou removendo da comercialização;
Explore todos os detalhes dessa API.
Controle e atualizações de tracking de pedidos
API utilizada para atualizações de status de pedidos gerados nos portais de vendas (Casas Bahia, Ponto Frio e Extra.com)
Explore todos os detalhes dessa API.
Além disso, é possível receber de maneira automática notificações de novos pedidos e atualizações de seus status, até aprovação do pagamento ou cancelamento (Importante: após aprovação, é de responsabilidade do lojista prosseguir com as atualizações de status - sendo estes status não notificados através do callback).
Criação de ordens em Produção
As ordens de venda são notificadas ao Marketplace pelo portal onde a venda foi realizada.
Dessa forma, sua aplicação deve estar preparada para fazer a consulta dessas ordens.
Criação de ordens em Sandbox
Para o ambiente de sandbox, você mesmo deverá simular a criação de ordens.
Isso pode ser realizado através de uma operação exclusiva do ambiente de sandbox.
Fluxo de status de pedidos
Os pedidos passarão ou poderão passar pelos seguintes fluxos e status:
Visão macro
PEN = Pendente de pagamento
PAY = Pagamento aprovado
RIN = Nota fiscal cadastrada
PRI = Nota fiscal parcialmente cadastrada
SHP = Enviado
PSH = Parcialmente enviado
DLV = Entregue
PDL = Parcialmente entregue
DVC = Devolução concluída
CAN = Cancelado
Visão micro - por SKU
PEI = Pedido incluso
ACR = Análise de dados
CAN = Entrega cancelada
AAP = Aguardando a confirmação do pagamento
PAP = Pagamento aprovado
NFS = Nota Fiscal emitida
ETQ = Etiqueta gerada (Exclusivo do Envvias)
ETR = Entrega em andamento
TRF = Em Transferência
ROT = Em Rota de Entrega
ENT = Entrega concluída
DVC = Pedido Devolvido
Criação e aprovação de pedidos em sandbox
Para o ambiente de sandbox, você mesmo deverá simular a criação de pedidos, uma vez que o ambiente de teste não possui integração direta e não reflete no ambiente Produção (consequentemente, não possui pedidos gerado nos sites de comercialização).
Importante atentar-se a este fluxo para completa simulação de passos do marketplace, cabendo a necessidade da criação de pedido e realizar a aprovação de pagamento manual do mesmo, uma vez que a ação não é provido automaticamente como em produção.
Eventos para Serviços de URLs integradas disponíveis
Eventos de notificação - Callback de Pedidos
As notificações de eventos devem ser processadas de forma assíncrona pelo lojista ou integrador
O Marketplace realiza o reenvio do evento caso sua aplicação esteja indisponível. São realizadas 5 tentativas e, não havendo sucesso, o envio do evento é cancelado.
Recomendamos que, duas ou três vezes ao dia, sejam realizadas consultas nos serviços que você aguarda receber eventos. Por exemplo, consultando a lista de pedidos novos (GET /orders/status/new) duas vezes ao dia, é possível garantir que, caso tenha ocorrido alguma falha no envio de evento de um novo pedido, o mesmo não deixará de ser integrado no seu sistema.
Os eventos são apenas notificações. Para obter as informações é necessário buscá-las no serviço relacionado ao evento recebido (o recurso fica disponível no campo uriResource)
Para obter maiores detalhes sobre como funciona o evento de notificação, acesse a documentação.
Para processo de como realizar a configuração da URL Callback de pedidos e maiores informações que serão fornecidas, acessar a documentação de eventos de notificação.
Reserva de estoque
A URL de Reserva de estoque tem como função comunicar a reserva de um determinado SKU para que a ferramenta de gestão de estoque do lojista (integradora/ ERP) consiga movimentar o estoque corretamente. Esta comunicação assegura a reserva do SKU e garante o envio de todos os produtos vendidos no marketplace.
Para maiores informações explicativas de uso e configurações, acessar a documentação.
Frete
A URL de Frete é um serviço de consulta, em tempo real, do preço e prazo de um frete para um determinado produto. A implementação dessa operação deverá permitir a consulta do frete de um ou mais produtos para um CEP específico, de acordo com os parâmetros passados na URL.
Para maiores informações de configurações, acessar a documentação.
Operações de CRUD
Operações de CRUD
No Recurso Raiz, podemos acessar as principais operações do serviço (CRUD), através dos métodos do padrão HTTP, conforme tabela abaixo:
CRUD |
Métodos HTTP |
Create |
POST |
Read |
GET |
Update |
PUT |
Delete |
DELETE |