API V1 - Hub de Marketplaces

Para comenzar a desarrollar la integración de su sistema con Marketplaces Hub, necesitará una cuenta en el entorno sandbox, de modo que pueda probar todas las funciones disponibles en la API antes de pasar a producción.

Haga clic en botón a continuación y solicite su cuenta en el entorno sandbox.

Una vez que hayas terminado las pruebas, deberás solicitar la aprobación de tu aplicación completando el formulario con evidencia de las funcionalidades integradas. Luego, nuestro equipo de soporte analizará la información enviada y, si todo es correcto, tu solicitud será aprobada y recibirás el AppToken de producción, que deberás utilizar para integrar a producción a todos los vendedores de tu sistema.

El proceso de aprobación se realizará solo una vez y, después de la aprobación, su aplicación podrá funcionar en producción.

Si su aplicación está en producción y se informan muchos errores, puede revocar su AppToken y tendrá que pasar por el proceso de aprobación nuevamente

Haga clic en el botón a continuación para solicitar la aprobación de su integración.

Los entornos de producción y aprobación están divididos y se puede acceder a ellos a través de las siguientes URL:

Salvadera

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

Producción

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

Las solicitudes POST, PUT y DELETE tienen algunos encabezados útiles en su respuesta, que contienen el ID de la solicitud generada (Request-Id) y los límites de solicitud para cada punto final (X-RateLimit -Limit y X-RateLimit-Remaining). Si tiene problemas con una solicitud, simplemente informe al equipo de soporte del ID de la solicitud, ya que esto facilitará la obtención de los registros y reducirá el tiempo necesario para solucionar el problema.

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

Las API de Marketplace Hub tienen dos niveles de autenticación: autenticación de aplicación y autenticación de integración.

Autenticación de aplicaciones

Todas las aplicaciones integradas tienen un token de identificación llamado AppToken que debe enviarse en el encabezado de todas las solicitudes, ya que sin él no es posible identificar la aplicación conectada y su conexión será denegada inmediatamente.

En producción, cada aplicación tiene un AppToken único; sin embargo, en la aprobación, todas las aplicaciones deben usar el AppToken de homologacao, como se muestra en el siguiente ejemplo:

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

Autenticación de integración

El segundo nivel de autenticación es el de integración, es decir, de la cuenta del vendedor que se desea solicitar.

La autenticación de integración se realiza mediante un token de acceso temporal, generado en la autenticación y que debe ser enviado en el encabezado de todas las solicitudes en el índice Autorización (excepto la solicitud de autenticación, donde solo se debe enviar el AppToken).

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

En producción tenemos varios servicios de protección conectados (firewall, protección anti-DDoS, TLS siempre actualizado, entre otros) y todos estos servicios trabajan para garantizar la integridad del sistema (principalmente porque los datos que pasan por la plataforma es confidencial (números de tarjetas de datos, direcciones, etc.).

Para que su sistema no sea bloqueado por nuestros servicios de seguridad y pueda crear una comunicación estable con nuestras API de producción, es extremadamente importante que todas las solicitudes se envíen agentes de usuario válidos, todas las conexiones se realizan utilizando el protocolo HTTPS y que su sistema admite los certificados TLS/SSL más actualizados (use un servicio en línea como SSL Labs para comprobar qué certificado TLS/SSL es compatible con los servidores de producción).

Además, el uso de una IP fija en La producción de solicitudes también es muy importante, ya que nuestro equipo de infraestructura y seguridad puede crear reglas específicas para esta IP, lo que aumenta en gran medida la seguridad y reduce el riesgo de bloqueo.

En el entorno de aprobación, el riesgo de bloqueo por seguridad Los servicios son bajos, así que siempre desarrolle su aplicación enfocándose en los niveles máximos de seguridad que se requerirán en producción.

POST /v1/auth

Recurso responsable de generar el token de autenticación de integración.

Para este recurso el único token que se debe enviar en el encabezado es el AppToken, ya que en este momento tienes aún no tendrá el token de integración.
Los datos enviados en el cuerpo (ApiKey y SecretKey) están relacionados con la cuenta de integración del Vendedor (cuenta de aprobación o producción).

Después de generar el token, tendrá una validez de 30 minutos y deberá enviarse en el encabezado Autorización de otras API.

Importante: Siempre que Se genera un nuevo token, el anterior será revocado y perderás el acceso inmediatamente.

Request

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

Detalles de la request

Response

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

Detalles de la respuesta

GET /v1/ping

Ruta de prueba de tokens. Utilice esta URL para probar el token generado en el recurso de autorización. Si recibe la palabra 'pong' (en texto sin formato), significa que su solicitud fue autenticada exitosamente, es decir, su AppToken y su token temporal son válidos.

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"
}

Las siguientes funciones permiten una gestión completa de los productos y sus variaciones.

Importante: Los productos también se pueden cambiar a través del panel; sin embargo, los cambios se perderán si llegan nuevas actualizaciones. desde la API.

GET /v1/products

Recurso responsable de enumerar todos los productos registrados, ordenados por fecha de registro.

En este recurso, solo se devolverán los datos básicos del producto, por lo que es necesario realizar una llamada al recurso de consulta de producto individual para obtener todos los datos sobre un producto 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
    }
}

Detalles de la respuesta

GET /v1/products/{sku}

Recurso de consulta de producto individual responsable de devolver todos los datos registrados para un producto.

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
        }
    ]
}

Detalles de la respuesta

GET /v1/products/variation/{sku}

Recurso de consulta individual para una variación (voltaje/tamaño) de un producto, responsable de devolver todos los datos registrados para una variación

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
}

Detalles de la respuesta

POST /v1/products

Función de registro de producto individual, responsable de registrar un producto por pedido.

Cada producto solo puede tener un color y variar por talla o voltaje, es decir, no es posible tener más de un color. en un mismo producto o el mismo producto tiene variaciones de tamaño y voltaje al mismo tiempo. Para tener productos con diferentes colores, simplemente registra los dos productos, vinculándolos mediante el campo skuProdutoLider. Si el producto actual es líder (líder de variaciones de color o un solo producto, sin variaciones), envíe el mismo SKU en los campos skuProduto y skuProdutoLider.

Importante: el producto líder debe registrarse antes que los productos secundarios.

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
    }
  ]
}

Detalles de la 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
        }
    ]
}

Detalles de la respuesta

POST /v1/products/batch

Función de registro de productos por lotes, responsable de registrar varios productos a la vez. Las restricciones para los registros de color, tamaño, voltaje y enlace de producto son las mismas que para la función de registro individual.

Importante: si el mismo lote tiene un producto líder y sus hijos , el producto líder debe aparecer antes que sus productos secundarios.

Utilice la función de consulta por lotes para verificar el estado de procesamiento del lote creado.

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"
        }
      ]
    }
  ]
}

Detalles de la request

Response

{
    "id": 80
}

Detalles de la respuesta

PUT /v1/products/{sku}

Función de cambio de producto individual, responsable de cambiar la información del producto.

Importante: una vez registrado, un producto no puede tener los campos skuProdutoLider b> o skuProduto cambió, si se define algún color para el producto (en el registro o en una actualización), no se puede eliminar vía API y no es posible eliminar variaciones de tamaño o voltaje vía API

Request

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

Detalles de la 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
        }
    ]
}

Detalles de la respuesta

PUT /v1/products/variation/{sku}

Función de actualización de variaciones individuales, responsable de cambiar la información sobre una única variación de un producto

Importante: no es posible cambiar el SKU de una variación.

Request

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

Detalles de la 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
}

Detalles de la respuesta

PUT /v1/products/batch

Función de actualización de productos por lotes, responsable de actualizar varios productos a la vez. Las restricciones para los cambios son las mismas que para la función de actualización individual.

Utilice la función de consulta por lotes para verificar el estado de procesamiento del lote creado.

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,
    }
  ]
}

Detalles de la request

Response

{
    "id": 80
}

Detalles de la respuesta

PUT /v1/products/stock-batch

Función de actualización de lotes de inventario de productos.

Utilice la función de consulta de lotes para comprobar el estado de procesamiento del lote creado.

Request

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

Detalles de la request

Response

{
    "id": 80
}

Detalles de la respuesta

PUT /v1/products/price-batch

Función de actualización de lotes de precios de productos.

Utilice la función de consulta de lotes para comprobar el estado de procesamiento del lote creado.

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
		}
	]
}

Detalles de la request

Response

{
    "id": 80
}

Detalles de la respuesta

DELETE /v1/products/{sku}

Función de exclusión de productos individuales, responsable de eliminar un producto.

Importante: no es posible eliminar productos que estén vinculados a un canal del mercado y no es posible eliminar productos que tengan hijos, en este caso es necesario eliminar primero los productos hijos y luego eliminar el producto líder

GET /v1/batch/{id}

Recurso responsable de devolver todos los detalles sobre un lote, como su estado, artículos procesados, errores encontrados, fecha de creación y fecha de procesamiento de cada artículo.

Importante Los lotes se pueden consultar vía API hasta 10 días después de su creación. Después de este período, los detalles de un lote solo se pueden obtener mediante llamada.

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"
        }
    ]
}

Detalles de la respuesta

GET /v1/orders

Recurso responsable de enumerar todos los pedidos de los vendedores en Marketplaces Hub, ordenados por fecha de emisión.

En este recurso, solo se devolverán los datos básicos del pedido, lo que requiere una llamada al recurso de consulta de pedidos individuales. para obtener todos los datos sobre un 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
    }
}

Detalles de la respuesta

GET /v1/orders/{id}

Función de consulta de pedido individual, responsable de devolver toda la información sobre un 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
        }
    ]
}

Detalles de la respuesta

GET /v1/orders/queue

Función de consulta de cola de actualización de pedidos. Cada vez que llegue un nuevo pedido o el mercado actualice su estado, aparecerá en esta cola. Configure su sistema para consumir la cola de actualizaciones para recibir siempre nuevos pedidos y actualizaciones de estado.

En esta función, se devuelven todos los datos del pedido, es decir, no es necesario realizar una segunda solicitud para obtener todos los pedidos. información.

Importante: Después de actualizar su sistema, debe eliminar el pedido de la cola utilizando la función Eliminar pedidos de la cola. Si no hace esto, cada vez que consulte la cola seguirá recibiendo las mismas solicitudes.

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
    }
}

Detalles de la respuesta

DELETE /v1/orders/queue/{id}

Recurso responsable de eliminar pedidos de la cola de actualización.

En este recurso es necesario enviar el estado importado por tu sistema (esta información aparece en el panel de Marketplaces Hub para el Vendedor) y también un ID numérico exclusivo del pedido generado en su sistema. Si no tiene un ID numérico único, envíe el ID del pedido generado en Marketplaces Hub en este campo.

Request

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

Detalles de la request

POST /v1/orders (Sandbox)

Recurso responsable de la creación de pedidos en sandbox.

Utiliza este recurso para simular la creación de pedidos a través del mercado, ya que al crear un nuevo pedido aparecerá en la cola de actualizaciones

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
          }
       ]
 }

Detalles de la 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
        }
    ]
}

Detalles de la respuesta

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

Recurso responsable de actualizar el estado del pedido pagado en sandbox.

Utilice esta función para simular la actualización del estado a "pagado" por parte del mercado, porque cuando actualice un pedido a "pagado" aparecerá en la cola de actualización

Importante: El pedido debe tener un estado 'nuevo'

Request

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

Detalles de la request

PUT /v1/orders/{id}/invoiced

Recurso responsable de actualizar el estado del pedido a 'facturado'.

Importante: el pedido debe tener el estado 'pagado'

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"
 }

Detalles de la request

PUT /v1/orders/{id}/sent

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

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

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

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
  }
}

Detalles de la respuesta

Todas las solicitudes que resulten en errores tendrán el mismo patrón de devolución. El código de estado HTTP devuelto indicará si el problema está relacionado con la solicitud (sitio-cliente - 4xx) o con el procesamiento (sitio-servidor - 5xx) y el mensaje describirá detalles adicionales sobre el problema.

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

El Marketplaces Hub tiene un sistema de cálculo de flete interno basado en tablas de contingencia y también está integrado con sistemas externos de inteligencia de flete (Intellipost, SimFrete y Frenet), pero si tiene un cálculo de flete interno en su sistema, puede proporcionar una API para que Marketplaces Hub pueda ejecutar consultas de envío.

Cada vez que un cliente agrega un producto al carrito y solicita un cálculo de envío, Marketplaces Hub enviará una solicitud POST a su punto final con todos los datos del cálculo y debes calcular y devolver la información.

Importante: configurar esta URL en Marketplaces Hub es obligatorio para cálculos externos (que no sean la tabla de contingencia) del mercado wap.store, sin embargo, para otros mercados se recomienda que tu URL se configure directamente en sus respectivos portales, ya que los límites de tiempo de respuesta son muy estrictos, cuantos menos saltos tengas de conexión, más rápida será la respuesta. Si deseas configurar tu URL en Marketplaces Hub para calcular el envío de MercadoLivre o B2W, por ejemplo, el tiempo total de respuesta de tu API (conexión + procesamiento) al Marketplaces Hub debe ser de hasta 300ms.

Vea a continuación los requisitos para integrar su API de envío:

• El punto final debe estar en HTTPs;
• El estado de éxito debe ser '200 Ok', cualquier otro estado se entenderá como un error en su API y Marketplaces Hub usará la tabla de contingencia;
• El tiempo total de respuesta es de hasta 1000 ms (Markets Hub usará la tabla de contingencia si se excede este límite);
• El formato de respuesta debe corresponder al modelo descrito en esta documentación;
• El cálculo de la contingencia no puede exceder el 10% de las solicitudes (10 días). p>

  POST /seller/freight

  Información del endpoint
  Ambiente	Sandbox / Producción
  Estado de éxito	200 Ok

  Request

  Ejemplo de consulta de flete

  {
      "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"
              ]
          }
      ]
  }
  

  Detalles de la request

  Campo	Tipo	Obligatorio	Descripción
  id	String	Si	ID da requisição de frete
  cep	String	Si	CEP de destino
  produtos	Data Collection	Si	Produtos requisitados
  sku	String	Si	SKU do produto/variação
  precoPor	Number	Si	Preço 'por' unitário do produto/variação exibido para o cliente
  altura	Number	Si	Altura do produto/variação
  largura	Number	Si	Largura do produto/variação
  comprimento	Number	Si	Comprimento do produto/variação
  peso	Number	Si	Peso do produto/variação
  qtd	Number	Si	Quantidade solicitada do produto/variação
  tags	Array	No	Nome(s) da(s) tag(s) do produto

  Response

  Ejemplo de una respuesta exitosa a una consulta de transporte

  {
      "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
                }
              ]
          }
      ]
  }
  

  Ejemplo de respuesta de falta de stock a una consulta de envío

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

  Ejemplo de respuesta de región no disponible para consulta de envío

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

  Ejemplo de respuesta de error para consulta de envío

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

  Detalles de la respuesta

  Campo	Tipo	Descripción
  produtos	Data Collection	Produtos requisitados
  sku	String	SKU do produto/variação
  qtdDisponivel	Number	Quantidade total do produto/variação disponível em estoque no momento
  status	String	Status do cálculo de frete para o produto. Retorne ok para todos os casos em que o frete foi calculado corretamente, retorne semEstoque ou regiaoIndisponivel para impedir a venda do produto no marketplace e retorn erro para indicar ao Omni que o cálculo deve ser feito pela tabela de contingência. Valores aceptados: ok, semEstoque, regiaoIndisponivel, erro
  fretes	Data Collection	Opções de frete
  id	String	Identificador do frete no seu sistema (aparecerá no pedido no campo 'tipoFrete', caso o canal de marketplace nos informe)
  tipo	String	Tipo de frete Valores aceptados: economico, normal, expresso
  valor	Number	Valor total do frete a ser cobrado Valor mínimo: 0 | Valor máximo: 999999.99
  prazoEntrega	Number	Prazo de entrega do produto em dias úteis (para alguns marketplaces, o prazo de entrega mostrado para o cliente será o maior prazo entre os itens calculados) Valor mínimo: 1 | Valor máximo: 365

  Configuración y activación de URL

  Para que su URL de envío se active en Marketplaces Hub, además de configurar el punto final correcto, debe ejecutar una batería de pruebas para asegurarse de que su API devuelva datos correctamente y respete los límites de tiempo de respuesta, descritos en la documentación. Siga los pasos a continuación para configurar y activar su URL en Marketplaces Hub:

  • Acceda al módulo Configuración > Envío y haga clic en Nuevo envío. botón b>;
    
  • Asigne un nombre a su integración de envío, seleccione la opción API para el tipo de envío y envíe el formulario;
    
  • Regrese a la lista de envío y agregue, haga clic en el botón de configuración de integración de envío que acaba de crear;
    
  • Agregue la URL de su API de envío y envíe el formulario;
    
  • A partir de ahora, su URL está configurada, pero aún no está activa. Para activar, haga clic en el botón Activar integración;
    
  • Complete todos los datos solicitados para las pruebas (CEP, datos del producto, etc.) y haga clic en el botón Ejecutar pruebas. ;
    
  • Espere a que finalice la ejecución y vea los resultados obtenidos. Si no pasó alguna de las pruebas, su URL permanecerá inactiva hasta que se solucionen los problemas en su integración y se ejecute una nueva prueba. Puede ver los detalles de cada prueba haciendo clic en el botón Ver detalles.
    
    
  • Si tu URL ha pasado todas las pruebas, se activará inmediatamente y solo tendrás que esperar a que propagación del registro y quedará activo en producción.
    
    
    
  • Importante: es Es necesario agregar integración de carga en cada canal del Marketplace donde sea necesario utilizar el cálculo a través del mismo y para ello simplemente acceder al módulo Configuración > Canales, hacer clic en el botón de configuración del canal deseado y seleccionar integración en el campo Tipo de envío.
    
    

Estado del pedido

Estado válido para pedidos de Marketplaces Hub

Mercados integrados

Canales de Marketplace integrados con Marketplaces Hub.

Estado de respuesta HTTP

Códigos de retorno HTTP para recursos API.