Market Base de Conhecimento

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. Com ele utilize filas descritas abaixo para efetuar a integração:

Autenticação

Solicite um usuário e senha do Market Gestor, com permissão para o módulo Market Integração.  Com ele utilize a URL abaixo para obter o token de acesso ao serviço:

POST {{url}}v1/sistema/usuarios/autenticacao

Content-Type: application/json

{

"login": "USUARIO",

"password": "SENHA"

}


 

 

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})
  3. Utilize o DELETE para remover o produto da fila de pendências: Envie nessa URL o mesmo objeto obtido no item 1

Exemplo:

### consultar fila de sincronização com o CADASTRO alterado

GET {{url}}produtos/fila/cadastro

Authorization: Bearer {{token}}

 

### Marcar o produto como sincronizado removendo ele da fila até a próxima alteração em seu cadastro. DEVE SER ENVIADO O MESMO RETORNO DA FILA

DELETE {{url}}produtos/fila/cadastro

Content-Type: application/json

Authorization: Bearer {{token}}

{

"produtoId": 33796,

"ultimaAlteracao": "2025-03-19T14:23:00.297074"

}

 

 

Fila - Imagem

Na seção fila está a documentação para interagir com os itens pendentes de sincronização da imagem. 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 a imagem do produto: Quando o produto estiver pendente nessa fila, isso indica que pode ter havido alterações nos seguintes atributos:
    1. Imagem: ( URL: /produtos/{id}/imagem)
  3. Utilize o DELETE para remover o produto da fila de pendências: Envie nessa URL o mesmo objeto obtido no item 1

Exemplo:

### consultar fila de sincronização com A IMAGEM alterado

GET {{url}}produtos/fila/imagem?SomenteAtivos=true

Authorization: Bearer {{token}}

 

### Marcar o produto como sincronizado removendo ele da fila até a próxima alteração na IMAGEM. DEVE SER ENVIADO O MESMO RETORNO DA FILA

DELETE {{url}}produtos/fila/imagem

Content-Type: application/json

Authorization: Bearer {{token}}

{

"produtoId": 34534,

"ultimaAlteracao": "2024-12-14T11:29:44.302554"

}

 

Fila - Preço

Os preços dos produtos no sistema Market Gestor é enviado para as lojas após um processo de geração de preço, após esse mesmo processo os preços ficam disponíveis nessa fila para integração.

  1. Utilize o GET para obter os preços pendentes: Esta consulta é por pacote, utilize os parâmetros page e pageSize para navegar entre os registros.
  2. Sincronize o preço: Quando o produto estiver pendente nessa fila, isso indica que pode ter havido alterações nos seguintes atributos:
    1. 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

 

Exemplo:

### consultar fila de sincronização com o PREÇO alterado

GET {{url}}produtos/fila/preco?SomenteAtivos=true

Authorization: Bearer {{token}}

 

### Marcar o produto como sincronizado removendo ele da fila até a próxima alteração em seu preço. DEVE SER ENVIADO O MESMO RETORNO DA FILA

DELETE {{url}}produtos/fila/preco

Content-Type: application/json

Authorization: Bearer {{token}}

{

"produtoId": 33368,

"ultimaAlteracao": "2025-02-17T09:35:46.689886"

}

 

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

Exemplo:

### consultar fila de sincronização com o ESTOQUE alterado

GET {{url}}produtos/fila/estoque?SomenteAtivos=true

Authorization: Bearer {{token}}

 

### Marcar o produto como sincronizado removendo ele da fila até a próxima alteração em seu preço. DEVE SER ENVIADO O MESMO RETORNO DA FILA

DELETE {{url}}produtos/fila/estoque

Content-Type: application/json

Authorization: Bearer {{token}}

{

"produtoId": 34222,

"ultimaAlteracao": "2025-04-07T16:32:36.214515"

}

 

Fila - Clientes

Para consultar os clientes vinculados ao seu vendedor utilize o exemplo abaixo:

### consultar clientes

GET {{url}}vendedores/clientes

Authorization: Bearer {{token}}

Se for necessário manter localmente os dados do cliente é possível controlar por meio dessa fila se teve alterações no cadastro do cliente.

Para consultar os itens da fila e remover utilize o exemplo abaixo:

### consultar fila de sincronização com o CADASTRO alterado

GET {{url}}clientes/fila/cadastro

Authorization: Bearer {{token}}

 

### Marcar o cliente como sincronizado removendo ele da fila até a próxima alteração em seu cadastro. DEVE SER ENVIADO O MESMO RETORNO DA FILA

DELETE {{url}}clientes/fila/cadastro

Content-Type: application/json

Authorization: Bearer {{token}}

{

"clienteId": 70512,

"ultimaAlteracao": "2025-05-09T11:59:05.630042"

}

 

 

 

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, mas já vai estar vinculado ao seu usuário.

 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 as listas de preços do vendedor ou as listas disponíveis para um determinado cliente:

Listas de preços do vendedor

Todo vendedor pode possuir diversas listas de preços, para mais informações consulte a seção Preço da documentação.

Exemplo:

### consultar listas de preços que o vendedor pode utilizar

GET {{url}}vendedores/precos

Authorization: Bearer {{token}}

 

### consultar lista de preços do vendedor

GET {{url}}precos?ListaPrecoId=LJ1

Authorization: Bearer {{token}}

 

 

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 mais informações consulte a seção Preço da documentação.

Exemplo:

### consultar clientes vinculados ao vendedor com suas listas de preços e planos de pagamento disponíveis

GET {{url}}vendedores/clientes

Authorization: Bearer {{token}}

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 pedido estiver na situação 3 já poderá ser consultado o documento fiscal dele em /pedidos/{id}/docfiscal

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

 

Preço nos concorrentes. 

Para saber mais sobre a integração da cotação de preços nos concorrentes clique aqui.

 

 

Gestor \ Integração

Escrito por Josué Diniz Lourenço e revisado por Matheus Leandro Ferreira em 04/06/2025.

Artigos relacionados

Configurando e-commerce integrado diretamente com o Market Gestor.

Integração com e-commerce

Como cadastrar fotos dos produtos com imagens online

Como ter acesso aos documentos fiscais via API?

Como faço para loja não aparecer na consulta de venda em tempo real?

Vídeos da Market

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