API V1 - Hub de Marketplaces

Para começar a desenvolver a integração do seu sistema com o Hub de Marketplaces, você precisará de uma conta no ambiente sandbox, para que possa testar todos os recursos disponíveis na API antes de ir para produção.

Clique no botão abaixo e solicite a sua conta no ambiente sandbox.

Assim que finalizar os testes, você deverá solicitar a homologação de sua aplicação preenchendo o formulário com as evidências das funcionalidades integradas. Em seguida, o nosso time de suporte irá analisar as informações enviadas e, caso esteja tudo certo, sua aplicação será homologada e você receberá o AppToken de produção, que deverá ser utilizado para integrar todos os sellers de seu sistema em produção.

O processo de homologação será feito apenas uma vez e, a partir da homologação, sua aplicação estará apta a trabalhar em produção.

Caso sua aplicação esteja em produção e muitos erros forem reportados, você poderá ter seu AppToken revogado e terá que passar novamente pelo processo de homologação

Clique no botão abaixo para solicitar a homologação da sua integração.

Os ambientes de produção e homologação são dividos e podem ser acessados pelas URLs abaixo:

Sandbox

• API: https://omni.sandbox.wapstore.com.br/omni-api
• Portal: https://omni.sandbox.wapstore.com.br

Produção

• API: https://omni.wapstore.com.br/omni-api
• Portal: https://omni.wapstore.com.br

Requisições POST, PUT e DELETE possuem alguns headers úteis em seu response, contendo o ID da requisição gerada (Request-Id) e os limites de requisições para cada endpoint (X-RateLimit-Limit e X-RateLimit-Remaining). Caso encontre problemas com alguma requisição, basta informar ID da requisição ao time de suporte, pois isso facilitará a obtenção dos logs e diminuirá o tempo de correção do problema.

Cache-Control: no-cache, private
Content-Type: application/json
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
Request-Id: 1R17E20190510133646C1557506206412V9676

As APIs do Hub de Marketplaces possuem dois níveis de autenticação: Autenticação da aplicação e Autenticação da integração.

Autenticação da aplicação

Todas as aplicações integradas possuem um token de identificação chamado AppToken que deve ser enviado no header de todas as requisições, pois sem ele, não é possível identificar a aplicação conectada e sua conexão será negada imediatamente.

Em produção, cada aplicação possui um AppToken exclusivo, porém em homologação, todas as aplicações devem utilizar o AppToken homologacao, conforme o exemplo abaixo:

App-Token: homologacao
Content-Type: application/json
cache-control: no-cache

Autenticação da integração

O segundo nível de autenticação é o da integração, ou seja, da conta do seller a ser requisitada.

A autenticação da integração é feita a partir de um token de acesso temporário, gerado no recurso de autenticação e que deve ser enviado no header de todas as requisões no índice Authorization (exceto a requisição de autenticação, onde apenas o AppToken deve ser enviado).

App-Token: homologacao
Content-Type: application/json
cache-control: no-cache
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBpLm9tbmkud2Fwc3RvcmUuY29tLmJyXC8iLCJhdWQiOiJBcGkgZGUgVGVzdGUiLCJpYXQiOjE1NTc0MjgzMjcsIm5iZiI6MTU1NzQyODMyNywiZXhwIjoxNTU3NDMwMTI3LCJ0aWQiOiIwOWI4ZGI5YWYxNjhkMDRhMmE2OTBhNTQ1NmEyZWRmMSJ9.Gfvm1Z54pUXZhlNhafV1fEoOBiMGS_sku4o2a8CKWmY

Em produção, temos vários serviços de proteção ligados (firewall, proteção anti DDoS, TLS sempre atualizado, entre outros) e todos esses serviços trabalham para garantir a integridade do sistema (principalmente porque os dados que transitam pela plataforma são sensíveis - dados de cartão, endereços, etc).

Para que seu sistema não seja bloqueado por nossos serviços de segurança e consiga criar uma comunicação estável com nossas APIs de produção, é de suma importância que em todas as requisições sejam enviados user-agents válidos, todas as conexões sejam feitas utilizando o protocolo HTTPS e que seu sistema tenha suporte aos certificados TLS/SSL mais atualizados (utilize algum serviço online como o SSL Labs para verificar qual certificado TLS/SSL é suportado pelos servidores de produção).

Além disso, a utilização de um IP fixo nas requisições de produção também é muito importante, pois nossa equipe de infraestrutura e segurança pode criar regras específicas para esse IP, o que aumenta muito a segurança e diminui o risco de bloqueios.

No ambiente de homologação o risco de bloqueio pelos serviços de segurança é baixo, por isso sempre desenvolva sua aplicação focando nos níveis máximos de segurança que serão exigidos em produção.

POST /v1/auth

Recurso responsável por gerar o token de autenticação da integração.

Para esse recurso, o único token que deverá enviar no header é o AppToken, pois nesse momento você ainda não terá o token da integração.
Os dados enviados no body (ApiKey e SecretKey) são relacionados a conta de integração do Seller (conta de homologação ou produção).

Após o token ser gerado, ele será válido por 30 minutos e deverá ser enviado no header Authorization das demais APIs.

Importante: Sempre que um novo token for gerado o anterior será revogado e perderá o acesso imediatamente.

Request

{
	"apiKey": "1234A5678B9012C3456",
	"secretKey":"3456D9012E5678F1234"
}

Detalhes da Request

Response

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBpLm9tbmkud2Fwc3RvcmUuY29tLmJyXC8iLCJhdWQiOiJBcGkgZGUgVGVzdGUiLCJpYXQiOjE1NTc0NTc2OTYsIm5iZiI6MTU1NzQ1NzY5NiwiZXhwIjoxNTU3NDU5NDk2LCJ0aWQiOiI5MzRjZTY2ZGY5MDQ1YWNmMzY1MGIyZWEzNWUxYjMwMSJ9.Ii148QGob19NI2-fsMbqvMpmVFyGR3bkJjSbOxaCxmg"
}

Detalhes do Response

GET /v1/ping

Rota de teste de token. Utilize essa URL para testar o token gerado no recurso de autorização. Caso receba a palavra 'pong' (em texto puro), significa que a sua requisição foi autenticada com sucesso, ou seja, seu AppToken e o token temporário são válido.

Recurso responsável por notificar uma url configurada sempre que houver uma atualização de pedido dentro do HUB.

URL

A url configurada será receptora das notificações e deverá responder com o status HTTP 200 OK e retornando os campos "idInterno" e "status" a todas notificações. Caso o status code seja diferente ou não retorne os campos esperados, o webhook será inativado automaticamente, sendo necessário a ativação novamente pelo painel do HUB.

Confirmação de leitura

É extremamente importante que, após o consumo de uma atualização de um item na api, a confirmação de leitura desse item seja realizada, para remover o item da fila e possibilitar que futuras atualizações do mesmo sejam sincronizadas. Você também pode ativar através do painel do HUB a confirmação de leitura da fila de forma automática, ou seja, assim que a notificação de um item é enviada, o mesmo é removido da fila de atualizações, sem necessitar uma confirmação manual de leitura nas rotas de api.

Recomendamos fortemente que habilite a leitura de pedidos de forma automática para evitar inconsistências nas notificações. Porém caso deseje manter o processo manual pode deixar a configuração desabilitada e neste caso deverá realizar a confirmação da leitura da notificação através das rotas disponíveis.

Notificações

Cada notificação possui o id do pedido no HUB, o domínio da fila referente à notificação atual, urls de leitura e confirmação de leitura (quando em confirmação manual), a data de envio da requisição

{
  "id": 123321456,
  "dominio":"pedido",
  "urlLeitura":"GET http://localhost/omni/omni-api/v1/order/{idPedido}",
  "urlConfirmacaoLeitura":"confirmacao-automatica",
  "data":"2022-10-14 08:12:17"
}

Os recursos a seguir permitem o gerenciamento completo dos produtos e suas variações.

Importante: Os produtos também podem ser alterados via painel, no entanto as alterações serão perdidas no caso de novas atualizações vindas da API.

GET /v1/products

Recurso responsável por listar todos os produtos cadastrados, ordenados pela data de cadastro.

Nesse recurso serão retornados apenas os dados básicos dos produtos, sendo necessário realizar uma chamada ao recurso de consulta individual de produtos para obter todos os dados sobre um produto específico.

Response

{
    "produtos": [
        {
            "skuProdutoLider": "HDEXT1TB",
            "skuProduto": "HDEXT1TB",
            "nome": "HD externo 1tb",
            "ativo": true,
            "precoDe":350.00,
            "precoPor":299.99,
            "precoDeMidia":350.00,
            "precoPorMidia":299.99,
            "estoque": 0,
            "prazoProducao": 1,
            "links": {
                "GET": "https://api.sandbox.omni.wapstore.com.br/v1/products/HDEXT1TB",
                "PUT": "https://api.sandbox.omni.wapstore.com.br/v1/products/HDEXT1TB"
            }
        },
        {
            "skuProdutoLider": "SLTALTOVERMELHO",
            "skuProduto": "SLTALTOVERMELHO",
            "nome": "Salto alto vermelho",
            "ativo": true,
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "prazoProducao": 2,
            "links": {
                "GET": "https://api.sandbox.omni.wapstore.com.br/v1/products/SLTALTOVERMELHO",
                "PUT": "https://api.sandbox.omni.wapstore.com.br/v1/products/SLTALTOVERMELHO"
            }
        },
        {
            "skuProdutoLider": "FURADEIRAABC",
            "skuProduto": "FURADEIRAABC",
            "nome": "Furadeira profissional 800w",
            "ativo": true,
            "precoDe": 199,
            "precoPor": 199,
            "precoDeMidia": 199,
            "precoPorMidia": 199,
            "estoque": 0,
            "prazoProducao": 1,
            "links": {
                "GET": "https://api.sandbox.omni.wapstore.com.br/v1/products/FURADEIRAABC",
                "PUT": "https://api.sandbox.omni.wapstore.com.br/v1/products/FURADEIRAABC"
            }
        }
    ],
    "info": {
        "filtros": [],
        "prev": "",
        "self": "https://api.sandbox.omni.wapstore.com.br/v1/products?offset=0&limit=100",
        "next": "",
        "offset": 0,
        "limit": 100,
        "exibindo": 3,
        "total": 3
    }
}

Detalhes do Response

GET /v1/products/{sku}

Recurso de consulta individual de produtos responsável por retornar todos os dados cadastrados de um produto.

Response

{
    "skuProdutoLider": "SLTALTOVERMELHO",
    "skuProduto": "SLTALTOVERMELHO",
    "nome": "Salto alto vermelho",
    "ativo": true,
    "precoDe": 199,
    "precoPor": 129.5,
    "precoDeMidia": 199,
    "precoPorMidia": 129.5,
    "estoque": 0,
    "prazoProducao": 2,
    "descricao": "<b>Salto alto vermelho com verniz</b><br><ul><li>Solado resistente e muito confortável</li><li>1 ano de garantia</li></ul>",
    "descricaoCurta": "Salto alto cor vermlho com verniz",
    "descricaoSimples": "Salto alto vermelho com verniz, solado resistente e muito confortável. Acompanha nota fiscal. 1 ano de garantia.",
    "altura":10.00,
    "largura":15.00,
    "comprimento":25.00,
    "peso":0.500,
    "ean": "1234567890128",
    "mpn": "",
    "ncm": "",
    "idCategoriaGoogle": 0,
    "condicao": "novo",
    "faixaEtaria": "adulto",
    "genero": "feminino",
    "urlProduto": "",
    "urlVideo": "",
    "marca": "Teste API",
    "categoria": [
        "Moda e Acessórios",
        "Sapatos",
        "Salto Alto"
    ],
    "caracteristicas": {
        "Garantia": "1 ano"
    },
    "tags": [
        "nacional", "internacional"
    ],
    "imagens": [
        {
            "id": 1,
            "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
        },
        {
            "id": 2,
            "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
        },
        {
            "id": 3,
            "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
        },
        {
            "id": 4,
            "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
        }
    ],
    "cor": "Vermelho",
    "variacoes": [
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-37",
            "ean": "1234567890128",
            "tamanho": "37",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        },
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-38",
            "ean": "1234567890128",
            "tamanho": "38",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        }
    ]
}

Detalhes do Response

GET /v1/products/variation/{sku}

Recurso de consulta individual de uma variação (voltagem/tamanho) de um produto, responsável por retornar todos os dados cadastrados de uma variação

Response

{
    "skuProduto": "FURADEIRAABC",
    "skuVariacao": "FURADEIRAABC-220v",
    "ean": "1234567890128",
    "voltagem": "220v",
    "precoDe": 199,
    "precoPor": 199,
    "precoDeMidia": 199,
    "precoPorMidia": 199,
    "estoque": 0,
    "altura": 10,
    "largura": 15,
    "comprimento": 25,
    "peso": 1
}

Detalhes do Response

POST /v1/products

Recurso de cadastro individual de produtos, responsável por cadastrar um produto por requisição.

Cada produto pode possuir apenas uma cor e variar por tamanho ou voltagem, ou seja, não é possível ter mais de uma cor em um mesmo produto ou um mesmo produto possuir variações de temanho e voltagem ao mesmo tempo. Para ter produtos com cores diferentes, basta cadastrar os dois produtos, vinculando-os pelo campo skuProdutoLider. Caso o produto atual seja líder (líder das variações de cor ou produto único, sem variações), envie o mesmo SKU nos campos skuProduto e skuProdutoLider.

Importante: o produto líder deve ser cadastrado antes dos produtos filhos.

Requests

{
  "skuProduto":"HDEXT1TB",
  "skuProdutoLider":"HDEXT1TB",
  "nome":"HD externo 1tb",
  "descricao":"<b>HD externo de 1tb</b><br><ul><li>Conexão USB 3.0</li><li>1 ano de garantia</li></ul>",
  "descricaoCurta":"HD externo 1tb com conexão USB 3.0",
  "descricaoSimples":"HD externo de 1tb com Conexão USB 3.0, 1 ano de garantia e acompanha cabo USB.",
  "ean":"1234567890128",
  "condicao":"novo",
  "idCategoriaGoogle":0,
  "precoDe":350.00,
  "precoPor":299.99,
  "ativo":true,
  "prazoProducao":1,
  "altura":2.00,
  "largura":10.00,
  "comprimento":5.00,
  "peso":0.100,
  "caracteristicas":{
      "Armazenamento": "1tb",
      "Garantia": "1 ano",
      "Conexão": "USB 3.0"
  },
  "categoria":[
    "Informática",
    "Acessórios",
    "HDs externos"
  ],
  "tags": [
    "nacional", "internacional"
  ],
  "marca":"MarcaTeste",
  "urlVideo":"https://www.youtube.com.br/?watch=abc123",
  "imagens":[
    {
      "id": 1,
      "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
    },
    {
      "id": 2,
      "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
    },
    {
      "id": 3,
      "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
    },
    {
      "id": 4,
      "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
    }
  ]
}

{
  "skuProduto":"SLTALTOVERMELHO",
  "skuProdutoLider":"SLTALTOVERMELHO",
  "nome":"Salto alto vermelho",
  "descricao":"<b>Salto alto vermelho com verniz</b><br><ul><li>Solado resistente e muito confortável</li><li>1 ano de garantia</li></ul>",
  "descricaoCurta":"Salto alto cor vermlho com verniz",
  "descricaoSimples":"Salto alto vermelho com verniz, solado resistente e muito confortável. Acompanha nota fiscal. 1 ano de garantia.",
  "ean":"1234567890128",
  "condicao":"novo",
  "faixaEtaria":"adulto",
  "genero":"feminino",
  "idCategoriaGoogle":0,
  "precoDe":199.00,
  "precoPor":129.50,
  "ativo":true,
  "prazoProducao":2,
  "altura":10.00,
  "largura":15.00,
  "comprimento":25.00,
  "peso":0.500,
  "caracteristicas":{
      "Garantia": "1 ano"
  },
  "tags": [
    "nacional", "internacional"
  ],
  "categoria":[
    "Moda e Acessórios",
    "Sapatos",
    "Salto Alto"
  ],
  "marca":"Teste API",
  "urlVideo":"https://www.youtube.com.br/?watch=abc123",
  "imagens":[
    {
      "id": 1,
      "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
    },
    {
      "id": 2,
      "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
    },
    {
      "id": 3,
      "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
    },
    {
      "id": 4,
      "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
    }
  ],
  "cor":"Vermelho",
  "variacoes":[
  	{
      "skuVariacao":"SLTALTOVERMELHO-37",
      "tamanho":"37",
      "precoDe":199.00,
      "precoPor":129.50
    },
    {
      "skuVariacao":"SLTALTOVERMELHO-38",
      "tamanho":"38",
      "precoDe":199.00,
      "precoPor":129.50
    }
  ]
}

{
  "skuProduto":"FURADEIRAABC",
  "skuProdutoLider":"FURADEIRAABC",
  "nome":"Furadeira profissional 800w",
  "descricao":"<b>Furadeira profissional 800w</b><br><ul><li>Indicada para paredes, madeira, metais e até concreto</li><li>1 ano de garantia</li></ul>",
  "descricaoCurta":"Furadeira profissional 800w para paredes, madeira, metais e concreto",
  "descricaoSimples":"Furadeira profissional 800w, indicada para paredes, madeira, metais e até concreto com 1 ano de garantia.",
  "ean":"1234567890128",
  "condicao":"novo",
  "idCategoriaGoogle":0,
  "precoDe":199.00,
  "precoPor":199.00,
  "ativo":true,
  "prazoProducao":1,
  "altura":10.00,
  "largura":15.00,
  "comprimento":25.00,
  "peso":1.000,
  "caracteristicas":{
      "Potência": "800w",
      "Garantia": "1 ano"
  },
  "categoria":[
    "Ferramentas",
    "Elétricas",
    "Furadeiras"
  ],
  "tags": [
    "nacional", "internacional"
  ],
  "marca":"Teste API",
  "urlVideo":"https://www.youtube.com.br/?watch=abc123",
  "imagens":[
    {
      "id": 1,
      "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
    },
    {
      "id": 2,
      "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
    },
    {
      "id": 3,
      "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
    },
    {
      "id": 4,
      "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
    }
  ],
  "variacoes":[
  	{
      "skuVariacao":"FURADEIRAABC-110v",
      "voltagem":"110v",
      "precoDe":199.00,
      "precoPor":199.00
    },
    {
      "skuVariacao":"FURADEIRAABC-220v",
      "voltagem":"220v",
      "precoDe":199.00,
      "precoPor":199.00
    }
  ]
}

Detalhes da Request

Response

{
    "skuProdutoLider": "SLTALTOVERMELHO",
    "skuProduto": "SLTALTOVERMELHO",
    "nome": "Salto alto vermelho",
    "ativo": true,
    "precoDe": 199,
    "precoPor": 129.5,
    "precoDeMidia": 199,
    "precoPorMidia": 129.5,
    "estoque": 0,
    "prazoProducao": 2,
    "descricao": "<b>Salto alto vermelho com verniz</b><br><ul><li>Solado resistente e muito confortável</li><li>1 ano de garantia</li></ul>",
    "descricaoCurta": "Salto alto cor vermlho com verniz",
    "descricaoSimples": "Salto alto vermelho com verniz, solado resistente e muito confortável. Acompanha nota fiscal. 1 ano de garantia.",
    "altura":10.00,
    "largura":15.00,
    "comprimento":25.00,
    "peso":0.500,
    "ean": "1234567890128",
    "mpn": "",
    "ncm": "",
    "idCategoriaGoogle": 0,
    "condicao": "novo",
    "faixaEtaria": "adulto",
    "genero": "feminino",
    "urlProduto": "",
    "urlVideo": "",
    "marca": "Teste API",
    "categoria": [
        "Moda e Acessórios",
        "Sapatos",
        "Salto Alto"
    ],
    "caracteristicas": {
        "Garantia": "1 ano"
    },
    "tags": [
        "nacional", "internacional"
    ],
    "imagens": [
        {
            "id": 1,
            "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
        },
        {
            "id": 2,
            "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
        },
        {
            "id": 3,
            "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
        },
        {
            "id": 4,
            "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
        }
    ],
    "cor": "Vermelho",
    "variacoes": [
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-37",
            "ean": "1234567890128",
            "tamanho": "37",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        },
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-38",
            "ean": "1234567890128",
            "tamanho": "38",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        }
    ]
}

Detalhes do Response

POST /v1/products/batch

Recurso de cadastro em lote de produtos, responsável por cadastrar vários produtos de uma única vez. As restrições para cadastros de cor, tamanho, voltagem e vínculo de produtos, são as mesmas do recurso de cadastro individual.

Importante: caso um mesmo lote possua um produto líder e seus filhos, o produto líder deve vir antes dos seus produtos filhos.

Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.

Request

{
  "produtos":[
    {
      "skuProduto":"HDEXT1TB",
      "skuProdutoLider":"HDEXT1TB",
      "nome":"HD externo 1tb",
      "descricao":"<b>HD externo de 1tb</b><br><ul><li>Conexão USB 3.0</li><li>1 ano de garantia</li></ul>",
      "descricaoCurta":"HD externo 1tb com conexão USB 3.0",
      "descricaoSimples":"HD externo de 1tb com Conexão USB 3.0, 1 ano de garantia e acompanha cabo USB.",
      "ean":"1234567890128",
      "condicao":"novo",
      "idCategoriaGoogle":0,
      "precoDe":350.00,
      "precoPor":299.99,
      "ativo":true,
      "prazoProducao":1,
      "altura":2.00,
      "largura":10.00,
      "comprimento":5.00,
      "peso":0.100,
      "caracteristicas":{
          "Armazenamento": "1tb",
          "Garantia": "1 ano",
          "Conexão": "USB 3.0"
      },
      "tags": [
        "nacional", "internacional"
      ],
      "categoria":[
        "Informática",
        "Acessórios",
        "HDs externos"
      ],
      "marca":"MarcaTeste",
      "urlVideo":"https://www.youtube.com.br/?watch=abc123",
      "imagens":[
        { 
          "id": 1,
          "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
        },
        { 
          "id": 2,
          "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
        },
        { 
          "id": 3,
          "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
        },
        { 
          "id": 4,
          "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
        }
      ]
    }
  ]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

PUT /v1/products/{sku}

Recurso de alteração individual de produtos, responsável por alterar informações de um produto.

Importante: após cadastrado, um produto não poderá ter os campos skuProdutoLider ou skuProduto alterados, caso alguma cor seja definida para o produto (no cadastro ou em alguma atualização), ela não poderá ser removida via API e não é possível remover variações de tamanho ou voltagem via API.

Request

{
  "skuProduto": "SLTALTOVERMELHO",
  "nome": "Salto alto vermelho",
  "ativo": true,
  "precoDe": 199,
  "precoPor": 129.5
}

Detalhes da Request

Response

{
    "skuProdutoLider": "SLTALTOVERMELHO",
    "skuProduto": "SLTALTOVERMELHO",
    "nome": "Salto alto vermelho",
    "ativo": true,
    "precoDe": 199,
    "precoPor": 129.5,
    "precoDeMidia": 199,
    "precoPorMidia": 129.5,
    "estoque": 0,
    "prazoProducao": 2,
    "descricao": "<b>Salto alto vermelho com verniz</b><br><ul><li>Solado resistente e muito confortável</li><li>1 ano de garantia</li></ul>",
    "descricaoCurta": "Salto alto cor vermlho com verniz",
    "descricaoSimples": "Salto alto vermelho com verniz, solado resistente e muito confortável. Acompanha nota fiscal. 1 ano de garantia.",
    "altura":10.00,
    "largura":15.00,
    "comprimento":25.00,
    "peso":0.500,
    "ean": "1234567890128",
    "mpn": "",
    "ncm": "",
    "idCategoriaGoogle": 0,
    "condicao": "novo",
    "faixaEtaria": "adulto",
    "genero": "feminino",
    "urlProduto": "",
    "urlVideo": "",
    "marca": "Teste API",
    "categoria": [
        "Moda e Acessórios",
        "Sapatos",
        "Salto Alto"
    ],
    "caracteristicas": {
        "Garantia": "1 ano"
    },
    "tags": [
        "nacional", "internacional"
    ],
    "imagens": [
        {
            "id": 1,
            "url": "https://www.seusite.com.br/imagens/produto-teste.jpg"
        },
        {
            "id": 2,
            "url": "https://www.seusite.com.br/imagens/produto-teste-2.jpg"
        },
        {
            "id": 3,
            "url": "https://www.seusite.com.br/imagens/produto-teste-3.jpg"
        },
        {
            "id": 4,
            "url": "https://www.seusite.com.br/imagens/produto-teste-4.jpg"
        }
    ],
    "cor": "Vermelho",
    "variacoes": [
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-37",
            "ean": "1234567890128",
            "tamanho": "37",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        },
        {
            "skuProduto": "SLTALTOVERMELHO",
            "skuVariacao": "SLTALTOVERMELHO-38",
            "ean": "1234567890128",
            "tamanho": "38",
            "precoDe": 199,
            "precoPor": 129.5,
            "precoDeMidia": 199,
            "precoPorMidia": 129.5,
            "estoque": 0,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":0.500
        }
    ]
}

Detalhes do Response

PUT /v1/products/variation/{sku}

Recurso de atualização individual de variações, responsável por alterar informações de uma única variação de um produto

Importante: não é possível alterar o SKU de uma variação.

Request

{
    "skuVariacao": "FURADEIRAABC-220v",
    "ean": "5554443322212",
    "precoDe": 1000.00,
    "precoPor": 200.00,
    "peso": 10.00
}

Detalhes da Request

Response

{
    "skuProduto": "FURADEIRAABC",
    "skuVariacao": "FURADEIRAABC-220v",
    "ean": "1234567890128",
    "voltagem": "220v",
    "precoDe": 199,
    "precoPor": 199,
    "precoDeMidia": 199,
    "precoPorMidia": 199,
    "estoque": 0,
    "altura": 10,
    "largura": 15,
    "comprimento": 25,
    "peso": 1
}

Detalhes do Response

PUT /v1/products/batch

Recurso de atualização em lote de produtos, responsável por atualizar vários produtos de uma única vez. As restrições para alterações são as mesmas do recurso de atualização individual.

Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.

Request

{
  "produtos":[
    {
      "skuProduto":"HDEXT1TB",
      "nome":"HD externo 1tb",
      "descricao":"<b>HD externo de 1tb</b><br><ul><li>Conexão USB 3.0</li><li>1 ano de garantia</li></ul>",
      "descricaoCurta":"HD externo 1tb com conexão USB 3.0",
      "descricaoSimples":"HD externo de 1tb com Conexão USB 3.0, 1 ano de garantia e acompanha cabo USB.",
      "precoDe":350.00,
      "precoPor":299.99,
    }
  ]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

PUT /v1/products/stock-batch

Recurso de atualização em lote de estoques de produtos.

Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.

Request

{
	"estoques": [
		{
		    "sku": "SLTALTOVERMELHO-37",
		    "estoque":232
		},
		{
			"sku": "SLTALTOVERMELHO-38",
			"estoque":32
		},
		{
			"sku": "HDEXT1TB",
			"estoque":32
		}
	]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

PUT /v1/products/price-batch

Recurso de atualização em lote de preços de produtos.

Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.

Request

{
	"precos": [
		{
		    "sku": "SLTALTOVERMELHO-37",
		    "precoDe":190.00,
		    "precoPor":190.00
		},
		{
			"sku": "SLTALTOVERMELHO-38",
			"precoDe":190.00,
		    "precoPor":190.00
		},
		{
			"sku": "HDEXT1TB",
			"precoDe":250.00,
		    "precoPor":229.90
		}
	]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

DELETE /v1/products/{sku}

Recurso de exclusão individual de produtos, responsável por excluir um produto.

Importante: não é possível excluir produtos que estejam vinculados com algum canal de marketplace e não é possível excluir produtos que possuam filhos, nesse caso é necessário excluir primeiro os produtos filhos para depois excluir o produto líder

GET /v1/batch/{id}

Recurso responsável por retornar todos os detalhes sobre o um lote, como seu status, itens processados, erros encontrados, data de criação e data de processamento de cada item.

Importante: Os lotes podem ser consultados via API até 10 dias após sua criação. Após esse período, os detalhes de um lote só poderão ser obtidos via chamado.

Response

{
    "batchId": "80",
    "requestId": "CI1O18G20190614104404P1560519844050X2326",
    "data": "2019-05-14 13:44:04",
    "tipo": "produto",
    "acao": "atualizarEstoque",
    "status": "processado",
    "contemErros": true,
    "observacoes": [
        {
            "identificador": "12345ABC",
            "sucesso": true,
            "info": "Ação executada com sucesso",
            "data": "2019-05-14 10:44:10"
        },
        {
            "identificador": "123456ABCD",
            "sucesso": false,
            "error": "Problemas ao executar ação",
            "details": [
                "SKU  '123456ABCD' não encontrado"
            ],
            "data": "2019-05-14 10:44:10"
        }
    ]
}

Detalhes do Response

GET /v1/orders

Recurso responsável por listar todos os pedidos do seller no Hub de Marketplaces, ordenados pela data de emissão.

Nesse recurso serão retornados apenas os dados básicos dos pedidos, sendo necessário realizar uma chamada ao recurso de consulta individual de pedidos para obter todos os dados sobre um pedido específico.

Response

{
    "pedidos": [
        {
            "idPedido": 192062,
            "idPedidoCanal": "MKTP-5678",
            "referenciaPedidoCanal": "MKTP-5678",
            "idInterno": 0,
            "dataEmissao": "2019-05-09 00:36:00",
            "dataIntegracao": "2019-05-13 08:28:58",
            "status": "novo",
            "moeda": "BRL",
            "canal": {
                "canal": "Mktplace Wapstore",
                "canalIntegracao": "Api de Teste",
                "hashCanal": "api"
            },
            "cliente": {
                "nome": "João de Oliveira",
                "email": "exemplo@teste.com.br",
                "cpfCnpj": "123.789.456-48",
                "pessoa": "f",
                "telefone": "(11) 1234-4567",
                "celular": "(11) 999999-9999"
            },
            "entrega": {
                "cep": "01310-940",
                "destinatario": "João de Oliveira",
                "endereco": "Av. Paulista",
                "bairro": "Centro",
                "cidade": "São Paulo",
                "uf": "SP",
                "numero": "1234",
                "complemento": "Sala 123",
                "referencia": "Aurora Center",
                "prazoEntrega": 12,
                "tipoFrete": "SEDEX",
                "codigoRastreio": "",
                "linkRastreio": ""
            },
            "valores": {
                "subtotal": 199,
                "frete": 29,
                "desconto": 0,
                "total": 228
            },
            "fiscal": {
                "nfeSerie": "",
                "nfeNumero": "",
                "nfeChave": "",
                "nfseNumero":"",
                "nfseCodigoVerificacao":"",
                "nfseUrlConsulta":""
            },
            "links": {
                "GET": "https://api.sandbox.omni.wapstore.com.br/v1/orders/192062",
                "PUT": {
                    "faturado": "https://api.sandbox.omni.wapstore.com.br/v1/orders/192062/invoiced",
                    "enviado": "https://api.sandbox.omni.wapstore.com.br/v1/orders/192062/sent",
                    "entregue": "https://api.sandbox.omni.wapstore.com.br/v1/orders/192062/delivered"
                }
            }
        }
    ],
    "info": {
        "filtros": [],
        "prev": "",
        "self": "https://api.sandbox.omni.wapstore.com.br/v1/orders?offset=0&limit=100",
        "next": "",
        "offset": 0,
        "limit": 100,
        "exibindo": 1,
        "total": 1
    }
}

Detalhes do Response

GET /v1/orders/{id}

Recurso de consulta individual de pedidos, responsável por retornar todas as informações sobre um pedido

Response

{
    "idPedido": 192062,
    "idPedidoCanal": "MKTP-5678",
    "referenciaPedidoCanal": "MKTP-5678",
    "idInterno": 0,
    "dataEmissao": "2019-05-09 00:36:00",
    "dataIntegracao": "2019-05-13 08:28:58",
    "status": "novo",
    "moeda": "BRL",
    "canal": {
        "canal": "Mktplace Wapstore",
        "canalIntegracao": "Api de Teste",
        "hashCanal": "api"
    },
    "cliente": {
        "nome": "João de Oliveira",
        "email": "exemplo@teste.com.br",
        "cpfCnpj": "123.789.456-48",
        "pessoa": "f",
        "telefone": "(11) 1234-4567",
        "celular": "(11) 999999-9999",
        "rgIe": "11.123.123-4",
        "sexo": "m",
        "nascimento": "10/06/1995"
    },
    "entrega": {
        "cep": "01310-940",
        "destinatario": "João de Oliveira",
        "endereco": "Av. Paulista",
        "bairro": "Centro",
        "cidade": "São Paulo",
        "uf": "SP",
        "numero": "1234",
        "complemento": "Sala 123",
        "referencia": "Aurora Center",
        "prazoEntrega": 12,
        "tipoFrete": "SEDEX",
        "codigoRastreio": "",
        "linkRastreio": "",
        "freteMapeado": {
            "id": "1235",
            "nome": "SEDEX"
        }
    },
    "valores": {
        "subtotal": 199,
        "frete": 29,
        "desconto": 0,
        "total": 228
    },
    "fiscal": {
        "nfeSerie": "",
        "nfeNumero": "",
        "nfeChave": "",
        "nfseNumero":"",
        "nfseCodigoVerificacao":"",
        "nfseUrlConsulta":""
    },
    "itens": [
        {
            "sku": "FURADEIRAABC-220v",
            "nome": "Furadeira profissional 800w",
            "detalhes": "Voltagem:220v",
            "valor": 199,
            "qtd": 1
        }
    ],
    "pagamentos": [
        {
            "metodo": "Cartão de Crédito",
            "descricao": "Visa 10x",
            "qtdParcelas": 10,
            "valor": 228
        }
    ]
}

Detalhes do Response

GET /v1/orders/queue

Recurso de consulta da fila de atualizações de pedidos. Sempre que um novo pedido chegar ou tiver seu status atualizado pelo marketplace ele aparecerá nessa fila. Configure o seu sistema para consumir a fila de atualizações para sempre receber os novos pedidos e as atualziações de status.

Nesse recurso são retornados todos os dados dos pedidos, ou seja, não é necessário fazer uma segunda requisição para obter todas as informações dos pedidos.

Importante: Após atualizar seu sistema, você deverá remover o pedido da fila utilizando o recurso de remoção de pedidos da fila. Se não fizer isso, todas as vezes que consultar a fila continuará recebendo os mesmos pedidos.

Response

{
    "pedidos": [
        {
            "idPedido": 192062,
            "idPedidoCanal": "MKTP-5678",
            "referenciaPedidoCanal": "MKTP-5678",
            "idInterno": 0,
            "dataEmissao": "2019-05-09 00:36:00",
            "dataIntegracao": "2019-05-13 08:28:58",
            "status": "novo",
            "moeda": "BRL",
            "canal": {
                "canal": "Mktplace Wapstore",
                "canalIntegracao": "Api de Teste",
                "hashCanal": "api"
            },
            "cliente": {
                "nome": "João de Oliveira",
                "email": "exemplo@teste.com.br",
                "cpfCnpj": "123.789.456-48",
                "pessoa": "f",
                "telefone": "(11) 1234-4567",
                "celular": "(11) 999999-9999",
                "rgIe": "11.123.123-4",
                "sexo": "m",
                "nascimento": "10/06/1995"
            },
            "entrega": {
                "cep": "01310-940",
                "destinatario": "João de Oliveira",
                "endereco": "Av. Paulista",
                "bairro": "Centro",
                "cidade": "São Paulo",
                "uf": "SP",
                "numero": "1234",
                "complemento": "Sala 123",
                "referencia": "Aurora Center",
                "prazoEntrega": 12,
                "tipoFrete": "SEDEX",
                "codigoRastreio": "",
                "linkRastreio": "",
                "freteMapeado": {
                    "id": "1235",
                    "nome": "SEDEX"
                }
            },
            "valores": {
                "subtotal": 199,
                "frete": 29,
                "desconto": 0,
                "total": 228
            },
            "fiscal": {
                "nfeSerie": "",
                "nfeNumero": "",
                "nfeChave": "",
                "nfseNumero":"",
                "nfseCodigoVerificacao":"",
                "nfseUrlConsulta":""
            },
            "itens": [
                {
                    "sku": "FURADEIRAABC-220v",
                    "nome": "Furadeira profissional 800w",
                    "detalhes": "Voltagem:220v",
                    "valor": 199,
                    "qtd": 1
                }
            ],
            "pagamentos": [
                {
                    "metodo": "Cartão de Crédito",
                    "descricao": "Visa 10x",
                    "qtdParcelas": 10,
                    "valor": 228
                }
            ]
        }
    ],
    "info": {
        "filtros": [],
        "limit": 100,
        "exibindo": 1,
        "total": 1
    }
}

Detalhes do Response

DELETE /v1/orders/queue/{id}

Recurso responsável por remover pedidos da fila de atualizações.

Nesse recurso é necessário enviar o status importado pelo seu sistema (essa informação aparece no painel do Hub de Marketplaces para o Seller) e também um ID númerico único do pedido gerado em seu sistema. Caso você não possua um ID númerico único, envie o ID do pedido gerado no Hub de Marketplaces nesse campo.

Request

{
   "idInterno":1234,
   "status":"novo"
 }

Detalhes da Request

POST /v1/orders (Sandbox)

Recurso responsável por criar pedidos em sandbox.

Use esse recurso para simular a criação de pedidos pelo marketplace, pois ao criar um novo pedido ele aparecerá na fila de atualizações

Request

{
   "idPedidoCanal":"MKTP-5678",
   "referenciaPedidoCanal":"MKTP-5678",
   "canal":"Mktplace Wapstore",
   "dataEmissao":"2019-05-09 00:36:00",
   "moeda": "BRL",
   "cliente":{
     "nome":"João de Oliveira",
     "email":"exemplo@teste.com.br",
     "cpfCnpj":"123.789.456-48",
     "rgIe":"11.123.123-4",
     "pessoa":"f",
     "sexo":"m",
     "telefone":"(11) 1234-4567",
     "celular":"(11) 999999-9999",
     "nascimento":"10/06/1995"
    },
    "entrega":{
      "cep":"01310-940",
      "destinatario":"João de Oliveira",
      "endereco":"Av. Paulista",
      "bairro":"Centro",
      "cidade":"São Paulo",
      "uf":"SP",
      "numero":"1234",
      "complemento":"Sala 123",
      "referencia":"Aurora Center",
      "prazoEntrega":12,
      "tipoFrete":"SEDEX"
     },
     "valores":{
       "frete":29.00,
       "subtotal":199.00,
       "desconto":0.00,
       "total":228.00
      },
      "itens":[
        {
          "sku":"FURADEIRAABC-220v",
          "nome":"Furadeira profissional 800w",
          "qtd":1,
          "valor":199.00
         }
      ],
       "pagamentos":[
         {
             "metodo":"Cartão de Crédito",
             "descricao":"Visa 10x",
             "qtdParcelas":10,
             "valor":228.00
          }
       ]
 }

Detalhes da Request

Response

{
    "idPedido": 192062,
    "idPedidoCanal": "MKTP-5678",
    "referenciaPedidoCanal": "MKTP-5678",
    "idInterno": 0,
    "dataEmissao": "2019-05-09 00:36:00",
    "dataIntegracao": "2019-05-13 08:28:58",
    "status": "novo",
    "moeda": "BRL",
    "canal": {
        "canal": "Mktplace Wapstore",
        "canalIntegracao": "Api de Teste",
        "hashCanal": "api"
    },
    "cliente": {
        "nome": "João de Oliveira",
        "email": "exemplo@teste.com.br",
        "cpfCnpj": "123.789.456-48",
        "pessoa": "f",
        "telefone": "(11) 1234-4567",
        "celular": "(11) 999999-9999",
        "rgIe": "11.123.123-4",
        "sexo": "m",
        "nascimento": "10/06/1995"
    },
    "entrega": {
        "cep": "01310-940",
        "destinatario": "João de Oliveira",
        "endereco": "Av. Paulista",
        "bairro": "Centro",
        "cidade": "São Paulo",
        "uf": "SP",
        "numero": "1234",
        "complemento": "Sala 123",
        "referencia": "Aurora Center",
        "prazoEntrega": 12,
        "tipoFrete": "SEDEX",
        "codigoRastreio": "",
        "linkRastreio": "",
        "freteMapeado": {
            "id": "1235",
            "nome": "SEDEX"
        }
    },
    "valores": {
        "subtotal": 199,
        "frete": 29,
        "desconto": 0,
        "total": 228
    },
    "fiscal": {
        "nfeSerie": "",
        "nfeNumero": "",
        "nfeChave": "",
        "nfseNumero":"",
        "nfseCodigoVerificacao":"",
        "nfseUrlConsulta":""
    },
    "itens": [
        {
            "sku": "FURADEIRAABC-220v",
            "nome": "Furadeira profissional 800w",
            "detalhes": "Voltagem:220v",
            "valor": 199,
            "qtd": 1
        }
    ],
    "pagamentos": [
        {
            "metodo": "Cartão de Crédito",
            "descricao": "Visa 10x",
            "qtdParcelas": 10,
            "valor": 228
        }
    ]
}

Detalhes do Response

PUT /v1/orders/{id}/paid (Sandbox)

Recurso responsável por atualizar o status do pedido pago em sandbox.

Use esse recurso para simular a atualização de status para 'pago' pelo marketplace, pois ao atualizar um pedido para 'pago' ele aparecerá na fila de atualizações

Importante: é necessário que o pedido esteja com o status 'novo'

Request

{
   "dataOcorrencia":"2019-04-25 14:15:00"
 }

Detalhes da Request

PUT /v1/orders/{id}/invoiced

Recurso responsável por atualizar o status do pedido para 'faturado'.

Importante: é necessário que o pedido esteja com o status 'pago'

Request

{
   "dataOcorrencia":"2019-04-25 14:15:00",
   "nfeChave":"11112222333344445555666677778888999900001234",
   "nfeNumero":"11000.1",
   "nfeSerie":"001",
   "nfePdfUrl": "",
   "nfseNumero":"2022/191",
   "nfseCodigoVerificacao":"f31bfa55",
   "nfseUrlConsulta":"www.exemplo.com.br/exemploNfse"
 }

Detalhes da Request

PUT /v1/orders/{id}/sent

Recurso responsável por atualizar o status do pedido para 'enviado'.

Importante: é necessário que o pedido esteja com o status 'faturado'

Request

{
   "dataOcorrencia":"2019-04-25 14:15:00",
   "codigoRastreio":"AB00000000000000BR",
   "linkRastreio":"https://www.linkcorreios.com.br/AB00000000000000BR"
 }

Detalhes da Request

PUT /v1/orders/{id}/delivered

Recurso responsável por atualizar o status do pedido para 'entregue'.

Importante: é necessário que o pedido esteja com o status 'enviado' e como o status 'entregue' é um status final, o status do pedido não poderá mais ser alterado.

Request

{
   "dataOcorrencia":"2019-04-25 14:15:00"
 }

Detalhes da Request

PUT /v1/orders/{id}/canceled (Sandbox)

Recurso responsável por atualizar o status do pedido para 'cancelado' em sandbox.

Use esse recurso para simular a atualização de status para 'cancelado' pelo marketplace, pois ao atualizar um pedido para 'cancelado' ele aparecerá na fila de atualizações

Importante: como o status 'cancelado' é um status final, o status do pedido não poderá mais ser alterado.

Request

{
   "dataOcorrencia":"2019-04-25 14:15:00"
 }

Detalhes da Request

GET /v1/orders/{id}/shipment_labels

Response

{
  "etiquetas": [
    {
      "conteudo": "YXJxdWl2byB0ZXN0ZQ==",
      "tipo": "pdf",
      "canal": "string",
      "idPedidoCanal": "123"
    },
    {
      "conteudo": "YXJxdWl2byB0ZXN0ZQ==",
      "tipo": "zpl",
      "canal": "string",
      "idPedidoCanal": "123"
    },
    {
      "conteudo": "YXJxdWl2byB0ZXN0ZQ==",
      "tipo": "png|jpg",
      "canal": "string",
      "idPedidoCanal": "123"
    }
  ],
  "info": {
    "filtros": [],
    "prev": "",
    "self": "http://localhost/v1/logistic/orders/13127721/shipment_labels?offset=0&limit=100",
    "next": "",
    "offset": 0,
    "limit": 100,
    "exibindo": 0,
    "total": 0
  }
}

Detalhes do Response

Todas as requisições que resultarem em erros, terão o mesmo padrão de retorno. O código de status HTTP retornado indicará se o problema está na requisição (client-site - 4xx) ou no processamento (server-site - 5xx) e a mensagem descreverá os detalhes adicionais sobre o problema.

{
    "error": "Requisição rejeitada.",
    "details": [
        "O SKU 'TESTEAPISIMPLES' já está cadastrado"
    ]
}

O Hub de Marketplaces possui um sistema de cálculo interno de fretes com base em tabelas de contingência e também é integrado com sistemas externos de inteligência de fretes (Intelipost, SimFrete e Frenet), porém caso você possua um cálculo interno de fretes em seu sistema, você poderá disponibilizar uma API para que o Hub de Marketplaces possa executar as consultas de frete.

Cada vez que um cliente adicionar um produto ao carrinho e solicitar o cálculo de frete, o Hub de Marketplaces enviará uma requisição POST para o seu endpoint com todos os dados do cálculo e você deverá calcular e retornar as informações.

Importante: a configuração dessa URL no Hub de Marketplaces é obrigatória para cálculos externos (sem ser a tabela de contingência) do marketplace wap.store, porém, para os demais marketplaces é recomendável que a sua URL seja configurada diretamente em seus respectivos portais, pois como os limites de tempo de resposta são bem rígidos, quanto menos saltos a conexão tiver, mais rápida será a resposta. Caso queira configurar a sua URL no Hub de Marketplaces para o cálculo de fretes do MercadoLivre ou B2W, por exemplo, o tempo total de resposta da sua API (conexão + processamento) para o Hub de Marketplaces deverá ser de até 300ms.

Veja abaixo os requisitos para a integração de sua API de fretes:

• Endpoint deve ser em HTTPs;
• O Status de sucesso deve ser '200 Ok', qualquer outro status será entendido como erro de sua API e o Hub de Marketplaces utilizará a tabela de contingência;
• O tempo total de resposta é de até 1000ms (o Hub de Marketplaces utilizará a tabela de contingência caso esse limite seja ultrapassado);
• O formato da resposta deve corresponder ao modelo descrito nessa documentação;
• O cálculo por contigência não poderá ultrapassar 10% das requisições (10 dias).

POST /seller/freight

Request

{
    "id": "85bovfu28230so6sqtbldq2j30",
    "cep": "01310940",
    "produtos": [
        {
            "sku": "FURADEIRAABC-220v",
            "precoPor":199.00,
            "altura":10.00,
            "largura":15.00,
            "comprimento":25.00,
            "peso":1.000,
            "qtd": 1,
            "tags": [
                "nacional", "internacional"
            ]
        }
    ]
}

Detalhes da Request

Response

{
    "produtos": [
        {
            "sku": "FURADEIRAABC-220v",
            "qtdDisponivel":1,
            "status":"ok",
            "fretes":[
              {
                "id":"SEDEX10",
                "tipo":"expresso",
                "valor":39.00,
                "prazoEntrega":1
              },              
              {
                "id":"SEDEX",
                "tipo":"normal",
                "valor":29.00,
                "prazoEntrega":10
              },
              {
                "id":"PAC",
                "tipo":"economico",
                "valor":15.00,
                "prazoEntrega":20
              }
            ]
        }
    ]
}

{
  "produtos":[
    {
        "sku": "FURADEIRAABC-220v",
        "qtdDisponivel":0,
        "status":"semEstoque",
        "fretes":[]
    }
  ]
}

{
  "produtos":[
    {
        "sku": "FURADEIRAABC-220v",
        "qtdDisponivel":1,
        "status":"regiaoIndisponivel",
        "fretes":[]
    }
  ]
}

{
  "produtos":[
    {
        "sku": "FURADEIRAABC-220v",
        "qtdDisponivel":1,
        "status":"erro",
        "fretes":[]
    }
  ]
}

Detalhes do Response

Configuração e ativação da URL

Para a sua URL de fretes ser ativada no Hub de Marketplaces, além de configurar o endpoint correto é necessário executar uma bateria de testes para garantir que sua API esteja retornando os dados de forma correta e respeitando os limites de tempo de resposta, descritos na documentação. Siga os passos abaixo para configurar e ativar a sua URL no Hub de Marketplaces:

• Acesse o módulo Configurações > Fretes e clique no botão Novo Frete;
  
• Dê um nome para a sua integração de fretes, selecione a opção API para o tipo de frete e submeta o formulário;
  
• Volte para a listagem de fretes e adicione clique no botão de configuração da integração de fretes que você acabou de criar;
  
• Adicione a URL de sua API de fretes e submeta o formulário;
  
• A partir de agora, sua URL está configurada, mas ainda não está ativa. Para ativar, clique no botão Ativar integração;
  
• Preencha todos os dados solicitados para os testes (CEP, dados dos produtos, etc) e clique no botão Executar testes;
  
• Aguarde a finalização da execução e veja os resultados obtidos. Caso tenha sido reprovado em algum dos testes, a sua URL continuará inativa até que os problemas em sua integração sejam corrigidos e um novo teste seja executado. Você poderá ver os detalhes de cada teste clicando no botão Ver detalhes.
  
  
• Caso sua URL tenha sido aprovada em todos os testes, ela será ativada imediatamente e basta aguardar a propagação do cadastro e ela estará ativa em produção.
  
  
  
• Importante: é necessário adicionar a integração de fretes em cada canal de marketplace em que for necessário utilizar o cálculo por meio dela e para isso, basta acessar o módulo Configurações > Canais, clicar no botão de configuração do canal desejado e selecionar a integração no campo Tipo de frete.
  
  

Status de pedido

Status válidos para pedidos no Hub de Marketplaces.

Marketplaces Integrados

Canais de Marketplace integrados com o Hub de Marketplaces.

Status de resposta HTTP

Códigos de retorno HTTP para os recursos da API.