Manual do integrador

Nota: Este manual já parte do princípio que você como integrador já possui um usuário, senha de acesso e o endereço da API de integração com o Market Gestor. Caso ainda não possua, entre em contato com o suporte da Market.

 

Ao acessar o endereço da API você ira visualizar a documentação, conforme exemplo abaixo:

O primeiro processo que você deve fazer é obter o seu token de acesso, utilizando o seu usuário e senha, para isso utilize a seção Autenticação. Com ele utilize filas descritas abaixo para efetuar a integração:

Fila - Cadastro

Na seção fila está a documentação para interagir com os itens pendentes de sincronização do cadastro. Realize os seguintes passos para a integração:

  1. Utilize o GET para obter os produtos pendentes: Esta consulta é por pacote, utilize os parâmetros page e pageSize para navegar entre os registros.
  2. Sincronize o produto: Quando o produto estiver pendente nessa fila, isso indica que pode ter havido alterações nos seguintes atributos:
    1. Cadastro básico (URL: /produtos/{id})
    2. Imagem: ( URL: /produtos/{id}/imagem)
    3. Preços: (URL: /produtos/{id}/preco)
  3. Utilize o DELETE para remover o produto da fila de pendências: Envie nessa URL o mesmo objeto obtido no item 1

Fila - Estoque

O estoque no sistema Market Gestor é atualizado em tempo real, por esse motivo ele sofre alterações com uma frequência muito maior que o cadastro, dessa forma temos uma fila exclusiva para o saldo. 

Realize os seguintes passos para a integração:

  1. Utilize o GET para obter os produtos pendentes: Esta consulta é por pacote, utilize os parâmetros page e pageSize para navegar entre os registros.
  2. Sincronize o estoque do produto: Quando o produto estiver pendente nessa fila, isso indica que pode ter havido alterações nos seguintes atributos:
    1. Estoque (URL: /produtos/{id}/estoque)
  3. Utilize o DELETE para remover o produto da fila de pendências: Envie nessa URL o mesmo objeto obtido no item 1

 

Vendedor

 Chamamos de vendedor a empresa de e-commerce que irá integrar com o Market Gestor, exemplo Bis2Bis, iFood, Mercado Livre. Cada vendedor terá um cadastro prévio no sistema Market Gestor e seus dados podem ser obtidos na seção Vendedor da documentação.

 Preços

O sistema trabalha com listas de preços, durante a integração com o cadastro do produto o que é obtido são listas de preços. Para saber qual lista de preço deve ser utilizada, consulte a lista de preço padrão para o vendedor ou as listas disponíveis para um determinado cliente:

Lista de preços padrão do vendedor

Todo vendedor possui uma lista de preços padrão que pode ser obtida na URL "/vendedores/{id}/precos" para mais informações consulte a seção Preço da documentação.

Listas de preços adicionais para o cliente 

Um determinado cliente pode possuir listas de preços adicionais, liberadas previamente para ele em seu cadastro. Para consultar quais são essas listas utilize a URL "/vendedores/{id}/clientes/{cpfcnpj} " para mais informações consulte a seção Preço da documentação.

Note que é retornado uma lista para cada loja, utilize a lista apropriada para cada loja.

Plano de pagamento

No tópico acima vimos como obter uma lista de preços, junto com cada lista terá o plano de pagamento. Ele deverá ser informado no momento de lançar o pedido e também tem uma informação muito importante, se a mercadoria será paga na entrega. 

Quando o atributo "PagoNaEntrega" não estiver habilitado, não crie o pedido sem ter a confirmação do pagamento.

Note que cada lista de preços possui um plano de pagamento, dessa forma não misture itens com planos de pagamento diferentes, visto que eles deverão ser enviados em pedidos separados nesse caso.

Pedido

Na seção "Pedido" da documentação, note que os pedidos só podem ser criados ou cancelados. 

Criando um pedido

Ao criar um novo pedido será necessário informar os dados cadastrais de um cliente, como por exemplo seu endereço de entrega. Caso não exista ainda um cadastro para o cliente isso será feito automaticamente. O pedido possui um atributo chamado "Situacao", para acompanhar o seu andamento, os possíveis valores são:

1 - Em análise(1 / 3)

2 - Pronto para separação(2 / 3)

3 - Separado e encaminhado para entrega(3 / 3)

99 - Cancelado

Quando o plano de pagamento não for pago na entrega, após criar o pedido ele já vai ficar com a situação "2 - Pronto para separação(2 / 3)".

 

Cancelando um pedido

Utilize a requisição DELETE, conforme a documentação, para cancelar o pedido. 

Não é permitido cancelar um pedido que já esteja nas seguintes situações:

3 - Separado e encaminhado para entrega(3 / 3)

99 - Cancelado

 

 

 


Gestor \ Integração

Escrito por Josué Diniz Lourenço e revisado por Matheus Leandro Ferreira em 18/09/2021.


Link público: www.conhecimento.market.com.br/artigo/596