Para começar a desenvolver a integração do seu sistema com o Wapstore, você precisará de um par de chaves válidas para integração e de um ambiente para executar as requisições. Esse ambiente poderá ser diretamente a loja em produção (as chaves serão geradas pelo administrador da loja) ou no ambiente sandbox, porém o ambiente de sandbox precisa ser solicitado à equipe Wapstore pelo e-mail suporte@wapstore.com.br
Os endpoints corretos de homologação e produção serão disponibilizados a partir da solicitação, seja ela para a equipe Wapstore (sandbox) ou para o administrador da loja (produção).
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 WapStore são autenticadas por um token temporário gerado no recurso de autorização.
No Wapstore não existe processo de homologação, ou seja, uma vez criadas as chaves, sua aplicação já poderá ser conectada ao sistema e utilizar os recursos da API em produção.
Por esse motivo todas as aplicações deverão utilizar o mesmo token de aplicação. O token de aplicação é chamado de AppToken e deve ser enviado no header de todas as requisições. Todas as aplicações devem utilizar o AppToken wapstore, conforme o exemplo abaixo:
App-Token: wapstore
Content-Type: application/json
cache-control: no-cache
O segundo nível de autenticação é o da integração, ou seja, da conta de API a ser conectada.
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: wapstore
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.
Buscando um melhor fluxo de integração com a fila de atualizações, possuímos um webhook responsável por notificar uma url configurada sempre que houverem novos itens na fila. Para utilizar o recurso, entre em contato com a equipe de suporte da wap.store ou com o administrador da loja e solicite a configuração do serviço.
A url configurada será receptora das notificações e deverá responder com o status HTTP 200 Ok a todas as notificações. Caso o status seja diferente, após 10 tentativas de notificação, o webhook será automaticamente inativado, dado à inconsistência da integração.
Caso ocorra a inativação do serviço, entre em contato com a equipe de suporte da wap.store ou administrador da loja novamente para solicitar a re-ativação.
É 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. Por padrão, assim que o webhook é configurado, a confirmação de leitura da fila se torna 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 a confirmação automática de leitura seja mantida para diminuição de possíveis inconsistências nas notificações, porém, caso seja necessário, é possível ativar a confirmação de leitura manual. Neste caso, a confirmação de leitura deve ser executada manualmente após o recebimento da notificação, caso não aconteça, muitas notificações com os mesmos itens serão enviadas.
Cada notificação possui um id, o id do token registrado, o domínio da fila referente à notificação atual, url's de leitura e confirmação de leitura (quando em confirmação manual), a data de envio da requisição e um array com os identificadores dos itens que sofreram atualizações recentemente.
{
"id":3,
"idToken":16,
"dominio":"produto",
"urlLeitura":"GET http://localhost/modelos/site/api/v2/products/{item}",
"urlConfirmacaoLeitura":"confirmacao-automatica",
"data":"2022-10-14 08:12:17",
"itens":[
"24",
"132",
"217",
"218",
"432"
]
}
Você pode importar nossa collection para o Postman pelo link: https://www.getpostman.com/collections/dd8ebdb464b5c47274de
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 de API (chaves geradas pelo administrador da loja ou equipe Wapstore).
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.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 30 |
{
"apiKey": "1234A5678B9012C3456",
"secretKey":"3456D9012E5678F1234"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
apiKey | String | Sim | Chave pública da API de integração do Seller |
secretKey | String | Sim | Chave privada da API de integração do Seller |
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvYXBpLm9tbmkud2Fwc3RvcmUuY29tLmJyXC8iLCJhdWQiOiJBcGkgZGUgVGVzdGUiLCJpYXQiOjE1NTc0NTc2OTYsIm5iZiI6MTU1NzQ1NzY5NiwiZXhwIjoxNTU3NDU5NDk2LCJ0aWQiOiI5MzRjZTY2ZGY5MDQ1YWNmMzY1MGIyZWEzNWUxYjMwMSJ9.Ii148QGob19NI2-fsMbqvMpmVFyGR3bkJjSbOxaCxmg"
}
Campo | Tipo | Descrição |
---|---|---|
token | String | Token de acesso gerado para as APIs |
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.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
No WapStore, um pedido pode ter itens vendidos de mais de um armazém (caso o lojista tenha essa opção ativa) e caso um pedido tenha mais de um armazém o WapStore cria subpedidos vinculados ao pedido base, pois entende-se que serão necessários códigos de rastreios diferentes, notas fiscais diferentes e até status diferentes para cada subpedido. O mesmo acontece para pedidos que são feitos com itens de sellers do Marketplace Wapstore, pois devem ser separados do itens normais da loja.
Sempre que uma consulta for feita nos recursos de pedidos (/orders) ou fila de atualizações de pedidos (/orders/queue) os pedidos apresentados já estarão separados em subpedidos e você poderá identificar o pedido base (pedido que gerou os sub pedidos) com base no código disponível no campo detalhes > numeroPedidoBase.
Importante: Subpedidos diferem em valor total, subtotal, valor de frete, descontos e juros aplicados. Os dados de pagamentos (gateways, transações, boletos bancários, etc) são compartilhados entre os subpedidos, ou seja, em todos os sub pedidos as informações de pagamento estarão completas e com os mesmos valores.
Recurso responsável por listar todos os pedidos da WapStore, ordenados pela data de emissão.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os pedidos pelos status. Envie o ID de um ou mais status separados por '|' (Veja os IDs de status disponíveis consultando a API de status de pedido) Exemplo de requisição: /v2/orders?status=1|3 tipo: Filtra os pedidos pelo seu tipo. Envie o valor 'marketplace' para obter pedidos que são de marketplace, ou 'wapstore'para pedidos com itens da própria loja. Exemplo de requisição: /v2/orders?tipo=marketplace origem: Filtra a origem do pedido. Envie até dois dos valores 'wapstore', 'connect' ou 'api', para obter pedidos gerados de acordo com a sua origem Exemplo de requisição: /v2/orders?origem=wapstore dataEmissao: Filtra os pedidos pela data de emissão. Envie uma data ou um intervalo de duas datas separadas por '|' Exemplo de requisição: /v2/orders?dataEmissao=2019-08-05|2019-08-06 idMarketplaceSeller: Filtra os pedidos pelo seller do marketplace. Envie o ID de um seller, para listar pedidos do marketplace, ou envie '0' para listar apenas pedidos da loja Exemplo de requisição: /v2/orders?idMarketplaceSeller=1 idArmazem: Filtra os pedidos pelo ID do armazém. Envie o ID de até dois armazéns separados por '|' Exemplo de requisição: /v2/orders?idArmazem=3|8 codigoArmazem: Filtra os pedidos pelo código do armazém. Envie o código de até dois armazéns separados por '|' Exemplo de requisição: /v2/orders?codigoArmazem=69133525000100|0002 personalizacao: Filtra os pedidos que possuem ou não uma personalização. Valores aceitos 's' ou 'n'. Exemplo de requisição: /v2/orders?personalizacao=s order: Ordernação de orders.Valores aceitos 'id DESC' e 'id ASC' Exemplo de requisição: /v2/orders?order=id DESC codigoUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders?codigoUsuario=gerente emailUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders?emailUsuario=maria@gmail.com idUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders?idUsuario=550 |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/orders?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pedidos":[
{
"numeroPedido": "123456-1",
"idPagamento": 150,
"canal": "wapstore",
"tipoLogistica": "logistica",
"parceiroCanal": "wapstore",
"ip": "186.230.24.242",
"recomendacao": "Vendedor X",
"hash": "a2ae6a7df4c46fd5e8c93aecb7a88a94",
"dataEmissao": "2018-04-18 18:28:18",
"moeda": "BRL",
"previsaoEntrega": "2018-04-28",
"detalhes": {
"marketplace":true,
"idPedidoPlataforma": "WS-123",
"numeroPedidoBase": "123456",
"subpedido": 1,
"qtdItens": 2,
"qtdSubpedidos": 2,
"subpedidos":[
"123456-1",
"123456-2"
],
"canal": "wapstore",
"armazem": {
"id": 47,
"codigoInterno": "123123123123123",
"nome": "Parceiro Omni",
"principal": false
},
"seller":{
"id":47,
"nome":"Parceiro Omni",
"cnpj":"123123123123123"
}
},
"status": {
"id": 3,
"idPai": 3,
"descricao": "Pago",
"descricaoPainel": "",
"descricaoSite": "",
"dataAlteracao": "2020-08-05 23:16:07",
"dataOcorrencia": "2020-08-05 20:16:07"
},
"intermediador": {
"id": 89,
"nome": "Fulano Ciclano",
"email": "fulano.ciclnano@email.com.br",
"cpfCnpj": "12345678912",
"rgIe": "",
"pessoa": "f",
"telefone": "1812345678",
"celular": "18999999999",
"nascimento": "14/02/1997",
"sexo": "m",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"canalVenda": {},
"atividadePrincipal": {
"cnae": "4753900",
"descricao": "Comércio varejista especializado de eletrodomésticos e equipamentos de áudio e vídeo"
},
"atividadesSecundarias": [
{
"cnae": "4755503",
"descricao": "Comércio varejista de artigos de cama, mesa e banho"
},
{
"cnae": "4755502",
"descricao": "Comércio varejista de artigos de armarinho"
},
{
"cnae": "4789001",
"descricao": "Comércio varejista de suvenires, bijuterias e artesanatos"
}
]
},
"cliente": {
"id": 282731,
"nome": "Cliente de Teste",
"email": "cliente@teste.com.br",
"cpfCnpj": "11111111000101",
"rgIe": "",
"pessoa": "j",
"telefone": "",
"celular": "(24) 99995-2015",
"nascimento": "",
"sexo": "j",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"representante": {
"id": 547,
"codigoInterno": "WAP030521",
"nome": "Representante Teste",
"email": "representante@email.com"
},
"entrega": {
"cep": "36660000",
"destinatario": "Destinatário Teste",
"tipo": "casa",
"endereco": "Rua Teste",
"bairro": "Centro",
"cidade": "Teste",
"uf": "SP",
"numero": "180",
"complemento": "LOJA 03",
"referencia": ""
},
"faturamento": {
"cep": "36660000",
"destinatario": "Destinatário Teste",
"tipo": "casa",
"endereco": "Rua Teste",
"bairro": "Centro",
"cidade": "Teste",
"uf": "SP",
"numero": "180",
"complemento": "LOJA 03",
"referencia": ""
},
"destinatarioRetirada": {
"idPedido": "1811",
"nome": "Fulano Teste",
"cpfCnpj": "12345678912",
"informacoesAdicionais": [
{
"titulo": "Campo teste",
"valorAtual": "valor teste"
}
]
},
"frete": {
"id": 4,
"nome": "PAC",
"transportadora": "Correios",
"prazoEntrega": 10,
"idFreteCotacao": "651065106516651"
},
"cupom": {
"id": 1,
"hash": "cupomteste"
},
"vendaInterna": {
"id": 97,
"codigoInterno": "atendenteTeste",
"idUsuario": "43",
"nomeUsuario": "Atendente Teste",
"enviarEmail": true,
"observacao": "Teste de observação"
},
"bloqueios": [
{
"id": 65,
"idBloqueioPedido": 3,
"nomeBloqueio": "Bloqueio Tipo de Venda 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"observacao": "Tudo certo",
"idPedido": 27019,
"status": "aprovado",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 4,
"nome": "Admin 2",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:16"
},
{
"id": 66,
"idBloqueioPedido": 9,
"nomeBloqueio": "Bloqueio Tipo de Venda Teste 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"idPedido": 27019,
"status": "aprovado",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 7,
"nome": "Admin 4",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:44"
}
],
"tipoVenda": {
"id": 1,
"nome": "Venda futura"
},
"promocao": {
"ativo": true,
"id": 12,
"titulo": "Promoção verão 2019",
"tipo": "frete_fixo",
"valor": 138.00
},
"pontosGastos": 22.33,
"detalhesPontosGastos": [
{
"quantidade": 22.33,
"valorEmMoeda": 0.44,
"canalVendaOrigem": {
"id": 0,
"nome": "wap.store",
"dominio": "https://lojascrum.wapstore.com.br/",
"tipo": "principal"
}
}
],
"pontosGerados": {
"pedido": {
"quantidade": 45,
"valorEmMoeda": 22.5,
"status": "pendente"
}
},
"itens": [
{
"id": 238,
"idAtributoSimples": 0,
"nome": "Ar Condicionado Split Hi Wall Springer Midea 18000 BTUs Frio 220V - 42MACA18S5",
"descricao": "",
"quantidade": 1,
"valor": 1900.00,
"sku": "100212273",
"skuSeller":"ARCSPLSPR18000220V",
"tipo":"produto",
"caracteristicas": {
"7": "220V",
"8": "7 oitavas"
},
"devolvido":false,
"personalizacoes": [
{
"id": 13,
"nome": "Personalize com seu nome",
"valor": "Teste web.art",
"quantidade": 1,
"precoUnitario": 10,
"precoTotal": 10
},
{
"id": 14,
"nome": "Adicione uma estampa",
"valor": "Logotipo teste",
"quantidade": 1,
"precoUnitario": 5,
"precoTotal": 5
}
],
"cancelamentoSeller":{
"usuario":"Seller Teste",
"motivo":"Produto sem estoque",
"dataCancelamento":"2019-06-19 00:00:00"
},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{
"id":27,
"nome":"Rebate FDS 2019",
"valorOriginal":1981.98,
"valorRebate":1900.00,
"percentual":0.5
},
"comissaoAplicada":{
"percentual":0.5,
"valor":9.5
}
},
"entrega": {
"nfeNumero": "000186418",
"nfeSerie": "000186418",
"nfeChave": "32180401754239001868550010001864181000235711",
"rastreio": "CE1231CA2312B3",
"frete": {
"valor": 69.00,
"idFreteCotacao": "651065106516651"
}
}
},
{
"id": 269,
"idAtributoSimples": 0,
"nome": "Ar Condicionado Split Hi Wall Springer Midea 30000 BTUs Frio 220V - 42MACA30S5",
"descricao": "",
"quantidade": 1,
"valor": 3386.79,
"sku": "100213180",
"skuSeller":"ARCSPLSPR30000220V",
"devolvido":false,
"personalizacoes": [],
"cancelamentoSeller":{},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{},
"comissaoAplicada":{
"percentual":1,
"valor":33.87
}
},
"entrega": {
"nfeNumero": "000186418",
"nfeSerie": "000186418",
"nfeChave": "32180401754239001868550010001864181000235711",
"rastreio": "CE1231CA2312B3",
"frete": {
"valor": 69.00,
"idFreteCotacao": "651065106516651"
}
}
}
],
"comissao": {
"pedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
],
"subpedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
]
},
"pagamento": [
{
"id": 150,
"nome": "MasterCard",
"bandeira": "mastercard",
"gateway": "mundipagg",
"parcelas": 10,
"vencimentoBoleto": "",
"numeroBanco": "",
"valor": 5424.79,
"retentativa": 1,
"detalhes": {
"chavePedido": "a837a781-58ab-4bf3-96ed-0000000000",
"referenciaPedido": "123456",
"chaveTransacao": "028ec811-4989-4440-b078-0000000000",
"referenciaTransacao": 164,
"codigoAutorizacao": "101010",
"adquirente": "Redecard",
"codigoBarras": "",
"linhaDigitavel": "",
"statusTransacao": "Captured",
"tipoPagamento": "creditCard",
"dataCapturaPagamento": "2018-04-21T14:30:52"
}
},
{
"id": 118,
"nome": "Depósito Bancário",
"bandeira": "deposito",
"gateway": "proprio",
"cnpjGateway": "",
"parcelas": 1,
"vencimentoBoleto": "2023-05-07",
"numeroBanco": "87987",
"valor": 328.47,
"retentativa": 0,
"aprovacaoManual": {
"status": "pago",
"historico": [
{
"idUsuario": 2,
"nomeUsuario": "Fulano Ciclano",
"observacao": "Pagamento aprovado",
"data": "2023-05-08 16:19:42"
}
]
},
"pagamentoPersonalizado": {
"id": 1,
"nome": "Pagamento Personalizado",
"informacoesAdicionais": [
{
"hash": "informacao-adicional-checkbox",
"valor": [
"Bradesco",
"Itaú"
]
},
{
"hash": "informacao-adicional-numero",
"valor": [
"123"
]
},
{
"hash": "informacao-adicional-texto",
"valor": [
"teste"
]
},
{
"hash": "informacao-adicional-select",
"valor": [
"Opção 4"
]
}
]
},
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"linhaDigitavel": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"numeroSequencialUnicoCaptura": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
],
"valores": {
"subtotal": 5286.79,
"juros": 0.00,
"frete": 138.00,
"presente": 0.00,
"descontoCupom": 0.00,
"descontoBoleto": 0.00,
"descontoRevendedor": 0.00,
"descontoPromocao": 0.00,
"descontoVoucher": 0.00,
"descontoAdicional": 0.00,
"descontoTotal": 0.00,
"comissao":43.77,
"comissaoEstornada":9.5,
"totalComissao":34.27,
"totalPedido": 5424.79,
"totalEstornado":1969.00,
"total":3524.79
},
"informacoesAdicionais": [
{
"hash": "como-voce-conheceu-a-loja",
"valor": "Youtube"
},
{
"hash": "pra-que-time-voce-torce",
"valor": "Flamengo"
}
],
"historico": [
{
"id": 16,
"idStatus": 1,
"detalhes": {
"1008":{
"nome":"Alteração de status",
"mensagem":"",
"email":"cliente@teste.com.br",
"sms":"(23) 1313-1313",
"1008":{
"alteracoes":{
"idPedStatus":"1",
"idPedSubStatus":"1"
}
}
}
},
"tipo": "status",
"dataAlteracao": "2020-08-04 16:17:22",
"dataOcorrencia": "2020-08-04 13:17:22"
}
],
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/orders?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":1,
"total":1
}
}
Campo | Tipo | Descrição |
---|---|---|
pedidos | Data Collection | Pedidos listados |
numeroPedido | String | Número do pedido/subpedido gerado |
idPagamento | Number | ID da forma de pagamento do pedido (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
canal | String | Define se o pedido foi gerado na plataforma (wapstore), se foi gerado por um marketplace (omni) ou se foi criado via integração (api) Valores aceitos: api, omni, wapstore |
tipoLogistica | String | Tipo de logística do pedido |
canalLoja | String | Loja que gerou o pedido |
parceiroCanal | String | Nome do parceiro do canal que gerou o pedido (CNOVA, B2W, etc) |
ip | String | IP do cliente ou sistema que gerou o pedido |
recomendacao | String | Recomendação do pedido |
hash | String | Hash única do pedido (a mesma hash é compartilhada em todos os sub pedidos) |
dataEmissao | String | Data e hora que o pedido foi criado na WapStore Formato esperado: 2019-05-11 22:15:00 |
previsaoEntrega | String | Data prevista de entrega para o pedido (YYYY-MM-DD) |
moeda | String | Moeda em que o pedido foi gerado (BRL, USD...) |
detalhes | Object | Detalhes adicionais sobre o pedido |
marketplace | Boolean | Define se o pedido tem produtos de um seller do marketplace (true) ou da própria loja (false) |
idPedidoPlataforma | String | Mapeamento do pedido entre a wap.store e a plataforma de marketplace |
numeroPedidoBase | String | Número do pedido base que gerou os sub pedidos |
subpedido | Number | Número do sub pedido atual |
qtdItens | Number | Quantidade de itens no pedido |
qtdSubpedidos | Number | Quantidade de sub pedidos gerados |
subpedidos | Array de strings | Subpedidos vinculados |
canal | Object | Dados da transação quando vier do marketplace |
nomeSeller | String | Nome do seller que fez a venda |
cnpjMarketplace | String | CNPJ do marketplace que fez a venda |
armazem | Object | Dados do armazém responsável por esse pedido/subpedido. |
seller | Object | Dados do seller (apenas para pedidos do marketplace) |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
status | Object | Detalhes do status do pedido |
id | Number | ID do status (veja todos os IDs de status consultando a API de status de pedido) |
idPai | Number | ID do status pai (status principal do pedido - caso o status atual seja intermediário) |
descricao | String | Nome do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
dataAlteracao | String | Data de alteração do status |
dataOcorrencia | String | Data de ocorrencia do status |
intermediador | Object | Dados do intermediador (cliente que efetuou a compra, disponível no modelo de negócio B2B2C) |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
cliente | Object | Dados do cliente |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
representante | Object | Dados do representante |
id | Number | Identificador do usuário representante |
codigoInterno | String | Código interno do usuário representante |
nome | String | Nome do usuário representante |
String | E-mail do usuário representante | |
entrega | Object | Dados da entrega |
cep | String | CEP de entrega |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de entrega |
bairro | String | Bairro de entrega |
cidade | String | Cidade de entrega |
uf | String | UF de entrega |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para entrega |
faturamento | Object | Dados do endereço de faturamento |
cep | String | CEP de faturamento |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de faturamento |
bairro | String | Bairro de faturamento |
cidade | String | Cidade de faturamento |
uf | String | UF de faturamento |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para o endereço de faturamento |
destinatarioRetirada | Object | Dados do destinatário do pedido de retirada em loja |
idPedido | Number | Identificador do pedido |
nome | String | Nome do destinatário |
cpfCnpj | String | CPF ou CNPJ do destinatário |
informacoesAdicionais | Object | Informações adicionais do destinatário |
pontoRetirada | Object | Dados do destinatário do pedido de retirada em loja |
id | Number | Id do ponto de retirada |
nome | String | Nome do ponto de retirada |
valor | Number | Valor do custo da retirada |
prazo | String | Prazo para poder retirar |
local | Object | Lista com o endereço do ponto de retirada |
endereco | String | Endereço do ponto de retirada |
numero | String | Número do endereço do ponto de retirada |
bairro | String | Bairro do ponto de retirada |
cidade | String | Cidade do ponto de retirada |
cep | String | CEP do ponto de retirada |
obs | String | Observação do endereço do ponto de retirada mono estoque |
latitude | String | Latitude do ponto de retirada multi estoque |
longitude | String | Longitude do ponto de retirada multi estoque |
horarioFuncionamento | String | Horário de funcionamento do ponto de retirada multi estoque |
frete | Object | Dados de frete |
id | Number | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) |
nome | String | Nome do tipo de frete (Ex. SEDEX, PAC, etc) |
transportadora | String | Nome da transportadora (Ex. Correios) |
prazoEntrega | Number | Prazo de entrega do pedido em dias úteis |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
cupom | Object | Dados de cupom utilizado |
id | Number | ID do cupom utilizado |
hash | String | HASH do cupom utilizado |
vendaInterna | Object | Dados de venda interna (somente para pedidos que contenham venda interna) |
id | Number | ID da venda interna que gerou o pedido |
codigoInternoUsuario | String | Código interno do usuário que gerou a venda interna |
idUsuario | Number | ID do usuário que gerou a venda interna |
nomeUsuario | String | Nome do usuário que gerou a venda interna |
enviarEmail | Boolean | Determina se a venda interna envia e-mail ou não |
observacao | String | Observação da venda interna |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
nome | String | Nome da situação de bloqueio do pedido |
hash | String | Hash da situação de bloqueio pedido |
bloqueios | Data Collection | Bloqueios do Pedido |
id | Number | ID da Associação entre Bloqueio e Pedido |
idBloqueioPedido | Number | ID do Bloqueio de Pedido |
nomeBloqueio | String | Nome do Bloqueio |
tipoBloqueio | String | Hash do Tipo de Bloqueio |
descricaoTipoBloqueio | String | Descrição do Tipo de Bloqueio |
status | String | Status do Bloqueio |
regraAplicacao | Object | Regra de Aplicação do Bloqueio |
valorAplicado | Object | Valor pendente de liberação para prosseguimento com o Pedido |
idUsuarioAlteracao | Number | ID do Usuário que alterou o status do bloqueio |
nomeUsuarioMovimentacao | String | Nome do Usuário que alterou o status do bloqueio |
observacao | String | Observação referente à movimentação de status |
perfisAlcadaAprovacao | Data Collection | Perfis da alçada responsáveis pela aprovação |
dataAlteracao | String | Data da alteração do status do bloqueio |
tipoVenda | Object | Dados do tipo de venda (disponível no modelo de negócio B2B2BC) |
id | Number | ID do tipo de venda |
nome | String | Nome do tipo de venda |
pontosGastos | Number | Quantidade total de pontos gastos no pedido |
detalhesPontosGastos | Data Collection | Detalhes de pontos gastos no pedido |
quantidade | Number | Quantidade de pontos aplicados |
valorEmMoeda | Number | Valor em moeda dos pontos aplicados |
canalVendaOrigem | Object | Canal de venda de origem dos pontos aplicados |
pontosGerados | Object | Objeto com dados sobre os pontos gerados |
pedido | Object | Objeto com dados sobre os pontos gerados pelo pedido |
quantidade | Number | Quantidade de pontos gerados |
valorEmMoeda | Number | Valor em moeda dos pontos gerados |
status | String | Status dos pontos gerados. O status pendente indica que os pontos ainda não foram disponibilizados ao cliente, disponivel indica que o cliente já pode usar os pontos gerados, indisponivel indica que os pontos não estão mais disponíveis para uso e redisponibilizado indica que os pontos ficaram indisponíveis mais estão disponíveis novamente. Valores aceitos: pendente, disponivel, indisponivel, redisponibilizado |
promocao | Object | Dados de promoção aplicada no pedido (somente para pedidos que possuem promoção ativa) |
id | Number | ID da promoção aplicada |
titulo | String | Título da promoção |
tipo | String | Tipo de promoção aplicada Valores aceitos: valor_desconto, porcentagem_desconto, frete_fixo, porcentagem_desconto_frete, valor_desconto_frete, promocoes_cumulativas |
valor | Number | Valor de desconto configurado segundo o tipo de promoção. Para ver o valor total de desconto da promoção verifique o campo 'descontoPromocao' do objeto de totais. |
itens | Data Collection | Dados dos itens do pedido |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
comissao | Object | Dados de comissão do pedido |
pedido | Data Collection | Dados de comissão do pedido |
subpedido | Data Collection | Dados de comissão do subpedido |
alteracoes | Object | Dados de alteração do subtotal do subpedido |
pedido | Data Collection | Alteração de valor do pedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do pedido |
valorAplicado | Number | Valor aplicado ao pedido |
variacaoPercentual | Number | Valor em percentual da variação de valor |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
subpedido | Data Collection | Alteração de valor do subpedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do subpedido |
valorAplicado | Number | Valor aplicado ao subpedido |
variacaoPercentual | Number | Valor em percentual da variação de subtotal |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
pagamento | Data Collection | Dados de pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
valores | Object | Valores do pedido |
subtotal | Number | Sub total (soma do valor dos itens) |
juros | Number | Valor dos juros aplicados |
impostos | Number | Valor dos impostos aplicados no pedido |
tarifaServico | Number | Valor da tarifa de serviço (disponível no modelo de negócio B2B2C) |
frete | Number | Valor de frete |
presente | Number | Valor de itens para presente |
descontoCupom | Number | Valor de desconto de cupom |
descontoBoleto | Number | Valor de desconto de boleto |
descontoRevendedor | Number | Valor de desconto de revendedor |
descontoPromocao | Number | Valor de desconto promocional |
descontoVoucher | Number | Valor de desconto do voucher |
descontoAdicional | Number | Valor de outros descontos |
descontoTotal | Number | Valor total dos descontos do pedido |
comissao | Number | Total de comissão gerada no pedido |
comissaoEstornada | Number | Total de comissão estornada (comissão cancelada) |
totalComissao | Number | Total líquido da comissão (comissao - comissaoEstornada) |
totalPedido | Number | Total do pedido sem estornos (sub total + juros + frete + presente - descontos) |
totalEstornado | Number | Valor total estornado (valores de itens, fretes, juros, etc. sobre os produtos cancelados do pedido) |
total | Number | Total do pedido com estornos (total - totalEstornado) |
informacoesAdicionais | Data Collection | Informações adicionais do pedido |
hash | String | Identificador da informação adicional |
valor | String | Valor definido para a informação adicional |
historico | Data Collection | Dados de histórico |
id | Number | ID do histórico |
idStatus | Number | ID do Status |
detalhes | Object | Objeto com detalhes do histórico |
tipo | String | Tipo do histórico (status,transacao,api,erp) Valores aceitos: status, transacao, api, erp |
dataAlteracao | String | Data que foi alterado o histórico |
dataOcorrencia | String | Data da Ocorrencia |
site | Object | Canal de Vendas do Pedido (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
pedidosComErro | Array | Pedidos que contém erros e que foram retirados da listagem |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de pedidos, responsável por retornar todas as informações sobre um pedido.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/orders/{numeroPedido} | Número do pedido (número retornado no campo 'numeroPedido') |
Limite de requisições por minuto | 60 |
{
"numeroPedido": "123456-1",
"idPagamento": 150,
"canal": "wapstore",
"tipoLogistica": "logistica",
"parceiroCanal": "wapstore",
"ip": "186.230.24.242",
"recomendacao": "Vendedor X",
"hash": "a2ae6a7df4c46fd5e8c93aecb7a88a94",
"dataEmissao": "2018-04-18 18:28:18",
"moeda": "USD",
"previsaoEntrega": "2018-04-28",
"detalhes": {
"marketplace":true,
"idPedidoPlataforma": "WS-123",
"numeroPedidoBase": "123456",
"subpedido": 1,
"qtdItens": 2,
"qtdSubpedidos": 2,
"subpedidos":[
"123456-1",
"123456-2"
],
"canal": "wapstore",
"armazem": {
"id": 47,
"codigoInterno": "123123123123123",
"nome": "Parceiro Omni",
"princiapal": false
},
"seller":{
"id":47,
"nome":"Parceiro Omni",
"cnpj":"123123123123123"
}
},
"status": {
"id": 3,
"idPai": 3,
"descricao": "Pago",
"descricaoPainel": "",
"descricaoSite": "",
"dataAlteracao": "2020-08-05 23:16:07",
"dataOcorrencia": "2020-08-05 20:16:07"
},
"intermediador": {
"id": 89,
"nome": "Fulano Ciclano",
"email": "fulano.ciclnano@email.com.br",
"cpfCnpj": "12345678912",
"rgIe": "",
"pessoa": "f",
"telefone": "1812345678",
"celular": "18999999999",
"nascimento": "14/02/1997",
"sexo": "m",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"canalVenda": {},
"atividadePrincipal": {
"cnae": "4753900",
"descricao": "Comércio varejista especializado de eletrodomésticos e equipamentos de áudio e vídeo"
},
"atividadesSecundarias": [
{
"cnae": "4755503",
"descricao": "Comércio varejista de artigos de cama, mesa e banho"
},
{
"cnae": "4755502",
"descricao": "Comércio varejista de artigos de armarinho"
},
{
"cnae": "4789001",
"descricao": "Comércio varejista de suvenires, bijuterias e artesanatos"
}
]
},
"cliente": {
"id": 282731,
"nome": "Cliente de Teste",
"email": "cliente@teste.com.br",
"cpfCnpj": "11111111000101",
"rgIe": "",
"pessoa": "j",
"telefone": "",
"celular": "(24) 99995-2015",
"nascimento": "",
"sexo": "j",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"representante": {
"id": 547,
"codigoInterno": "WAP030521",
"nome": "Representante Teste",
"email": "representante@email.com"
},
"entrega": {
"cep": "36660000",
"destinatario": "Destinatário Teste",
"tipo": "casa",
"endereco": "Rua Teste",
"bairro": "Centro",
"cidade": "Teste",
"uf": "SP",
"numero": "180",
"complemento": "LOJA 03",
"referencia": ""
},
"faturamento": {
"cep": "36660000",
"destinatario": "Destinatário Teste",
"tipo": "casa",
"endereco": "Rua Teste",
"bairro": "Centro",
"cidade": "Teste",
"uf": "SP",
"numero": "180",
"complemento": "LOJA 03",
"referencia": ""
},
"destinatarioRetirada": {
"idPedido": "1811",
"nome": "Fulano Teste",
"cpfCnpj": "12345678912",
"informacoesAdicionais": [
{
"titulo": "Campo teste",
"valorAtual": "valor teste"
}
]
},
"frete": {
"id": 4,
"nome": "PAC",
"transportadora": "Correios",
"prazoEntrega": 10,
"idFreteCotacao": "651065106516651"
},
"cupom": {
"id": 1,
"hash": "cupomteste"
},
"vendaInterna": {
"id": 97,
"codigoInterno": "atendenteTeste",
"idUsuario": "43",
"nomeUsuario": "Atendente Teste",
"enviarEmail": true,
"observacao": "Teste de observação"
},
"bloqueios": [
{
"id": 65,
"idBloqueioPedido": 3,
"nomeBloqueio": "Bloqueio Tipo de Venda 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"observacao": "Tudo certo",
"idPedido": 27019,
"status": "aprovado",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 4,
"nome": "Admin 2",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:16"
},
{
"id": 66,
"idBloqueioPedido": 9,
"nomeBloqueio": "Bloqueio Tipo de Venda Teste 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"idPedido": 27019,
"status": "aprovado",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 7,
"nome": "Admin 4",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:44"
}
],
"tipoVenda": {
"id": 1,
"nome": "Venda futura"
},
"promocao": {
"ativo": true,
"id": 12,
"titulo": "Promoção verão 2019",
"tipo": "frete_fixo",
"valor": 138.00
},
"pontosGastos": 22.33,
"detalhesPontosGastos": [
{
"quantidade": 22.33,
"valorEmMoeda": 0.44,
"canalVendaOrigem": {
"id": 0,
"nome": "wap.store",
"dominio": "https://lojascrum.wapstore.com.br/",
"tipo": "principal"
}
}
],
"pontosGerados": {
"pedido": {
"quantidade": 45,
"valorEmMoeda": 22.5,
"status": "pendente"
}
},
"itens": [
{
"id": 238,
"idAtributoSimples": 0,
"nome": "Ar Condicionado Split Hi Wall Springer Midea 18000 BTUs Frio 220V - 42MACA18S5",
"descricao": "",
"quantidade": 1,
"valor": 1900.00,
"sku": "100212273",
"skuSeller":"ARCSPLSPR18000220V",
"tipo":"produto",
"caracteristicas": {
"7": "220V",
"8": "7 oitavas"
},
"devolvido":false,
"personalizacoes": [
{
"id": 13,
"nome": "Personalize com seu nome",
"valor": "Teste web.art",
"quantidade": 1,
"precoUnitario": 10,
"precoTotal": 10
},
{
"id": 14,
"nome": "Adicione uma estampa",
"valor": "Logotipo teste",
"quantidade": 1,
"precoUnitario": 5,
"precoTotal": 5
}
],
"cancelamentoSeller":{
"usuario":"Seller Teste",
"motivo":"Produto sem estoque",
"dataCancelamento":"2019-06-19 00:00:00"
},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{
"id":27,
"nome":"Rebate FDS 2019",
"valorOriginal":1981.98,
"valorRebate":1900.00,
"percentual":0.5
},
"comissaoAplicada":{
"percentual":0.5,
"valor":9.5
}
},
"entrega": {
"nfeNumero": "000186418",
"nfeSerie": "000186418",
"nfeChave": "32180401754239001868550010001864181000235711",
"rastreio": "CE1231CA2312B3",
"frete": {
"valor": 69.00,
"idFreteCotacao": "651065106516651"
}
}
},
{
"id": 269,
"idAtributoSimples": 0,
"nome": "Ar Condicionado Split Hi Wall Springer Midea 30000 BTUs Frio 220V - 42MACA30S5",
"descricao": "",
"quantidade": 1,
"valor": 3386.79,
"sku": "100213180",
"skuSeller":"ARCSPLSPR30000220V",
"devolvido":false,
"personalizacoes": [],
"cancelamentoSeller":{},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{},
"comissaoAplicada":{
"percentual":1,
"valor":33.87
}
},
"entrega": {
"nfeNumero": "000186418",
"nfeSerie": "000186418",
"nfeChave": "32180401754239001868550010001864181000235711",
"rastreio": "CE1231CA2312B3",
"frete": {
"valor": 69.00,
"idFreteCotacao": "651065106516651"
}
}
},
{
"id": 42,
"idAtributoSimples": 0,
"nome": "Kit Action Figures DBZ - Majin Boo",
"descricao": "",
"quantidade": 1,
"valor": 713.64,
"sku": "lcafdbz-01",
"skuSeller": "",
"tipo": "lista",
"devolvido": false,
"itens": [
{
"id": 296,
"idAtributoSimples": 21,
"nome": "Majin Boo",
"descricao": "Caixa: Com Caixa",
"quantidade": 1,
"valor": 378.22,
"sku": "af-mb-001",
"skuSeller": "",
"tipo": "produto",
"devolvido": false,
"cancelamentoSeller": [],
"comissao": [],
"entrega": {
"nfeNumero": "",
"nfeSerie": "",
"nfeChave": "",
"nfeXml": "",
"rastreio": "",
"frete": {
"valor": 0,
"idFreteCotacao": "0"
}
}
},
{
"id": 297,
"idAtributoSimples": 21,
"nome": "Majin Boo - Fat",
"descricao": "Caixa: Com Caixa",
"quantidade": 1,
"valor": 335.41,
"sku": "af-mbf-001",
"skuSeller": "",
"tipo": "produto",
"devolvido": false,
"cancelamentoSeller": [],
"comissao": [],
"entrega": {
"nfeNumero": "",
"nfeSerie": "",
"nfeChave": "",
"nfeXml": "",
"rastreio": "",
"frete": {
"valor": 0,
"idFreteCotacao": "0"
}
}
}
],
"cancelamentoSeller": {},
"comissao": {},
"entrega": {}
}
],
"comissao": {
"pedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
],
"subpedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
]
},
"pagamento": [
{
"id": 150,
"nome": "MasterCard",
"bandeira": "mastercard",
"gateway": "mundipagg",
"parcelas": 10,
"vencimentoBoleto": "",
"numeroBanco": "",
"valor": 6138.43,
"retentativa": 1,
"detalhes": {
"chavePedido": "a837a781-58ab-4bf3-96ed-0000000000",
"referenciaPedido": "123456",
"chaveTransacao": "028ec811-4989-4440-b078-0000000000",
"referenciaTransacao": 164,
"codigoAutorizacao": "101010",
"adquirente": "Redecard",
"codigoBarras": "",
"linhaDigitavel": "",
"statusTransacao": "Captured",
"tipoPagamento": "creditCard",
"dataCapturaPagamento": "2018-04-21T14:30:52"
}
},
{
"id": 118,
"nome": "Depósito Bancário",
"bandeira": "deposito",
"gateway": "proprio",
"cnpjGateway": "",
"parcelas": 1,
"vencimentoBoleto": "2023-05-07",
"numeroBanco": "87987",
"valor": 328.47,
"retentativa": 0,
"aprovacaoManual": {
"status": "pago",
"historico": [
{
"idUsuario": 2,
"nomeUsuario": "Fulano Ciclano",
"observacao": "Pagamento aprovado",
"data": "2023-05-08 16:19:42"
}
]
},
"pagamentoPersonalizado": {
"id": 1,
"nome": "Pagamento Personalizado",
"informacoesAdicionais": [
{
"hash": "informacao-adicional-checkbox",
"valor": [
"Bradesco",
"Itaú"
]
},
{
"hash": "informacao-adicional-numero",
"valor": [
"123"
]
},
{
"hash": "informacao-adicional-texto",
"valor": [
"teste"
]
},
{
"hash": "informacao-adicional-select",
"valor": [
"Opção 4"
]
}
]
},
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"linhaDigitavel": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"numeroSequencialUnicoCaptura": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
],
"valores": {
"subtotal": 6138.43,
"juros": 0.00,
"frete": 138.00,
"presente": 0.00,
"descontoCupom": 0.00,
"descontoBoleto": 0.00,
"descontoRevendedor": 0.00,
"descontoPromocao": 0.00,
"descontoVoucher": 0.00,
"descontoAdicional": 0.00,
"descontoTotal": 0.00,
"comissao":43.77,
"comissaoEstornada":9.5,
"totalComissao":34.27,
"totalPedido": 5424.79,
"totalEstornado":1969.00,
"total":3524.79
},
"informacoesAdicionais": [
{
"hash": "como-voce-conheceu-a-loja",
"valor": "Youtube"
},
{
"hash": "pra-que-time-voce-torce",
"valor": "Flamengo"
}
],
"historico": [
{
"id": 16,
"idStatus": 1,
"detalhes": {
"1008":{
"nome":"Alteração de status",
"mensagem":"",
"email":"cliente@teste.com.br",
"sms":"(23) 1313-1313",
"1008":{
"alteracoes":{
"idPedStatus":"1",
"idPedSubStatus":"1"
}
}
}
},
"tipo": "status",
"dataAlteracao": "2020-08-04 16:17:22",
"dataOcorrencia": "2020-08-04 13:17:22"
}
],
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
}
Campo | Tipo | Descrição |
---|---|---|
numeroPedido | String | Número do pedido/subpedido gerado |
idPagamento | Number | ID da forma de pagamento do pedido (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
canal | String | Define se o pedido foi gerado na plataforma (wapstore), se foi gerado por um marketplace (omni) ou se foi criado via integração (api) Valores aceitos: api, omni, wapstore |
tipoLogistica | String | Tipo de logística do pedido |
canalLoja | String | Loja que gerou o pedido |
parceiroCanal | String | Nome do parceiro do canal que gerou o pedido (CNOVA, B2W, etc) |
ip | String | IP do cliente ou sistema que gerou o pedido |
recomendacao | String | Recomendação do pedido |
hash | String | Hash única do pedido (a mesma hash é compartilhada em todos os sub pedidos) |
dataEmissao | String | Data e hora que o pedido foi criado na WapStore Formato esperado: 2019-05-11 22:15:00 |
previsaoEntrega | String | Data prevista de entrega para o pedido (YYYY-MM-DD) |
moeda | String | Moeda em que o pedido foi gerado (BRL, USD...) |
detalhes | Object | Detalhes adicionais sobre o pedido |
marketplace | Boolean | Define se o pedido tem produtos de um seller do marketplace (true) ou da própria loja (false) |
idPedidoPlataforma | String | Mapeamento do pedido entre a wap.store e a plataforma de marketplace |
numeroPedidoBase | String | Número do pedido base que gerou os sub pedidos |
subpedido | Number | Número do sub pedido atual |
qtdItens | Number | Quantidade de itens no pedido |
qtdSubpedidos | Number | Quantidade de sub pedidos gerados |
subpedidos | Array de strings | Subpedidos vinculados |
canal | Object | Dados da transação quando vier do marketplace |
nomeSeller | String | Nome do seller que fez a venda |
cnpjMarketplace | String | CNPJ do marketplace que fez a venda |
armazem | Object | Dados do armazém responsável por esse pedido/subpedido. |
seller | Object | Dados do seller (apenas para pedidos do marketplace) |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
status | Object | Detalhes do status do pedido |
id | Number | ID do status (veja todos os IDs de status consultando a API de status de pedido) |
idPai | Number | ID do status pai (status principal do pedido - caso o status atual seja intermediário) |
descricao | String | Nome do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
dataAlteracao | String | Data de alteração do status |
dataOcorrencia | String | Data de ocorrencia do status |
intermediador | Object | Dados do intermediador (cliente que efetuou a compra, disponível no modelo de negócio B2B2C) |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
cliente | Object | Dados do cliente |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
representante | Object | Dados do representante |
id | Number | Identificador do usuário representante |
codigoInterno | String | Código interno do usuário representante |
nome | String | Nome do usuário representante |
String | E-mail do usuário representante | |
entrega | Object | Dados da entrega |
cep | String | CEP de entrega |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de entrega |
bairro | String | Bairro de entrega |
cidade | String | Cidade de entrega |
uf | String | UF de entrega |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para entrega |
faturamento | Object | Dados do endereço de faturamento |
cep | String | CEP de faturamento |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de faturamento |
bairro | String | Bairro de faturamento |
cidade | String | Cidade de faturamento |
uf | String | UF de faturamento |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para o endereço de faturamento |
destinatarioRetirada | Object | Dados do destinatário do pedido de retirada em loja |
idPedido | Number | Identificador do pedido |
nome | String | Nome do destinatário |
cpfCnpj | String | CPF ou CNPJ do destinatário |
informacoesAdicionais | Object | Informações adicionais do destinatário |
pontoRetirada | Object | Dados do destinatário do pedido de retirada em loja |
id | Number | Id do ponto de retirada |
nome | String | Nome do ponto de retirada |
valor | Number | Valor do custo da retirada |
prazo | String | Prazo para poder retirar |
local | Object | Lista com o endereço do ponto de retirada |
endereco | String | Endereço do ponto de retirada |
numero | String | Número do endereço do ponto de retirada |
bairro | String | Bairro do ponto de retirada |
cidade | String | Cidade do ponto de retirada |
cep | String | CEP do ponto de retirada |
obs | String | Observação do endereço do ponto de retirada mono estoque |
latitude | String | Latitude do ponto de retirada multi estoque |
longitude | String | Longitude do ponto de retirada multi estoque |
horarioFuncionamento | String | Horário de funcionamento do ponto de retirada multi estoque |
frete | Object | Dados de frete |
id | Number | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) |
nome | String | Nome do tipo de frete (Ex. SEDEX, PAC, etc) |
transportadora | String | Nome da transportadora (Ex. Correios) |
prazoEntrega | Number | Prazo de entrega do pedido em dias úteis |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
cupom | Object | Dados de cupom utilizado |
id | Number | ID do cupom utilizado |
hash | String | HASH do cupom utilizado |
vendaInterna | Object | Dados de venda interna (somente para pedidos que contenham venda interna) |
id | Number | ID da venda interna que gerou o pedido |
codigoInternoUsuario | String | Código interno do usuário que gerou a venda interna |
idUsuario | Number | ID do usuário que gerou a venda interna |
nomeUsuario | String | Nome do usuário que gerou a venda interna |
enviarEmail | Boolean | Determina se a venda interna envia e-mail ou não |
observacao | String | Observação da venda interna |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
nome | String | Nome da situação de bloqueio do pedido |
hash | String | Hash da situação de bloqueio pedido |
bloqueios | Data Collection | Bloqueios do Pedido |
id | Number | ID da Associação entre Bloqueio e Pedido |
idBloqueioPedido | Number | ID do Bloqueio de Pedido |
nomeBloqueio | String | Nome do Bloqueio |
tipoBloqueio | String | Hash do Tipo de Bloqueio |
descricaoTipoBloqueio | String | Descrição do Tipo de Bloqueio |
status | String | Status do Bloqueio |
regraAplicacao | Object | Regra de Aplicação do Bloqueio |
valorAplicado | Object | Valor pendente de liberação para prosseguimento com o Pedido |
idUsuarioAlteracao | Number | ID do Usuário que alterou o status do bloqueio |
nomeUsuarioMovimentacao | String | Nome do Usuário que alterou o status do bloqueio |
observacao | String | Observação referente à movimentação de status |
perfisAlcadaAprovacao | Data Collection | Perfis da alçada responsáveis pela aprovação |
dataAlteracao | String | Data da alteração do status do bloqueio |
tipoVenda | Object | Dados do tipo de venda (disponível no modelo de negócio B2B2BC) |
id | Number | ID do tipo de venda |
nome | String | Nome do tipo de venda |
pontosGastos | Number | Quantidade total de pontos gastos no pedido |
detalhesPontosGastos | Data Collection | Detalhes de pontos gastos no pedido |
quantidade | Number | Quantidade de pontos aplicados |
valorEmMoeda | Number | Valor em moeda dos pontos aplicados |
canalVendaOrigem | Object | Canal de venda de origem dos pontos aplicados |
pontosGerados | Object | Objeto com dados sobre os pontos gerados |
pedido | Object | Objeto com dados sobre os pontos gerados pelo pedido |
quantidade | Number | Quantidade de pontos gerados |
valorEmMoeda | Number | Valor em moeda dos pontos gerados |
status | String | Status dos pontos gerados. O status pendente indica que os pontos ainda não foram disponibilizados ao cliente, disponivel indica que o cliente já pode usar os pontos gerados, indisponivel indica que os pontos não estão mais disponíveis para uso e redisponibilizado indica que os pontos ficaram indisponíveis mais estão disponíveis novamente. Valores aceitos: pendente, disponivel, indisponivel, redisponibilizado |
promocao | Object | Dados de promoção aplicada no pedido (somente para pedidos que possuem promoção ativa) |
id | Number | ID da promoção aplicada |
titulo | String | Título da promoção |
tipo | String | Tipo de promoção aplicada Valores aceitos: valor_desconto, porcentagem_desconto, frete_fixo, porcentagem_desconto_frete, valor_desconto_frete, promocoes_cumulativas |
valor | Number | Valor de desconto configurado segundo o tipo de promoção. Para ver o valor total de desconto da promoção verifique o campo 'descontoPromocao' do objeto de totais. |
itens | Data Collection | Dados dos itens do pedido |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
comissao | Object | Dados de comissão do pedido |
pedido | Data Collection | Dados de comissão do pedido |
subpedido | Data Collection | Dados de comissão do subpedido |
alteracoes | Object | Dados de alteração do subtotal do subpedido |
pedido | Data Collection | Alteração de valor do pedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do pedido |
valorAplicado | Number | Valor aplicado ao pedido |
variacaoPercentual | Number | Valor em percentual da variação de valor |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
subpedido | Data Collection | Alteração de valor do subpedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do subpedido |
valorAplicado | Number | Valor aplicado ao subpedido |
variacaoPercentual | Number | Valor em percentual da variação de subtotal |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
pagamento | Data Collection | Dados de pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
valores | Object | Valores do pedido |
subtotal | Number | Sub total (soma do valor dos itens) |
juros | Number | Valor dos juros aplicados |
impostos | Number | Valor dos impostos aplicados no pedido |
tarifaServico | Number | Valor da tarifa de serviço (disponível no modelo de negócio B2B2C) |
frete | Number | Valor de frete |
presente | Number | Valor de itens para presente |
descontoCupom | Number | Valor de desconto de cupom |
descontoBoleto | Number | Valor de desconto de boleto |
descontoRevendedor | Number | Valor de desconto de revendedor |
descontoPromocao | Number | Valor de desconto promocional |
descontoVoucher | Number | Valor de desconto do voucher |
descontoAdicional | Number | Valor de outros descontos |
descontoTotal | Number | Valor total dos descontos do pedido |
comissao | Number | Total de comissão gerada no pedido |
comissaoEstornada | Number | Total de comissão estornada (comissão cancelada) |
totalComissao | Number | Total líquido da comissão (comissao - comissaoEstornada) |
totalPedido | Number | Total do pedido sem estornos (sub total + juros + frete + presente - descontos) |
totalEstornado | Number | Valor total estornado (valores de itens, fretes, juros, etc. sobre os produtos cancelados do pedido) |
total | Number | Total do pedido com estornos (total - totalEstornado) |
informacoesAdicionais | Data Collection | Informações adicionais do pedido |
hash | String | Identificador da informação adicional |
valor | String | Valor definido para a informação adicional |
historico | Data Collection | Dados de histórico |
id | Number | ID do histórico |
idStatus | Number | ID do Status |
detalhes | Object | Objeto com detalhes do histórico |
tipo | String | Tipo do histórico (status,transacao,api,erp) Valores aceitos: status, transacao, api, erp |
dataAlteracao | String | Data que foi alterado o histórico |
dataOcorrencia | String | Data da Ocorrencia |
site | Object | Canal de Vendas do Pedido (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
Recurso responsável por incluir pedidos na base da plataforma.
Os pedidos incluídos por meio deste recurso não possuem processamento de pagamento, ou seja, a plataforma irá aceitar os dados que o integrador enviar, mas não fará verificações de pagamento nos gateways.
O campo idPedidoCanal deve ser único para cada pedido, pois ele será usado juntamente com o campo prefixoPedido para gerar o número do pedido/subpedido, utilizando o padrão PREFIXO-ID. Esse número gerado poderá ser utilizado para consultar ou alterar o status do pedido/subpedido via API.
Importante: É necessário enviar pelo menos um contato telefônico nas informações do cliente e caso o CPF/CNPJ não seja encontrado na base da plataforma, um novo cadastro será feito durante a inserção do pedido.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"idPedidoCanal": 123456,
"prefixoPedido": "WAP",
"parceiroCanal": "wap.connect",
"dataEmissao": "2020-11-16 09:36:00",
"idStatus": 1,
"cliente": {
"nome": "João de Oliveira",
"email": "exemplo@teste.com.br",
"cpfCnpj": "123.456.789-10",
"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,
"idFrete": 48
},
"faturamento": {
"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"
},
"valores": {
"frete": 29.00,
"subtotal": 199.00,
"juros": 0.00,
"desconto": 10.00,
"total": 218.00
},
"itens": [
{
"sku": "furadeira-110-63",
"nome": "Furadeira profissional 800w",
"quantidade": 1,
"valor": 199.00
}
],
"pagamento": {
"nome": "Cartão de Crédito",
"descricao": "Visa",
"parcelas": 10,
"valor": 218.00
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idPedidoCanal | Number | Sim | ID único do pedido dentro do canal Valor mínimo: 1 |
prefixoPedido | String | Sim | Prefixo identificador do canal para a geração do número do pedido/subpedido (PREFIXO-ID_PEDIDO_CANAL) Tamanho mínimo: 1 | Tamanho máximo: 10 |
parceiroCanal | String | Sim | Nome do canal em que o pedido foi gerado (nome do ERP, site parceiro, etc) Tamanho mínimo: 1 | Tamanho máximo: 250 |
idStatus | Number | Sim | ID do status do pedido (veja todos os IDs de status consultando a API de status de pedido) |
dataEmissao | String | Sim | Data da emissão do pedido no canal Formato esperado: 2019-05-11 22:15:00 |
cliente | Object | Sim | Dados do cliente |
nome | String | Sim | Nome completo ou razão social do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
|
cpfCnpj | String | Sim | CPF ou CNPJ do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
rgIe | String | Sim | RG ou Inscrição estadual do cliente Tamanho máximo: 250 |
pessoa | String | Sim | Pessoa física (f) ou jurídica (j) Valores aceitos: f, j |
sexo | String | Sim | Sexo do cliente. Envie 'j' para pessoas jurídicas Valores aceitos: m, f, o, i, j |
nascimento | String | Sim | Data de nascimento do cliente no formato 'dd/mm/aaaa' Tamanho mínimo: 1 | Tamanho máximo: 250 |
telefone | String | Sim | Telefone do cliente Tamanho máximo: 250 |
celular | String | Sim | Celular do cliente Tamanho máximo: 250 |
entrega | Object | Sim | Dados da entrega |
cep | String | Sim | CEP de entrega Tamanho mínimo: 1 | Tamanho máximo: 9 |
destinatario | String | Sim | Nome do destinatário Tamanho mínimo: 1 | Tamanho máximo: 250 |
endereco | String | Sim | Nome da rua ou avenida Tamanho mínimo: 1 | Tamanho máximo: 250 |
bairro | String | Sim | Nome do bairro Tamanho mínimo: 1 | Tamanho máximo: 250 |
cidade | String | Sim | Nome da cidade Tamanho mínimo: 1 | Tamanho máximo: 250 |
uf | String | Sim | Estado de destino Tamanho mínimo: 2 | Tamanho máximo: 2 |
numero | String | Sim | Número da casa Tamanho mínimo: 1 | Tamanho máximo: 50 |
complemento | String | Sim | Complemento do endereço Tamanho máximo: 250 |
referencia | String | Sim | Ponto de referência Tamanho máximo: 250 |
prazoEntrega | Number | Sim | Prazo de entrega em dias úteis Valor mínimo: 1 | Valor máximo: 365 |
idFrete | String | Sim | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) Tamanho mínimo: 1 | Tamanho máximo: 250 |
agendamento | String | Não | Define se o frete atual é permite o agendamento da data de entrega Valores aceitos: sim, nao |
periodoAgendamento | String | Não | Período do dia que a entrega agendada será feita Valores aceitos: manha, tarde, noite |
dataAgendamento | String | Não | Período do dia que a entrega agendada será feita |
faturamento | Object | Não | Dados do endereço de faturamento |
cep | String | Sim | CEP do endereço de faturamento Tamanho mínimo: 1 | Tamanho máximo: 9 |
destinatario | String | Sim | Nome do endereço de faturamento Tamanho mínimo: 1 | Tamanho máximo: 250 |
endereco | String | Sim | Nome da rua ou avenida Tamanho mínimo: 1 | Tamanho máximo: 250 |
bairro | String | Sim | Nome do bairro Tamanho mínimo: 1 | Tamanho máximo: 250 |
cidade | String | Sim | Nome da cidade Tamanho mínimo: 1 | Tamanho máximo: 250 |
uf | String | Sim | Estado do endereço de faturamento Tamanho mínimo: 2 | Tamanho máximo: 2 |
numero | String | Sim | Número da casa Tamanho mínimo: 1 | Tamanho máximo: 50 |
complemento | String | Sim | Complemento do endereço de faturamento Tamanho máximo: 250 |
referencia | String | Sim | Ponto de referência Tamanho máximo: 250 |
valores | Object | Sim | Valores do pedido |
frete | Number | Sim | Valor cobrado de frete Valor mínimo: 0 | Valor máximo: 999999.99 |
subtotal | Number | Sim | Valor cobrado dos itens Valor mínimo: 0 | Valor máximo: 999999.99 |
juros | Number | Sim | Valor total de juros aplicados no pedido Valor mínimo: 0 | Valor máximo: 999999.99 |
desconto | Number | Sim | Valor do desconto aplicado no pedido Valor mínimo: 0 | Valor máximo: 999999.99 |
total | Number | Sim | Valor total do pedido (frete + itens - desconto) Valor mínimo: 0 | Valor máximo: 999999.99 |
itens | Data Collection | Sim | Dados dos itens Tamanho mínimo: 1 |
sku | String | Sim | SKU do produto/variação Tamanho mínimo: 1 | Tamanho máximo: 250 |
nome | String | Sim | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
quantidade | Number | Sim | Quantidade Tamanho máximo: 99999 Valor mínimo: 1 |
valor | Number | Sim | Valor unitário Valor mínimo: 0 | Valor máximo: 999999.99 |
pagamento | Object | Sim | Dados do pagamento |
nome | String | Sim | Nome do tipo de pagamento Tamanho mínimo: 1 | Tamanho máximo: 250 |
descricao | String | Sim | Descrição do tipo de pagamento Tamanho mínimo: 1 | Tamanho máximo: 250 |
parcelas | Number | Sim | Quantidade de parcelas Valor mínimo: 1 | Valor máximo: 99999 |
valor | Number | Sim | Valor pago |
{
"numeroPedido": "WAP-123456",
"idPagamento": 160,
"canal": "api",
"tipoLogistica": "logistica",
"parceiroCanal": "wap.connect",
"ip": "172.18.0.1",
"recomendacao": "Vendedor X",
"hash": "5d2c2cee8ab0b9a36bd1ed7196bd6c4a",
"dataEmissao": "2020-11-16 09:36:00",
"previsaoEntrega": "",
"detalhes": {
"marketplace": false,
"idPedidoPlataforma": "",
"numeroPedidoBase": "WAP-129288",
"subpedido": 1,
"qtdItens": 1,
"qtdSubpedidos": 1,
"subpedidos": [
"WAP-129288"
],
"armazem": {
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true
},
"seller": {}
},
"status": {
"id": 1,
"idPai": 1,
"descricao": "Aguardando Pagamento",
"descricaoPainel": "",
"descricaoSite": "",
"dataAlteracao": "2020-11-16 09:36:00",
"dataOcorrencia": "2020-11-16 09:36:00"
},
"cliente": {
"id": 283174,
"nome": "João de Oliveira",
"email": "exemplo@teste.com.br",
"cpfCnpj": "123.456.789-10",
"rgIe": "11.123.123-4",
"pessoa": "f",
"telefone": "1112344567",
"celular": "119999999999",
"nascimento": "1995-06-10 00:00:00",
"sexo": "m",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"representante": {},
"entrega": {
"cep": "01310-940",
"destinatario": "João de Oliveira",
"tipo": "casa",
"endereco": "Av. Paulista",
"bairro": "Centro",
"cidade": "São Paulo",
"uf": "SP",
"numero": "1234",
"complemento": "Sala 123",
"referencia": "Aurora Center"
},
"faturamento": {
"cep": "01310-940",
"destinatario": "João de Oliveira",
"tipo": "casa",
"endereco": "Av. Paulista",
"bairro": "Centro",
"cidade": "São Paulo",
"uf": "SP",
"numero": "1234",
"complemento": "Sala 123",
"referencia": "Aurora Center"
},
"frete": {
"id": 48,
"nome": "Sedex Expresso",
"transportadora": "Correios",
"prazoEntrega": 12,
"idFreteCotacao": "651065106516651"
},
"cupom": {},
"vendaInterna": {},
"promocao": {},
"pontosGastos": 0,
"itens": [
{
"id": 13,
"idAtributoSimples": 10,
"nome": "Furadeira profissional 800w",
"descricao": "",
"quantidade": 1,
"valor": 199,
"sku": "furadeira-110-63",
"skuSeller": "",
"devolvido": false,
"cancelamentoSeller": {},
"comissao": {},
"entrega": {
"nfeNumero": "",
"nfeSerie": "",
"nfeChave": "",
"rastreio": "",
"frete": {
"valor": 0,
"idFreteCotacao": "651065106516651"
}
}
}
],
"pagamento": [
{
"id": 160,
"nome": "Pagamento Personalizado",
"bandeira": "personalizado",
"gateway": "personalizado",
"cnpjGateway": "personalizado",
"parcelas": 10,
"vencimentoBoleto": "",
"valor": 218,
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "Cartão de Crédito (Visa)",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"numeroSequencialUnicoCaptura": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
],
"valores": {
"subtotal": 199,
"presente": 0,
"frete": 29,
"juros": 0,
"descontoCupom": 0,
"descontoBoleto": 0,
"descontoRevendedor": 0,
"descontoPromocao": 0,
"descontoAdicional": 10,
"descontoTotal": 10,
"comissao": 0,
"comissaoEstornada": 0,
"totalComissao": 0,
"totalPedido": 218,
"totalEstornado": 0,
"total": 218
},
"historico": [],
"site": {
"id": 0,
"nome": "",
"dominio": "",
"tipo": ""
}
}
Campo | Tipo | Descrição |
---|---|---|
numeroPedido | String | Número do pedido/subpedido gerado |
idPagamento | Number | ID da forma de pagamento do pedido (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
canal | String | Define se o pedido foi gerado na plataforma (wapstore), se foi gerado por um marketplace (omni) ou se foi criado via integração (api) Valores aceitos: api, omni, wapstore |
tipoLogistica | String | Tipo de logística do pedido |
canalLoja | String | Loja que gerou o pedido |
parceiroCanal | String | Nome do parceiro do canal que gerou o pedido (CNOVA, B2W, etc) |
ip | String | IP do cliente ou sistema que gerou o pedido |
recomendacao | String | Recomendação do pedido |
hash | String | Hash única do pedido (a mesma hash é compartilhada em todos os sub pedidos) |
dataEmissao | String | Data e hora que o pedido foi criado na WapStore Formato esperado: 2019-05-11 22:15:00 |
previsaoEntrega | String | Data prevista de entrega para o pedido (YYYY-MM-DD) |
moeda | String | Moeda em que o pedido foi gerado (BRL, USD...) |
detalhes | Object | Detalhes adicionais sobre o pedido |
marketplace | Boolean | Define se o pedido tem produtos de um seller do marketplace (true) ou da própria loja (false) |
idPedidoPlataforma | String | Mapeamento do pedido entre a wap.store e a plataforma de marketplace |
numeroPedidoBase | String | Número do pedido base que gerou os sub pedidos |
subpedido | Number | Número do sub pedido atual |
qtdItens | Number | Quantidade de itens no pedido |
qtdSubpedidos | Number | Quantidade de sub pedidos gerados |
subpedidos | Array de strings | Subpedidos vinculados |
canal | Object | Dados da transação quando vier do marketplace |
nomeSeller | String | Nome do seller que fez a venda |
cnpjMarketplace | String | CNPJ do marketplace que fez a venda |
armazem | Object | Dados do armazém responsável por esse pedido/subpedido. |
seller | Object | Dados do seller (apenas para pedidos do marketplace) |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
status | Object | Detalhes do status do pedido |
id | Number | ID do status (veja todos os IDs de status consultando a API de status de pedido) |
idPai | Number | ID do status pai (status principal do pedido - caso o status atual seja intermediário) |
descricao | String | Nome do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
dataAlteracao | String | Data de alteração do status |
dataOcorrencia | String | Data de ocorrencia do status |
intermediador | Object | Dados do intermediador (cliente que efetuou a compra, disponível no modelo de negócio B2B2C) |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
cliente | Object | Dados do cliente |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
representante | Object | Dados do representante |
id | Number | Identificador do usuário representante |
codigoInterno | String | Código interno do usuário representante |
nome | String | Nome do usuário representante |
String | E-mail do usuário representante | |
entrega | Object | Dados da entrega |
cep | String | CEP de entrega |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de entrega |
bairro | String | Bairro de entrega |
cidade | String | Cidade de entrega |
uf | String | UF de entrega |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para entrega |
faturamento | Object | Dados do endereço de faturamento |
cep | String | CEP de faturamento |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de faturamento |
bairro | String | Bairro de faturamento |
cidade | String | Cidade de faturamento |
uf | String | UF de faturamento |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para o endereço de faturamento |
destinatarioRetirada | Object | Dados do destinatário do pedido de retirada em loja |
idPedido | Number | Identificador do pedido |
nome | String | Nome do destinatário |
cpfCnpj | String | CPF ou CNPJ do destinatário |
informacoesAdicionais | Object | Informações adicionais do destinatário |
pontoRetirada | Object | Dados do destinatário do pedido de retirada em loja |
id | Number | Id do ponto de retirada |
nome | String | Nome do ponto de retirada |
valor | Number | Valor do custo da retirada |
prazo | String | Prazo para poder retirar |
local | Object | Lista com o endereço do ponto de retirada |
endereco | String | Endereço do ponto de retirada |
numero | String | Número do endereço do ponto de retirada |
bairro | String | Bairro do ponto de retirada |
cidade | String | Cidade do ponto de retirada |
cep | String | CEP do ponto de retirada |
obs | String | Observação do endereço do ponto de retirada mono estoque |
latitude | String | Latitude do ponto de retirada multi estoque |
longitude | String | Longitude do ponto de retirada multi estoque |
horarioFuncionamento | String | Horário de funcionamento do ponto de retirada multi estoque |
frete | Object | Dados de frete |
id | Number | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) |
nome | String | Nome do tipo de frete (Ex. SEDEX, PAC, etc) |
transportadora | String | Nome da transportadora (Ex. Correios) |
prazoEntrega | Number | Prazo de entrega do pedido em dias úteis |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
cupom | Object | Dados de cupom utilizado |
id | Number | ID do cupom utilizado |
hash | String | HASH do cupom utilizado |
vendaInterna | Object | Dados de venda interna (somente para pedidos que contenham venda interna) |
id | Number | ID da venda interna que gerou o pedido |
codigoInternoUsuario | String | Código interno do usuário que gerou a venda interna |
idUsuario | Number | ID do usuário que gerou a venda interna |
nomeUsuario | String | Nome do usuário que gerou a venda interna |
enviarEmail | Boolean | Determina se a venda interna envia e-mail ou não |
observacao | String | Observação da venda interna |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
nome | String | Nome da situação de bloqueio do pedido |
hash | String | Hash da situação de bloqueio pedido |
bloqueios | Data Collection | Bloqueios do Pedido |
id | Number | ID da Associação entre Bloqueio e Pedido |
idBloqueioPedido | Number | ID do Bloqueio de Pedido |
nomeBloqueio | String | Nome do Bloqueio |
tipoBloqueio | String | Hash do Tipo de Bloqueio |
descricaoTipoBloqueio | String | Descrição do Tipo de Bloqueio |
status | String | Status do Bloqueio |
regraAplicacao | Object | Regra de Aplicação do Bloqueio |
valorAplicado | Object | Valor pendente de liberação para prosseguimento com o Pedido |
idUsuarioAlteracao | Number | ID do Usuário que alterou o status do bloqueio |
nomeUsuarioMovimentacao | String | Nome do Usuário que alterou o status do bloqueio |
observacao | String | Observação referente à movimentação de status |
perfisAlcadaAprovacao | Data Collection | Perfis da alçada responsáveis pela aprovação |
dataAlteracao | String | Data da alteração do status do bloqueio |
tipoVenda | Object | Dados do tipo de venda (disponível no modelo de negócio B2B2BC) |
id | Number | ID do tipo de venda |
nome | String | Nome do tipo de venda |
pontosGastos | Number | Quantidade total de pontos gastos no pedido |
detalhesPontosGastos | Data Collection | Detalhes de pontos gastos no pedido |
quantidade | Number | Quantidade de pontos aplicados |
valorEmMoeda | Number | Valor em moeda dos pontos aplicados |
canalVendaOrigem | Object | Canal de venda de origem dos pontos aplicados |
pontosGerados | Object | Objeto com dados sobre os pontos gerados |
pedido | Object | Objeto com dados sobre os pontos gerados pelo pedido |
quantidade | Number | Quantidade de pontos gerados |
valorEmMoeda | Number | Valor em moeda dos pontos gerados |
status | String | Status dos pontos gerados. O status pendente indica que os pontos ainda não foram disponibilizados ao cliente, disponivel indica que o cliente já pode usar os pontos gerados, indisponivel indica que os pontos não estão mais disponíveis para uso e redisponibilizado indica que os pontos ficaram indisponíveis mais estão disponíveis novamente. Valores aceitos: pendente, disponivel, indisponivel, redisponibilizado |
promocao | Object | Dados de promoção aplicada no pedido (somente para pedidos que possuem promoção ativa) |
id | Number | ID da promoção aplicada |
titulo | String | Título da promoção |
tipo | String | Tipo de promoção aplicada Valores aceitos: valor_desconto, porcentagem_desconto, frete_fixo, porcentagem_desconto_frete, valor_desconto_frete, promocoes_cumulativas |
valor | Number | Valor de desconto configurado segundo o tipo de promoção. Para ver o valor total de desconto da promoção verifique o campo 'descontoPromocao' do objeto de totais. |
itens | Data Collection | Dados dos itens do pedido |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
comissao | Object | Dados de comissão do pedido |
pedido | Data Collection | Dados de comissão do pedido |
subpedido | Data Collection | Dados de comissão do subpedido |
alteracoes | Object | Dados de alteração do subtotal do subpedido |
pedido | Data Collection | Alteração de valor do pedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do pedido |
valorAplicado | Number | Valor aplicado ao pedido |
variacaoPercentual | Number | Valor em percentual da variação de valor |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
subpedido | Data Collection | Alteração de valor do subpedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do subpedido |
valorAplicado | Number | Valor aplicado ao subpedido |
variacaoPercentual | Number | Valor em percentual da variação de subtotal |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
pagamento | Data Collection | Dados de pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
valores | Object | Valores do pedido |
subtotal | Number | Sub total (soma do valor dos itens) |
juros | Number | Valor dos juros aplicados |
impostos | Number | Valor dos impostos aplicados no pedido |
tarifaServico | Number | Valor da tarifa de serviço (disponível no modelo de negócio B2B2C) |
frete | Number | Valor de frete |
presente | Number | Valor de itens para presente |
descontoCupom | Number | Valor de desconto de cupom |
descontoBoleto | Number | Valor de desconto de boleto |
descontoRevendedor | Number | Valor de desconto de revendedor |
descontoPromocao | Number | Valor de desconto promocional |
descontoVoucher | Number | Valor de desconto do voucher |
descontoAdicional | Number | Valor de outros descontos |
descontoTotal | Number | Valor total dos descontos do pedido |
comissao | Number | Total de comissão gerada no pedido |
comissaoEstornada | Number | Total de comissão estornada (comissão cancelada) |
totalComissao | Number | Total líquido da comissão (comissao - comissaoEstornada) |
totalPedido | Number | Total do pedido sem estornos (sub total + juros + frete + presente - descontos) |
totalEstornado | Number | Valor total estornado (valores de itens, fretes, juros, etc. sobre os produtos cancelados do pedido) |
total | Number | Total do pedido com estornos (total - totalEstornado) |
informacoesAdicionais | Data Collection | Informações adicionais do pedido |
hash | String | Identificador da informação adicional |
valor | String | Valor definido para a informação adicional |
historico | Data Collection | Dados de histórico |
id | Number | ID do histórico |
idStatus | Number | ID do Status |
detalhes | Object | Objeto com detalhes do histórico |
tipo | String | Tipo do histórico (status,transacao,api,erp) Valores aceitos: status, transacao, api, erp |
dataAlteracao | String | Data que foi alterado o histórico |
dataOcorrencia | String | Data da Ocorrencia |
site | Object | Canal de Vendas do Pedido (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
Recurso de consulta da fila de atualizações de pedidos. Sempre que um novo pedido chegar ou tiver alguma informação atualizada, ele aparecerá nessa fila. Configure o seu sistema para consumir a fila de atualizações para sempre receber os novos pedidos e as atualizaçõ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.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os pedidos pelos status. Envie o ID de um ou mais status separados por '|' (Veja os IDs de status disponíveis consultando a API de status de pedido) Exemplo de requisição: /v2/orders/queue?status=1|3 tipo: Filtra os pedidos pelo seu tipo. Envie o valor 'marketplace' para obter pedidos que são de marketplace, ou 'wapstore'para pedidos com itens da própria loja. Exemplo de requisição: /v2/orders/queue?tipo=marketplace idMarketplaceSeller: Filtra os pedidos pelo seller do marketplace. Envie o ID de um seller, para listar pedidos do marketplace, ou envie '0' para listar apenas pedidos da loja Exemplo de requisição: /v2/orders/queue?idMarketplaceSeller=1 idArmazem: Filtra os pedidos pelo ID do armazém. Envie o ID de até dois armazéns separados por '|' Exemplo de requisição: /v2/orders/queue?idArmazem=3|8 codigoArmazem: Filtra os pedidos pelo código do armazém. Envie o código de até dois armazéns separados por '|' Exemplo de requisição: /v2/orders/queue?codigoArmazem=69133525000100|0002 possuiServico: Filtra os pedidos que possuem pelo menos 1 serviço entre seus itens Exemplo de requisição: /v2/orders/queue?possuiServico=true personalizacao: Filtra os pedidos que possuem ou não uma personalização. Valores aceitos 's' ou 'n'. Exemplo de requisição: /v2/orders/queue?personalizacao=s codigoUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders/queue?codigoUsuario=gerente emailUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders/queue?emailUsuario=maria@gmail.com idUsuario: Filtra os pedidos que tem vínculo com o usuário Exemplo de requisição: /v2/orders/queue?idUsuario=550 |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio do parâmetro limit na URL da requisição (não é permitido enviar o parâmetro offset para essa requisição). Exemplo de requisição: /v2/orders/queue?limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pedidos":[
{
"numeroPedido":"123456-1",
"idPagamento":150,
"canal":"wapstore",
"parceiroCanal":"wapstore",
"ip":"186.230.24.242",
"hash":"a2ae6a7df4c46fd5e8c93aecb7a88a94",
"dataEmissao":"2018-04-18 18:28:18",
"previsaoEntrega":"2018-04-28",
"detalhes":{
"marketplace":true,
"idPedidoPlataforma": "WS-123",
"numeroPedidoBase":"123456",
"subpedido":1,
"qtdItens":2,
"qtdSubpedidos":2,
"subpedidos":[
"123456-1",
"123456-2"
],
"armazem":{
"id":47,
"codigoInterno":"123123123123123",
"nome":"Parceiro Omni",
"principal": false
},
"seller":{
"id":47,
"nome":"Parceiro Omni",
"cnpj":"123123123123123"
}
},
"status":{
"id":3,
"idPai":3,
"descricao":"Pago",
"descricaoPainel": "",
"descricaoSite": "",
"dataAlteracao": "2020-08-05 23:16:07",
"dataOcorrencia": "2020-08-05 20:16:07"
},
"intermediador": {
"id": 89,
"nome": "David Guimaraes",
"email": "david.guimaraes@wapstore.com.br",
"cpfCnpj": "42615021001",
"rgIe": "",
"pessoa": "f",
"telefone": "1125971952",
"celular": "18999999999",
"nascimento": "14/02/1997",
"sexo": "m",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"canalVenda": {}
},
"cliente":{
"id":282731,
"nome":"Cliente de Teste",
"email":"cliente@teste.com.br",
"cpfCnpj":"11111111000101",
"rgIe":"",
"pessoa":"j",
"telefone":"",
"celular":"(24) 99995-2015",
"nascimento":"",
"sexo":"j"
},
"entrega":{
"cep":"36660000",
"destinatario":"Destinatário Teste",
"tipo":"casa",
"endereco":"Rua Teste",
"bairro":"Centro",
"cidade":"Teste",
"uf":"SP",
"numero":"180",
"complemento":"LOJA 03",
"referencia":""
},
"faturamento":{
"cep":"36660000",
"destinatario":"Destinatário Teste",
"tipo":"casa",
"endereco":"Rua Teste",
"bairro":"Centro",
"cidade":"Teste",
"uf":"SP",
"numero":"180",
"complemento":"LOJA 03",
"referencia":""
},
"frete":{
"id":4,
"nome":"PAC",
"transportadora":"Correios",
"prazoEntrega":10,
"idFreteCotacao": "651065106516651"
},
"cupom":{
"id":1,
"hash":"cupomteste"
},
"vendaInterna":{
"ativo":true,
"id":97,
"idUsuario":"43",
"nomeUsuario":"Atendente Teste"
},
"bloqueios": [
{
"id": 65,
"idBloqueioPedido": 3,
"nomeBloqueio": "Bloqueio Tipo de Venda 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"idPedido": 27019,
"status": "aprovado",
"observacao": "Tudo certo",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 4,
"nome": "Admin 2",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:16"
},
{
"id": 66,
"idBloqueioPedido": 9,
"nomeBloqueio": "Bloqueio Tipo de Venda Teste 1",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"idPedido": 27019,
"status": "aprovado",
"regraAplicacao": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"valorAplicado": {
"idTipoVenda": 1,
"nomeTipoVenda": "Tipo de Venda 1"
},
"idUsuarioAlteracao": 1,
"nomeUsuarioMovimentacao": "Webart (teste)",
"perfisAlcadaAprovacao": [
{
"id": 2,
"nome": "Admin",
"ativo": "s"
},
{
"id": 7,
"nome": "Admin 4",
"ativo": "s"
},
{
"id": 16,
"nome": "Admin 5",
"ativo": "s"
}
],
"dataAlteracao": "2023-05-19 11:34:44"
}
],
"tipoVenda": {
"id": 1,
"nome": "Venda futura"
},
"promocao":{
"ativo":true,
"id":12,
"titulo":"Promoção verão 2019",
"tipo":"frete_fixo",
"valor":138.00
},
"pontosGastos": 875.64,
"detalhesPontosGastos": [
{
"quantidade": 875.64,
"valorEmMoeda": 437.82,
"canalVendaOrigem": {
"id": 0,
"nome": "Wapstore 2.0",
"dominio": "localhost/modelos",
"tipo": "principal"
}
}
],
"pontosGerados": {
"pedido": {
"quantidade": 45,
"valorEmMoeda": 22.5,
"status": "pendente"
}
},
"itens":[
{
"id":238,
"idAtributoSimples":0,
"nome":"Ar Condicionado Split Hi Wall Springer Midea 18000 BTUs Frio 220V - 42MACA18S5",
"descricao":"",
"quantidade":1,
"valor":1900.00,
"sku":"100212273",
"skuSeller":"ARCSPLSPR18000220V",
"tipo":"produto",
"caracteristicas": {
"7": "Marcos Eduardo de Souza",
"8": "7 oitavas"
},
"devolvido":false,
"personalizacoes": [
{
"id": 13,
"nome": "Personalize com seu nome",
"valor": "Teste web.art",
"quantidade": 1,
"precoUnitario": 10,
"precoTotal": 10
},
{
"id": 14,
"nome": "Adicione uma estampa",
"valor": "Logotipo teste",
"quantidade": 1,
"precoUnitario": 5,
"precoTotal": 5
}
],
"cancelamentoSeller":{
"usuario":"Seller Teste",
"motivo":"Produto sem estoque",
"dataCancelamento":"2019-06-19 00:00:00"
},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{
"id":27,
"nome":"Rebate FDS 2019",
"valorOriginal":1981.98,
"valorRebate":1900.00,
"percentual":0.5
},
"comissaoAplicada":{
"percentual":0.5,
"valor":9.5
}
},
"entrega":{
"nfeNumero":"000186418",
"nfeSerie":"000186418",
"nfeChave":"32180401754239001868550010001864181000235711",
"rastreio":"CE1231CA2312B3",
"frete":{
"valor":69.00,
"idFreteCotacao": "651065106516651"
}
}
},
{
"id":269,
"idAtributoSimples":0,
"nome":"Ar Condicionado Split Hi Wall Springer Midea 30000 BTUs Frio 220V - 42MACA30S5",
"descricao":"",
"quantidade":1,
"valor":3386.79,
"sku":"100213180",
"skuSeller":"ARCSPLSPR30000220V",
"devolvido":false,
"personalizacoes": [],
"cancelamentoSeller":{
},
"comissao":{
"regra":{
"percentual":1,
"descricao":"Categoria Ar Condicionado"
},
"rebate":{
},
"comissaoAplicada":{
"percentual":1,
"valor":33.87
}
},
"entrega":{
"nfeNumero":"000186418",
"nfeSerie":"000186418",
"nfeChave":"32180401754239001868550010001864181000235711",
"rastreio":"CE1231CA2312B3",
"frete":{
"valor":69.00,
"idFreteCotacao": "651065106516651"
}
}
}
],
"comissao": {
"pedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
],
"subpedido": [
{
"tipo": "reservaTecnica",
"origem": "cliente",
"percentualBase": 10,
"valorBase": 71.17,
"percentualAplicado": 55.04,
"valorAplicado": 391.74
}
]
},
"pagamento":[
{
"id":150,
"nome":"MasterCard",
"bandeira":"mastercard",
"gateway":"mundipagg",
"parcelas":10,
"vencimentoBoleto":"",
"valor":5424.79,
"detalhes":{
"chavePedido":"a837a781-58ab-4bf3-96ed-0000000000",
"referenciaPedido":"123456",
"chaveTransacao":"028ec811-4989-4440-b078-0000000000",
"referenciaTransacao":164,
"codigoAutorizacao":"101010",
"adquirente":"Redecard",
"codigoBarras":"",
"statusTransacao":"Captured",
"tipoPagamento":"creditCard",
"dataCapturaPagamento":"2018-04-21T14:30:52"
}
},
{
"id": 118,
"nome": "Depósito Bancário",
"bandeira": "deposito",
"gateway": "proprio",
"cnpjGateway": "",
"parcelas": 1,
"vencimentoBoleto": "2023-05-07",
"numeroBanco": "87987",
"valor": 328.47,
"retentativa": 0,
"aprovacaoManual": {
"status": "pago",
"historico": [
{
"idUsuario": 2,
"nomeUsuario": "Fulano Ciclano",
"observacao": "Pagamento aprovado",
"data": "2023-05-08 16:19:42"
}
]
},
"pagamentoPersonalizado": {
"id": 1,
"nome": "Pagamento Personalizado",
"informacoesAdicionais": [
{
"hash": "informacao-adicional-checkbox",
"valor": [
"Bradesco",
"Itaú"
]
},
{
"hash": "informacao-adicional-numero",
"valor": [
"123"
]
},
{
"hash": "informacao-adicional-texto",
"valor": [
"teste"
]
},
{
"hash": "informacao-adicional-select",
"valor": [
"Opção 4"
]
}
]
},
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"linhaDigitavel": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"numeroSequencialUnicoCaptura": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
],
"valores":{
"subtotal":5286.79,
"juros":0.00,
"frete":138.00,
"presente":0.00,
"descontoCupom":0.00,
"descontoBoleto":0.00,
"descontoRevendedor":0.00,
"descontoPromocao":0.00,
"descontoAdicional":0.00,
"descontoTotal":0.00,
"comissao":43.77,
"comissaoEstornada":9.5,
"totalComissao":34.27,
"totalPedido":5424.79,
"totalEstornado":1969.00,
"total":3524.79
},
"historico": [
{
"id": 16,
"idStatus": 1,
"detalhes": {
"1008":{
"nome":"Alteração de status",
"mensagem":"",
"email":"cliente@teste.com.br",
"sms":"(23) 1313-1313",
"1008":{
"alteracoes":{
"idPedStatus":"1",
"idPedSubStatus":"1"
}
}
}
},
"tipo": "status",
"dataAlteracao": "2020-08-04 16:17:22",
"dataOcorrencia": "2020-08-04 13:17:22"
}
]
}
],
"identificadoresFila": [
"123456-1"
],
"info":{
"filtros":[
],
"limit":100,
"exibindo":1,
"total":1
}
}
Campo | Tipo | Descrição |
---|---|---|
pedidos | Data Collection | Pedidos listados |
numeroPedido | String | Número do pedido/subpedido gerado |
idPagamento | Number | ID da forma de pagamento do pedido (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
canal | String | Define se o pedido foi gerado na plataforma (wapstore), se foi gerado por um marketplace (omni) ou se foi criado via integração (api) Valores aceitos: api, omni, wapstore |
tipoLogistica | String | Tipo de logística do pedido |
canalLoja | String | Loja que gerou o pedido |
parceiroCanal | String | Nome do parceiro do canal que gerou o pedido (CNOVA, B2W, etc) |
ip | String | IP do cliente ou sistema que gerou o pedido |
recomendacao | String | Recomendação do pedido |
hash | String | Hash única do pedido (a mesma hash é compartilhada em todos os sub pedidos) |
dataEmissao | String | Data e hora que o pedido foi criado na WapStore Formato esperado: 2019-05-11 22:15:00 |
previsaoEntrega | String | Data prevista de entrega para o pedido (YYYY-MM-DD) |
moeda | String | Moeda em que o pedido foi gerado (BRL, USD...) |
detalhes | Object | Detalhes adicionais sobre o pedido |
marketplace | Boolean | Define se o pedido tem produtos de um seller do marketplace (true) ou da própria loja (false) |
idPedidoPlataforma | String | Mapeamento do pedido entre a wap.store e a plataforma de marketplace |
numeroPedidoBase | String | Número do pedido base que gerou os sub pedidos |
subpedido | Number | Número do sub pedido atual |
qtdItens | Number | Quantidade de itens no pedido |
qtdSubpedidos | Number | Quantidade de sub pedidos gerados |
subpedidos | Array de strings | Subpedidos vinculados |
canal | Object | Dados da transação quando vier do marketplace |
nomeSeller | String | Nome do seller que fez a venda |
cnpjMarketplace | String | CNPJ do marketplace que fez a venda |
armazem | Object | Dados do armazém responsável por esse pedido/subpedido. |
seller | Object | Dados do seller (apenas para pedidos do marketplace) |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
status | Object | Detalhes do status do pedido |
id | Number | ID do status (veja todos os IDs de status consultando a API de status de pedido) |
idPai | Number | ID do status pai (status principal do pedido - caso o status atual seja intermediário) |
descricao | String | Nome do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
dataAlteracao | String | Data de alteração do status |
dataOcorrencia | String | Data de ocorrencia do status |
intermediador | Object | Dados do intermediador (cliente que efetuou a compra, disponível no modelo de negócio B2B2C) |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
cliente | Object | Dados do cliente |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
representante | Object | Dados do representante |
id | Number | Identificador do usuário representante |
codigoInterno | String | Código interno do usuário representante |
nome | String | Nome do usuário representante |
String | E-mail do usuário representante | |
entrega | Object | Dados da entrega |
cep | String | CEP de entrega |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de entrega |
bairro | String | Bairro de entrega |
cidade | String | Cidade de entrega |
uf | String | UF de entrega |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para entrega |
faturamento | Object | Dados do endereço de faturamento |
cep | String | CEP de faturamento |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de faturamento |
bairro | String | Bairro de faturamento |
cidade | String | Cidade de faturamento |
uf | String | UF de faturamento |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para o endereço de faturamento |
destinatarioRetirada | Object | Dados do destinatário do pedido de retirada em loja |
idPedido | Number | Identificador do pedido |
nome | String | Nome do destinatário |
cpfCnpj | String | CPF ou CNPJ do destinatário |
informacoesAdicionais | Object | Informações adicionais do destinatário |
pontoRetirada | Object | Dados do destinatário do pedido de retirada em loja |
id | Number | Id do ponto de retirada |
nome | String | Nome do ponto de retirada |
valor | Number | Valor do custo da retirada |
prazo | String | Prazo para poder retirar |
local | Object | Lista com o endereço do ponto de retirada |
endereco | String | Endereço do ponto de retirada |
numero | String | Número do endereço do ponto de retirada |
bairro | String | Bairro do ponto de retirada |
cidade | String | Cidade do ponto de retirada |
cep | String | CEP do ponto de retirada |
obs | String | Observação do endereço do ponto de retirada mono estoque |
latitude | String | Latitude do ponto de retirada multi estoque |
longitude | String | Longitude do ponto de retirada multi estoque |
horarioFuncionamento | String | Horário de funcionamento do ponto de retirada multi estoque |
frete | Object | Dados de frete |
id | Number | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) |
nome | String | Nome do tipo de frete (Ex. SEDEX, PAC, etc) |
transportadora | String | Nome da transportadora (Ex. Correios) |
prazoEntrega | Number | Prazo de entrega do pedido em dias úteis |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
cupom | Object | Dados de cupom utilizado |
id | Number | ID do cupom utilizado |
hash | String | HASH do cupom utilizado |
vendaInterna | Object | Dados de venda interna (somente para pedidos que contenham venda interna) |
id | Number | ID da venda interna que gerou o pedido |
codigoInternoUsuario | String | Código interno do usuário que gerou a venda interna |
idUsuario | Number | ID do usuário que gerou a venda interna |
nomeUsuario | String | Nome do usuário que gerou a venda interna |
enviarEmail | Boolean | Determina se a venda interna envia e-mail ou não |
observacao | String | Observação da venda interna |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
nome | String | Nome da situação de bloqueio do pedido |
hash | String | Hash da situação de bloqueio pedido |
bloqueios | Data Collection | Bloqueios do Pedido |
id | Number | ID da Associação entre Bloqueio e Pedido |
idBloqueioPedido | Number | ID do Bloqueio de Pedido |
nomeBloqueio | String | Nome do Bloqueio |
tipoBloqueio | String | Hash do Tipo de Bloqueio |
descricaoTipoBloqueio | String | Descrição do Tipo de Bloqueio |
status | String | Status do Bloqueio |
regraAplicacao | Object | Regra de Aplicação do Bloqueio |
valorAplicado | Object | Valor pendente de liberação para prosseguimento com o Pedido |
idUsuarioAlteracao | Number | ID do Usuário que alterou o status do bloqueio |
nomeUsuarioMovimentacao | String | Nome do Usuário que alterou o status do bloqueio |
observacao | String | Observação referente à movimentação de status |
perfisAlcadaAprovacao | Data Collection | Perfis da alçada responsáveis pela aprovação |
dataAlteracao | String | Data da alteração do status do bloqueio |
tipoVenda | Object | Dados do tipo de venda (disponível no modelo de negócio B2B2BC) |
id | Number | ID do tipo de venda |
nome | String | Nome do tipo de venda |
pontosGastos | Number | Quantidade total de pontos gastos no pedido |
detalhesPontosGastos | Data Collection | Detalhes de pontos gastos no pedido |
quantidade | Number | Quantidade de pontos aplicados |
valorEmMoeda | Number | Valor em moeda dos pontos aplicados |
canalVendaOrigem | Object | Canal de venda de origem dos pontos aplicados |
pontosGerados | Object | Objeto com dados sobre os pontos gerados |
pedido | Object | Objeto com dados sobre os pontos gerados pelo pedido |
quantidade | Number | Quantidade de pontos gerados |
valorEmMoeda | Number | Valor em moeda dos pontos gerados |
status | String | Status dos pontos gerados. O status pendente indica que os pontos ainda não foram disponibilizados ao cliente, disponivel indica que o cliente já pode usar os pontos gerados, indisponivel indica que os pontos não estão mais disponíveis para uso e redisponibilizado indica que os pontos ficaram indisponíveis mais estão disponíveis novamente. Valores aceitos: pendente, disponivel, indisponivel, redisponibilizado |
promocao | Object | Dados de promoção aplicada no pedido (somente para pedidos que possuem promoção ativa) |
id | Number | ID da promoção aplicada |
titulo | String | Título da promoção |
tipo | String | Tipo de promoção aplicada Valores aceitos: valor_desconto, porcentagem_desconto, frete_fixo, porcentagem_desconto_frete, valor_desconto_frete, promocoes_cumulativas |
valor | Number | Valor de desconto configurado segundo o tipo de promoção. Para ver o valor total de desconto da promoção verifique o campo 'descontoPromocao' do objeto de totais. |
itens | Data Collection | Dados dos itens do pedido |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
comissao | Object | Dados de comissão do pedido |
pedido | Data Collection | Dados de comissão do pedido |
subpedido | Data Collection | Dados de comissão do subpedido |
alteracoes | Object | Dados de alteração do subtotal do subpedido |
pedido | Data Collection | Alteração de valor do pedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do pedido |
valorAplicado | Number | Valor aplicado ao pedido |
variacaoPercentual | Number | Valor em percentual da variação de valor |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
subpedido | Data Collection | Alteração de valor do subpedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do subpedido |
valorAplicado | Number | Valor aplicado ao subpedido |
variacaoPercentual | Number | Valor em percentual da variação de subtotal |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
pagamento | Data Collection | Dados de pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
valores | Object | Valores do pedido |
subtotal | Number | Sub total (soma do valor dos itens) |
juros | Number | Valor dos juros aplicados |
impostos | Number | Valor dos impostos aplicados no pedido |
tarifaServico | Number | Valor da tarifa de serviço (disponível no modelo de negócio B2B2C) |
frete | Number | Valor de frete |
presente | Number | Valor de itens para presente |
descontoCupom | Number | Valor de desconto de cupom |
descontoBoleto | Number | Valor de desconto de boleto |
descontoRevendedor | Number | Valor de desconto de revendedor |
descontoPromocao | Number | Valor de desconto promocional |
descontoVoucher | Number | Valor de desconto do voucher |
descontoAdicional | Number | Valor de outros descontos |
descontoTotal | Number | Valor total dos descontos do pedido |
comissao | Number | Total de comissão gerada no pedido |
comissaoEstornada | Number | Total de comissão estornada (comissão cancelada) |
totalComissao | Number | Total líquido da comissão (comissao - comissaoEstornada) |
totalPedido | Number | Total do pedido sem estornos (sub total + juros + frete + presente - descontos) |
totalEstornado | Number | Valor total estornado (valores de itens, fretes, juros, etc. sobre os produtos cancelados do pedido) |
total | Number | Total do pedido com estornos (total - totalEstornado) |
informacoesAdicionais | Data Collection | Informações adicionais do pedido |
hash | String | Identificador da informação adicional |
valor | String | Valor definido para a informação adicional |
historico | Data Collection | Dados de histórico |
id | Number | ID do histórico |
idStatus | Number | ID do Status |
detalhes | Object | Objeto com detalhes do histórico |
tipo | String | Tipo do histórico (status,transacao,api,erp) Valores aceitos: status, transacao, api, erp |
dataAlteracao | String | Data que foi alterado o histórico |
dataOcorrencia | String | Data da Ocorrencia |
site | Object | Canal de Vendas do Pedido (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
identificadoresFila | Array de strings | Lista com os números de pedidos presentes na paginação |
pedidosComErro | Array | Pedidos que contém erros e que foram retirados da listagem |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por remover pedidos da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/orders/queue/{numeroPedido} | Número do pedido (número retornado no campo 'numeroPedido') |
Limite de requisições por minuto | 12000 |
Recurso responsável por remover pedidos em lote da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 1000 |
{
"pedidos": [
"123456-1",
"123456-2",
"123457",
"123458"
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
pedidos | Array de strings | Sim | Lista com os identificadores de pedidos a serem removidos da fila |
Recurso responsável por alterar o status de pedidos.
Importante: Não são aceitas alterações para o pedido base, somente para os subpedidos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/orders/{numeroPedido}/status | Número do pedido ou do sub pedido |
Limite de requisições por minuto | 60 |
{
"dataOcorrencia":"2019-06-26 09:38:00",
"status":7,
"nfeNumero":"3000.2",
"nfeChave":"43171207364617000135550000000120141000120146",
"nfeSerie":"001",
"nfeXml":"",
"nfeUrl": "",
"codigoRastreio":"AA0029023912",
"codigoLogisticaReversa": "AA0029023912",
"linkRastreio":"https://www.linkcorreios.com.br/AA0029023912",
"obs":"Enviamos um presente para você!",
"enviarObsCliente":true,
"email":true,
"sms":true
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
dataOcorrencia | String | Não | Data real da alteração de status Formato esperado: 2019-05-11 22:15:00 |
status | Number | Sim | ID do status do pedido (veja todos os status disponíveis consultando a API de status de pedido) Valor mínimo: 1 |
nfeChave | String | Não | Chave da nota fiscal eletrônica |
nfeNumero | String | Não | Número da nota fiscal eletrônica Tamanho mínimo: 1 | Tamanho máximo: 50 |
nfeSerie | String | Não | Número da série nota fiscal eletrônica Tamanho mínimo: 1 | Tamanho máximo: 50 |
nfeXml | String | Não | Conteúdo XML da nota fiscal eletrônica Tamanho mínimo: 1 |
nfeUrl | String | Não | Url da nota fiscal eletrônica Tamanho mínimo: 1 |
codigoRastreio | String | Não | Código de rastreio Tamanho mínimo: 1 | Tamanho máximo: 250 |
codigoLogisticaReversa | String | Não | Código de logística reversa Tamanho mínimo: 1 | Tamanho máximo: 250 |
obs | String | Não | Observação da alteração de status Tamanho mínimo: 1 | Tamanho máximo: 250 |
enviarObsCliente | Boolean | Não | Define se o texto preenchido na observação deve aparecer no e-mail enviado ao cliente (true) ou não (false) - por padrão a observação, caso exista, é sempre enviada. |
Boolean | Sim | Define se essa alteração deve notificar o cliente por e-mail (true) ou não (false) | |
sms | Boolean | Sim | Define se essa alteração deve notificar o cliente por SMS (true) ou não (false) |
linkRastreio | String | Não | URL de rastreio do pedido Tamanho mínimo: 1 | Tamanho máximo: 255 URL válida: e.g. https://sualoja.com.br/retorno |
Endpoint que permite a criação de pedidos de venda interna.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 60 |
{
"idCanalVenda": 0,
"vendaInterna": {
"idUsuario": 1,
"enviarEmail": false,
"observacao": "Observação da venda interna"
},
"cliente": {
"nome": "Cliente Teste",
"email": "teste@wapstore.com.br",
"cpfCnpj": "87569983652",
"rgIe": "779896354",
"pessoa": "f",
"sexo": "m",
"nascimento": "30/04/1995",
"telefone": "(18) 2344-5466",
"celular": "(18) 988730-9844"
},
"entrega": {
"cep": "16202017",
"destinatario": "Nome do destinatário",
"endereco": "Rua teste",
"bairro": "Bairro teste",
"cidade": "Teste",
"uf": "SP",
"numero": "232",
"complemento": "Complemento do endereço",
"referencia": "Ponto de referência",
"prazoEntrega": 20,
"valorFrete": 82
},
"itens": [
{
"idProduto": 123176,
"idAtributoValor": 0,
"quantidade": 1
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idSite | Number | Não | ID do Canal de Vendas do pedido, informe 0 para o padrão (Este campo está depreciado e será removido em uma versão futura da API. Utilize o parâmetro 'idCanalVenda'). |
idCanalVenda | Number | Não | ID do Canal de Vendas do pedido, informe 0 para o padrão |
vendaInterna | Object | Sim | Dados da venda interna |
idUsuario | Number | Sim | ID do usuário realizando a venda interna |
enviarEmail | Boolean | Sim | Determina se a venda interna envia e-mail ou não |
observacao | String | Não | Observação da venda interna |
cliente | Object | Sim | Dados do cliente |
nome | String | Sim | Nome completo ou razão social do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
|
cpfCnpj | String | Sim | CPF ou CNPJ do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
rgIe | String | Sim | RG ou Inscrição estadual do cliente Tamanho máximo: 250 |
pessoa | String | Sim | Pessoa física (f) ou jurídica (j) Valores aceitos: f, j |
sexo | String | Sim | Sexo do cliente. Envie 'j' para pessoas jurídicas Valores aceitos: m, f, o, i, j |
nascimento | String | Sim | Data de nascimento do cliente no formato 'dd/mm/aaaa' Tamanho mínimo: 1 | Tamanho máximo: 250 |
telefone | String | Sim | Telefone do cliente Tamanho máximo: 250 |
celular | String | Sim | Celular do cliente Tamanho máximo: 250 |
entrega | Object | Sim | Dados da entrega |
cep | String | Sim | CEP de entrega Tamanho mínimo: 1 | Tamanho máximo: 9 |
destinatario | String | Sim | Nome do destinatário Tamanho mínimo: 1 | Tamanho máximo: 250 |
endereco | String | Sim | Nome da rua ou avenida Tamanho mínimo: 1 | Tamanho máximo: 250 |
bairro | String | Sim | Nome do bairro Tamanho mínimo: 1 | Tamanho máximo: 250 |
cidade | String | Sim | Nome da cidade Tamanho mínimo: 1 | Tamanho máximo: 250 |
uf | String | Sim | Estado de destino Tamanho mínimo: 2 | Tamanho máximo: 2 |
numero | String | Sim | Número da casa Tamanho mínimo: 1 | Tamanho máximo: 50 |
complemento | String | Sim | Complemento do endereço Tamanho máximo: 250 |
referencia | String | Sim | Ponto de referência Tamanho máximo: 250 |
prazoEntrega | Number | Sim | Prazo de entrega em dias úteis Valor mínimo: 1 | Valor máximo: 365 |
valorFrete | Number | Sim | Valor do frete do pedido |
itens | Data Collection | Sim | Dados dos itens Tamanho mínimo: 1 |
idProduto | Number | Sim | ID do produto |
idAtributoValor | Number | Sim | ID do valor do atributo |
quantidade | Number | Sim | Quantidade Tamanho máximo: 99999 Valor mínimo: 1 |
descontos | Object | Não | Descontos do pedido |
hashCupom | String | Não | Hash do cupom usado no pedido |
{
"numeroPedido": "1116",
"idPagamento": 119,
"canal": "wapstore",
"tipoLogistica": "",
"parceiroCanal": "wapstore",
"ip": "::1",
"recomendacao": "",
"hash": "dd77279f7d325eec933f05b1672f6a1f",
"dataEmissao": "2022-03-07 16:54:09",
"previsaoEntrega": "",
"detalhes": {
"marketplace": false,
"idPedidoPlataforma": "",
"numeroPedidoBase": "1116",
"subpedido": 1,
"qtdItens": 1,
"qtdSubpedidos": 1,
"subpedidos": [
"1116"
],
"canal": {},
"armazem": {
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true
},
"seller": {}
},
"status": {
"id": 1,
"idPai": 1,
"descricao": "Aguardando Pagamento",
"descricaoPainel": "",
"descricaoSite": "",
"dataAlteracao": "2022-03-07 16:54:09",
"dataOcorrencia": "2022-03-07 16:54:09"
},
"cliente": {
"id": 283199,
"nome": "Cliente Teste",
"email": "teste@wapstore.com.br",
"cpfCnpj": "87569983652",
"rgIe": "779896354",
"pessoa": "f",
"telefone": "(18) 2344-5466",
"celular": "(18) 988730-9844",
"nascimento": "1995-04-30 00:00:00",
"sexo": "m",
"idRevendedor": 0,
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": []
},
"entrega": {
"cep": "16202017",
"destinatario": "Nome do destinatário",
"tipo": "casa",
"endereco": "Rua teste",
"bairro": "Bairro teste",
"cidade": "Teste",
"uf": "SP",
"numero": "232",
"complemento": "Complemento do endereço",
"referencia": "Ponto de referência"
},
"frete": {
"id": -1,
"nome": "Frete",
"transportadora": "Transportadora",
"prazoEntrega": 20,
"idFreteCotacao": "651065106516651"
},
"cupom": {},
"vendaInterna": {
"id": 323,
"idUsuario": 1,
"nomeUsuario": "Webart (teste)",
"enviarEmail": true,
"observacao": "Observação da venda interna"
},
"promocao": {},
"pontosGastos": 0,
"itens": [
{
"id": 123176,
"idAtributoSimples": 0,
"nome": "Produto Teste",
"descricao": "",
"quantidade": 1,
"valor": 20,
"sku": "PRODUTO_TESTE",
"skuSeller": "",
"devolvido": false,
"cancelamentoSeller": {},
"caracteristicas": {
"7": "Marcos Eduardo de Souza",
"8": "7 oitavas"
},
"comissao": {},
"entrega": {
"nfeNumero": "",
"nfeSerie": "",
"nfeChave": "",
"rastreio": "",
"frete": {
"valor": 0,
"idFreteCotacao": "651065106516651"
}
}
}
],
"pagamento": [
{
"id": 119,
"nome": "Venda Interna",
"bandeira": "vendainterna",
"gateway": "proprio",
"cnpjGateway": "",
"parcelas": 1,
"vencimentoBoleto": "2022-03-10",
"valor": 102,
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"numeroSequencialUnicoCaptura": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
],
"valores": {
"subtotal": 20,
"presente": 0,
"frete": 82,
"juros": 0,
"descontoCupom": 0,
"descontoBoleto": 0,
"descontoRevendedor": 0,
"descontoPromocao": 0,
"descontoAdicional": 0,
"descontoTotal": 0,
"comissao": 0,
"comissaoEstornada": 0,
"totalComissao": 0,
"totalPedido": 102,
"totalEstornado": 0,
"total": 102
},
"historico": [
{
"id": 6109,
"idStatus": 1,
"detalhes": {
"1116": {
"nome": "Status Inicial do Pedido - Pedido cadastrado via API para cadastrado de pedidos de venda interna"
}
},
"tipo": "status",
"dataAlteracao": "2022-03-07 16:54:09",
"dataOcorrencia": "2022-03-07 16:54:09"
}
],
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"canalVenda": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
}
Campo | Tipo | Descrição |
---|---|---|
numeroPedido | String | Número do pedido/subpedido gerado |
idPagamento | Number | ID da forma de pagamento do pedido (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
canal | String | Define se o pedido foi gerado na plataforma (wapstore), se foi gerado por um marketplace (omni) ou se foi criado via integração (api) Valores aceitos: api, omni, wapstore |
tipoLogistica | String | Tipo de logística do pedido |
canalLoja | String | Loja que gerou o pedido |
parceiroCanal | String | Nome do parceiro do canal que gerou o pedido (CNOVA, B2W, etc) |
ip | String | IP do cliente ou sistema que gerou o pedido |
recomendacao | String | Recomendação do pedido |
hash | String | Hash única do pedido (a mesma hash é compartilhada em todos os sub pedidos) |
dataEmissao | String | Data e hora que o pedido foi criado na WapStore Formato esperado: 2019-05-11 22:15:00 |
previsaoEntrega | String | Data prevista de entrega para o pedido (YYYY-MM-DD) |
moeda | String | Moeda em que o pedido foi gerado (BRL, USD...) |
detalhes | Object | Detalhes adicionais sobre o pedido |
marketplace | Boolean | Define se o pedido tem produtos de um seller do marketplace (true) ou da própria loja (false) |
idPedidoPlataforma | String | Mapeamento do pedido entre a wap.store e a plataforma de marketplace |
numeroPedidoBase | String | Número do pedido base que gerou os sub pedidos |
subpedido | Number | Número do sub pedido atual |
qtdItens | Number | Quantidade de itens no pedido |
qtdSubpedidos | Number | Quantidade de sub pedidos gerados |
subpedidos | Array de strings | Subpedidos vinculados |
canal | Object | Dados da transação quando vier do marketplace |
nomeSeller | String | Nome do seller que fez a venda |
cnpjMarketplace | String | CNPJ do marketplace que fez a venda |
armazem | Object | Dados do armazém responsável por esse pedido/subpedido. |
seller | Object | Dados do seller (apenas para pedidos do marketplace) |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
status | Object | Detalhes do status do pedido |
id | Number | ID do status (veja todos os IDs de status consultando a API de status de pedido) |
idPai | Number | ID do status pai (status principal do pedido - caso o status atual seja intermediário) |
descricao | String | Nome do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
dataAlteracao | String | Data de alteração do status |
dataOcorrencia | String | Data de ocorrencia do status |
intermediador | Object | Dados do intermediador (cliente que efetuou a compra, disponível no modelo de negócio B2B2C) |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
cliente | Object | Dados do cliente |
id | Number | ID |
codigo | String | Nome |
nome | String | Nome |
String | E-mail (marketplaces, como B2W, não informam o e-mail correto do cliente) | |
cpfCnpj | String | CPF ou CNPJ |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
rgIe | String | RG ou inscrição estadual |
pessoa | String | Define se o cliente é uma pessoa física (f) ou jurídica (j) Valores aceitos: j, f |
telefone | String | Telefone |
celular | String | Celular |
nascimento | String | Data de nascimento |
sexo | String | Define se o sexo do cliente é masculino (m), feminino (f), outro(o), indefinido(i) ou é uma pessoa jurídica (j) Valores aceitos: m, f, o, i, j |
idRevendedor | Number | ID de revendedor |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
newsletter | String | Verifica se deve receber newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
site | Object | Canal de Vendas (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
tributacao | String | Tipo de tributação |
enquadramentoFiscal | String | Enquadramento Fiscal |
informacoesAdicionais | Object | Informações adicionais do cliente |
representante | Object | Dados do representante |
id | Number | Identificador do usuário representante |
codigoInterno | String | Código interno do usuário representante |
nome | String | Nome do usuário representante |
String | E-mail do usuário representante | |
entrega | Object | Dados da entrega |
cep | String | CEP de entrega |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de entrega |
bairro | String | Bairro de entrega |
cidade | String | Cidade de entrega |
uf | String | UF de entrega |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para entrega |
faturamento | Object | Dados do endereço de faturamento |
cep | String | CEP de faturamento |
destinatario | String | Nome do destinatário |
tipo | String | Tipo de endereço (casa, apartamento, etc) |
endereco | String | Endereço de faturamento |
bairro | String | Bairro de faturamento |
cidade | String | Cidade de faturamento |
uf | String | UF de faturamento |
numero | String | Número da casa, prédio, etc |
complemento | String | Complemento do endereço |
referencia | String | Ponto de referência para o endereço de faturamento |
destinatarioRetirada | Object | Dados do destinatário do pedido de retirada em loja |
idPedido | Number | Identificador do pedido |
nome | String | Nome do destinatário |
cpfCnpj | String | CPF ou CNPJ do destinatário |
informacoesAdicionais | Object | Informações adicionais do destinatário |
pontoRetirada | Object | Dados do destinatário do pedido de retirada em loja |
id | Number | Id do ponto de retirada |
nome | String | Nome do ponto de retirada |
valor | Number | Valor do custo da retirada |
prazo | String | Prazo para poder retirar |
local | Object | Lista com o endereço do ponto de retirada |
endereco | String | Endereço do ponto de retirada |
numero | String | Número do endereço do ponto de retirada |
bairro | String | Bairro do ponto de retirada |
cidade | String | Cidade do ponto de retirada |
cep | String | CEP do ponto de retirada |
obs | String | Observação do endereço do ponto de retirada mono estoque |
latitude | String | Latitude do ponto de retirada multi estoque |
longitude | String | Longitude do ponto de retirada multi estoque |
horarioFuncionamento | String | Horário de funcionamento do ponto de retirada multi estoque |
frete | Object | Dados de frete |
id | Number | ID do tipo de frete (veja os tipos de frete disponíveis na API de fretes) |
nome | String | Nome do tipo de frete (Ex. SEDEX, PAC, etc) |
transportadora | String | Nome da transportadora (Ex. Correios) |
prazoEntrega | Number | Prazo de entrega do pedido em dias úteis |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
cupom | Object | Dados de cupom utilizado |
id | Number | ID do cupom utilizado |
hash | String | HASH do cupom utilizado |
vendaInterna | Object | Dados de venda interna (somente para pedidos que contenham venda interna) |
id | Number | ID da venda interna que gerou o pedido |
codigoInternoUsuario | String | Código interno do usuário que gerou a venda interna |
idUsuario | Number | ID do usuário que gerou a venda interna |
nomeUsuario | String | Nome do usuário que gerou a venda interna |
enviarEmail | Boolean | Determina se a venda interna envia e-mail ou não |
observacao | String | Observação da venda interna |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
nome | String | Nome da situação de bloqueio do pedido |
hash | String | Hash da situação de bloqueio pedido |
bloqueios | Data Collection | Bloqueios do Pedido |
id | Number | ID da Associação entre Bloqueio e Pedido |
idBloqueioPedido | Number | ID do Bloqueio de Pedido |
nomeBloqueio | String | Nome do Bloqueio |
tipoBloqueio | String | Hash do Tipo de Bloqueio |
descricaoTipoBloqueio | String | Descrição do Tipo de Bloqueio |
status | String | Status do Bloqueio |
regraAplicacao | Object | Regra de Aplicação do Bloqueio |
valorAplicado | Object | Valor pendente de liberação para prosseguimento com o Pedido |
idUsuarioAlteracao | Number | ID do Usuário que alterou o status do bloqueio |
nomeUsuarioMovimentacao | String | Nome do Usuário que alterou o status do bloqueio |
observacao | String | Observação referente à movimentação de status |
perfisAlcadaAprovacao | Data Collection | Perfis da alçada responsáveis pela aprovação |
dataAlteracao | String | Data da alteração do status do bloqueio |
tipoVenda | Object | Dados do tipo de venda (disponível no modelo de negócio B2B2BC) |
id | Number | ID do tipo de venda |
nome | String | Nome do tipo de venda |
pontosGastos | Number | Quantidade total de pontos gastos no pedido |
detalhesPontosGastos | Data Collection | Detalhes de pontos gastos no pedido |
quantidade | Number | Quantidade de pontos aplicados |
valorEmMoeda | Number | Valor em moeda dos pontos aplicados |
canalVendaOrigem | Object | Canal de venda de origem dos pontos aplicados |
pontosGerados | Object | Objeto com dados sobre os pontos gerados |
pedido | Object | Objeto com dados sobre os pontos gerados pelo pedido |
quantidade | Number | Quantidade de pontos gerados |
valorEmMoeda | Number | Valor em moeda dos pontos gerados |
status | String | Status dos pontos gerados. O status pendente indica que os pontos ainda não foram disponibilizados ao cliente, disponivel indica que o cliente já pode usar os pontos gerados, indisponivel indica que os pontos não estão mais disponíveis para uso e redisponibilizado indica que os pontos ficaram indisponíveis mais estão disponíveis novamente. Valores aceitos: pendente, disponivel, indisponivel, redisponibilizado |
promocao | Object | Dados de promoção aplicada no pedido (somente para pedidos que possuem promoção ativa) |
id | Number | ID da promoção aplicada |
titulo | String | Título da promoção |
tipo | String | Tipo de promoção aplicada Valores aceitos: valor_desconto, porcentagem_desconto, frete_fixo, porcentagem_desconto_frete, valor_desconto_frete, promocoes_cumulativas |
valor | Number | Valor de desconto configurado segundo o tipo de promoção. Para ver o valor total de desconto da promoção verifique o campo 'descontoPromocao' do objeto de totais. |
itens | Data Collection | Dados dos itens do pedido |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
id | Number | ID do produto |
idAtributoSimples | Number | ID do atributo simples do produto |
nome | String | Nome do produto |
descricao | String | Descrição adicional do produto (cor, tamanho, voltagem, etc) |
quantidade | Number | Quantidade do item |
valor | Number | Valor unitário do produto |
alteracoes | Data Collection | Dados de alteração de preço do item do pedido |
tipoAlteracao | String | Tipo da alteração de valor do item do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do item do pedido |
variacaoValor | Number | Valor absoluto da variação de preço |
variacaoPercentual | Number | Valor em percentual da variação de preço |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
sku | String | SKU do produto na WapStore |
skuSeller | String | SKU do produto para o Seller (apenas para pedidos de sellers) |
tipo | String | Tipo do item (produto, servico ou conjunto) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
itens | Data Collection | Itens do produto caso ele seja do tipo conjunto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
devolvido | Boolean | Define se o produto foi devolvido |
personalizacoes | Data Collection | Personalizações aplicadas no produto |
id | Number | ID da personalização |
nome | String | Nome da personalização |
valor | String | Valor aplicado a personalização |
quantidade | Number | Quantidade aplicada da personalização no produto |
precoUnitario | Number | Valor unitário da personalização |
precoTotal | Number | Valor total da personalização |
cancelamentoSeller | Object | Dados de cancelamento de item pelo seller (apenas para pedidos de sellers que sofreram cancelamento pelo seller) |
usuario | String | Nome do usuário que executou o cancelamento |
motivo | String | Motivo do cancelamento |
dataCancelamento | String | Data e hora de cancelamento Formato esperado: 2019-05-11 22:15:00 |
comissao | Object | Dados de comissão (apenas para pedidos de sellers) |
regra | Object | Dados da regra de comissão aplicada |
percentual | Number | Percentual de comissão |
descricao | String | Descrição da comissão aplicada (nome da categoria) |
rebate | Object | Dados do rebate (caso exista um rebate no produto) |
id | Number | ID do rebate aplicado |
nome | String | Nome do rebate aplicado |
valorOriginal | Number | Valor original do produto (se não houvesse rebate) |
valorRebate | Number | Valor do produto fixado no rebate |
percentual | String | Percentual de comissão fixada no rebate |
comissaoAplicada | Object | Dados da comissão aplicada (comissão real ou rebate) |
percentual | Number | Percentual de comissão aplicada |
valor | String | Valor de comissão cobrada do pedido |
entrega | Object | Dados da entrega |
nfeNumero | String | Número da nota fiscal |
nfeSerie | String | Série da nota fiscal |
nfeChave | String | Chave da nota fiscal |
nfeXml | String | XML da nota fiscal |
rastreio | String | Código de rastreio |
frete | Object | Dados do frete do item |
valor | Number | Valor do frete cobrado para o item |
idFreteCotacao | String | ID da cotação de frete fornecido pelo gateway |
label | String | Label do título da entrega agendada |
periodo | String | Período da entrega que o cliente agendou |
dataAgendada | String | Data de o cliente agendou a para entrega |
fraseExibicao | String | Frase de exibição |
impostos | Object | Informações dos impostos aplicados ao item |
totalImpostos | Number | Valor somado de todos os impostos aplicados ao item do pedido |
taxasAplicadas | Data Collection | Taxas de impostos que foram aplicadas |
nome | String | Nome do imposto |
descricao | String | Descrição do imposto |
valor | String | Valor do imposto |
comissao | Object | Dados de comissão do pedido |
pedido | Data Collection | Dados de comissão do pedido |
subpedido | Data Collection | Dados de comissão do subpedido |
alteracoes | Object | Dados de alteração do subtotal do subpedido |
pedido | Data Collection | Alteração de valor do pedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do pedido |
valorAplicado | Number | Valor aplicado ao pedido |
variacaoPercentual | Number | Valor em percentual da variação de valor |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
subpedido | Data Collection | Alteração de valor do subpedido |
tipoAlteracao | String | Tipo da alteração de valor do pedido Valores aceitos: frete, subtotal |
valorOriginal | Number | Valor original do subpedido |
valorAplicado | Number | Valor aplicado ao subpedido |
variacaoPercentual | Number | Valor em percentual da variação de subtotal |
variacaoTipo | String | Tipo da variação Valores aceitos: desconto, acrescimo |
pagamento | Data Collection | Dados de pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
valores | Object | Valores do pedido |
subtotal | Number | Sub total (soma do valor dos itens) |
juros | Number | Valor dos juros aplicados |
impostos | Number | Valor dos impostos aplicados no pedido |
tarifaServico | Number | Valor da tarifa de serviço (disponível no modelo de negócio B2B2C) |
frete | Number | Valor de frete |
presente | Number | Valor de itens para presente |
descontoCupom | Number | Valor de desconto de cupom |
descontoBoleto | Number | Valor de desconto de boleto |
descontoRevendedor | Number | Valor de desconto de revendedor |
descontoPromocao | Number | Valor de desconto promocional |
descontoVoucher | Number | Valor de desconto do voucher |
descontoAdicional | Number | Valor de outros descontos |
descontoTotal | Number | Valor total dos descontos do pedido |
comissao | Number | Total de comissão gerada no pedido |
comissaoEstornada | Number | Total de comissão estornada (comissão cancelada) |
totalComissao | Number | Total líquido da comissão (comissao - comissaoEstornada) |
totalPedido | Number | Total do pedido sem estornos (sub total + juros + frete + presente - descontos) |
totalEstornado | Number | Valor total estornado (valores de itens, fretes, juros, etc. sobre os produtos cancelados do pedido) |
total | Number | Total do pedido com estornos (total - totalEstornado) |
informacoesAdicionais | Data Collection | Informações adicionais do pedido |
hash | String | Identificador da informação adicional |
valor | String | Valor definido para a informação adicional |
historico | Data Collection | Dados de histórico |
id | Number | ID do histórico |
idStatus | Number | ID do Status |
detalhes | Object | Objeto com detalhes do histórico |
tipo | String | Tipo do histórico (status,transacao,api,erp) Valores aceitos: status, transacao, api, erp |
dataAlteracao | String | Data que foi alterado o histórico |
dataOcorrencia | String | Data da Ocorrencia |
site | Object | Canal de Vendas do Pedido (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
Endpoint responsável por atualizar as informações adicionais de um pedido.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/orders/{numeroPedido}/more-info | Número do pedido (número retornado no campo 'numeroPedido') |
Limite de requisições por minuto | 60 |
{
"informacoesAdicionais": [
{
"hash": "pra-que-time-voce-torce",
"valor": "Barcelona"
},
{
"hash": "como-voce-conheceu-a-loja",
"valor": "youtube"
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
informacoesAdicionais | Data Collection | Sim | Informações adicionais a serem alteradas Tamanho mínimo: 1 |
hash | String | Sim | Hash da informação adicional Tamanho mínimo: 1 |
valor | String | Sim | Valor definido para a informação adicional Tamanho mínimo: 1 |
Endpoint responsável por buscar todos os bloqueios de pedidos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os bloqueios pelos status. Filtros válidos (pendente|aprovado) Exemplo de requisição: /v2/orders/blocking?status=pendente numeroPedido: Filtra os bloqueios por um pedido específico. Exemplo de requisição: /v2/orders/blocking?numeroPedido=TESTE-001 usuario: Filtra os bloqueios que o usuário informado pode visualizar. Exemplo de requisição: /v2/orders/blocking?usuario=1 identificador: Define o tipo do valor utilizado no filtro de usuário. Caso nenhum valor seja informado, será considerado o tipo ID. Filtros permitidos (id|codigo|email) Exemplo de requisição: /v2/orders/blocking?identificador=codigo |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/orders/blocking?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pedidos": [
{
"id": 1,
"numeroPedido": "TESTE-0001",
"emailCliente": "teste@gmail.com",
"dataEmissao": "2024-01-15 15:38:16",
"valorTotal": 3801,
"bloqueios": [
{
"id": 1,
"idBloqueioPedido": 1,
"nomeBloqueio": "Venda Futura",
"tipoBloqueio": "tipo_venda",
"descricaoTipoBloqueio": "Tipo de Venda",
"observacao": "",
"status": "pendente",
"regraAplicacao": {
"idTipoVenda": 6,
"nomeTipoVenda": "Futura"
},
"valorAplicado": {
"idTipoVenda": 6,
"nomeTipoVenda": "Futura"
},
"idUsuarioAlteracao": 0,
"nomeUsuarioMovimentacao": "",
"perfisAlcadaAprovacao": [
{
"id": 10,
"nome": "Vendedor",
"ativo": "s"
},
{
"id": 1,
"nome": "Gerente",
"ativo": "s"
}
],
"dataAlteracao": ""
}
]
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/orders?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 1,
"exibindo": 1,
"total": 17
}
}
Campo | Tipo | Descrição |
---|---|---|
pedidos | Data Collection | Dados dos pedidos bloqueados |
id | Number | ID do pedido bloqueado |
numeroPedido | String | Número do pedido bloqueado |
emailCliente | String | E-mail do cliente vinculado ao pedido |
dataEmissao | String | Data de emissão do pedido |
valorTotal | Number | Valor total do pedido |
situacaoBloqueio | Object | Situação do bloqueio do pedido |
bloqueios | Data Collection | Informações dos tipos de bloqueios no pedido |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Endpoint responsável por atualizar status dos bloqueios em lote.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
{
"usuario": {
"email": "teste@email.com"
},
"bloqueios": [
{
"idBloqueio": 1,
"status": "aprovado",
"observacao": ""
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
usuario | Object | Sim | Usuário responsável pela aprovação dos bloqueios de pedidos |
String | Sim | E-mail do usuário responsável pela aprovação | |
bloqueios | Data Collection | Sim | Dados com os bloqueios de pedidos |
idBloqueio | Number | Sim | ID do bloqueio |
status | String | Sim | Status de bloqueio. O status 'pendente' poderá ser utilizada apenas se houver alteração da situação do pedido bloqueado Valores aceitos: pendente, aprovado, reprovado |
observacao | String | Não | Obserção que será vinculada a alteração de status do bloqueio de pedido |
situacaoBloqueio | String | Não | Situação de bloqueio do pedido Valores aceitos: aguardando, analise |
Recurso responsável por listar todas as informações adicionais de pedido disponíveis na loja.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
{
"informacoesAdicionais": [
{
"hash": "como-voce-conheceu-a-loja",
"titulo": "Como você conheceu a loja?",
"tipo": "select",
"valoresDisponiveis": [
"youtube",
"instagram",
"twitter",
"tik-tok",
"google",
"outros"
],
"visivelEm": [
"pedido",
"site",
"api"
],
"editavelEm": [
"site"
],
"idStatusMaximoPedidoEdicao": 1
},
{
"hash": "pra-que-time-voce-torce",
"titulo": "Pra que time você torce?",
"tipo": "text",
"visivelEm": [
"pedido",
"venda-interna",
"site",
"api"
],
"editavelEm": [
"site"
],
"idStatusMaximoPedidoEdicao": 4
},
{
"hash": "observacoes",
"titulo": "Observações",
"tipo": "textarea",
"visivelEm": [
"pedido",
"venda-interna",
"site",
"api"
],
"editavelEm": [
"pedido",
"venda-interna",
"site",
"api"
],
"idStatusMaximoPedidoEdicao": 8
}
]
}
Campo | Tipo | Descrição |
---|---|---|
informacoesAdicionais | Data Collection | Informações adicionais existentes |
hash | String | Identificador da informação adicional. |
titulo | String | Título da informação adicional. |
tipo | String | Tipo da informação adicional. |
valoresDisponiveis | Array | Valores disponíveis para a informação adicional. |
visivelEm | Array | Locais onde a informação é visivel. |
editavelEm | Array | Locais onde a informação é visivel. |
idStatusMaximoPedidoEdicao | Number | Id do status pedido máximo de edição do campo. |
Recurso responsável por listar todos os canais de venda da wap.store, ordenados pelo identificador único.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/sales-channel?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"canais": [
{
"id": 1,
"codigo": "loja1",
"idCanalPai": 0,
"dominio": "www.loja1.com.br",
"tipo": "Produto",
"nome": "Loja 1",
"ativo": "s"
},
{
"id": 2,
"codigo": "loja2",
"idCanalPai": 1,
"dominio": "www.loja2.com.br",
"tipo": "Produto",
"nome": "Loja 2",
"ativo": "s"
},
{
"id": 3,
"codigo": "loja3",
"idCanalPai": 1,
"dominio": "www.loja3.com.br",
"tipo": "Produto",
"nome": "Loja 3",
"ativo": "s"
},
{
"id": 4,
"codigo": "loja4",
"idCanalPai": 1,
"dominio": "www.loja4.com.br",
"tipo": "Produto",
"nome": "Loja 4",
"ativo": "s"
},
{
"id": 5,
"codigo": "loja5",
"idCanalPai": 1,
"dominio": "www.loja5.com.br",
"tipo": "Produto",
"nome": "Loja 5",
"ativo": "s"
},
{
"id": 6,
"codigo": "loja6",
"idCanalPai": 0,
"dominio": "www.loja6.com.br",
"tipo": "Produto",
"nome": "Loja 6",
"ativo": "s"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/sales-channel?offset=0&limit=20",
"next": "",
"offset": 0,
"limit": 20,
"exibindo": 6,
"total": 6
}
}
Campo | Tipo | Descrição |
---|---|---|
canais | Data Collection | Canais de Vendas Disponíveis |
id | Number | Identificador único do Canal de Vendas |
idCanalPai | Number | Identificador do Canal de Vendas Pai |
codigo | String | Código do Canal de Vendas |
dominio | String | Domínio do Canal de Vendas |
tipo | String | Tipo do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
ativo | String | Determina se o canal de vendas está ativo ou não |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por incluir Canais de Venda na base da plataforma.
O campo idCanalPai não pode abrigar o ID de um Canal já que seja filho de algum outro. Um Canal pode ser pai apenas caso este não possua nenhum filho e não esteja associado a algum pai.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 2000 |
{
"dominio": "www.loja1.com.br",
"codigo": "123456789",
"idCanalPai": 20,
"tipo": "Produto",
"nome": "Loja 1",
"ativo": "s"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCanalPai | Number | Não | Identificador do Canal de Vendas Pai |
codigo | String | Não | Código do Canal de Vendas |
dominio | String | Sim | Domínio do Canal de Vendas |
tipo | String | Não | Tipo do Canal de Vendas |
nome | String | Sim | Nome do Canal de Vendas Tamanho mínimo: 1 |
ativo | String | Sim | Determina se o canal de vendas está ativo ou não Valores aceitos: s, n |
{
"id": 51,
"codigo": "123456789",
"idCanalPai": 1,
"dominio": "www.loja1.com.br",
"tipo": "Produto",
"nome": "Loja 1",
"ativo": "s"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Canal de Vendas |
idCanalPai | Number | Identificador do Canal de Vendas Pai |
codigo | String | Código do Canal de Vendas |
dominio | String | Domínio do Canal de Vendas |
tipo | String | Tipo do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
ativo | String | Determina se o canal de vendas está ativo ou não |
Recurso responsável por listar todos os clientes disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | email: Filtra os clientes por seu email. Exemplo de requisição: /v2/customers?email=exemplo@wapstore.com.br |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/customers?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"clientes": [
{
"id": 1,
"codigo": "cli-1",
"nome": "Cliente de Teste",
"sobrenomeFantasia": "",
"atividadePrincipal": {
"cnae": "4753900",
"descricao": "Comércio varejista especializado de eletrodomésticos e equipamentos de áudio e vídeo"
},
"atividadesSecundarias": [
{
"cnae": "4755503",
"descricao": "Comércio varejista de artigos de cama, mesa e banho"
},
{
"cnae": "4755502",
"descricao": "Comércio varejista de artigos de armarinho"
},
{
"cnae": "4789001",
"descricao": "Comércio varejista de suvenires, bijuterias e artesanatos"
}
],
"email": "cliente@teste.com.br",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(12) 12345-6789",
"nascimento": "29/12/1998",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"pontos": [
{
"quantidade": 200.04,
"valorEmMoeda": 4,
"canalVendaOrigem": {
"id": 0,
"nome": "Principal",
"dominio": "https://lojascrum.wapstore.com.br",
"tipo": "principal"
},
"validade": "2023-05-12 15:05:06"
},
{
"quantidade": 324.32,
"valorEmMoeda": 6.48,
"canalVendaOrigem": {
"id": 1,
"nome": "Discomania",
"dominio": "https://www.discomania.wapstore.com.br",
"tipo": ""
},
"validade": "2023-06-12 13:17:23"
}
],
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"comissao": [
{
"tipo": "reservaTecnica",
"percentualBase": 25,
"percentualMaximo": 95
},
{
"tipo": "tarifaServico",
"percentualBase": 25,
"percentualMaximo": 95
}
]
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/customers?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
clientes | Data Collection | Clientes disponíveis |
id | Number | Identificador único do cliente |
codigo | String | Identificador externo do cliente |
site | Object | Canal de Vendas do cliente (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
nome | String | Nome oficial do cliente |
nomeFantasia | String | Sobrenome do cliente ou nome fantasia da empresa |
cpfCnpj | String | CPF do cliente ou CNPJ da empresa |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
atividadesSecundarias | Data Collection | Define os dados das atividades secundárias de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade secundária exercida pelo cliente PJ |
descricao | String | Descrição da atividade secundária do cliente PJ |
String | Endereço de e-mail do cliente | |
telefone | String | Número de telefone do cliente |
celular | String | Número de celular do cliente |
pessoa | String | Tipo do cliente (Físico ou Jurídico) Valores aceitos: f, j |
intermediador | Boolean | O cliente é um intermediador da loja e pode vender produtos (B2B2C) |
nascimento | String | Data de nascimento do cliente |
sexo | String | Sexo do cliente (Masculino, Feminino, Outros, Indefinido ou Jurídico) Valores aceitos: m, f, o, i, j |
newsletter | String | Se o cliente recebe newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
rgIe | String | Registro geral ou inscrição estadual do cliente |
dataCadastro | String | Data de cadastro do cliente |
pontos | Data Collection | Pontos do cliente |
quantidade | Number | Quantidade de pontos do cliente |
valorEmMoeda | Number | Valor dos pontos em moeda |
canalVendaOrigem | Object | Canal de venda de origem dos pontos |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
validade | String | Data de expiração dos pontos |
enderecos | Data Collection | Endereços do cliente |
id | Number | Identificador único do endereço do cliente |
nome | String | Nome do endereço |
tipo | String | Tipo do endereço Valores aceitos: apartamento, casa, comercial, outro |
cep | String | CEP do endereço |
endereco | String | Rua do endereço |
numero | String | Número do endereço |
complemento | String | Complemento do endereço |
referencia | String | Referência do endereço |
bairro | String | Bairro do endereço |
cidade | String | Cidade do endereço |
uf | String | Unidade federal do endereço |
destinatario | String | Nome do destinatário |
principal | String | Define se é o endereço é principal Valores aceitos: s, n |
informacoesAdicionais | Object | Informações adicionais do cliente |
comissao | Data Collection | Dados de comissão do cliente |
tipo | String | Tipo da comissão Valores aceitos: reservaTecnica, tarifaServico |
percentualBase | Number | Percentual base da comissão |
percentualMaximo | Number | Percentual máximo da comissão |
tributacao | String | Tipo de tributação do cliente |
enquadramentoFiscal | String | Enquadramento Fiscal do cliente |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
pagamentosPersonalizado | Array de números | Pagamentos vinculados ao cliente |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por listar todas as solicitações de recuperação de senha de clientes
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | cliente: Filtra as recuperações de senha pelo id do cliente. Exemplo de requisição: /v2/customers/password-recovery?cliente=10 email: Filtra as recuperações de senha pelo email do cliente. Exemplo de requisição: /v2/customers/password-recovery?email=exemplo@wapstore.com.br dataSolicitacao: Filtra as recuperações de senha pela data de solicitação. Exemplo de requisição: /v2/customers/password-recovery?dataSolicitacao=2022-09-01 dataExpiracao: Filtra as recuperações de senha pela data de expiração. Exemplo de requisição: /v2/customers/password-recovery?dataExpiracao=2022-09-02 |
Limite de requisições por minuto | 220 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/customers/password-recovery?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"recuperacaoSenha": [
{
"id": 3,
"tipo": "cliente",
"dataSolicitacao": "2022-09-01 00:00:00",
"dataExpiracao": "2022-09-04 00:00:00",
"urlRecuperacao": "https://sandbox.wapstore.com.br/minha-conta/redefinir-senha/?key=6124f70941c1eb2057c52bacdfcfe960",
"cliente": {
"id": 89,
"nome": "wap.store",
"email": "exemplo@wapstore.com.br",
"celular": "(12) 12345-6789",
"telefone": "",
"cpfCnpj": "12345678998",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
}
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/v2/customers/recovery-password?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
recuperacaoSenha | Data Collection | Listagem das solicitações de recuperação de senha |
id | Number | ID da recuperação de senha |
tipo | String | Tipo de conta que solicitou a alteração de senha Valores aceitos: cliente |
dataSolicitacao | String | Data da solicitação de alteração de senha |
dataExpiracao | String | Data de expiração da solicitação de alteração de senha |
urlRecuperacao | String | Url da solicitação de recuperação de senha |
cliente | Object | Informações do cliente |
id | Number | ID do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
celular | String | Número de celular do cliente |
telefone | String | Número de telefone do cliente |
cpfCnpj | String | CPF/CNPJ do cliente |
site | Object | Canais de Vendas vinculados ao cliente (Deprecated) |
id | Number | ID do canal de venda |
nome | String | Nome do Canal |
tipo | String | Tipo do canal de venda |
dominio | String | Domínio do canal de venda |
canalVenda | Object | Canais de Vendas vinculados ao cliente |
id | Number | ID do canal de venda |
nome | String | Nome do Canal |
tipo | String | Tipo do canal de venda |
dominio | String | Domínio do canal de venda |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de cliente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/customers/{idCodigoCliente} | ID ou o código externo do cliente |
Filtros | identificador: Realiza a busca de um cliente pelo seu identificador. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/customers/{idCodigoCliente}?identificador=id |
Limite de requisições por minuto | 120 |
{
"id": 1,
"codigo": "cli-1",
"nome": "Cliente de Teste",
"sobrenomeFantasia": "",
"atividadePrincipal": {
"cnae": "4753900",
"descricao": "Comércio varejista especializado de eletrodomésticos e equipamentos de áudio e vídeo"
},
"atividadesSecundarias": [
{
"cnae": "4755503",
"descricao": "Comércio varejista de artigos de cama, mesa e banho"
},
{
"cnae": "4755502",
"descricao": "Comércio varejista de artigos de armarinho"
},
{
"cnae": "4789001",
"descricao": "Comércio varejista de suvenires, bijuterias e artesanatos"
}
],
"email": "cliente@teste.com.br",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(12) 12345-6789",
"nascimento": "29/12/1998",
"sexo": "m",
"rgIe": "12.345.678-9",
"dataCadastro": "2019-01-10 15:00:02",
"enderecos": [
{
"id": "1",
"cep": "18540000",
"endereco": "Rua de Teste",
"numero": "46",
"complemento": "Casa",
"referencia": "Esquina",
"bairro": "Teste",
"cidade": "Teste",
"uf": "SP",
"destinatario": "Exemplo Wapstore",
"principal": "n"
}
],
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"pontos": [
{
"quantidade": 200.04,
"valorEmMoeda": 4,
"canalVendaOrigem": {
"id": 0,
"nome": "Principal",
"dominio": "https://lojascrum.wapstore.com.br",
"tipo": "principal"
},
"validade": "2023-05-12 15:05:06"
},
{
"quantidade": 324.32,
"valorEmMoeda": 6.48,
"canalVendaOrigem": {
"id": 1,
"nome": "Discomania",
"dominio": "https://www.discomania.wapstore.com.br",
"tipo": ""
},
"validade": "2023-06-12 13:17:23"
}
],
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"comissao": [
{
"tipo": "reservaTecnica",
"percentualBase": 25,
"percentualMaximo": 95
},
{
"tipo": "tarifaServico",
"percentualBase": 25,
"percentualMaximo": 95
}
]
}
{
"id": 153,
"nome": "Fulano Beltrano",
"nomeFantasia": "",
"cpfCnpj": "66576787801",
"email": "fulano_beltrano@teste.com",
"pessoa": "f",
"intermediador": true,
"telefone": "",
"celular": "1898777878",
"nascimento": "01/03/1990",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"pontos": {},
"site": {},
"canalVenda": {},
"rgIe": "",
"dataCadastro": "2023-02-08 18:01:19",
"enderecos": [
{
"id": "1",
"cep": "18540000",
"endereco": "Rua de Teste",
"numero": "46",
"complemento": "Casa",
"referencia": "Esquina",
"bairro": "Teste",
"cidade": "Teste",
"uf": "SP",
"destinatario": "Exemplo Wapstore",
"principal": "n"
}
],
"informacoesAdicionais": [],
"revendedor": {
"nomeGrupo": "Gold",
"tipoPreco": "desconto",
"freteTipo": {
"id": 203,
"nome": "Correios PAC"
},
"landingPage": {},
"minimoCompra": 200.00,
"desconto": 15,
"canalVenda": [
{
"id": 2,
"nome": "Canal de Venda 2",
"valor": 20
},
{
"id": 3,
"nome": "Canal de Venda 3",
"valor": 0
}
]
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do cliente |
codigo | String | Identificador externo do cliente |
site | Object | Canal de Vendas do cliente (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
nome | String | Nome oficial do cliente |
nomeFantasia | String | Sobrenome do cliente ou nome fantasia da empresa |
cpfCnpj | String | CPF do cliente ou CNPJ da empresa |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
atividadesSecundarias | Data Collection | Define os dados das atividades secundárias de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade secundária exercida pelo cliente PJ |
descricao | String | Descrição da atividade secundária do cliente PJ |
String | Endereço de e-mail do cliente | |
telefone | String | Número de telefone do cliente |
celular | String | Número de celular do cliente |
pessoa | String | Tipo do cliente (Físico ou Jurídico) Valores aceitos: f, j |
intermediador | Boolean | O cliente é um intermediador da loja e pode vender produtos (B2B2C) |
nascimento | String | Data de nascimento do cliente |
sexo | String | Sexo do cliente (Masculino, Feminino, Outros, Indefinido ou Jurídico) Valores aceitos: m, f, o, i, j |
newsletter | String | Se o cliente recebe newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
rgIe | String | Registro geral ou inscrição estadual do cliente |
dataCadastro | String | Data de cadastro do cliente |
pontos | Data Collection | Pontos do cliente |
quantidade | Number | Quantidade de pontos do cliente |
valorEmMoeda | Number | Valor dos pontos em moeda |
canalVendaOrigem | Object | Canal de venda de origem dos pontos |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
validade | String | Data de expiração dos pontos |
enderecos | Data Collection | Endereços do cliente |
id | Number | Identificador único do endereço do cliente |
nome | String | Nome do endereço |
tipo | String | Tipo do endereço Valores aceitos: apartamento, casa, comercial, outro |
cep | String | CEP do endereço |
endereco | String | Rua do endereço |
numero | String | Número do endereço |
complemento | String | Complemento do endereço |
referencia | String | Referência do endereço |
bairro | String | Bairro do endereço |
cidade | String | Cidade do endereço |
uf | String | Unidade federal do endereço |
destinatario | String | Nome do destinatário |
principal | String | Define se é o endereço é principal Valores aceitos: s, n |
informacoesAdicionais | Object | Informações adicionais do cliente |
comissao | Data Collection | Dados de comissão do cliente |
tipo | String | Tipo da comissão Valores aceitos: reservaTecnica, tarifaServico |
percentualBase | Number | Percentual base da comissão |
percentualMaximo | Number | Percentual máximo da comissão |
tributacao | String | Tipo de tributação do cliente |
enquadramentoFiscal | String | Enquadramento Fiscal do cliente |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
pagamentosPersonalizado | Array de números | Pagamentos vinculados ao cliente |
Recurso responsável por cadastrar um token de login na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 2000 |
{
"email":"teste@webart.com.br",
"senha":"abcdef"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
|
senha | String | Não | Senha do cliente Tamanho mínimo: 6 | Tamanho máximo: 250 |
{
"url": "https://sandbox.wapstore.com.br/login/1b36a11f5184ac6925b906841389f475"
}
Campo | Tipo | Descrição |
---|---|---|
url | String | Url para login do cliente |
Recurso responsável por enviar uma solicitação de recuperação de senha para o e-mail do cliente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 2000 |
{
"email":"teste@webart.com.br"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
Recurso responsável por cadastrar um cliente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 2000 |
{
"cliNome":"Exemplo Cliente",
"cliEmail":"exemplo@wapstore.com.br",
"cliSenha":"abcdef",
"cliNascimento":"01/02/1991",
"intermediador":"n"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cliNome | String | Sim | Nome do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
cliEmail | String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
cliSenha | String | Não | Senha do cliente Tamanho mínimo: 6 | Tamanho máximo: 250 |
cliNascimento | String | Não | Data de nascimento do cliente (DD/MM/YYYY) Tamanho mínimo: 10 | Tamanho máximo: 10 |
intermediador | String | Não | Define se o cliente é um intermediador da loja e pode vender produtos(B2B2C) Valores aceitos: s, n |
Campo | Tipo | Descrição |
---|---|---|
status | String | Status da alteração excutada· |
Recurso responsável por cadastrar um cliente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 240 |
{
"email": "teste@email.com",
"cpfCnpj": "12345678910",
"codigo": "cli-123",
"nomeRazao": "Cliente Teste",
"nomeFantasia": "",
"nascimento": "01/01/1992",
"tipoPessoa": "fisica",
"sexo": "masculino",
"tributacao": "isento",
"rgIe": "",
"telefone": "",
"celular": "(18) 12345-1234",
"senha": "sua-senha",
"intermediador": false,
"informacoesAdicionais": [
{
"hash": "instagram",
"valor": "cli-teste"
}
],
"pagamentosPersonalizado": [1,2]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
String | Sim | E-mail do cliente | |
cpfCnpj | String | Sim | CPF ou CNPJ sem formatação do cliente Tamanho mínimo: 11 |
codigo | String | Não | Identificador externo do cliente |
nomeRazao | String | Não | Nome do cliente |
nomeFantasia | String | Não | Nome fantasia do cliente |
nascimento | String | Não | Data de nascimento do cliente |
tipoPessoa | String | Não | Tipo do cliente (pessoa física ou jurídica) Valores aceitos: fisica, juridica |
sexo | String | Não | Define o sexo do cliente Valores aceitos: masculino, feminino, indefinido, outro, juridica |
tributacao | String | Não | Define se o PJ possui tributação no Simples Nacional Valores aceitos: isento, contribuinte, nao contribuinte |
rgIe | String | Não | Inscrição estadual do cliente PJ |
telefone | String | Não | Telefone de contato do cliente |
celular | String | Não | Telefone celular do cliente |
senha | String | Não | Senha que o cliete utilizará para acessar a área restrita |
intermediador | Boolean | Não | Define se o cliente é um cliente intermediador |
informacoesAdicionais | Array | Não | Informações adicionais do cliente |
hash | String | Não | Hash da informação adicional |
valor | String | Não | Valor da informação adicional do cliente |
pagamentosPersonalizado | Array de números | Não | Pagamentos vinculados ao cliente |
{
"id": 123,
"codigo": "cli-123",
"nome": "Cliente Teste",
"nomeFantasia": "",
"cpfCnpj": "11455206008",
"email": "teste@email.com",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(18) 12345-1234",
"nascimento": "01/01/1992",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"pontos": {},
"site": {},
"canalVenda": {},
"pagamentosPersonalizado": [1,2],
"rgIe": "",
"dataCadastro": "2023-04-28 16:25:33",
"enderecos": [],
"informacoesAdicionais": {
"instagram": {
"titulo": "Instagram",
"tipo": "texto",
"valorAtual": "cli-teste",
"valores": []
}
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do cliente |
codigo | String | Identificador externo do cliente |
site | Object | Canal de Vendas do cliente (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
nome | String | Nome oficial do cliente |
nomeFantasia | String | Sobrenome do cliente ou nome fantasia da empresa |
cpfCnpj | String | CPF do cliente ou CNPJ da empresa |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
atividadesSecundarias | Data Collection | Define os dados das atividades secundárias de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade secundária exercida pelo cliente PJ |
descricao | String | Descrição da atividade secundária do cliente PJ |
String | Endereço de e-mail do cliente | |
telefone | String | Número de telefone do cliente |
celular | String | Número de celular do cliente |
pessoa | String | Tipo do cliente (Físico ou Jurídico) Valores aceitos: f, j |
intermediador | Boolean | O cliente é um intermediador da loja e pode vender produtos (B2B2C) |
nascimento | String | Data de nascimento do cliente |
sexo | String | Sexo do cliente (Masculino, Feminino, Outros, Indefinido ou Jurídico) Valores aceitos: m, f, o, i, j |
newsletter | String | Se o cliente recebe newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
rgIe | String | Registro geral ou inscrição estadual do cliente |
dataCadastro | String | Data de cadastro do cliente |
pontos | Data Collection | Pontos do cliente |
quantidade | Number | Quantidade de pontos do cliente |
valorEmMoeda | Number | Valor dos pontos em moeda |
canalVendaOrigem | Object | Canal de venda de origem dos pontos |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
validade | String | Data de expiração dos pontos |
enderecos | Data Collection | Endereços do cliente |
id | Number | Identificador único do endereço do cliente |
nome | String | Nome do endereço |
tipo | String | Tipo do endereço Valores aceitos: apartamento, casa, comercial, outro |
cep | String | CEP do endereço |
endereco | String | Rua do endereço |
numero | String | Número do endereço |
complemento | String | Complemento do endereço |
referencia | String | Referência do endereço |
bairro | String | Bairro do endereço |
cidade | String | Cidade do endereço |
uf | String | Unidade federal do endereço |
destinatario | String | Nome do destinatário |
principal | String | Define se é o endereço é principal Valores aceitos: s, n |
informacoesAdicionais | Object | Informações adicionais do cliente |
comissao | Data Collection | Dados de comissão do cliente |
tipo | String | Tipo da comissão Valores aceitos: reservaTecnica, tarifaServico |
percentualBase | Number | Percentual base da comissão |
percentualMaximo | Number | Percentual máximo da comissão |
tributacao | String | Tipo de tributação do cliente |
enquadramentoFiscal | String | Enquadramento Fiscal do cliente |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
pagamentosPersonalizado | Array de números | Pagamentos vinculados ao cliente |
Recurso responsável por creditar, debitar ou atualizar pontos de clientes.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 30 |
{
"transacoes":[
{
"idCliente":"1",
"operacao":"credito",
"valor": 241.56
}
]
}
{
"transacoes":[
{
"idCliente":"1",
"operacao":"debito",
"valor": 241.56
}
]
}
{
"transacoes":[
{
"idCliente":"1",
"operacao":"atualizacao",
"valor": 241.56
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
transacoes | Data Collection | Sim | Transações de pontos do cliente Tamanho mínimo: 1 | Tamanho máximo: 100 |
idCliente | Number | Não | ID do cliente |
cpfCnpj | String | Não | CPF/CNPJ do cliente (apenas dígitos) Tamanho mínimo: 11 | Tamanho máximo: 14 |
String | Não | E-mail do cliente | |
operacao | String | Sim | Operação da transação Valores aceitos: credito, debito, atualizacao |
valor | Number | Sim | Valor da transação |
idCanalVenda | Number | Não | Id do canal de venda onde os pontos serão alterados |
{
"id": 80
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote gerado |
Recurso responsável por atualizar um cliente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
/v2/customers/{idCliente} | ID do cliente |
Limite de requisições por minuto | 240 |
{
"cliNome":"Exemplo Cliente",
"cliEmail":"exemplo@wapstore.com.br",
"cliSenha":"abcdef",
"cliNascimento":"01/02/1991",
"intermediador":"n"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cliNome | String | Sim | Nome do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
cliEmail | String | Sim | E-mail do cliente Tamanho mínimo: 1 | Tamanho máximo: 250 |
cliSenha | String | Não | Senha do cliente Tamanho mínimo: 6 | Tamanho máximo: 250 |
cliNascimento | String | Não | Data de nascimento do cliente (DD/MM/YYYY) Tamanho mínimo: 10 | Tamanho máximo: 10 |
intermediador | String | Não | Define se o cliente é um intermediador da loja e pode vender produtos(B2B2C) Valores aceitos: s, n |
Campo | Tipo | Descrição |
---|---|---|
status | String | Status da alteração excutada· |
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/customers-v2/{idCodigoCliente} | ID ou o código externo do cliente que será atualizado. |
Filtros | identificador: Realiza a busca de um cliente pelo seu identificador. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/customers-v2/{idCodigoCliente}?identificador=id |
Limite de requisições por minuto | 240 |
{
"email": "teste@email.com",
"cpfCnpj": "12345678910",
"codigo": "cli-123",
"nomeRazao": "Cliente Teste",
"nomeFantasia": "",
"nascimento": "01/01/1992",
"tipoPessoa": "fisica",
"sexo": "masculino",
"tributacao": "isento",
"rgIe": "",
"telefone": "",
"celular": "(18) 12345-1234",
"senha": "sua-senha",
"intermediador": false,
"informacoesAdicionais": [
{
"hash": "instagram",
"valor": "cli-teste"
}
],
"pagamentosPersonalizado": [1,2]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
String | Não | E-mail do cliente | |
cpfCnpj | String | Não | CPF ou CNPJ sem formatação do cliente Tamanho mínimo: 11 |
codigo | String | Não | Identificador externo do cliente |
nomeRazao | String | Não | Nome do cliente |
nomeFantasia | String | Não | Nome fantasia do cliente |
nascimento | String | Não | Data de nascimento do cliente |
tipoPessoa | String | Não | Tipo do cliente (pessoa física ou jurídica) Valores aceitos: fisica, juridica |
sexo | String | Não | Define o sexo do cliente Valores aceitos: masculino, feminino, indefinido, outro, juridica |
tributacao | String | Não | Define se o PJ possui tributação no Simples Nacional Valores aceitos: isento, contribuinte, nao contribuinte |
rgIe | String | Não | Inscrição estadual do cliente PJ |
telefone | String | Não | Telefone de contato do cliente |
celular | String | Não | Telefone celular do cliente |
senha | String | Não | Senha que o cliete utilizará para acessar a área restrita |
intermediador | Boolean | Não | Define se o cliente é um cliente intermediador |
informacoesAdicionais | Array | Não | Informações adicionais do cliente |
hash | String | Não | Hash da informação adicional |
valor | String | Não | Valor da informação adicional do cliente |
pagamentosPersonalizado | Array de números | Não | Pagamentos vinculados ao cliente |
{
"id": 123,
"codigo": "cli-123",
"nome": "Cliente Teste",
"nomeFantasia": "",
"cpfCnpj": "11455206008",
"email": "teste@email.com",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(18) 12345-1234",
"nascimento": "01/01/1992",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"pontos": {},
"site": {},
"canalVenda": {},
"pagamentosPersonalizado": [1,2],
"rgIe": "",
"dataCadastro": "2023-04-28 16:25:33",
"enderecos": [],
"informacoesAdicionais": {
"instagram": {
"titulo": "Instagram",
"tipo": "texto",
"valorAtual": "cli-teste",
"valores": []
}
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do cliente |
codigo | String | Identificador externo do cliente |
site | Object | Canal de Vendas do cliente (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
nome | String | Nome oficial do cliente |
nomeFantasia | String | Sobrenome do cliente ou nome fantasia da empresa |
cpfCnpj | String | CPF do cliente ou CNPJ da empresa |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
atividadesSecundarias | Data Collection | Define os dados das atividades secundárias de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade secundária exercida pelo cliente PJ |
descricao | String | Descrição da atividade secundária do cliente PJ |
String | Endereço de e-mail do cliente | |
telefone | String | Número de telefone do cliente |
celular | String | Número de celular do cliente |
pessoa | String | Tipo do cliente (Físico ou Jurídico) Valores aceitos: f, j |
intermediador | Boolean | O cliente é um intermediador da loja e pode vender produtos (B2B2C) |
nascimento | String | Data de nascimento do cliente |
sexo | String | Sexo do cliente (Masculino, Feminino, Outros, Indefinido ou Jurídico) Valores aceitos: m, f, o, i, j |
newsletter | String | Se o cliente recebe newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
rgIe | String | Registro geral ou inscrição estadual do cliente |
dataCadastro | String | Data de cadastro do cliente |
pontos | Data Collection | Pontos do cliente |
quantidade | Number | Quantidade de pontos do cliente |
valorEmMoeda | Number | Valor dos pontos em moeda |
canalVendaOrigem | Object | Canal de venda de origem dos pontos |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
validade | String | Data de expiração dos pontos |
enderecos | Data Collection | Endereços do cliente |
id | Number | Identificador único do endereço do cliente |
nome | String | Nome do endereço |
tipo | String | Tipo do endereço Valores aceitos: apartamento, casa, comercial, outro |
cep | String | CEP do endereço |
endereco | String | Rua do endereço |
numero | String | Número do endereço |
complemento | String | Complemento do endereço |
referencia | String | Referência do endereço |
bairro | String | Bairro do endereço |
cidade | String | Cidade do endereço |
uf | String | Unidade federal do endereço |
destinatario | String | Nome do destinatário |
principal | String | Define se é o endereço é principal Valores aceitos: s, n |
informacoesAdicionais | Object | Informações adicionais do cliente |
comissao | Data Collection | Dados de comissão do cliente |
tipo | String | Tipo da comissão Valores aceitos: reservaTecnica, tarifaServico |
percentualBase | Number | Percentual base da comissão |
percentualMaximo | Number | Percentual máximo da comissão |
tributacao | String | Tipo de tributação do cliente |
enquadramentoFiscal | String | Enquadramento Fiscal do cliente |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
pagamentosPersonalizado | Array de números | Pagamentos vinculados ao cliente |
Recurso de consulta da fila de atualizações de clientes. Sempre que um novo cliente for registrado ou tiver alguma informação atualizada, ele aparecerá nessa fila. Solicite a ativação do webhook de fila de sincronizações à loja integrada para receber notificações sempre que houver uma nova atualização. Configure o seu sistema para consumir a fila de atualizações para sempre receber as atualizações de clientes.
Importante: Caso o webhook esteja inativo, ou o consumo automático da fila estiver desligado, após atualizar seu sistema, você deverá remover o clientes da fila utilizando o recurso de remoção de clientes da fila. Se não fizer isso, todas as vezes que consultar a fila continuará recebendo os mesmos clientes.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | newsletter: Filtra os clientes pelo status de recebimento de newsletter. Exemplo de requisição: /v2/customers/queue?newsletter=s pessoa: Filtra os clientes pelo tipo de pessoa (física ou jurídica). Exemplo de requisição: /v2/customers/queue?pessoa=f |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio do parâmetro limit na URL da requisição (não é permitido enviar o parâmetro offset para essa requisição). Exemplo de requisição: /v2/customers/queue?limit=100 Valor máximo para o parâmetro limit: 100 |
{
"clientes": [
{
"id": 1,
"codigo": "cli-1",
"nome": "Sherlock Holmes",
"nomeFantasia": "",
"cpfCnpj": "98227365094",
"email": "holmes@sherlock.com",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(67) 97278-2104",
"nascimento": "22/05/1859",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": {}
},
{
"id": 14,
"codigo": "cli-14",
"nome": "Drácula",
"nomeFantasia": "",
"cpfCnpj": "50312893175",
"email": "dracula@vamp.com",
"pessoa": "f",
"intermediador": false,
"telefone": "",
"celular": "(83) 98803-2827",
"nascimento": "07/12/1431",
"sexo": "m",
"newsletter": "n",
"whatsappPromocional": "n",
"whatsappTransacional": "n",
"site": {}
}
],
"identificadoresFila": [
1,
14
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/customers/queue?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 2,
"total": 2
}
}
Campo | Tipo | Descrição |
---|---|---|
clientes | Data Collection | Clientes disponíveis |
id | Number | Identificador único do cliente |
codigo | String | Identificador externo do cliente |
site | Object | Canal de Vendas do cliente (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal de Vendas do cliente |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
nome | String | Nome oficial do cliente |
nomeFantasia | String | Sobrenome do cliente ou nome fantasia da empresa |
cpfCnpj | String | CPF do cliente ou CNPJ da empresa |
atividadePrincipal | Object | Define os dados da atividade principal de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade principal exercida pelo cliente PJ |
descricao | String | Descrição da atividade principal do cliente PJ |
atividadesSecundarias | Data Collection | Define os dados das atividades secundárias de um cliente, caso ele seja uma pessoa jurídica. |
cnae | String | Código da atividade secundária exercida pelo cliente PJ |
descricao | String | Descrição da atividade secundária do cliente PJ |
String | Endereço de e-mail do cliente | |
telefone | String | Número de telefone do cliente |
celular | String | Número de celular do cliente |
pessoa | String | Tipo do cliente (Físico ou Jurídico) Valores aceitos: f, j |
intermediador | Boolean | O cliente é um intermediador da loja e pode vender produtos (B2B2C) |
nascimento | String | Data de nascimento do cliente |
sexo | String | Sexo do cliente (Masculino, Feminino, Outros, Indefinido ou Jurídico) Valores aceitos: m, f, o, i, j |
newsletter | String | Se o cliente recebe newsletter ou não Valores aceitos: n, s |
whatsappPromocional | String | Verifica se o cliente deseja receber promoções via whatsapp Valores aceitos: n, s |
whatsappTransacional | String | Verifica se o cliente deseja receber atualizações via whatsapp Valores aceitos: n, s |
rgIe | String | Registro geral ou inscrição estadual do cliente |
dataCadastro | String | Data de cadastro do cliente |
pontos | Data Collection | Pontos do cliente |
quantidade | Number | Quantidade de pontos do cliente |
valorEmMoeda | Number | Valor dos pontos em moeda |
canalVendaOrigem | Object | Canal de venda de origem dos pontos |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
validade | String | Data de expiração dos pontos |
enderecos | Data Collection | Endereços do cliente |
id | Number | Identificador único do endereço do cliente |
nome | String | Nome do endereço |
tipo | String | Tipo do endereço Valores aceitos: apartamento, casa, comercial, outro |
cep | String | CEP do endereço |
endereco | String | Rua do endereço |
numero | String | Número do endereço |
complemento | String | Complemento do endereço |
referencia | String | Referência do endereço |
bairro | String | Bairro do endereço |
cidade | String | Cidade do endereço |
uf | String | Unidade federal do endereço |
destinatario | String | Nome do destinatário |
principal | String | Define se é o endereço é principal Valores aceitos: s, n |
informacoesAdicionais | Object | Informações adicionais do cliente |
comissao | Data Collection | Dados de comissão do cliente |
tipo | String | Tipo da comissão Valores aceitos: reservaTecnica, tarifaServico |
percentualBase | Number | Percentual base da comissão |
percentualMaximo | Number | Percentual máximo da comissão |
tributacao | String | Tipo de tributação do cliente |
enquadramentoFiscal | String | Enquadramento Fiscal do cliente |
revendedor | Object | Dados do grupo de revendedores |
nomeGrupo | String | Nome do grupo de revendedores |
tipoPreco | String | Tipo de aplicação de preço |
desconto | Number | Percentual de desconto do revendedor |
acrescimo | Number | Percentual de acréscimo do revendedor |
freteTipo | Object | Dados do frete tipo vinculado ao revendedor |
id | Number | Identificador do frete tipo |
nome | String | Nome do frete tipo |
landingPage | Object | Dados da landing page vinculada ao revendedor |
id | Number | Identificador da landing page |
nome | String | Nome da landing page |
minimoCompra | Number | Valor mínimo de compra do revendedor |
canalVenda | Data Collection | Segmentação de valores (de desconto ou acréscimo) por canal de venda |
id | Number | Identificador do canal de venda |
nome | String | Nome do canal de venda |
valor | Number | Valor (de desconto ou acréscimo) atribuído ao grupo de revendedores para o canal de venda |
pagamentosPersonalizado | Array de números | Pagamentos vinculados ao cliente |
identificadoresFila | Array de números | Lista com os clientes presentes na paginação |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por remover clientes da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/customers/queue/{idCodigoCliente} | ID ou código externo do cliente a ser removido da fila. |
Filtros | identificador: Realiza a busca de um cliente pelo seu identificador. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/customers/queue/{idCodigoCliente}?identificador=id |
Limite de requisições por minuto | 12000 |
Recurso responsável por remover clientes em lote da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Filtros | identificador: Define o identificador os dados enviados no body da request. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/customers/queue?identificador=id |
Limite de requisições por minuto | 1000 |
{
"clientes": [
1,
14
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
clientes | Array de strings | Sim | Lista com os identificadores dos clientes a serem removidos das fila |
Recurso responsável por listar todos os status de pedido disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/statuses?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"status":[
{
"id":1,
"idPai":0,
"descricao":"Aguardando Pagamento",
"descricaoPainel": "",
"descricaoSite": "",
"tipo":"principal",
"ativo":true
},
{
"id":3,
"idPai":"0",
"descricao":"Pago",
"descricaoPainel": "",
"descricaoSite": "",
"tipo":"principal",
"ativo":true
},
{
"id":90,
"idPai":3,
"descricao":"Aguardando nota fiscal",
"descricaoPainel": "",
"descricaoSite": "",
"tipo":"intermediario",
"ativo":true
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/statues?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":3,
"total":3
}
}
Campo | Tipo | Descrição |
---|---|---|
status | Data Collection | Status de pedidos disponíveis |
id | Number | Identificador único do status |
idPai | Number | Identificador do status pai (principal) vinculado a um status intermediário |
descricao | String | Descrição do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
tipo | String | Define se o status é principal (padrão da plataforma) ou é um status intermediário (status criado pelo administrador) Valores aceitos: principal, intermediario |
ativo | Boolean | Define se o status está ativo na plataforma |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de status de pedido.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/statuses/{id} | ID do status |
Limite de requisições por minuto | 60 |
{
"id":1,
"idPai":0,
"descricao":"Aguardando Pagamento",
"descricaoPainel": "",
"descricaoSite": "",
"tipo":"principal",
"ativo":true
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do status |
idPai | Number | Identificador do status pai (principal) vinculado a um status intermediário |
descricao | String | Descrição do status |
descricaoPainel | String | Nome do status exibido no painel |
descricaoSite | String | Nome do status exibido no site (área restrita e e-mails para cliente) |
tipo | String | Define se o status é principal (padrão da plataforma) ou é um status intermediário (status criado pelo administrador) Valores aceitos: principal, intermediario |
ativo | Boolean | Define se o status está ativo na plataforma |
Recurso responsável por listar todos os tipos de pagamentos disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/payments?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pagamentos":[
{
"id":39,
"nome":"Boleto Bancário",
"bandeira":"boleto",
"gateway":"proprio"
},
{
"id":41,
"nome":"Visa",
"bandeira":"visa",
"gateway":"cielo"
},
{
"id":42,
"nome":"Master",
"bandeira":"mastercard",
"gateway":"cielo"
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/payments?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":3,
"total":3
}
}
Campo | Tipo | Descrição |
---|---|---|
pagamentos | Data Collection | Tipos de pagamentos |
id | Number | Identificador único do pagamento |
nome | String | Nome do pagamento |
bandeira | String | Bandeira do pagamento (a bandeira pode ser a mesma em diferentes gateways) |
gateway | String | Hash do gateway |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de tipos de pagamento.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/payments/{id} | ID do pagamento |
Limite de requisições por minuto | 60 |
{
"id":41,
"nome":"Visa",
"bandeira":"visa",
"gateway":"cielo"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do pagamento |
nome | String | Nome do pagamento |
bandeira | String | Bandeira do pagamento (a bandeira pode ser a mesma em diferentes gateways) |
gateway | String | Hash do gateway |
Recurso responsável por listar todos os gateways e adquirentes disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/payments/gateways?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"gateways":[
{
"hash":"cielo",
"nome":"Cielo 3.0",
"cartaoCredito":true,
"doisCartoes":true,
"cartaoDebito":true,
"boleto":false,
"debitoOnline":false,
"checkoutExterno":false,
"deposito":false,
"faturamento":false,
"configurado":true
},
{
"hash":"mundipagg",
"nome":"MundiPagg",
"cartaoCredito":true,
"doisCartoes":true,
"cartaoDebito":false,
"boleto":true,
"debitoOnline":true,
"checkoutExterno":false,
"deposito":false,
"faturamento":false,
"configurado":true
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/payments/gateways?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":2,
"total":2
}
}
Campo | Tipo | Descrição |
---|---|---|
gateways | Data Collection | Gateways disponíveis |
hash | String | Hash única do gateway (identificador) |
nome | String | Nome do gateway |
cartaoCredito | Boolean | Define se o gateway possui opção de pagamento com cartão de crédito |
doisCartoes | Boolean | Define se o gateway possui opção de pagamento com dois cartões de crédito |
cartaoDebito | Boolean | Define se o gateway possui opção de pagamento com cartão de débito |
boleto | Boolean | Define se o gateway possui opção de pagamento com boleto bancário |
debitoOnline | Boolean | Define se o gateway possui opção de pagamento com débito online |
checkoutExterno | Boolean | Define se o gateway possui opção de pagamento com checkout externo (onde o cliente sai da loja para pagar - Ex. PayPal, PagSeguro, MercadoPago) |
deposito | Boolean | Define se o gateway possui opção de pagamento com deposíto bancário |
faturamento | Boolean | Define se o gateway possui opção de pagamento com faturamento |
configurado | Boolean | Define se o pagamento está configurado na plataforma - Um pagamento pode estar configurado, mas não aparecer no site. |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por listar todos os pagamentos personalizados.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/payments/custom?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pagamentos": [
{
"id": 1,
"nome": "Pagamento via WhatsApp",
"label": "Pagamento pelo Whatsapp",
"prazoCancelamento": 7,
"aprovacaoManual": true,
"aplicarDescontoVista": true,
"segmentarCliente": true,
"ativo": true,
"apenasVendaInterna": false,
"aplicarParcelas": false,
"maximoParcelas": 0,
"tipoJuros": "simples"
},
{
"id": 2,
"nome": "Pagamento por boleto",
"label": "Boleto báncario parcelado",
"prazoCancelamento": 7,
"aprovacaoManual": true,
"aplicarDescontoVista": false,
"segmentarCliente": false,
"ativo": true,
"apenasVendaInterna": false,
"aplicarParcelas": true,
"maximoParcelas": 5,
"tipoJuros": "simples"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/payments/custom?offset=0&limit=2",
"next": "http://localhost/v2/payments/custom?offset=2&limit=2",
"offset": 0,
"limit": 2,
"exibindo": 2,
"total": 11
}
}
Campo | Tipo | Descrição |
---|---|---|
pagamentos | Data Collection | Pagamentos personalizados |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
label | String | Label do pagamento personalizado |
prazoCancelamento | Number | Prazo de cancelamento do pagamento personalizado |
aprovacaoManual | Boolean | Aprovação manual do pagamento personalizado |
aplicarDescontoVista | Boolean | Aplicar desconto à vista no pagamento personalizado |
segmentarCliente | Boolean | Segmentação de cliente no pagamento personalizado |
ativo | Boolean | Status do pagamento personalizado |
apenasVendaInterna | Boolean | Define se o pagamento é apenas na venda interna em relação do pagamento personalizado |
aplicarParcelas | Boolean | Aplicar parcelas no pagamento personalizado |
maximoParcelas | Number | Máximo de parcelas no pagamento personalizado |
tipoJuros | String | Tipo de juros do pagamento personalizado |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por listar todos os pagamentos de pedidos que possuem aprovação manual.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os pagamentos de aprovação manual pelo status. Envie um ou mais status separados por '|', os valores aceitos são 'aguardando', 'pago' ou 'cancelado' Exemplo de requisição: /v2/payments/manual-approval?status=aguardando|pago idPagamento: Filtra os pagamentos ID do pagamento. Exemplo de requisição: /v2/payments/manual-approval?idPagamento=160 idPedido: Filtra os pagamentos pelo ID do pedido. Exemplo de requisição: /v2/payments/manual-approval?idPedido=12356 idCliente: Filtra os pagamentos por cliente. Exemplo de requisição: /v2/payments/manual-approval?idCliente=89 idCanalVenda: Filtra os pagamentos por canal de venda. Exemplo de requisição: /v2/payments/manual-approval?idCanalVenda=1 dataEmissao: Filtra os pagamentos pela data de emissão do pedido. Exemplo de requisição: /v2/payments/manual-approval?dataEmissao=2023-09-28|2023-09-29 numeroPedido: Filtra os pagamentos pelo número do pedido. Exemplo de requisição: /v2/payments/manual-approval?numeroPedido=sWAP123-1 codigoCliente: Filtra os pagamentos pelo código do cliente. Exemplo de requisição: /v2/payments/manual-approval?codigoCliente=cli-0001 |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/payments/manual-approval?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"aprovacaoManual": [
{
"pedido": {
"id": 27075,
"numeroPedido": "WAP-1054910196",
"dataEmissao": "2023-03-30 11:17:13"
},
"cliente": {
"id": 89,
"codigo": "",
"cpfCnpj": "25766042183",
"email": "developer@wapstore.com.br",
"nome": "wap.store"
},
"pagamento": {
"id": 118,
"idPedidoPagamento": 25713,
"nome": "Depósito Bancário",
"bandeira": "deposito",
"gateway": "proprio",
"cnpjGateway": "",
"parcelas": 0,
"vencimentoBoleto": "2023-04-02",
"numeroBanco": "12345",
"valor": 486.3,
"retentativa": 0,
"aprovacaoManual": {
"status": "aguardando",
"historico": []
},
"detalhes": {
"chavePedido": "",
"referenciaPedido": "",
"chaveTransacao": "",
"referenciaTransacao": "",
"identificadorAdicional": "",
"codigoAutorizacao": "",
"adquirente": "",
"codigoBarras": "",
"linhaDigitavel": "",
"boletoUrl": "",
"statusTransacao": "",
"tipoPagamento": "",
"dataCapturaPagamento": "",
"numeroSequencialUnico": "",
"mensagem": "",
"mensagemErro": "",
"antifraude": {}
}
}
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/payments/manual-approval?offset=0&limit=100",
"next": "https://sandbox.wapstore.com.br/api/v2/payments/manual-approval?offset=100&limit=100",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
aprovacaoManual | Data Collection | Listagem de pagamentos com aprovação manual |
pedido | Object | Informações do pedido |
id | Number | ID |
numeroPedido | String | Número do pedido |
dataEmissao | String | Data de emissão do pedido |
cliente | Object | Informações do cliente |
id | Number | ID |
codigo | String | Código externo |
cpfCnpj | String | CPF ou CNPJ |
String | ||
nome | String | Nome |
pagamento | Object | Informações do pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Endpoint responsável por atualizar o status da transação.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/payments/manual-approval/{idPedidoPagamento} | ID do pedido pagamento (ID retornado no campo 'idPedidoPagamento' no detalhe do pagamento) |
Limite de requisições por minuto | 60 |
{
"status": "pago",
"observacao": "Comprovante de pagamento validado"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
status | String | Sim | Define se a o status da transação será pago ou cancelado Valores aceitos: pago, cancelado |
observacao | String | Não | Observação sobre a alteração do status da transação Tamanho máximo: 500 |
Campo | Tipo | Descrição |
---|---|---|
pedido | Object | Informações do pedido |
id | Number | ID |
numeroPedido | String | Número do pedido |
dataEmissao | String | Data de emissão do pedido |
cliente | Object | Informações do cliente |
id | Number | ID |
codigo | String | Código externo |
cpfCnpj | String | CPF ou CNPJ |
String | ||
nome | String | Nome |
pagamento | Object | Informações do pagamento |
id | Number | ID da forma de pagamento (veja todos os pagamentos disponíveis consultando a API de pagamentos) |
idPedidoPagamento | Number | ID do pedido pagamento |
nome | String | Nome da forma de pagamento (Visa, MasterCard, Boleto Bancário,etc) |
bandeira | String | Bandeira do pagamento (visa, master, boleto, etc) |
gateway | String | Gateway ou adquirente de pagamentos (veja todos os gateways e adquirentes disponíveis consultando a API de pagamentos) |
cnpjGateway | String | CNPJ do gateway de pagamento, se houver |
parcelas | Number | Quantidade de parcelas escolhidas |
vencimentoBoleto | String | Data de vencimento de boleto (apenas para pedidos de boleto) |
numeroBanco | String | Número do banco (apenas para pedidos de depósito) |
valor | Number | Valor do pagamento |
retentativa | Number | Registra a ordem da retentativa de pagamento |
aprovacaoManual | Object | Detalhe da aprovação manual de pagamentos |
status | String | Status da transação |
historico | Data Collection | Historico de atualizações do pedido pagamento |
idUsuario | Number | ID do usuário |
nomeUsuario | String | Nome do usuário |
observacao | String | Observação |
data | String | Data de atualização do pagamento do pedido |
pagamentoPersonalizado | Object | Detalhes do pagamento personalizado |
id | Number | ID do pagamento personalizado |
nome | String | Nome do pagamento personalizado |
informacoesAdicionais | Data Collection | Dados adicionais da transação do pagamento personalizado |
hash | String | Identificador da informação |
valor | Array | Valores da informação |
detalhes | Object | Detalhes da transação de pagamento |
chavePedido | String | Chave de acesso do pedido dentro do gateway/adquirente |
referenciaPedido | String | Referência do pedido dentro do gateway/adquirente |
chaveTransacao | String | Chave da transação dentro do gateway/adquirente |
referenciaTransacao | String | Referência da transação dentro do gateway/adquirente |
identificadorAdicional | String | Identificador da transação dentro do gateway/adquirente |
codigoAutorizacao | String | Código de autorização (apenas para cartões de crédito) |
adquirente | String | Nome do adquirente |
codigoBarras | String | Código de barras (apenas para boleto bancário) |
linhaDigitavel | String | Linha digitável (apenas para boleto bancário) |
boletoUrl | String | Url do boleto |
statusTransacao | String | Status da transação - texto variável de acordo com cada gateway/adquirente |
tipoPagamento | String | Tipo de pagamento - texto variável de acordo com cada gateway/adquirente |
dataCapturaPagamento | String | Data de captura ou confirmação de pagamento |
numeroSequencialUnico | String | Armazena o NSU gerado pelo pagamento via cartão |
numeroSequencialUnicoCaptura | String | Armazena o NSU gerado na captura do pagamento via cartão |
mensagem | String | Mensagem da capturada via response |
mensagemErro | String | Mensagem que será exibida em casos de armazenagem de resposta textual de erro |
antifraude | Object | Dados de antifraude da Clearsale |
score | Number | Score da transação na Clearsale |
status | String | Status do pagamento na Clearsale |
mensagem | String | Mensagem |
Recurso responsável por listar todos os tipos de frete disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/freights?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"fretes":[
{
"id":1,
"idTransportadora":1,
"tipoCalculo":"valor",
"disponivelCliente":true,
"disponivelRevendedor":true,
"valorMinimoCarrinho":0.00,
"valorMaximoCarrinho":0.00,
"nome":"SEDEX",
"label":"Entrega Expressa",
"ativo":true
},
{
"id":2,
"idTransportadora":1,
"tipoCalculo":"valor",
"disponivelCliente":true,
"disponivelRevendedor":true,
"valorMinimoCarrinho":0.00,
"valorMaximoCarrinho":0.00,
"nome":"PAC",
"label":"Entrega Econômica",
"ativo":true
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/freights?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":2,
"total":2
}
}
Campo | Tipo | Descrição |
---|---|---|
fretes | Data Collection | Tipos de frete disponíveis |
id | Number | Identificador único do tipo de frete |
idTransportadora | Number | Identificador da transportadora |
tipoCalculo | String | Define se o frete será aplicado por um valor fixo para cada faixa de peso x CEP (valor) ou será calculado dinamicamente por um percentual sobre o valor dos itens no carrinho (porcentagem) Valores aceitos: valor, porcentagem, formula |
disponivelCliente | Boolean | Define se o frete está disponível para clientes (sem ser revendedor) |
disponivelRevendedor | Boolean | Define se o frete está disponível para revendedores |
valorMinimoCarrinho | Number | Valor mínimo do carrinho para ativação do frete (O valor 0.00 indica que não há valor mínimo) |
valorMaximoCarrinho | Number | Valor máximo do carrinho para ativação do frete (O valor 0.00 indica que não há valor máximo) |
nome | String | Nome do tipo de frete (nome que aparece para o adminstrador) |
label | String | Label do tipo de frete (nome que aparece para o cliente final) |
ativo | Boolean | Define se o tipo de frete está ativo |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de tipos de frete.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/freights/{id} | ID do tipo de frete |
Limite de requisições por minuto | 60 |
{
"id":1,
"idTransportadora":1,
"tipoCalculo":"valor",
"disponivelCliente":true,
"disponivelRevendedor":true,
"valorMinimoCarrinho":0.00,
"valorMaximoCarrinho":0.00,
"nome":"SEDEX",
"label":"Entrega Expressa",
"ativo":true
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do tipo de frete |
idTransportadora | Number | Identificador da transportadora |
tipoCalculo | String | Define se o frete será aplicado por um valor fixo para cada faixa de peso x CEP (valor) ou será calculado dinamicamente por um percentual sobre o valor dos itens no carrinho (porcentagem) Valores aceitos: valor, porcentagem, formula |
disponivelCliente | Boolean | Define se o frete está disponível para clientes (sem ser revendedor) |
disponivelRevendedor | Boolean | Define se o frete está disponível para revendedores |
valorMinimoCarrinho | Number | Valor mínimo do carrinho para ativação do frete (O valor 0.00 indica que não há valor mínimo) |
valorMaximoCarrinho | Number | Valor máximo do carrinho para ativação do frete (O valor 0.00 indica que não há valor máximo) |
nome | String | Nome do tipo de frete (nome que aparece para o adminstrador) |
label | String | Label do tipo de frete (nome que aparece para o cliente final) |
ativo | Boolean | Define se o tipo de frete está ativo |
Recurso responsável por listar as transportadoras disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/freights/carriers?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"transportadoras":[
{
"id":1,
"nome":"Correios",
"ativo":true
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/freights/carriers?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":1,
"total":1
}
}
Campo | Tipo | Descrição |
---|---|---|
transportadoras | Data Collection | Transportadoras disponíveis |
id | Number | Identificador único da transportadora |
nome | String | Nome da transportadora |
ativo | Boolean | Define se a transportadora está ativa |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por calcular o frete dos itens informados no corpo da request.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
{
"cep": "15370446",
"codigoPais":"BRA",
"itens": [
{
"idProduto": 8,
"idAtributoValor": 0,
"quantidade": 3,
"preco": 100,
"hashAdicional": "8-0-0",
"grupo": {
"hashNivel1": "",
"hashNivel2": "",
"quantidadeBase": 0
}
},
{
"idProduto": 3140,
"idAtributoValor": 19,
"quantidade": 4,
"preco": 54,
"hashAdicional": "3140-19-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 2
}
},
{
"idProduto": 3139,
"idAtributoValor": 17,
"quantidade": 6,
"preco": 47.31,
"hashAdicional": "3139-17-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 3
}
},
{
"idProduto": 3166,
"idAtributoValor": 20,
"quantidade": 8,
"preco": 34.45,
"hashAdicional": "3166-20-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 4
}
},
{
"idProduto": 3165,
"idAtributoValor": 0,
"preco": 15.45,
"quantidade": 1,
"hashAdicional": "3165-0-0",
"grupo": {
"hashNivel1": "",
"hashNivel2": "",
"quantidadeBase": 0
}
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cep | String | Sim | CEP de destino para o calculo de frete |
codigoPais | String | Não | Código do país de origem do CEP para calcular o frete |
idTipoEstoque | Number | Não | ID do tipo de estoque para calcular o frete |
idsArmazensDespriorizados | Array de números | Não | IDs dos armazéns que serão despriorizados no calculo de frete |
itens | Data Collection | Sim | Itens para calculo do frete Tamanho mínimo: 1 |
idProduto | Number | Sim | Identificador do produto |
idAtributoValor | Number | Sim | ID do atributo valor do produto |
preco | Number | Sim | Preço do produto |
quantidade | Number | Sim | Quantidade do produto Valor mínimo: 1 |
hashAdicional | String | Não | Hash adicional do item para diferenciar itens com a mesma combinação de Id produto e Id atributo valor |
grupo | Object | Não | Dados do grupo a qual o item pertence |
hashNivel1 | String | Sim | Hash de identificação de nível 1 do grupo (ex: Hash da lista de compra ou conjunto que contém o item) |
hashNivel2 | String | Sim | Hash de identificação de nível 2 do grupo (ex: Hash da lista de compra que contém o item, sendo que a lista está dentro de um conjunto) |
quantidadeBase | Number | Sim | Quantidade base do item no grupo |
{
"entregas": [
{
"armazem": {
"id": 1,
"razaoSocial": "Armazém Principal",
"nomeFantasia": "Armazém Principal",
"cep": "29161376"
},
"idsFreteModal": [
0
],
"subtotal": 300,
"subtotalOriginal": 150,
"itens": [
{
"idProduto": 8,
"idAtributoValor": 0,
"preco": 100,
"precoOriginal": 50,
"quantidade": 3,
"peso": 0.001,
"altura": 0.05,
"largura": 0.05,
"comprimento": 0.05,
"idFreteModal": 0,
"prazoProducao": 10,
"vendaSemEstoque": false,
"servico": false,
"hashAdicional": "8-0-0",
"grupo": {
"hashNivel1": "",
"hashNivel2": "",
"quantidadeBase": 0
}
}
],
"cotacoes": [
{
"idFreteTipo": 1,
"label": "Rápido",
"valor": 15,
"prazoMinimo": 17,
"prazoMaximo": 19
},
{
"idFreteTipo": 2,
"label": "Intermediário",
"valor": 25,
"prazoMinimo": 21,
"prazoMaximo": 27
},
{
"idFreteTipo": 3,
"label": "Econômico",
"valor": 30,
"prazoMinimo": 23,
"prazoMaximo": 31
}
],
"opcoesRetiradaLoja": [
{
"idRetiradaLoja": 25,
"nome": "Loja wap.store Birigui",
"endereco": "Rua Estela Tomazini Tolomei",
"numero": "51",
"bairro": "João Crevelaro",
"cidade": "Birigüi",
"uf": "SP",
"cep": "16202-343",
"horarioFuncionamento": "12h - 18h",
"latitude": "22",
"longitude": "33",
"valor": 40,
"prazo": 3,
"tipoPrazo": "hora"
},
{
"idRetiradaLoja": 27,
"nome": "Loja wap.store Araçatuba",
"endereco": "Rua Eliana Viana Martinez",
"numero": "123",
"bairro": "Conjunto Habitacional Vicente Luiz Grosso",
"cidade": "Araçatuba",
"uf": "SP",
"cep": "16012-140",
"horarioFuncionamento": "",
"latitude": "30",
"longitude": "20",
"valor": 90,
"prazo": 10,
"tipoPrazo": "dia"
}
]
},
{
"armazem": {
"id": 1,
"razaoSocial": "Armazém Principal",
"nomeFantasia": "Armazém Principal",
"cep": "29161376"
},
"idsFreteModal": [
1
],
"subtotal": 775.46,
"subtotalOriginal": 898.8,
"itens": [
{
"idProduto": 3140,
"idAtributoValor": 19,
"preco": 54,
"precoOriginal": 60,
"quantidade": 4,
"peso": 1.222,
"altura": 1.23,
"largura": 4.57,
"comprimento": 6.78,
"idFreteModal": 1,
"prazoProducao": 10,
"vendaSemEstoque": false,
"servico": false,
"hashAdicional": "3140-19-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 2
}
},
{
"idProduto": 3139,
"idAtributoValor": 17,
"preco": 47.31,
"precoOriginal": 49.8,
"quantidade": 6,
"peso": 1,
"altura": 2,
"largura": 2,
"comprimento": 2,
"idFreteModal": 1,
"prazoProducao": 20,
"vendaSemEstoque": false,
"servico": false,
"hashAdicional": "3139-17-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 3
}
},
{
"idProduto": 3166,
"idAtributoValor": 20,
"preco": 34.45,
"precoOriginal": 45,
"quantidade": 8,
"peso": 1,
"altura": 1,
"largura": 1,
"comprimento": 1,
"idFreteModal": 1,
"prazoProducao": 0,
"vendaSemEstoque": false,
"servico": false,
"hashAdicional": "3166-20-0",
"grupo": {
"hashNivel1": "35-eyJ1cHNlbGwiOnsiaWQiOiI1IiwibG9jYWxPZmVydGEiOiJjYXJyaW5obyIsIml0ZW0iOnsiaWQiOiIzNSIsImlkQXRyaWJ1dG9WYWxvciI6MH19fQ==",
"hashNivel2": "",
"quantidadeBase": 4
}
}
],
"cotacoes": [
{
"idFreteTipo": 1,
"label": "Rápido",
"valor": 15,
"prazoMinimo": 37,
"prazoMaximo": 39
},
{
"idFreteTipo": 2,
"label": "Intermediário",
"valor": 25,
"prazoMinimo": 41,
"prazoMaximo": 47
},
{
"idFreteTipo": 3,
"label": "Econômico",
"valor": 30,
"prazoMinimo": 43,
"prazoMaximo": 51
}
],
"opcoesRetiradaLoja": [
{
"idRetiradaLoja": 25,
"nome": "Loja wap.store Birigui",
"endereco": "Rua Estela Tomazini Tolomei",
"numero": "51",
"bairro": "João Crevelaro",
"cidade": "Birigüi",
"uf": "SP",
"cep": "16202-343",
"horarioFuncionamento": "12h - 18h",
"latitude": "22",
"longitude": "33",
"valor": 40,
"prazo": 3,
"tipoPrazo": "hora"
},
{
"idRetiradaLoja": 27,
"nome": "Loja wap.store Araçatuba",
"endereco": "Rua Eliana Viana Martinez",
"numero": "123",
"bairro": "Conjunto Habitacional Vicente Luiz Grosso",
"cidade": "Araçatuba",
"uf": "SP",
"cep": "16012-140",
"horarioFuncionamento": "",
"latitude": "30",
"longitude": "20",
"valor": 90,
"prazo": 10,
"tipoPrazo": "dia"
}
]
}
],
"itensIndisponiveis": [
{
"idProduto": 3165,
"idAtributoValor": 0,
"preco": 15.45,
"precoOriginal": 100,
"quantidade": 1,
"peso": 1,
"altura": 1,
"largura": 1,
"comprimento": 1,
"idFreteModal": 3,
"prazoProducao": 0,
"vendaSemEstoque": false,
"servico": false,
"hashAdicional": "3165-0-0",
"grupo": {
"hashNivel1": "",
"hashNivel2": "",
"quantidadeBase": 0
}
}
]
}
Campo | Tipo | Descrição |
---|---|---|
entregas | Data Collection | Array com os grupos de entrega de itens. |
armazem | Object | Dados do armazém de saída da entrega |
id | Number | ID do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia do armazém |
cep | String | CEP do armazém |
idsFreteModal | Data Collection | Array com IDs de modal de frete |
itens | Data Collection | Array de itens da entrega |
idProduto | Number | Id do produto do item |
idAtributoValor | Number | Id do atributo valor do item |
preco | Number | Preço do item |
precoOriginal | Number | Preço original do item |
quantidade | Number | Quantidade do item |
peso | Number | Peso do item |
altura | Number | Altura do item |
largura | Number | Largura do item |
comprimento | Number | Comprimento do item |
idFreteModal | Number | ID de modal do item |
representatividadeFrete | Number | Porcentagem da representatividade do produto em relação a entrega ao qual ele está inserido |
vendaSemEstoque | Boolean | Status de venda sem estoque do item |
servico | Boolean | Determina se o item é um serviço ou não |
prazoProducao | Number | Prazo de produção do item |
hashAdicional | String | Hash adicional do item para diferenciar itens com a mesma combinação de Id produto e Id atributo valorm |
grupo | Object | Dados do grupo a qual o item pertence |
hashNivel1 | String | Hash de identificação de nível 1 do grupo (ex: Hash da lista de compra ou conjunto que contém o item) |
hashNivel2 | String | Hash de identificação de nível 2 do grupo (ex: Hash da lista de compra que contém o item, sendo que a lista está dentro de um conjunto) |
quantidadeBase | Number | Quantidade base do item no grupo |
subtotal | Number | Subtotal da entrega |
subtotalOriginal | Number | Subtotal original da entrega |
cotacoes | Data Collection | Cotações da entrega |
idFreteTipo | Number | ID do tipo de frete da cotação |
label | String | Label do frete da cotação |
valor | Number | Valor da cotação |
prazoMinimo | Number | Prazo mínimo da cotação |
prazoMaximo | Number | Prazo máximo da cotação |
entregaAgendada | Boolean | Determina se a cotação de frete possui entrega agendada |
prazoMinimoEntregaAgendada | Number | Prazo mínimo a partir do qual a entrega pode ser agendada pelo cliente |
tipoPrazoMinimoEntregaAgendada | String | Tipo do prazo mínimo a partir do qual a entrega pode ser agendada pelo cliente (dias úteis ou corridos) Valores aceitos: uteis, corridos |
detalhes | Object | Detalhes da cotação |
opcoesRetiradaLoja | Data Collection | Opções de retirada na loja da entrega |
idRetiradaLoja | Number | ID |
nome | String | Nome |
endereco | String | Endereço |
numero | Number | Número de residência |
bairro | String | Bairro |
cidade | String | Cidade |
uf | String | Estado |
cep | String | CEP |
horarioFuncionamento | String | Horário de funcionamento |
latitude | String | Latitude |
longitude | String | Longitude |
valor | Number | Valor de retirada |
prazo | Number | Prazo de retirada |
tipoPrazo | String | Tipo do prazo ("horas", "dias") |
fretesPromocionais | Data Collection | Opções de fretes promocionais que podem ser aplicados no checkout |
promocoes | Data Collection | Retornas as opções de fretes promocionais que pode ser possível ser aplicada a um produto quando estiver no checkout |
idFreteTipo | Number | ID do tipo de frete da cotação |
idPromocao | Number | ID da promoção de frete fixo que pode ser aplicada |
label | String | Nome da promoção de frete fixo |
valor | Number | Valor do frete fixo promocional |
prazoMinimo | Number | Prazo mínimo do frete promocional |
prazoMaximo | Number | Prazo máximo do frete promocional |
itensIndisponiveis | Data Collection | Array de itens que não tem disponibilidade de entrega. |
idProduto | Number | Id do produto do item |
idAtributoValor | Number | Id do atributo valor do item |
preco | Number | Preço do item |
precoOriginal | Number | Preço original do item |
quantidade | Number | Quantidade do item |
peso | Number | Peso do item |
altura | Number | Altura do item |
largura | Number | Largura do item |
comprimento | Number | Comprimento do item |
idFreteModal | Number | ID de modal do item |
representatividadeFrete | Number | Porcentagem da representatividade do produto em relação a entrega ao qual ele está inserido |
vendaSemEstoque | Boolean | Status de venda sem estoque do item |
servico | Boolean | Determina se o item é um serviço ou não |
prazoProducao | Number | Prazo de produção do item |
hashAdicional | String | Hash adicional do item para diferenciar itens com a mesma combinação de Id produto e Id atributo valorm |
grupo | Object | Dados do grupo a qual o item pertence |
hashNivel1 | String | Hash de identificação de nível 1 do grupo (ex: Hash da lista de compra ou conjunto que contém o item) |
hashNivel2 | String | Hash de identificação de nível 2 do grupo (ex: Hash da lista de compra que contém o item, sendo que a lista está dentro de um conjunto) |
quantidadeBase | Number | Quantidade base do item no grupo |
Recurso responsável por listar todos os grupos de características criados na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/characteristics?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"caracteristicas": [
{
"id": 1,
"nome": "Caracteristicas Técnicas",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2017-09-13 13:52:30"
},
{
"id": 33,
"nome": "Caracteristicas Evaporadora",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2018-03-23 13:29:35"
},
{
"id": 34,
"nome": "Caracteristicas Condensadora",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2018-03-23 13:29:38"
},
{
"id": 37,
"nome": "Caracteristicas gerais",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2018-08-04 10:27:59"
},
{
"id": 38,
"nome": "Específicas Dafiti",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2018-12-14 06:55:45"
},
{
"id": 44,
"nome": "Caracteristicas",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2020-01-24 14:55:59"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/characteristics?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 6,
"total": 6
}
}
Campo | Tipo | Descrição |
---|---|---|
caracteristicas | Data Collection | Características listados |
id | Number | ID do grupo de características |
nome | String | Nome do grupo de caracteristicas |
visivelSite | Boolean | Determina se a característica deve aparecer no Site |
visivelApi | Boolean | Determina se a característica deve aparecer na API |
dataCriacao | String | Data de criação do grupo características |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável consultar um único grupo de característica.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/characteristics/{id} | ID do grupo de características |
Limite de requisições por minuto | 120 |
{
"id": 1,
"nome": "Caracteristicas Técnicas",
"visivelSite": true,
"visivelApi": false,
"dataCriacao": "2017-09-13 13:52:30"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do grupo de características |
nome | String | Nome do grupo de caracteristicas |
visivelSite | Boolean | Determina se a característica deve aparecer no Site |
visivelApi | Boolean | Determina se a característica deve aparecer na API |
dataCriacao | String | Data de criação do grupo características |
Recurso responsável por listar todos os valores de um grupo de características.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/characteristics/{id}/values | ID do grupo de características |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/characteristics/{id}/values?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"valores": [
{
"id": 2,
"nome": "Controle Remoto",
"ordem": 0
},
{
"id": 3,
"nome": "Deflexao de ar lateral",
"ordem": 1
},
{
"id": 4,
"nome": "Filtro Anti-pó",
"ordem": 2
},
{
"id": 5,
"nome": "Filtro Anti-bactéria",
"ordem": 3
},
{
"id": 6,
"nome": "Regulador de velocidade da ventilação",
"ordem": 4
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/characteristics/1/values?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 5,
"total": 5
}
}
Campo | Tipo | Descrição |
---|---|---|
valores | Data Collection | Valores listados |
id | Number | ID do valor da característica |
nome | String | Nome do valor da característica |
ordem | Number | Ordem de exibição |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável consultar um único valor de característica.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/characteristics/values/{id} | ID do valor |
Limite de requisições por minuto | 120 |
{
"id": 4,
"nome": "Filtro Anti-pó",
"ordem": 2
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do valor da característica |
nome | String | Nome do valor da característica |
ordem | Number | Ordem de exibição |
Recurso responsável por listar todos os atributos criados na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/attributes?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"atributos":[
{
"id": 82,
"nome": "Tamanho Calçado",
"unico": false,
"tipo": "texto",
"valores": [
{
"id": 226,
"label": "39",
"imagem": ""
},
{
"id": 227,
"label": "40",
"imagem": ""
},
{
"id": 228,
"label": "41",
"imagem": ""
}
]
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/attributes?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":1,
"total":1
}
}
Campo | Tipo | Descrição |
---|---|---|
atributos | Data Collection | Atributos listados |
id | Number | ID do atributo |
nome | String | Nome do atributo |
unico | Boolean | Define se o atributo é único |
tipo | String | Define o tipo de atributo Valores aceitos: imagem, texto |
valores | Data Collection | Valores do atributo |
id | Number | ID do valor |
label | String | Label do valor |
imagem | String | Imagem do valor |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de atributos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/attributes/{idAtributo} | ID do atributo |
Limite de requisições por minuto | 60 |
{
"id": 82,
"nome": "Tamanho Calçado",
"unico": false,
"tipo": "texto",
"valores": [
{
"id": 226,
"label": "39",
"imagem": ""
},
{
"id": 227,
"label": "40",
"imagem": ""
},
{
"id": 228,
"label": "41",
"imagem": ""
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do atributo |
nome | String | Nome do atributo |
unico | Boolean | Define se o atributo é único |
tipo | String | Define o tipo de atributo Valores aceitos: imagem, texto |
valores | Data Collection | Valores do atributo |
id | Number | ID do valor |
label | String | Label do valor |
imagem | String | Imagem do valor |
Recurso responsável por cadastrar atributos na plataforma.
Importante: Apenas atributos do tipo 'texto' podem ser cadastrados
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"nome":"Tamanho camiseta",
"unico":false
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
nome | String | Sim | Nome do atributo |
unico | Boolean | Sim | Define se o atributo é único |
{
"id": 88,
"nome": "Tamanho",
"unico": false,
"tipo": "texto",
"valores": []
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do atributo |
nome | String | Nome do atributo |
unico | Boolean | Define se o atributo é único |
tipo | String | Define o tipo de atributo Valores aceitos: imagem, texto |
valores | Data Collection | Valores do atributo |
id | Number | ID do valor |
label | String | Label do valor |
imagem | String | Imagem do valor |
Recurso responsável por cadastrar valores em um atributo da plataforma.
IMPORTANTE: Apenas atributos do tipo 'texto' podem receber cadastros de novos valores
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
/v2/attributes/{idAtributo}/values | ID do atributo |
Limite de requisições por minuto | 60 |
{
"label":"P"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
label | String | Sim | Label do valor |
{
"id": 244,
"label": "P",
"imagem": ""
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do valor |
label | String | Label do valor |
imagem | String | Imagem do valor |
Recurso responsável por listar todas as marcas disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/brands?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"marcas": [
{
"id": 123,
"codigo": "m-123",
"nome": "Marca API",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"logo": "https://sandbox.wapstore.com.br/upload/marca/teste.png",
"ativo": true,
"dataCadastro": "2020-01-10 01:02:04"
}
],
"info": {
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/brands?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
marcas | Data Collection | Marcas disponíveis |
id | Number | Identificador único da marca |
codigo | String | Código externo da marca |
nome | String | Nome da marca |
titulo | String | Título da marca |
descricao | String | Descrição da marca |
descricaoLonga | String | Define a descrição longa da marca |
titleSocial | String | Define o title social da marca |
descricaoSocial | String | Define a descrição social da marca |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph |
urlImagemTwitter | String | Define a url da imagem do Twitter |
linkCanonical | String | Define o link do canonical do Google |
googleDescription | String | Define a descrição do Google |
logo | String | Url para a logo da marca |
ativo | Boolean | Status da marca |
dataCadastro | String | Data de cadastro da marca |
info | Object | Informações sobre a listagem (paginação, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de marca.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/brands/{idMarca} | ID da marca |
Filtros | identificador: Define o identificador a ser utilizado na busca. Caso nenhum identificador for informado, o identificador 'id' será utilizado. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/brands/{idMarca}?identificador=codigo |
Limite de requisições por minuto | 60 |
{
"id": 123,
"codigo": "m-123",
"nome": "Marca API",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"logo": "https://sandbox.wapstore.com.br/upload/marca/teste.png",
"ativo": true,
"dataCadastro": "2020-01-10 01:02:04"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da marca |
codigo | String | Código externo da marca |
nome | String | Nome da marca |
titulo | String | Título da marca |
descricao | String | Descrição da marca |
descricaoLonga | String | Define a descrição longa da marca |
titleSocial | String | Define o title social da marca |
descricaoSocial | String | Define a descrição social da marca |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph |
urlImagemTwitter | String | Define a url da imagem do Twitter |
linkCanonical | String | Define o link do canonical do Google |
googleDescription | String | Define a descrição do Google |
logo | String | Url para a logo da marca |
ativo | Boolean | Status da marca |
dataCadastro | String | Data de cadastro da marca |
Recurso responsável por cadastrar uma marca.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 120 |
{
"codigo": "m-123",
"nome": "Teste",
"titulo": "Teste (Title Google)",
"descricao": "Descrição de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"ativo": true
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Não | Define o código externo da marca Tamanho mínimo: 1 | Tamanho máximo: 250 |
nome | String | Sim | Nome da marca Tamanho mínimo: 1 | Tamanho máximo: 150 |
titulo | String | Sim | Título da marca Tamanho mínimo: 1 | Tamanho máximo: 150 |
descricao | String | Sim | Descrição da marca Tamanho mínimo: 1 | Tamanho máximo: 250 |
descricaoLonga | String | Não | Define a descrição longa da marca Tamanho mínimo: 1 | Tamanho máximo: 250 |
titleSocial | String | Não | Define o title social da marca Tamanho mínimo: 1 | Tamanho máximo: 250 |
descricaoSocial | String | Não | Define a descrição social da marca Tamanho mínimo: 1 | Tamanho máximo: 250 |
urlImagemOpenGraph | String | Não | Define a url da imagem do Open Graph Tamanho mínimo: 1 | Tamanho máximo: 250 |
urlImagemTwitter | String | Não | Define a url da imagem do Twitter Tamanho mínimo: 1 | Tamanho máximo: 250 |
linkCanonical | String | Não | Define o link do canonical do Google Tamanho mínimo: 1 | Tamanho máximo: 150 |
googleDescription | String | Não | Define a descrição do Google Tamanho mínimo: 1 | Tamanho máximo: 250 |
ativo | Boolean | Sim | Define se a marca está ativa |
{
"id": 123,
"codigo": "m-123",
"nome": "Marca API",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"logo": "https://sandbox.wapstore.com.br/upload/marca/teste.png",
"ativo": true,
"dataCadastro": "2020-01-10 01:02:04"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da marca |
codigo | String | Código externo da marca |
nome | String | Nome da marca |
titulo | String | Título da marca |
descricao | String | Descrição da marca |
descricaoLonga | String | Define a descrição longa da marca |
titleSocial | String | Define o title social da marca |
descricaoSocial | String | Define a descrição social da marca |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph |
urlImagemTwitter | String | Define a url da imagem do Twitter |
linkCanonical | String | Define o link do canonical do Google |
googleDescription | String | Define a descrição do Google |
logo | String | Url para a logo da marca |
ativo | Boolean | Status da marca |
dataCadastro | String | Data de cadastro da marca |
Recurso responsável por atualizar uma marca.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/brands/{idMarca} | ID ou o código externo da marca |
Filtros | identificador: Define o identificador a ser utilizado na busca. Caso nenhum identificador for informado, o identificador 'id' será utilizado. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/brands/{idMarca}?identificador=codigo |
Limite de requisições por minuto | 120 |
{
"codigo": "123",
"nome": "Teste",
"titulo": "Teste (Title Google)",
"descricao": "Descrição de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"ativo": true
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Não | Define o código externo da marca Tamanho mínimo: 0 | Tamanho máximo: 250 |
nome | String | Não | Define o novo nome da marca Tamanho mínimo: 0 | Tamanho máximo: 150 |
titulo | String | Não | Define o título da marca Tamanho mínimo: 0 | Tamanho máximo: 150 |
descricao | String | Não | Define a descrição curta da marca Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricaoLonga | String | Não | Define a descrição longa da marca Tamanho mínimo: 0 | Tamanho máximo: 250 |
titleSocial | String | Não | Define o title social da marca Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricaoSocial | String | Não | Define a descrição social da marca Tamanho mínimo: 0 | Tamanho máximo: 250 |
urlImagemOpenGraph | String | Não | Define a url da imagem do Open Graph Tamanho mínimo: 0 | Tamanho máximo: 250 |
urlImagemTwitter | String | Não | Define a url da imagem do Twitter Tamanho mínimo: 0 | Tamanho máximo: 250 |
linkCanonical | String | Não | Define o link do canonical do Google Tamanho mínimo: 0 | Tamanho máximo: 150 |
googleDescription | String | Não | Define a descrição do Google Tamanho mínimo: 0 | Tamanho máximo: 250 |
ativo | Boolean | Não | Define se a marca está ativa |
{
"id": 123,
"codigo": "m-123",
"nome": "Marca API",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta de teste",
"descricaoLonga": "Descrição longa de teste",
"titleSocial": "Título social",
"descricaoSocial": "Essa é a descrição social",
"urlImagemOpenGraph": "http://url-imagem-open-graph.com.br",
"urlImagemTwitter": "http://url-imagem-twitter.com.br",
"linkCanonical": "http://seu-site.com.br/marcas/marca-api",
"googleDescription": "Descrição do Google",
"logo": "https://sandbox.wapstore.com.br/upload/marca/teste.png",
"ativo": true,
"dataCadastro": "2020-01-10 01:02:04"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da marca |
codigo | String | Código externo da marca |
nome | String | Nome da marca |
titulo | String | Título da marca |
descricao | String | Descrição da marca |
descricaoLonga | String | Define a descrição longa da marca |
titleSocial | String | Define o title social da marca |
descricaoSocial | String | Define a descrição social da marca |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph |
urlImagemTwitter | String | Define a url da imagem do Twitter |
linkCanonical | String | Define o link do canonical do Google |
googleDescription | String | Define a descrição do Google |
logo | String | Url para a logo da marca |
ativo | Boolean | Status da marca |
dataCadastro | String | Data de cadastro da marca |
Recurso responsável por listar todas as categorias disponíveis na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/categories?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"categorias": [
{
"id": 123,
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"tipo": "padrao",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1,
"url": "https://sandbox.wapstore.com.br/categoria-teste"
}
],
"info": {
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/categories?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
categorias | Data Collection | Categorias disponíveis |
id | Number | Identificador único da categoria |
codigo | String | Identificador externo da categoria |
nome | String | Nome da categoria |
palavrasBusca | Array | Palavras de busca vinculadas a categoria |
titulo | String | Título da categoria |
tipo | String | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Descrição curta da categoria |
descricaoLonga | String | Descrição longa da categoria |
ativo | Boolean | Status da categoria |
titleSocial | String | Define o título social da categoria |
descricaoSocial | String | Define a descrição social da categoria |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph da categoria |
urlImagemTwitter | String | Define a url da imagem do Twitter da categoria |
linkCanonical | String | Define o link canonical da categoria |
googleDescription | String | Define a descrição do Google da categoria |
idCategoriaPai | Number | Identificador único da categoria superior |
url | String | Url da categoria |
info | Object | Informações sobre a listagem (paginação, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de categoria.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/categories/{idCategoria} | ID da categoria |
Filtros | identificador: Define o identificador a ser utilizado na busca. Caso nenhum identificador for informado, o identificador 'id' será utilizado. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/categories/{idCategoria}?identificador=codigo |
Limite de requisições por minuto | 60 |
{
"id": 123,
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"tipo": "padrao",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1,
"url": "https://sandbox.wapstore.com.br/categoria-teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da categoria |
codigo | String | Identificador externo da categoria |
nome | String | Nome da categoria |
palavrasBusca | Array | Palavras de busca vinculadas a categoria |
titulo | String | Título da categoria |
tipo | String | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Descrição curta da categoria |
descricaoLonga | String | Descrição longa da categoria |
ativo | Boolean | Status da categoria |
titleSocial | String | Define o título social da categoria |
descricaoSocial | String | Define a descrição social da categoria |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph da categoria |
urlImagemTwitter | String | Define a url da imagem do Twitter da categoria |
linkCanonical | String | Define o link canonical da categoria |
googleDescription | String | Define a descrição do Google da categoria |
idCategoriaPai | Number | Identificador único da categoria superior |
url | String | Url da categoria |
Recurso responsável por cadastrar uma categoria.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 120 |
{
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Não | Código externo da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
nome | String | Sim | Nome da categoria Tamanho mínimo: 1 | Tamanho máximo: 150 |
titulo | String | Sim | Título da categoria Tamanho mínimo: 1 | Tamanho máximo: 150 |
tipo | String | Não | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Sim | Descrição da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
descricaoLonga | String | Sim | Define descrição longa da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
palavrasBusca | String | Não | Define os termos da busca de uma categoria de compatibilidade |
ativo | Boolean | Sim | Define se a categoria está ativa está ativa |
titleSocial | String | Não | Define o título social da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
descricaoSocial | String | Não | Define a descroção social da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
urlImagemOpenGraph | String | Não | Define a url da imagem do Open Graph da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
urlImagemTwitter | String | Não | Define a url da imagem do Twitter da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
linkCanonical | String | Não | Define o link canonical da categoria Tamanho mínimo: 1 | Tamanho máximo: 150 |
googleDescription | String | Não | Define a descrição do Google da categoria Tamanho mínimo: 1 | Tamanho máximo: 250 |
idCategoriaPai | Number | Não | Identificador da categoria vinculada. |
codigoCategoriaPai | String | Não | Código da categoria vinculada |
{
"id": 123,
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"tipo": "padrao",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1,
"url": "https://sandbox.wapstore.com.br/categoria-teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da categoria |
codigo | String | Identificador externo da categoria |
nome | String | Nome da categoria |
palavrasBusca | Array | Palavras de busca vinculadas a categoria |
titulo | String | Título da categoria |
tipo | String | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Descrição curta da categoria |
descricaoLonga | String | Descrição longa da categoria |
ativo | Boolean | Status da categoria |
titleSocial | String | Define o título social da categoria |
descricaoSocial | String | Define a descrição social da categoria |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph da categoria |
urlImagemTwitter | String | Define a url da imagem do Twitter da categoria |
linkCanonical | String | Define o link canonical da categoria |
googleDescription | String | Define a descrição do Google da categoria |
idCategoriaPai | Number | Identificador único da categoria superior |
url | String | Url da categoria |
Recurso responsável por atualizar os dados de uma categoria.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/categories/{idCategoria} | ID ou o código externo da categoria |
Filtros | identificador: Define o identificador a ser utilizado na busca. Caso nenhum identificador for informado, o identificador 'id' será utilizado. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/categories/{idCategoria}?identificador=codigo |
Limite de requisições por minuto | 120 |
{
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Não | Define o código externo da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
nome | String | Não | Define o novo nome da categoria Tamanho mínimo: 0 | Tamanho máximo: 150 |
titulo | String | Não | Define o novo título da categoria Tamanho mínimo: 0 | Tamanho máximo: 150 |
tipo | String | Não | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Não | Define descrição curta da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricaoLonga | String | Não | Define descrição longa da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
palavrasBusca | String | Não | Define os termos da busca de uma categoria de compatibilidade |
ativo | Boolean | Não | Define se a categoria está ativa ou não |
titleSocial | String | Não | Define o título social da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricaoSocial | String | Não | Define a descroção social da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
urlImagemOpenGraph | String | Não | Define a url da imagem do Open Graph da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
urlImagemTwitter | String | Não | Define a url da imagem do Twitter da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
linkCanonical | String | Não | Define o link canonical da categoria Tamanho mínimo: 0 | Tamanho máximo: 150 |
googleDescription | String | Não | Define a descrição do Google da categoria Tamanho mínimo: 0 | Tamanho máximo: 250 |
{
"id": 123,
"codigo": "c-123",
"nome": "Categoria Teste",
"titulo": "Teste (Title Google)",
"tipo": "padrao",
"descricao": "Descrição curta da categoria teste",
"descricaoLonga": "Descrição longa da categoria teste",
"ativo": true,
"titleSocial": "Título social",
"descricaoSocial": "Descrição social",
"urlImagemOpenGraph": "https://ulr-imagem-open-graph.com.br",
"urlImagemTwitter": "https://ulr-imagem-twitter.com.br",
"linkCanonical": "https://sandbox.wapstore.com.br/categoria-teste",
"googleDescription": "Descrição do google",
"idCategoriaPai": 1,
"url": "https://sandbox.wapstore.com.br/categoria-teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único da categoria |
codigo | String | Identificador externo da categoria |
nome | String | Nome da categoria |
palavrasBusca | Array | Palavras de busca vinculadas a categoria |
titulo | String | Título da categoria |
tipo | String | Define se a categoria é do tipo compatibilidade Valores aceitos: padrao, compatibilidade |
descricao | String | Descrição curta da categoria |
descricaoLonga | String | Descrição longa da categoria |
ativo | Boolean | Status da categoria |
titleSocial | String | Define o título social da categoria |
descricaoSocial | String | Define a descrição social da categoria |
urlImagemOpenGraph | String | Define a url da imagem do Open Graph da categoria |
urlImagemTwitter | String | Define a url da imagem do Twitter da categoria |
linkCanonical | String | Define o link canonical da categoria |
googleDescription | String | Define a descrição do Google da categoria |
idCategoriaPai | Number | Identificador único da categoria superior |
url | String | Url da categoria |
Recurso responsável por listar todos os produtos criados na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | sku: Filtra os produtos pelo SKU. Envie um ou mais SKUs separados por '|' Exemplo de requisição: /v2/products?sku=100214751|HDEXT1TB |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/products?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"produtos":[
{
"id": 7,
"idCategoria": 1028,
"idMarca": 30,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 7,
"nome": "T-shirt Batman",
"adicionalNome": "",
"sku": "100214751",
"tipo": "produto",
"ativo": false,
"venda": true,
"assinatura": false,
"precos": {
"precoDe": 800,
"precoPor": 800,
"precoCusto": 45,
"precoEspecial": 250,
"editarPreco": false,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.\r\n",
"descricao": "<p>{{CAMINHO}}</p>\r\n<p>O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.</p>\r\n<p> </p>",
"video": "",
"dimensoes": {
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 1
},
"estoque": 6,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {},
"estoque": 3
}
],
"tipoPrazoProducao": "especifico",
"prazoProducao": 119,
"idPrazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "",
"quantidadeVendida": 0,
"googleDescription": "bbb",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "b",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo": false,
"url": "http://sandbox.wapstore.com.br/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na-branco-1.html",
"avaliacao": {
"media": 4,
"quantidade": 1
},
"categoriasAdicionais": [
"4332021"
],
"landingPages": [
"1",
"45",
"46",
"50",
"56",
"122",
"163"
],
"filtros": [
"163",
"164",
"291",
"1249",
"1250",
"1251",
"1935",
"1936",
"2239",
"2243"
],
"caracteristicas": {
"2": "Sim",
"3": "Sim",
"4": "Sim",
"7": "Sim",
"8": "Sim",
"13": "48000 BTUs",
"14": " 14067 W",
"15": "Quente Frio",
"16": "B",
"17": "68",
"18": "380V",
"19": "102,8",
"20": "Sim",
"21": "Sim",
"23": "Trifasico",
"24": "R-410A",
"27": "Convencional",
"28": "Rotativo",
"31": "Não",
"32": "60",
"35": "Sim",
"36": "56 dB",
"37": "2409 mü/h",
"40": "Sim",
"41": "Sim",
"42": "Sim",
"43": "Sim",
"44": "Sim",
"46": "Sim",
"47": "Sim",
"48": "Sim",
"49": "Sim",
"50": "Sim",
"53": "8,16 A",
"57": "Sim",
"61": "120.00",
"62": "97.00",
"63": "42.00",
"64": "96.00",
"65": "1.10",
"66": "101.00",
"67": "101.00",
"68": "5.40",
"446": "2 KG",
"447": "5 METROS",
"448": "50 METROS",
"449": "80 METROS"
},
"atributoUnico": {
"id": 197,
"dataCriacao": "2018-01-09 11:57:04"
},
"atributosSimples": [
{
"id": 73,
"sku": "teste-wapstore-1",
"ean": "",
"estoque": 310,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"precos": {
"precoDe": 40,
"precoPor": 20,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 10.20,
"precoPor": 10.10
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 30.01,
"precoPor": 29.99
}
}
],
"dimensoes": {
"altura": 1,
"largura": 1,
"comprimento": 1,
"peso": 5
},
"dataCriacao": "2023-01-10 16:39:30"
}
],
"produtosVinculados": [
794,
797,
798,
801
],
"selos": [
{
"id": 28,
"posicao": {
"horizontal": "",
"vertical": ""
},
"periodo": {
"inicio": "2019-10-04 00:00:00",
"fimIndeterminado": false,
"fim": "2019-10-04 23:59:00"
}
}
],
"midias": {
"imagens": [
{
"id": 2541,
"url": "http://sandbox.wapstore.com.br/upload/produto/imagem/t-shirt-batman.jpg",
"ordem": 0,
"label": ""
}
],
"full": [
{
"id": 2513,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-1.jpg",
"ordem": 0,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
},
{
"id": 2521,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-2.jpg",
"ordem": 1,
"label": "",
"descricao": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA."
},
{
"id": 2512,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.jpg",
"ordem": 2,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit."
}
],
"arquivos": [
{
"id": 1955,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na.pdf",
"ordem": 0,
"label": "Manual de Instalação"
},
{
"id": 2522,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx",
"ordem": 1,
"label": "ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx"
}
],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2018-03-18 22:00:00",
"dataAtualizacao": "2019-07-30 17:39:50"
},
{
"id": 303,
"idCategoria": 15,
"idMarca": 11,
"tipoProduto": "s",
"produtoLider": true,
"idProdutoLider": 303,
"nome": "Kit Action Figures DBZ - Majin Boo",
"adicionalNome": "",
"sku": "lcafdbz-01",
"tipo": "lista",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 859.8,
"precoPor": 713.64
},
"canais": [],
"descricaoCurta": "Coleção do vilão Majin Boo.",
"descricao": "Coleção do vilão Majin Boo.",
"video": "",
"dimensoes": {
"altura": 10,
"largura": 5,
"comprimento": 5,
"peso": 2
},
"estoque": 110000,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Birigui",
"principal": true,
"seller": {},
"estoque": 110000
}
],
"vendaSemEstoque": false,
"busca": "figura, ação, boneco",
"quantidadeVendida": 0,
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"url": "http://localhost/clientes/plataforma",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [
1,
14
],
"landingPages": [
2
],
"filtros": [
1
],
"caracteristicas": {
"5": "CDC"
},
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [],
"full": [],
"arquivos": [],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": false,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2023-03-08 14:12:05",
"dataAtualizacao": "2023-03-13 18:21:42",
"dataAtualizacaoPainel": "",
"listaCompra": {
"id": 42,
"venderProdutoIndisponivel": false,
"preco": {
"aplicacaoDesconto": "lista",
"tipoDesconto": "desconto",
"tipoPrecoProduto": "percentual",
"descontoVista": 5,
"valor": 17
},
"itens": [
{
"id": 296,
"sku": "af-mb-001",
"nome": "Majin Boo",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 459.9,
"precoFinal": 335.41,
"percentualRepresentadoLista": 53
},
{
"id": 297,
"sku": "af-mbf-001",
"nome": "Majin Boo - Fat",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 399.9,
"precoFinal": 378.22,
"percentualRepresentadoLista": 47
}
]
}
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/products?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":2,
"total":2
}
}
Campo | Tipo | Descrição |
---|---|---|
produtos | Data Collection | Produtos listados |
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/products/{idSkuProduto} | ID ou SKU do produto |
Filtros | identificador: Define qual o identificador será utilizado para a busca do produto. Os valores aceitos são 'id' ou 'sku' Exemplo de requisição: /v2/products/{idSkuProduto}?identificador=sku |
Limite de requisições por minuto | 60 |
{
"id": 7,
"idCategoria": 1028,
"idMarca": 30,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 7,
"nome": "T-shirt Batman",
"adicionalNome": "",
"sku": "100214751",
"tipo": "produto",
"ativo": false,
"venda": true,
"assinatura": true,
"precos": {
"precoDe": 800,
"precoPor": 800,
"precoCusto": 45,
"precoEspecial": 250,
"editarPreco": false,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.\r\n",
"descricao": "<p>{{CAMINHO}}</p>\r\n<p>O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.</p>\r\n<p> </p>",
"video": "",
"dimensoes": {
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 1
},
"estoque": 6,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"tipoPrazoProducao": "especifico",
"prazoProducao": 119,
"idPrazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "",
"quantidadeVendida": 0,
"googleDescription": "bbb",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "b",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo": false,
"url": "http://sandbox.wapstore.com.br/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na-branco-1.html",
"avaliacao": {
"media": 4,
"quantidade": 1
},
"categoriasAdicionais": [
"4332021"
],
"landingPages": [
"1",
"45",
"46",
"50",
"56",
"122",
"163"
],
"filtros": [
"163",
"164",
"291",
"1249",
"1250",
"1251",
"1935",
"1936",
"2239",
"2243"
],
"caracteristicas": {
"2": "Sim",
"3": "Sim",
"4": "Sim",
"7": "Sim",
"8": "Sim",
"13": "48000 BTUs",
"14": " 14067 W",
"15": "Quente Frio",
"16": "B",
"17": "68",
"18": "380V",
"19": "102,8",
"20": "Sim",
"21": "Sim",
"23": "Trifasico",
"24": "R-410A",
"27": "Convencional",
"28": "Rotativo",
"31": "Não",
"32": "60",
"35": "Sim",
"36": "56 dB",
"37": "2409 mü/h",
"40": "Sim",
"41": "Sim",
"42": "Sim",
"43": "Sim",
"44": "Sim",
"46": "Sim",
"47": "Sim",
"48": "Sim",
"49": "Sim",
"50": "Sim",
"53": "8,16 A",
"57": "Sim",
"61": "120.00",
"62": "97.00",
"63": "42.00",
"64": "96.00",
"65": "1.10",
"66": "101.00",
"67": "101.00",
"68": "5.40",
"446": "2 KG",
"447": "5 METROS",
"448": "50 METROS",
"449": "80 METROS"
},
"atributoUnico": {
"id": 197,
"dataCriacao": "2018-01-09 11:57:04"
},
"atributosSimples": [
{
"id": 73,
"sku": "teste-wapstore-1",
"ean": "",
"estoque": 310,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"precos": {
"precoDe": 40,
"precoPor": 20,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 10.20,
"precoPor": 10.10
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 30.01,
"precoPor": 29.99
}
}
],
"dimensoes": {
"altura": 1,
"largura": 1,
"comprimento": 1,
"peso": 5
},
"dataCriacao": "2023-01-10 16:39:30"
}
],
"produtosVinculados": [
794,
797,
798,
801
],
"selos": [
{
"id": 28,
"posicao": {
"horizontal": "",
"vertical": ""
},
"periodo": {
"inicio": "2019-10-04 00:00:00",
"fimIndeterminado": false,
"fim": "2019-10-04 23:59:00"
}
}
],
"midias": {
"imagens": [
{
"id": 2541,
"url": "http://sandbox.wapstore.com.br/upload/produto/imagem/t-shirt-batman.jpg",
"ordem": 0,
"label": ""
}
],
"full": [
{
"id": 2513,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-1.jpg",
"ordem": 0,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
},
{
"id": 2521,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-2.jpg",
"ordem": 1,
"label": "",
"descricao": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA."
},
{
"id": 2512,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.jpg",
"ordem": 2,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit."
}
],
"arquivos": [
{
"id": 1955,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na.pdf",
"ordem": 0,
"label": "Manual de Instalação"
},
{
"id": 2522,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx",
"ordem": 1,
"label": "ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx"
}
],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2018-03-18 22:00:00",
"dataAtualizacao": "2019-07-30 17:39:50"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável por cadastrar produtos na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
{
"idCategoria": 1028,
"codigoMarca": 30,
"idProdutoLider": 0,
"nome": "Controle de televisão",
"adicionalNome": "",
"sku": "100214751",
"ativo": false,
"venda": true,
"servico": false,
"listaCompra": false,
"assinatura": true,
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"precos": {
"precoDe": 800,
"precoPor": 800,
"precoCusto": 45,
"precoEspecial": 250,
"editarPreco": true,
"dadosDescontoVista": {
"descontoGeral": 5.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.00,
"descontoCartao": 2.30
}
},
"descricaoCurta": "Descricao curta",
"descricao": "Descricao longa",
"video": "",
"dimensoes": {
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 1
},
"prazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "controle, televisão, tv",
"googleDescription": "Controle de televisao",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo": false,
"codigoCategoriasAdicionais": [
"1029"
],
"landingPages": [],
"filtros": [],
"caracteristicas": {},
"idAtributoUnico": 0,
"atributosSimples": []
}
{
"codigoCategoria":1028,
"idMarca":30,
"idProdutoLider":0,
"nome":"T-shirt Batman",
"adicionalNome":"",
"sku":"100214751",
"ativo":false,
"venda":true,
"servico":false,
"listaCompra":false,
"assinatura":true,
"aparecerSite":true,
"aparecerBusca":true,
"aparecerXml":false,
"sincronizarApi":false,
"sincronizarHub":true,
"precos":{
"precoDe":800,
"precoPor":800,
"precoCusto":45,
"editarPreco":true,
"dadosDescontoVista": {
"descontoGeral": 5.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.00,
"descontoCartao": 2.30
}
},
"descricaoCurta":"Descricao curta",
"descricao": "Descricao longa",
"video":"",
"dimensoes":{
"altura":1.64,
"largura":2.86,
"comprimento":2.3,
"peso":1
},
"prazoProducao":0,
"prazoFornecedor":0,
"vendaSemEstoque":false,
"busca":"",
"googleDescription":"T-shirt Batman",
"googleCondition":"new",
"googleAgeGroup":"adult",
"googleGender":"unisex",
"ncm":"84151011",
"mpn":"",
"ean":"7897013563560",
"exclusivo":false,
"categoriasAdicionais":[
4332021
],
"landingPages":[
1
],
"filtros":[
163
],
"caracteristicas":{
"2":"Sim"
},
"idAtributoUnico":197,
"atributosSimples":[
{
"id":238,
"sku":"1012",
"ean":"7896569202367",
"precos":{
"precoDefault":false,
"precoDe":880,
"precoPor":673.4,
"precoEspecial":0,
"dadosDescontoVista": {
"descontoGeral": 5.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.00,
"descontoCartao": 2.30
}
},
"dimensoes":{
"dimensaoDefault":false,
"altura":1.5,
"largura":1,
"comprimento":1.6,
"peso":0
}
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | ID externo da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | ID externo da marca do produto |
idProdutoLider | Number | Sim | ID do produto líder (envie 0 para identificar o produto atual como líder) |
nome | String | Sim | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Sim | SKU do produto |
ativo | Boolean | Sim | Define se o produto está ativo |
venda | Boolean | Sim | Define se o produto pode ser vendido |
servico | Boolean | Não | Define se é um serviço |
assinatura | Boolean | Não | Define se permite assinar o produto |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Não | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Não | Define se o produto deve sincronizar pelo hub (Omni) |
precos | Object | Sim | Detalhes dos preços do produto |
precoDe | Number | Sim | Preço 'de' |
precoPor | Number | Sim | Preço 'por' (preço de venda) |
precoCusto | Number | Não | Preço de custo |
precoEspecial | Number | Não | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
dimensoes | Object | Sim | Detalhes das dimensões do produto |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
prazoProducaoTabela | Object | Não | Define o ID da tabela caso o prazo de produção seja tabelado |
idPrazoProducao | Number | Sim | ID do prazo de produção tabelado |
prazoProducao | Number | Não | Prazo de produção em dias somado ao prazo de entrega (só será considerado caso o prazo não seja tabelado) |
prazoFornecedor | Number | Não | Prazo do fornecedor em dias (somado ao prazo de entrega caso o produto tenha venda sem estoque ativa e seja vendido sem ter estoque na plataforma) |
vendaSemEstoque | Boolean | Não | Define se o produto permite venda sem estoque |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias) |
codigoCategoriasAdicionais | Array de strings | Não | Ids externos das categorias adicionais do produto |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages) |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'} |
idAtributoUnico | Number | Não | ID do atributo único do produto |
atributosSimples | Data Collection | Não | Detalhes dos atributos simples do produto |
id | Number | Sim | ID do atributo simples |
sku | String | Não | SKU do atributo simples |
ean | String | Não | Código EAN/GTIN do atributo simples (deixe vazio caso seja o mesmo EAN do produto) |
precos | Object | Não | Detalhes dos preços do atributo simples |
precoDefault | Boolean | Não | Preço Default |
precoDe | Number | Sim | Preço 'de' |
precoPor | Number | Sim | Preço 'por' (preço de venda)' |
precoEspecial | Number | Não | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
dimensoes | Object | Não | Detalhes das dimensões |
dimensaoDefault | Boolean | Não | Dimensão Default |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
{
"id": 7,
"idCategoria": 1028,
"idMarca": 30,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 7,
"nome": "T-shirt Batman",
"adicionalNome": "",
"sku": "100214751",
"tipo": "produto",
"ativo": false,
"venda": true,
"assinatura": true,
"precos": {
"precoDe": 800,
"precoPor": 800,
"precoCusto": 45,
"precoEspecial": 250,
"editarPreco": false,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.\r\n",
"descricao": "<p>{{CAMINHO}}</p>\r\n<p>O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.</p>\r\n<p> </p>",
"video": "",
"dimensoes": {
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 1
},
"estoque": 6,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"tipoPrazoProducao": "especifico",
"prazoProducao": 119,
"idPrazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "",
"quantidadeVendida": 0,
"googleDescription": "bbb",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "b",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo": false,
"url": "http://sandbox.wapstore.com.br/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na-branco-1.html",
"avaliacao": {
"media": 4,
"quantidade": 1
},
"categoriasAdicionais": [
"4332021"
],
"landingPages": [
"1",
"45",
"46",
"50",
"56",
"122",
"163"
],
"filtros": [
"163",
"164",
"291",
"1249",
"1250",
"1251",
"1935",
"1936",
"2239",
"2243"
],
"caracteristicas": {
"2": "Sim",
"3": "Sim",
"4": "Sim",
"7": "Sim",
"8": "Sim",
"13": "48000 BTUs",
"14": " 14067 W",
"15": "Quente Frio",
"16": "B",
"17": "68",
"18": "380V",
"19": "102,8",
"20": "Sim",
"21": "Sim",
"23": "Trifasico",
"24": "R-410A",
"27": "Convencional",
"28": "Rotativo",
"31": "Não",
"32": "60",
"35": "Sim",
"36": "56 dB",
"37": "2409 mü/h",
"40": "Sim",
"41": "Sim",
"42": "Sim",
"43": "Sim",
"44": "Sim",
"46": "Sim",
"47": "Sim",
"48": "Sim",
"49": "Sim",
"50": "Sim",
"53": "8,16 A",
"57": "Sim",
"61": "120.00",
"62": "97.00",
"63": "42.00",
"64": "96.00",
"65": "1.10",
"66": "101.00",
"67": "101.00",
"68": "5.40",
"446": "2 KG",
"447": "5 METROS",
"448": "50 METROS",
"449": "80 METROS"
},
"atributoUnico": {
"id": 197,
"dataCriacao": "2018-01-09 11:57:04"
},
"atributosSimples": [
{
"id": 73,
"sku": "teste-wapstore-1",
"ean": "",
"estoque": 310,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"precos": {
"precoDe": 40,
"precoPor": 20,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 10.20,
"precoPor": 10.10
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 30.01,
"precoPor": 29.99
}
}
],
"dimensoes": {
"altura": 1,
"largura": 1,
"comprimento": 1,
"peso": 5
},
"dataCriacao": "2023-01-10 16:39:30"
}
],
"produtosVinculados": [
794,
797,
798,
801
],
"selos": [
{
"id": 28,
"posicao": {
"horizontal": "",
"vertical": ""
},
"periodo": {
"inicio": "2019-10-04 00:00:00",
"fimIndeterminado": false,
"fim": "2019-10-04 23:59:00"
}
}
],
"midias": {
"imagens": [
{
"id": 2541,
"url": "http://sandbox.wapstore.com.br/upload/produto/imagem/t-shirt-batman.jpg",
"ordem": 0,
"label": ""
}
],
"full": [
{
"id": 2513,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-1.jpg",
"ordem": 0,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
},
{
"id": 2521,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-2.jpg",
"ordem": 1,
"label": "",
"descricao": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA."
},
{
"id": 2512,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.jpg",
"ordem": 2,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit."
}
],
"arquivos": [
{
"id": 1955,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na.pdf",
"ordem": 0,
"label": "Manual de Instalação"
},
{
"id": 2522,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx",
"ordem": 1,
"label": "ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx"
}
],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2018-03-18 22:00:00",
"dataAtualizacao": "2019-07-30 17:39:50"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável por cadastrar produtos do tipo lista na plataforma.
Regras de configurações de precificação de listas de compra:
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
{
"idCategoria": 15,
"idMarca": 11,
"nome": "Kit Action Figures DBZ - Majin Boo",
"adicionalNome": "",
"sku": "lcafdbz-01",
"ativo": true,
"venda": true,
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": false,
"sincronizarApi": true,
"sincronizarHub": true,
"descricaoCurta": "Coleção do vilão Majin Boo.",
"descricao": "Coleção do vilão Majin Boo.",
"video": "",
"precos": {
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"dimensoes": {
"altura":10,
"largura":5,
"comprimento":5,
"peso":2
},
"busca": "figura, ação, boneco",
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"codigoCategoriasAdicionais": [
"1029"
],
"landingPages": [],
"filtros": [],
"caracteristicas": {}
}
{
"idCategoria": 15,
"idMarca": 11,
"nome": "Kit Action Figures DBZ - Majin Boo",
"adicionalNome": "",
"sku": "lcafdbz-01",
"ativo": true,
"venda": true,
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": false,
"sincronizarApi": true,
"sincronizarHub": true,
"descricaoCurta": "Coleção do vilão Majin Boo.",
"descricao": "Coleção do vilão Majin Boo.",
"video": "",
"precos": {
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"dimensoes": {
"altura":10,
"largura":5,
"comprimento":5,
"peso":2
},
"busca": "figura, ação, boneco",
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"categoriasAdicionais": [14],
"landingPages": [2],
"filtros": [1],
"caracteristicas": {
"5": "Sim"
},
"listaCompra": {
"venderProdutoIndisponivel": false,
"itens": [
{
"id": 296,
"idAtributoSimples": 21,
"quantidade": 1,
"valor": 237.81
},
{
"id": 297,
"idAtributoSimples": 21,
"quantidade": 1,
"valor": 252.89
}
],
"preco": {
"aplicacaoDesconto": "produto",
"tipoDesconto": "fixo",
"tipoPrecoProduto": "default",
"descontoVista": 5
}
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | ID externo da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | ID externo da marca do produto |
nome | String | Sim | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Sim | SKU do produto |
ativo | Boolean | Sim | Define se o produto está ativo |
venda | Boolean | Sim | Define se o produto pode ser vendido |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Não | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Não | Define se o produto deve sincronizar pelo hub (Omni) |
precos | Object | Não | Detalhes dos preços do produto |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
dimensoes | Object | Sim | Detalhes das dimensões do produto |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias) |
codigoCategoriasAdicionais | Array de strings | Não | Ids externos das categorias adicionais do produto |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages) |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'} |
listaCompra | Object | Não | Detalhes da lista de compras |
venderProdutoIndisponivel | Boolean | Não | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
itens | Data Collection | Sim | Dados dos itens pertencentes à lista de compras |
id | Number | Sim | Identificador do item (produto) |
idAtributoSimples | Number | Não | Identificador do atributo simples do item |
quantidade | Number | Sim | Quantidade do item na lista de compras Valor mínimo: 1 |
valor | Number | Não | Quando a aplicação de desconto é por produto, esse campo representa o preço unitário do item na lista de compras (tipoDesconto = fixo) ou o percentual de desconto no item (tipoDesconto = desconto) Valor mínimo: 0.01 |
percentual | Number | Não | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) Valor mínimo: 0.01 |
preco | Object | Sim | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Sim | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) Valores aceitos: lista, produto |
tipoDesconto | String | Sim | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) Valores aceitos: fixo, desconto |
tipoPrecoProduto | String | Não | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) Valores aceitos: default, percentual |
valor | Number | Não | Quando a aplicação de desconto é em toda a lista, esse valor representa um percentual de desconto (tipoDesconto = desconto) ou o preço por da lista (tipoDesconto = fixo) Valor mínimo: 0 |
descontoVista | Number | Não | Percentual de desconto aplicado para pagamentos à vista Valor mínimo: 0 | Valor máximo: 99.99 |
{
"id": 303,
"idCategoria": 15,
"idMarca": 11,
"tipoProduto": "s",
"produtoLider": true,
"idProdutoLider": 303,
"nome": "Kit Action Figures DBZ - Majin Boo",
"adicionalNome": "",
"sku": "lcafdbz-01",
"tipo": "lista",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 859.8,
"precoPor": 713.64,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [],
"descricaoCurta": "Coleção do vilão Majin Boo.",
"descricao": "Coleção do vilão Majin Boo.",
"video": "",
"dimensoes": {
"altura": 10,
"largura": 5,
"comprimento": 5,
"peso": 2
},
"estoque": 110000,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Birigui",
"principal": true,
"seller": {},
"estoque": 110000
}
],
"vendaSemEstoque": false,
"busca": "figura, ação, boneco",
"quantidadeVendida": 0,
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"url": "http://localhost/clientes/plataforma",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [
1,
14
],
"landingPages": [
2
],
"filtros": [
1
],
"caracteristicas": {
"5": "CDC"
},
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [],
"full": [],
"arquivos": [],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": false,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2023-03-08 14:12:05",
"dataAtualizacao": "2023-03-13 18:21:42",
"dataAtualizacaoPainel": "",
"listaCompra": {
"id": 42,
"venderProdutoIndisponivel": false,
"preco": {
"aplicacaoDesconto": "lista",
"tipoDesconto": "desconto",
"tipoPrecoProduto": "percentual",
"descontoVista": 5,
"valor": 17
},
"itens": [
{
"id": 296,
"sku": "af-mb-001",
"nome": "Majin Boo",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 459.9,
"precoFinal": 335.41,
"percentualRepresentadoLista": 53
},
{
"id": 297,
"sku": "af-mbf-001",
"nome": "Majin Boo - Fat",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 399.9,
"precoFinal": 378.22,
"percentualRepresentadoLista": 47
}
]
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável por cadastrar produtos do tipo 'conjunto' na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 60 |
{
"idCategoria": 23,
"idMarca": 1,
"nome": "PC Gamer",
"adicionalNome": "",
"sku": "gaming-computer",
"ativo": true,
"venda": true,
"aparecerSite": false,
"aparecerBusca": false,
"aparecerXml": false,
"descricaoCurta": "Computador perfeito para aquela jogatina com os colegas!",
"descricao": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"busca": "pc gamer, pc, computador, kit pc, gamer, gameplay, lol, csgo, valorant, rocket league, jogos, games",
"googleDescription": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"googleCondition": "18",
"googleAgeGroup": "10 a 30",
"googleGender": "All",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"categoriasAdicionais": [],
"landingPages": [],
"filtros": [],
"caracteristicas": {},
"conjunto": {
"venderProdutoIndisponivel": true,
"componentes": [
{
"idComponente": 17,
"label": "Gabinete",
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 251,
"iniciarSelecionado": false
},
{
"idProduto": 10824,
"iniciarSelecionado": true
},
{
"idProduto": 10825,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 2,
"label": "Placa Mãe",
"ordem": 1,
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 264,
"iniciarSelecionado": true
},
{
"idProduto": 265,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 3,
"label": "Memória RAM Principal",
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 262,
"iniciarSelecionado": true
},
{
"idProduto": 263,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 4,
"label": "Processador",
"ordem": 2,
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 259,
"iniciarSelecionado": true
},
{
"idProduto": 260,
"iniciarSelecionado": false
},
{
"idProduto": 261,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 10,
"obrigatorio": false,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 2,
"produtos": [
{
"idProduto": 10606,
"iniciarSelecionado": true
},
{
"idProduto": 10607,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 3,
"label": "Memórias RAM Adicionais",
"obrigatorio": false,
"configurarPorProduto": true,
"permitirMultiplaEscolha": true,
"produtos": [
{
"idProduto": 262,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100
},
{
"idProduto": 263,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100
}
]
}
]
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | ID externo da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | ID externo da marca do produto |
nome | String | Sim | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Sim | SKU do produto |
ativo | Boolean | Sim | Define se o produto está ativo |
venda | Boolean | Sim | Define se o produto pode ser vendido |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
precos | Object | Não | Detalhes dos preços do produto |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias) |
codigoCategoriasAdicionais | Array de strings | Não | Ids externos das categorias adicionais do produto |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages) |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'} |
conjunto | Object | Não | Propriedades do conjunto |
venderProdutoIndisponivel | Boolean | Sim | Define se o conjunto poderá ser comprado mesmo que seus produtos não permitam venda |
componentes | Data Collection | Sim | Dados dos componentes a serem vinculados ao conjunto |
idComponente | Number | Sim | Identificador do componente a ser vinculado ao conjunto |
label | String | Não | Nome de exibição do componente |
obrigatorio | Boolean | Sim | Obrigatoriedade do componente na compra do conjunto |
ordem | Number | Não | Ordem do componente no detalhe do conjunto. Não informar uma ordem ou informar o mesmo valor a dois componentes causará a ordenação automática dos componentes, de acordo com o posicionamento dos mesmos na requisição. |
permitirMultiplaEscolha | Boolean | Sim | Permissão de compra de mais de um produto do componente |
configurarPorProduto | Boolean | Sim | Define se o componente terá suas propriedades configuradas por produto. (Deve ser 'true', caso a permissão de múltipla escolha de produtos esteja ativa) |
permitirAlterarQuantidade | Boolean | Não | Permissão de alteração de quantidade de compra do componente. (Campo proibido quando a configuração por produto estiver ativa) |
quantidade | Number | Não | Quantidade fixa de compra do componente, quando impossível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver ativa e obrigatório quando inativa) Valor mínimo: 1 |
quantidadeMinima | Number | Não | Quantidade mínima de compra do componente, quando possível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
quantidadeMaxima | Number | Não | Quantidade máxima de compra do componente, quando possível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.quantidadeMinima |
valorIncremento | Number | Não | Valor de incremento de quantidade do componente no detalhe do conjunto. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
produtos | Data Collection | Sim | Configurações de produtos vinculados ao componente |
idProduto | Number | Sim | Identificador do produto |
iniciarSelecionado | Boolean | Sim | Início selecionado do produto no detalhe do componente. |
permitirAlterarQuantidade | Boolean | Não | Permissão de alteração de quantidade de compra do produto. (Campo proibido quando a configuração por produto estiver inativa) |
quantidade | Number | Não | Quantidade fixa de compra do produto, quando impossível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver ativa e obrigatório quando inativa) Valor mínimo: 1 |
quantidadeMinima | Number | Não | Quantidade mínima de compra do produto, quando possível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
quantidadeMaxima | Number | Não | Quantidade máxima de compra do produto, quando possível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.produtos.$2.quantidadeMinima |
quantidadeInicial | Number | Não | Quantidade inicial de compra do produto no detalhe do componente. (Campo proibido quando a permissão de alteração de quantidade estiver inativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.produtos.$2.quantidadeMinima Campo de referência para o valor máximo: conjunto.componentes.$1.produtos.$2.quantidadeMaxima |
valorIncremento | Number | Não | Valor de incremento de quantidade do produto no detalhe do componente (Campo proibido quando a permissão de alteração de quantidade estiver inativa) Valor mínimo: 1 |
{
"id": 10837,
"idCategoria": 23,
"idMarca": 1,
"tipoProduto": "s",
"produtoLider": true,
"idProdutoLider": 10837,
"nome": "PC Gamer",
"adicionalNome": "",
"sku": "gaming-computer",
"tipo": "conjunto",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 4395.42,
"precoPor": 3241.34,
"editarPreco": false
},
"canais": [],
"descricaoCurta": "Computador perfeito para aquela jogatina com os colegas!",
"descricao": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"video": "",
"estoque": 200,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": {},
"estoque": 200
}
],
"busca": "pc gamer, pc, computador, kit pc, gamer, gameplay, lol, csgo, valorant, rocket league, jogos, games",
"quantidadeVendida": 0,
"googleDescription": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"googleCondition": "18",
"googleAgeGroup": "10 a 30",
"googleGender": "All",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"url": "http://localhost/modelos/site",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [],
"landingPages": [],
"filtros": [],
"caracteristicas": [],
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [],
"full": [],
"arquivos": [],
"manuais": []
},
"aparecerSite": false,
"aparecerBusca": false,
"aparecerXml": false,
"sincronizarApi": false,
"sincronizarHub": false,
"dataCriacao": "2023-04-04 15:36:06",
"dataAtualizacao": "2023-04-04 18:36:06",
"dataAtualizacaoPainel": "",
"conjunto": {
"id": 174,
"venderProdutoIndisponivel": true,
"componentes": [
{
"id": 746,
"idComponente": 17,
"label": "Gabinete",
"obrigatorio": true,
"ordem": 0,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 956,
"idProduto": 251,
"iniciarSelecionado": false
},
{
"id": 957,
"idProduto": 10824,
"iniciarSelecionado": true
},
{
"id": 958,
"idProduto": 10825,
"iniciarSelecionado": false
}
]
},
{
"id": 747,
"idComponente": 2,
"label": "Placa Mãe",
"obrigatorio": true,
"ordem": 1,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 959,
"idProduto": 264,
"iniciarSelecionado": true
},
{
"id": 960,
"idProduto": 265,
"iniciarSelecionado": false
}
]
},
{
"id": 748,
"idComponente": 3,
"label": "Memória RAM Principal",
"obrigatorio": true,
"ordem": 2,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 961,
"idProduto": 262,
"iniciarSelecionado": true
},
{
"id": 962,
"idProduto": 263,
"iniciarSelecionado": false
}
]
},
{
"id": 749,
"idComponente": 4,
"label": "Processador",
"obrigatorio": true,
"ordem": 3,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 963,
"idProduto": 259,
"iniciarSelecionado": true
},
{
"id": 964,
"idProduto": 260,
"iniciarSelecionado": false
},
{
"id": 965,
"idProduto": 261,
"iniciarSelecionado": false
}
]
},
{
"id": 750,
"idComponente": 10,
"label": "Fone",
"obrigatorio": false,
"ordem": 4,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 2,
"valorIncremento": 1,
"produtos": [
{
"id": 966,
"idProduto": 10606,
"iniciarSelecionado": true
},
{
"id": 967,
"idProduto": 10607,
"iniciarSelecionado": false
}
]
},
{
"id": 751,
"idComponente": 3,
"label": "Memórias RAM Adicionais",
"obrigatorio": false,
"ordem": 5,
"configurarPorProduto": true,
"permitirMultiplaEscolha": true,
"produtos": [
{
"id": 968,
"idProduto": 262,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100,
"quantidadeInicial": 1,
"valorIncremento": 1
},
{
"id": 969,
"idProduto": 263,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100,
"quantidadeInicial": 1,
"valorIncremento": 1
}
]
}
]
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável pela atualização de dados dos produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/products/{idSkuProduto} | ID ou SKU do produto |
Limite de requisições por minuto | 60 |
{
"idCategoria": 102,
"idMarca": 12,
"idProdutoLider": 0,
"nome": "Camiseta Batman",
"adicionalNome": "Gotham",
"sku": "alteracao-sku-001",
"ativo": false,
"venda": true,
"servico": false,
"assinatura": false,
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"precos":{
"precoDe": 800,
"precoPor": 800,
"precoCusto": 100,
"editarPreco": true,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"descricaoCurta": "Alteração descricao curta",
"descricao": "Alteração descricao longa",
"video": "www.url-do-video.com.br",
"dimensoes":{
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 0.4
},
"prazoProducaoTabela": {
"idPrazoProducao": 4
},
"prazoFornecedor": 0,
"vendaSemEstoque":false,
"busca":"",
"googleDescription":"Camiseta Batman",
"googleCondition": "new",
"googleAgeGroup": "adult",
"googleGender": "unisex",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo":false,
"categoriasAdicionais":[
10, 15, 22
],
"landingPages":[
3, 8
],
"filtros":[
12, 14
],
"caracteristicas":{
"2": "Sim",
"7": "Algodão"
},
"atributosSimples":[
{
"id": 201,
"sku": "890-G",
"ean": "7896569202367",
"precos":{
"precoDefault": false,
"precoDe": 880,
"precoPor": 673.4,
"precoEspecial": 0
},
"dimensoes":{
"dimensaoDefault": false,
"altura":1.5,
"largura":1,
"comprimento":1.6,
"peso": 0.4
}
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | Código da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | Código da marca do produto |
idProdutoLider | Number | Não | ID do produto líder (envie 0 para identificar o produto atual como líder) |
nome | String | Não | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Não | SKU do produto |
ativo | Boolean | Não | Define se o produto está ativo |
venda | Boolean | Não | Define se o produto pode ser vendido |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias). Ao enviar esse campo, as categorias vinculadas anteriormente serão sobrescritas. |
codigoCategoriasAdicionais | Array de strings | Não | Categorias adicionais do produto (Códigos das categorias). Ao enviar esse campo, as categorias vinculadas anteriormente serão sobrescritas. |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages). Ao enviar esse campo, as landing pages vinculadas anteriormente serão sobrescritas. |
servico | Boolean | Não | Define se é um serviço |
assinatura | Boolean | Não | Define se permite assinar o produto |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Não | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Não | Define se o produto deve sincronizar pelo hub (Omni) |
precos | Object | Não | Detalhes dos preços do produto |
precoDe | Number | Sim | Preço 'de' |
precoPor | Number | Sim | Preço 'por' (preço de venda) |
precoCusto | Number | Não | Preço de custo |
precoEspecial | Number | Não | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
dimensoes | Object | Não | Detalhes das dimensões do produto |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
prazoProducaoTabela | Object | Não | Define o ID da tabela caso o prazo de produção seja tabelado |
idPrazoProducao | Number | Sim | ID do prazo de produção tabelado |
prazoProducao | Number | Não | Prazo de produção em dias somado ao prazo de entrega (só será considerado caso o prazo não seja tabelado) |
prazoFornecedor | Number | Não | Prazo do fornecedor em dias (somado ao prazo de entrega caso o produto tenha venda sem estoque ativa e seja vendido sem ter estoque na plataforma) |
vendaSemEstoque | Boolean | Não | Define se o produto permite venda sem estoque |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros). Ao enviar esse campo, os filtros vinculados anteriormente serão sobrescritas. |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'}. Ao enviar esse campo, as características vinculadas anteriormente serão sobrescritas. |
atributosSimples | Data Collection | Não | Detalhes dos novos atributos simples do produto |
id | Number | Sim | ID do atributo simples |
sku | String | Não | SKU do atributo simples |
ean | String | Não | Código EAN/GTIN do atributo simples (deixe vazio caso seja o mesmo EAN do produto) |
precos | Object | Não | Detalhes dos preços do atributo simples |
precoDefault | Boolean | Não | Preço Default |
precoDe | Number | Sim | Preço 'de' |
precoPor | Number | Sim | Preço 'por' (preço de venda)' |
precoEspecial | Number | Não | Preço especial (aplicado em páginas promocionais) |
dimensoes | Object | Não | Detalhes das dimensões |
dimensaoDefault | Boolean | Não | Dimensão Default |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
{
"id": 7,
"idCategoria": 1028,
"idMarca": 30,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 7,
"nome": "T-shirt Batman",
"adicionalNome": "",
"sku": "100214751",
"tipo": "produto",
"ativo": false,
"venda": true,
"assinatura": true,
"precos": {
"precoDe": 800,
"precoPor": 800,
"precoCusto": 45,
"precoEspecial": 250,
"editarPreco": false,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.\r\n",
"descricao": "<p>{{CAMINHO}}</p>\r\n<p>O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA.</p>\r\n<p> </p>",
"video": "",
"dimensoes": {
"altura": 1.64,
"largura": 2.86,
"comprimento": 2.3,
"peso": 1
},
"estoque": 6,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"tipoPrazoProducao": "especifico",
"prazoProducao": 119,
"idPrazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "",
"quantidadeVendida": 0,
"googleDescription": "bbb",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "b",
"ncm": "84151011",
"mpn": "",
"ean": "7897013563560",
"exclusivo": false,
"url": "http://sandbox.wapstore.com.br/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na-branco-1.html",
"avaliacao": {
"media": 4,
"quantidade": 1
},
"categoriasAdicionais": [
"4332021"
],
"landingPages": [
"1",
"45",
"46",
"50",
"56",
"122",
"163"
],
"filtros": [
"163",
"164",
"291",
"1249",
"1250",
"1251",
"1935",
"1936",
"2239",
"2243"
],
"caracteristicas": {
"2": "Sim",
"3": "Sim",
"4": "Sim",
"7": "Sim",
"8": "Sim",
"13": "48000 BTUs",
"14": " 14067 W",
"15": "Quente Frio",
"16": "B",
"17": "68",
"18": "380V",
"19": "102,8",
"20": "Sim",
"21": "Sim",
"23": "Trifasico",
"24": "R-410A",
"27": "Convencional",
"28": "Rotativo",
"31": "Não",
"32": "60",
"35": "Sim",
"36": "56 dB",
"37": "2409 mü/h",
"40": "Sim",
"41": "Sim",
"42": "Sim",
"43": "Sim",
"44": "Sim",
"46": "Sim",
"47": "Sim",
"48": "Sim",
"49": "Sim",
"50": "Sim",
"53": "8,16 A",
"57": "Sim",
"61": "120.00",
"62": "97.00",
"63": "42.00",
"64": "96.00",
"65": "1.10",
"66": "101.00",
"67": "101.00",
"68": "5.40",
"446": "2 KG",
"447": "5 METROS",
"448": "50 METROS",
"449": "80 METROS"
},
"atributoUnico": {
"id": 197,
"dataCriacao": "2018-01-09 11:57:04"
},
"atributosSimples": [
{
"id": 73,
"sku": "teste-wapstore-1",
"ean": "",
"estoque": 310,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "WAPSTORE ARMAZÉM 0001",
"principal": true,
"seller": {},
"estoque": 3
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "WAPSTORE ARMAZÉM 0002",
"principal": false,
"seller": {
"id": 148,
"nome": "Seller teste",
"cnpj": "87654590000154",
"email": "seller.teste@teste.com.br",
"telefone": "9999999999"
},
"estoque": 3
}
],
"precos": {
"precoDe": 40,
"precoPor": 20,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 10.20,
"precoPor": 10.10
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 30.01,
"precoPor": 29.99
}
}
],
"dimensoes": {
"altura": 1,
"largura": 1,
"comprimento": 1,
"peso": 5
},
"dataCriacao": "2023-01-10 16:39:30"
}
],
"produtosVinculados": [
794,
797,
798,
801
],
"selos": [
{
"id": 28,
"posicao": {
"horizontal": "",
"vertical": ""
},
"periodo": {
"inicio": "2019-10-04 00:00:00",
"fimIndeterminado": false,
"fim": "2019-10-04 23:59:00"
}
}
],
"midias": {
"imagens": [
{
"id": 2541,
"url": "http://sandbox.wapstore.com.br/upload/produto/imagem/t-shirt-batman.jpg",
"ordem": 0,
"label": ""
}
],
"full": [
{
"id": 2513,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-1.jpg",
"ordem": 0,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
},
{
"id": 2521,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na-2.jpg",
"ordem": 1,
"label": "",
"descricao": "O ROBE VALENTINA INSPIRA A DELICADEZA FEMININA EM CADA DETALHE. ELE É PERFEITO PARA VOCÊ CURTIR OS MOMENTOS A DOIS. O ROBE COM A CAMISOLA DEIXARÁ VOCÊ SEDUTORA E ELEGANTE. ELE É UMA ÓTIMA ESCOLHA PARA VOCÊ QUE ESTÁ A PROCURA DA LINGERIE ESPECIAL PARA A NOITE DE NÚPCIAS. FEITO EM CHIFON DE SEDA, O ROBE TEM TOQUE MUITO SUAVE, TÃO GOSTOSO DE TOCAR E UMA LEVE TRANSPARÊNCIA QUE REVELA O CORPO DE FORMA MISTERIOSA, COMO UM JARDIM SECRETO QUE GUARDA SEGREDOS! OS OMBROS E OS PUNHOS TÊM ACABAMENTO FINO EM RENDA SUPERDELICADA. ELE TEM ABERTURA TRANSPASSADA E FAIXA QUE DEIXA A CINTURA MARCADA. SEM DÚVIDAS, OCÊ FICARÁ LINDA NO ROBE VALENTINA."
},
{
"id": 2512,
"url": "http://sandbox.wapstore.com.br/upload/produto/full/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.jpg",
"ordem": 2,
"label": "",
"descricao": "Lorem ipsum dolor sit amet, consectetur adipisicing elit."
}
],
"arquivos": [
{
"id": 1955,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trifasico-45keqi48b2na.pdf",
"ordem": 0,
"label": "Manual de Instalação"
},
{
"id": 2522,
"url": "http://sandbox.wapstore.com.br/upload/produto/arquivo/ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx",
"ordem": 1,
"label": "ar-condicionado-split-cassete-elgin-eco-plus-48000-btus-quente-e-frio-380v-trif-sico-45keqi48b2na.xlsx"
}
],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2018-03-18 22:00:00",
"dataAtualizacao": "2019-07-30 17:39:50"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável pela atualização de dados dos produtos do tipo lista.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/products-list/{idProduto} | ID do produto tipo lista |
Limite de requisições por minuto | 60 |
{
"aparecerXml": true,
"descricaoCurta": "Nova descrição curta coleção do vilão Majin Boo.",
"descricao": "Nova descrição longa coleção do vilão Majin Boo.",
"dimensoes": {
"altura":10,
"largura":5,
"comprimento":5,
"peso":2
},
"listaCompra": {
"venderProdutoIndisponivel": false,
"itens": [
{
"id": 296,
"idAtributoSimples": 21,
"quantidade": 1,
"valor": 450
},
{
"id": 297,
"idAtributoSimples": 21,
"quantidade": 1,
"valor": 400
}
],
"preco": {
"aplicacaoDesconto": "produto",
"tipoDesconto": "fixo",
"tipoPrecoProduto": "default",
"descontoVista": 3
}
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | Código da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | Código da marca do produto |
nome | String | Não | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Não | SKU do produto |
ativo | Boolean | Não | Define se o produto está ativo |
venda | Boolean | Não | Define se o produto pode ser vendido |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias). Ao enviar esse campo, as categorias vinculadas anteriormente serão sobrescritas. |
codigoCategoriasAdicionais | Array de strings | Não | Categorias adicionais do produto (Códigos das categorias). Ao enviar esse campo, as categorias vinculadas anteriormente serão sobrescritas. |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages). Ao enviar esse campo, as landing pages vinculadas anteriormente serão sobrescritas. |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Não | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Não | Define se o produto deve sincronizar pelo hub (Omni) |
precos | Object | Não | Detalhes dos preços do produto |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
dimensoes | Object | Não | Detalhes das dimensões do produto |
altura | Number | Não | Altura em cm |
largura | Number | Não | Largura em cm |
comprimento | Number | Não | Comprimento em cm |
peso | Number | Sim | Peso em kg |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros). Ao enviar esse campo, os filtros vinculados anteriormente serão sobrescritas. |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'}. Ao enviar esse campo, as características vinculadas anteriormente serão sobrescritas. |
listaCompra | Object | Não | Detalhes da lista de compras |
venderProdutoIndisponivel | Boolean | Não | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
itens | Data Collection | Não | Dados dos itens pertencentes à lista de compras |
id | Number | Sim | Identificador do item (produto) |
idAtributoSimples | Number | Não | Identificador do atributo simples do item |
quantidade | Number | Sim | Quantidade do item na lista de compras Valor mínimo: 1 |
valor | Number | Não | Quando a aplicação de desconto é por produto, esse campo representa o preço unitário do item na lista de compras (tipoDesconto = fixo) ou o percentual de desconto no item (tipoDesconto = desconto) Valor mínimo: 0.01 |
percentual | Number | Não | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) Valor mínimo: 0.01 |
preco | Object | Não | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Sim | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) Valores aceitos: lista, produto |
tipoDesconto | String | Sim | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) Valores aceitos: fixo, desconto |
tipoPrecoProduto | String | Não | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) Valores aceitos: default, percentual |
valor | Number | Não | Quando a aplicação de desconto é em toda a lista, esse valor representa um percentual de desconto (tipoDesconto = desconto) ou o preço por da lista (tipoDesconto = fixo) Valor mínimo: 0 |
descontoVista | Number | Não | Percentual de desconto aplicado para pagamentos à vista Valor mínimo: 0 | Valor máximo: 99.99 |
{
"id": 303,
"idCategoria": 15,
"idMarca": 11,
"tipoProduto": "s",
"produtoLider": true,
"idProdutoLider": 303,
"nome": "Kit Action Figures DBZ - Majin Boo",
"adicionalNome": "",
"sku": "lcafdbz-01",
"tipo": "lista",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 859.8,
"precoPor": 713.64,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [],
"descricaoCurta": "Coleção do vilão Majin Boo.",
"descricao": "Coleção do vilão Majin Boo.",
"video": "",
"dimensoes": {
"altura": 10,
"largura": 5,
"comprimento": 5,
"peso": 2
},
"estoque": 110000,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Birigui",
"principal": true,
"seller": {},
"estoque": 110000
}
],
"vendaSemEstoque": false,
"busca": "figura, ação, boneco",
"quantidadeVendida": 0,
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"url": "http://localhost/clientes/plataforma",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [
1,
14
],
"landingPages": [
2
],
"filtros": [
1
],
"caracteristicas": {
"5": "CDC"
},
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [],
"full": [],
"arquivos": [],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": false,
"sincronizarApi": true,
"sincronizarHub": true,
"dataCriacao": "2023-03-08 14:12:05",
"dataAtualizacao": "2023-03-13 18:21:42",
"dataAtualizacaoPainel": "",
"listaCompra": {
"id": 42,
"venderProdutoIndisponivel": false,
"preco": {
"aplicacaoDesconto": "lista",
"tipoDesconto": "desconto",
"tipoPrecoProduto": "percentual",
"descontoVista": 5,
"valor": 17
},
"itens": [
{
"id": 296,
"sku": "af-mb-001",
"nome": "Majin Boo",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 459.9,
"precoFinal": 335.41,
"percentualRepresentadoLista": 53
},
{
"id": 297,
"sku": "af-mbf-001",
"nome": "Majin Boo - Fat",
"idAtributoSimples": 21,
"quantidade": 1,
"precoPor": 399.9,
"precoFinal": 378.22,
"percentualRepresentadoLista": 47
}
]
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável por atualizar produtos do tipo conjunto na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/products-conjunct/{idProduto} | ID do produto tipo 'conjunto' |
Limite de requisições por minuto | 60 |
{
"nome": "PC Gamer",
"adicionalNome": " - Monte o seu!",
"sku": "customizable-gaming-computer",
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"conjunto": {
"venderProdutoIndisponivel": false,
"componentes": [
{
"idComponente": 2,
"label": "Placa Mãe",
"ordem": 0,
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 264,
"iniciarSelecionado": true
},
{
"idProduto": 265,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 3,
"label": "Memória RAM Principal",
"ordem": 2,
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 262,
"iniciarSelecionado": true
},
{
"idProduto": 263,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 4,
"label": "Processador",
"ordem": 1,
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 259,
"iniciarSelecionado": true
},
{
"idProduto": 260,
"iniciarSelecionado": false
},
{
"idProduto": 261,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 10,
"obrigatorio": false,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 2,
"produtos": [
{
"idProduto": 10606,
"iniciarSelecionado": true
},
{
"idProduto": 10607,
"iniciarSelecionado": false
}
]
},
{
"idComponente": 3,
"label": "Memórias RAM Adicionais",
"obrigatorio": false,
"configurarPorProduto": true,
"permitirMultiplaEscolha": true,
"produtos": [
{
"idProduto": 262,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100
},
{
"idProduto": 263,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100
}
]
},
{
"idComponente": 17,
"label": "Gabinete do PC",
"obrigatorio": true,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"idProduto": 251,
"iniciarSelecionado": false
},
{
"idProduto": 10824,
"iniciarSelecionado": true
},
{
"idProduto": 10825,
"iniciarSelecionado": false
}
]
}
]
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idCategoria | Number | Não | ID da categoria principal |
codigoCategoria | String | Não | ID externo da categoria principal |
idMarca | Number | Não | ID da marca do produto |
codigoMarca | String | Não | ID externo da marca do produto |
nome | String | Não | Nome do produto Tamanho mínimo: 1 | Tamanho máximo: 250 |
adicionalNome | String | Não | Informação adicional ao nome (não aparece na URL) Tamanho mínimo: 0 | Tamanho máximo: 250 |
sku | String | Não | SKU do produto |
ativo | Boolean | Não | Define se o produto está ativo |
venda | Boolean | Não | Define se o produto pode ser vendido |
aparecerSite | Boolean | Não | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Não | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Não | Define se o produto deve constar nos XMLs de produtos |
precos | Object | Não | Detalhes dos preços do produto |
editarPreco | Boolean | Não | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
descricaoCurta | String | Não | Descrição curta do produto (sem HTML) Tamanho mínimo: 0 | Tamanho máximo: 250 |
descricao | String | Não | Descrição longa do produto (pode conter HTML) |
video | String | Não | URL do vídeo do produto Tamanho mínimo: 0 | Tamanho máximo: 250 |
busca | String | Não | Palavras de busca |
googleDescription | String | Não | Meta tag de descrição para buscadores |
googleCondition | String | Não | Condição do produto |
googleAgeGroup | String | Não | Faixa etária indicada do produto |
googleGender | String | Não | Gênero indicado do produto |
ncm | String | Não | Código da Nomenclatura Comum do Mercosul |
mpn | String | Não | Código do fabricante (manufacturer part number) |
ean | String | Não | Código GTIN/EAN do produto |
exclusivo | Boolean | Não | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
categoriasAdicionais | Array de números | Não | Categorias adicionais do produto (IDs das categorias) |
codigoCategoriasAdicionais | Array de strings | Não | Ids externos das categorias adicionais do produto |
landingPages | Array de números | Não | Landing pages vinculadas ao produto (IDs das landing pages) |
filtros | Array de números | Não | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Não | Características do produto seguindo o padrão {'id':'valor'} |
conjunto | Object | Não | Propriedades do conjunto |
venderProdutoIndisponivel | Boolean | Não | Define se o conjunto poderá ser comprado mesmo que seus produtos não permitam venda |
componentes | Data Collection | Não | Dados dos componentes a serem vinculados ao conjunto. (Todos os componentes previamente vinculados ao conjunto serão substituídos pelos componentes enviados nessa atualização) |
idComponente | Number | Sim | Identificador do componente a ser vinculado ao conjunto |
label | String | Não | Nome de exibição do componente |
obrigatorio | Boolean | Sim | Obrigatoriedade do componente na compra do conjunto |
ordem | Number | Não | Ordem do componente no detalhe do conjunto. Não informar uma ordem ou informar o mesmo valor a dois componentes causará a ordenação automática dos componentes, de acordo com o posicionamento dos mesmos na requisição. |
permitirMultiplaEscolha | Boolean | Sim | Permissão de compra de mais de um produto do componente |
configurarPorProduto | Boolean | Sim | Define se o componente terá suas propriedades configuradas por produto. (Deve ser 'true', caso a permissão de múltipla escolha de produtos esteja ativa) |
permitirAlterarQuantidade | Boolean | Não | Permissão de alteração de quantidade de compra do componente. (Campo proibido quando a configuração por produto estiver ativa) |
quantidade | Number | Não | Quantidade fixa de compra do componente, quando impossível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver ativa e obrigatório quando inativa) Valor mínimo: 1 |
quantidadeMinima | Number | Não | Quantidade mínima de compra do componente, quando possível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
quantidadeMaxima | Number | Não | Quantidade máxima de compra do componente, quando possível alterar a quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.quantidadeMinima |
valorIncremento | Number | Não | Valor de incremento de quantidade do componente no detalhe do conjunto. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
produtos | Data Collection | Sim | Configurações de produtos vinculados ao componente |
idProduto | Number | Sim | Identificador do produto |
iniciarSelecionado | Boolean | Sim | Início selecionado do produto no detalhe do componente. |
permitirAlterarQuantidade | Boolean | Não | Permissão de alteração de quantidade de compra do produto. (Campo proibido quando a configuração por produto estiver inativa) |
quantidade | Number | Não | Quantidade fixa de compra do produto, quando impossível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver ativa e obrigatório quando inativa) Valor mínimo: 1 |
quantidadeMinima | Number | Não | Quantidade mínima de compra do produto, quando possível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Valor mínimo: 1 |
quantidadeMaxima | Number | Não | Quantidade máxima de compra do produto, quando possível alterar quantidade. (Campo proibido quando a permissão de alteração de quantidade estiver inativa e obrigatório quando ativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.produtos.$2.quantidadeMinima |
quantidadeInicial | Number | Não | Quantidade inicial de compra do produto no detalhe do componente. (Campo proibido quando a permissão de alteração de quantidade estiver inativa) Campo de referência para o valor mínimo: conjunto.componentes.$1.produtos.$2.quantidadeMinima Campo de referência para o valor máximo: conjunto.componentes.$1.produtos.$2.quantidadeMaxima |
valorIncremento | Number | Não | Valor de incremento de quantidade do produto no detalhe do componente (Campo proibido quando a permissão de alteração de quantidade estiver inativa) Valor mínimo: 1 |
{
"id": 10837,
"idCategoria": 23,
"idMarca": 1,
"tipoProduto": "s",
"produtoLider": true,
"idProdutoLider": 10837,
"nome": "PC Gamer",
"adicionalNome": " - Monte o seu!",
"sku": "customizable-gaming-computer",
"tipo": "conjunto",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 4395.42,
"precoPor": 3241.34,
"editarPreco": false
},
"canais": [],
"descricaoCurta": "Computador perfeito para aquela jogatina com os colegas!",
"descricao": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"video": "",
"estoque": 200,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": {},
"estoque": 200
}
],
"busca": "pc gamer, pc, computador, kit pc, gamer, gameplay, lol, csgo, valorant, rocket league, jogos, games",
"quantidadeVendida": 0,
"googleDescription": "Computador perfeito para você que é um monstro atrás do teclado. Com esse kit completamente personalizável você irá destruir nas gameplays!",
"googleCondition": "18",
"googleAgeGroup": "10 a 30",
"googleGender": "All",
"ncm": "",
"mpn": "",
"ean": "",
"exclusivo": true,
"url": "http://localhost/modelos/site",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [],
"landingPages": [],
"filtros": [],
"caracteristicas": [],
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [],
"full": [],
"arquivos": [],
"manuais": []
},
"aparecerSite": true,
"aparecerBusca": true,
"aparecerXml": true,
"sincronizarApi": false,
"sincronizarHub": false,
"dataCriacao": "2023-04-04 15:36:06",
"dataAtualizacao": "2023-04-04 18:36:06",
"dataAtualizacaoPainel": "",
"conjunto": {
"id": 174,
"venderProdutoIndisponivel": false,
"componentes": [
{
"id": 758,
"idComponente": 2,
"label": "Placa Mãe",
"obrigatorio": true,
"ordem": 0,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 984,
"idProduto": 264,
"iniciarSelecionado": true
},
{
"id": 985,
"idProduto": 265,
"iniciarSelecionado": false
}
]
},
{
"id": 759,
"idComponente": 4,
"label": "Processador",
"obrigatorio": true,
"ordem": 1,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 986,
"idProduto": 259,
"iniciarSelecionado": true
},
{
"id": 987,
"idProduto": 260,
"iniciarSelecionado": false
},
{
"id": 988,
"idProduto": 261,
"iniciarSelecionado": false
}
]
},
{
"id": 760,
"idComponente": 3,
"label": "Memória RAM Principal",
"obrigatorio": true,
"ordem": 2,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 989,
"idProduto": 262,
"iniciarSelecionado": true
},
{
"id": 990,
"idProduto": 263,
"iniciarSelecionado": false
}
]
},
{
"id": 761,
"idComponente": 10,
"label": "Fone",
"obrigatorio": false,
"ordem": 3,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 2,
"valorIncremento": 1,
"produtos": [
{
"id": 991,
"idProduto": 10606,
"iniciarSelecionado": true
},
{
"id": 992,
"idProduto": 10607,
"iniciarSelecionado": false
}
]
},
{
"id": 762,
"idComponente": 3,
"label": "Memórias RAM Adicionais",
"obrigatorio": false,
"ordem": 4,
"configurarPorProduto": true,
"permitirMultiplaEscolha": true,
"produtos": [
{
"id": 993,
"idProduto": 262,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100,
"quantidadeInicial": 1,
"valorIncremento": 1
},
{
"id": 994,
"idProduto": 263,
"iniciarSelecionado": true,
"permitirAlterarQuantidade": true,
"quantidadeMinima": 1,
"quantidadeMaxima": 100,
"quantidadeInicial": 1,
"valorIncremento": 1
}
]
},
{
"id": 763,
"idComponente": 17,
"label": "Gabinete do PC",
"obrigatorio": true,
"ordem": 5,
"configurarPorProduto": false,
"permitirMultiplaEscolha": false,
"permitirAlterarQuantidade": false,
"quantidade": 1,
"produtos": [
{
"id": 995,
"idProduto": 251,
"iniciarSelecionado": false
},
{
"id": 996,
"idProduto": 10824,
"iniciarSelecionado": true
},
{
"id": 997,
"idProduto": 10825,
"iniciarSelecionado": false
}
]
}
]
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
Recurso responsável por atualizar os estoques dos produtos em lote.
Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.
Importante: Após o lote ser processado, os estoques podem demorar até 1 minuto para aparecerem na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"estoques": [
{
"sku": "HDEXT1TB",
"estoque":159,
"idArmazem": 1
}
]
}
{
"estoques": [
{
"idProduto": 10,
"idAtributoSimples": 1,
"estoque": 159,
"idArmazem": 2
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
estoques | Data Collection | Sim | Array de estoque a serem atualizados |
sku | String | Não | SKU do produto ou atributo simples |
idProduto | Number | Não | ID do produto |
idAtributoSimples | Number | Não | ID do atributo simples |
idArmazem | Number | Não | ID do armazém |
estoque | Number | Sim | Estoque do produto ou atributo |
{
"id": 80
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote gerado |
Recurso responsável por atualizar os preços dos produtos em lote.
Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.
Importante: Após o lote ser processado, os preços atualizados já estarão disponíveis nos produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"precos": [
{
"sku": "HDEXT1TB",
"precoDefault":true,
"precoDe":550.00,
"precoPor":499.90,
"precoCusto":425.50,
"precoEspecial":0,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
}
]
}
{
"precos": [
{
"idProduto": 10,
"idAtributoSimples": 1,
"precoDefault":false,
"precoDe":550.00,
"precoPor":499.90,
"precoCusto":425.50,
"precoEspecial":0,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
}
]
}
{
"precos": [
{
"idProduto": 11,
"precoDefault":true,
"precoDe":550.00,
"precoPor":499.90,
"precoCusto":425.50,
"precoEspecial":0,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
precos | Data Collection | Sim | Array de preços a serem atualizados |
sku | String | Não | SKU do produto ou atributo simples |
idProduto | Number | Não | ID do produto |
idAtributoSimples | Number | Não | ID do atributo simples |
precoDefault | Boolean | Não | Preço Default |
precoDe | Number | Não | Preço 'de' |
precoPor | Number | Sim | Preço 'por' (preço de venda) |
precoCusto | Number | Não | Preço de custo |
precoEspecial | Number | Não | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Não | Dados do desconto à vista do produto |
{
"id": 80
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote gerado |
Recurso responsável por associar os produtos aos Canais de Vendas, bem como atribuir preços específicos desses produtos para cada Canal.
Utilize o recurso de consulta de lotes para verificar o status do processamento do lote criado.
Importante: Após o lote ser processado, os preços atualizados já estarão disponíveis nos Canais.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"canais": [
{
"sku": "wap.store-teste",
"idCanalVenda": 2,
"precoDe": 987,
"precoPor": 654
}
]
}
{
"canais": [
{
"idProduto": 213,
"idAtributoSimples": 1,
"idCanalVenda": 2,
"precoDe": 987.56,
"precoPor": 654.32
}
]
}
{
"canais": [
{
"idProduto": 213,
"idCanalVenda": 2,
"precoDe": 987,
"precoPor": 654
}
]
}
{
"canais": [
{
"sku": "wap.store-teste",
"idCanalVenda": 2
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
canais | Data Collection | Sim | Array de Canais a serem associados |
sku | String | Não | SKU do produto ou atributo simples |
idProduto | Number | Não | ID do produto |
idAtributoSimples | Number | Não | ID do atributo simples |
idCanalVenda | Number | Sim | ID do Canal de Vendas |
precoDe | Number | Não | Preço De do Produto no Canal de Vendas |
precoPor | Number | Não | Preço Por do Produto no Canal de Vendas |
{
"id": 80
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote gerado |
Recurso responsável por listar todas as reservas de produtos criadas na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra as reservas por seu status. Os status disponíveis são 'ativo' ou 'inativo' Exemplo de requisição: /v2/products/reserves?status=ativo origem: Filtra as reservas por sua origem. As origens disponíveis são 'omni' ou 'api', ou 'inativo' Exemplo de requisição: /v2/products/reserves?origem=omni|wapstore |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/products/reserves?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"pedidos":[
{
"id":1,
"origem":"wapstore",
"ativo":true,
"dataCriacao":"2019-09-11 16:40:36",
"dataFinalizacao":"2019-09-12 10:26:22",
"observacao":"Reserva criada pelo painel",
"autor":{
"id":1,
"nome":"Usuário Teste"
},
"usuarioVinculado":{
"id":1,
"nome":"Usuário Teste"
},
"cliente":{
"id":1,
"nome":"Cliente Teste",
"email":"cliente@teste.com.br",
"cpfCnpj":"1111111111",
"telefone":"(11) 1232-1233",
"celular":"(11) 91232-1233"
},
"itens":[
{
"idProduto":1,
"idAtributoSimples":2,
"sku":"123456",
"nome":"Camiseta Branca",
"descricao":"Tamanho:M",
"qtd":1,
"armazem":{
"id":1,
"codigoInterno":"1234",
"razaoSocial":"Armazém Principal",
"nomeFantasia":"Armazém Principal"
}
}
]
}
],
"info":{
"filtros":[
],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/products/reserves?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":1,
"total":1
}
}
Campo | Tipo | Descrição |
---|---|---|
reservas | Data Collection | Reservas listadas |
id | Number | ID único da reserva |
origem | String | Origem da reserva.
|
ativo | Boolean | Define se a reserva está ativa (reservas ativas estão segurando estoque do produto) |
dataCriacao | String | Data de criação da reserva Formato esperado: 2019-05-11 22:15:00 |
dataFinalizacao | String | Data da finalização da reserva Formato esperado: 2019-05-11 22:15:00 |
observacao | String | Texto adicional enviado na criação da reserva |
autor | Object | Usuário que criou a reserva |
id | Number | ID do usuário que criou a reserva |
nome | String | Nome do usuário que criou a reserva |
usuarioVinculado | Object | Usuário que a reserva foi atribuída |
id | Number | ID do usuário que a reserva foi atribuída |
nome | String | Nome do usuário que a reserva foi atribuída |
cliente | Object | Dados do cliente |
id | Number | ID do cliente (pode ser retornado como 0, caso não seja uma reserva com origem Wapstore) |
codigo | String | ID externo do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
cpfCnpj | String | CPF ou CNPJ do cliente |
telefone | String | Telefone do cliente |
celular | String | Celular do cliente |
itens | Data Collection | Itens da reserva |
idProduto | Number | ID do produto reservado |
idAtributoSimples | Number | ID do atributo simples reervado |
sku | String | SKU do produto/atributo |
nome | String | Nome do produto |
descricao | String | Detalhes sobre a variação do produto (tamanho, voltagem, etc) |
qtd | Number | Quantidade reservada |
armazem | Object | Dados do armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de reservas.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/products/reserves/{idReserva} | ID da reserva |
Limite de requisições por minuto | 60 |
{
"id": 1,
"origem": "wapstore",
"ativo": true,
"dataCriacao": "2019-09-11 16:40:36",
"dataFinalizacao": "2019-09-12 10:26:22",
"observacao": "Reserva criada pelo painel",
"autor": {
"id": 1,
"nome": "Usuário Teste"
},
"usuarioVinculado": {
"id": 1,
"nome": "Usuário Teste"
},
"cliente": {
"id": 1,
"nome": "Cliente Teste",
"email": "cliente@teste.com.br",
"cpfCnpj": "1111111111",
"telefone": "(11) 1232-1233",
"celular": "(11) 91232-1233"
},
"itens": [
{
"idProduto": 1,
"idAtributoSimples": 2,
"sku": "123456",
"nome": "Camiseta Branca",
"descricao": "Tamanho:M",
"qtd": 1,
"armazem": {
"id": 1,
"codigoInterno": "1234",
"razaoSocial": "Armazém Principal",
"nomeFantasia": "Armazém Principal"
}
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID único da reserva |
origem | String | Origem da reserva.
|
ativo | Boolean | Define se a reserva está ativa (reservas ativas estão segurando estoque do produto) |
dataCriacao | String | Data de criação da reserva Formato esperado: 2019-05-11 22:15:00 |
dataFinalizacao | String | Data da finalização da reserva Formato esperado: 2019-05-11 22:15:00 |
observacao | String | Texto adicional enviado na criação da reserva |
autor | Object | Usuário que criou a reserva |
id | Number | ID do usuário que criou a reserva |
nome | String | Nome do usuário que criou a reserva |
usuarioVinculado | Object | Usuário que a reserva foi atribuída |
id | Number | ID do usuário que a reserva foi atribuída |
nome | String | Nome do usuário que a reserva foi atribuída |
cliente | Object | Dados do cliente |
id | Number | ID do cliente (pode ser retornado como 0, caso não seja uma reserva com origem Wapstore) |
codigo | String | ID externo do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
cpfCnpj | String | CPF ou CNPJ do cliente |
telefone | String | Telefone do cliente |
celular | String | Celular do cliente |
itens | Data Collection | Itens da reserva |
idProduto | Number | ID do produto reservado |
idAtributoSimples | Number | ID do atributo simples reervado |
sku | String | SKU do produto/atributo |
nome | String | Nome do produto |
descricao | String | Detalhes sobre a variação do produto (tamanho, voltagem, etc) |
qtd | Number | Quantidade reservada |
armazem | Object | Dados do armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia |
Recurso de consulta da fila de atualizações de produtos. Sempre que um novo produto for registrado ou tiver alguma informação atualizada, incluindo débito e crédito de estoque, ele aparecerá nessa fila. Solicite a ativação do webhook de fila de sincronizações à loja integrada para receber notificações sempre que houver uma nova atualização. Configure o seu sistema para consumir a fila de atualizações para sempre receber as atualizações de produtos.
Importante: Caso o webhook de fila de atualizações estiver inativo, ou seu consumo automático esteja desligado, após atualizar seu sistema, você deverá remover o produtos da fila utilizando o recurso de remoção de produtos da fila. Se não fizer isso, todas as vezes que consultar a fila continuará recebendo os mesmos produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | dataAtualizacao: Filtra os produtos pela data de atualização. Exemplo de requisição: /v2/products/queue?dataAtualizacao=2022-10-04 servico: Filtra os produtos que sejam serviços Exemplo de requisição: /v2/products/queue?servico=true idArmazem: Filtra os produtos pelo id do armazém. Exemplo de requisição: /v2/products/queue?idArmazem=9 idAtributo: Filtra os produtos pelo id do atributo. Exemplo de requisição: /v2/products/queue?idAtributo=55 |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio do parâmetro limit na URL da requisição (não é permitido enviar o parâmetro offset para essa requisição). Exemplo de requisição: /v2/products/queue?limit=100 Valor máximo para o parâmetro limit: 100 |
{
"produtos": [
{
"id": 37,
"idCategoria": 15,
"idMarca": 11,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 37,
"nome": "Goku SSJ4",
"adicionalNome": "Action Figure",
"sku": "GOKU_SSJ_4",
"tipo": "produto",
"ativo": true,
"venda": true,
"precos": {
"precoDe": 330,
"precoPor": 249.9,
"precoCusto": 100,
"precoEspecial": 0,
"dadosDescontoVista": {
"descontoGeral": 8.00,
"descontoBoleto": 3.00,
"descontoPix": 9.00,
"descontoDeposito": 4.05,
"descontoCartao": 2.35
}
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"descricao": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum aliquet odio vel maximus bibendum. Ut accumsan, augue quis scelerisque vestibulum, dolor justo tristique erat, tincidunt mollis urna arcu non eros. Praesent urna lacus, vehicula a suscipit at, aliquam porttitor turpis. Fusce mollis eros ut pellentesque rhoncus. Fusce ullamcorper lorem ipsum, sit amet euismod lacus vehicula egestas. Donec egestas, mauris non viverra mattis, lacus elit varius eros, vitae dictum sapien urna at massa. Quisque a volutpat lorem, sed sagittis diam. Aliquam semper finibus velit id hendrerit. Duis lacinia congue leo ut ultricies. In consequat fringilla tortor aliquam eleifend.</p>\r\n<p>Nunc vulputate dictum varius. Etiam at tempor purus. Pellentesque ultrices gravida urna vitae dictum. Phasellus gravida facilisis risus, non lobortis dui luctus id. Praesent nec lectus sit amet sem suscipit pulvinar. Aliquam ullamcorper mollis dolor, non consectetur massa auctor nec. Praesent iaculis mi sapien, in dignissim nunc tempus id. Donec sagittis, massa mollis pretium fringilla, nunc ante bibendum diam, aliquam viverra nisi lorem sed purus. Vestibulum sed tempus augue, pharetra convallis nisl.</p>\r\n<p>Aenean maximus tempus elit in tincidunt. Curabitur accumsan justo eget mauris pulvinar facilisis. Donec sed magna enim. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Integer eget condimentum leo. Nunc pharetra vulputate justo quis gravida. Nunc ac semper ligula.</p>",
"video": "",
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"estoque": 1009,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": {},
"estoque": 1000
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": {},
"estoque": 9
}
],
"prazoProducao": 0,
"prazoFornecedor": 20,
"vendaSemEstoque": true,
"busca": "",
"quantidadeVendida": 5,
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "GOKU_SSJ_4",
"ean": "GOKU_SSJ_4",
"exclusivo": false,
"url": "http://localhost/modelos/site",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [],
"landingPages": [],
"filtros": [
1,
2
],
"caracteristicas": [],
"atributoUnico": {},
"atributosSimples": [
{
"id": 21,
"sku": "GOKU_SSJ_4",
"ean": "GOKU_SSJ_4",
"estoque": 503,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": [],
"estoque": 500
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": [],
"estoque": 3
}
],
"precos": {
"precoDe": 330,
"precoPor": 249.9,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"dataCriacao": "2022-02-10 09:58:25"
},
{
"id": 22,
"sku": "GOKU_SSJ_4",
"ean": "GOKU_SSJ_4",
"estoque": 506,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": [],
"estoque": 500
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": [],
"estoque": 6
}
],
"precos": {
"precoDe": 308,
"precoPor": 229.7,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"dataCriacao": "2022-02-10 09:58:25"
}
],
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [
{
"id": 115,
"url": "http://localhost/modelos/site/upload/produto/imagem/goku-ssj4.webp",
"ordem": 1,
"label": ""
},
{
"id": 116,
"url": "http://localhost/modelos/site/upload/produto/imagem/goku-ssj4-1.webp",
"ordem": 2,
"label": ""
}
],
"full": [],
"arquivos": [],
"manuais": []
},
"dataCriacao": "2022-02-10 09:56:39",
"dataAtualizacao": "2022-10-04 19:08:34",
"dataAtualizacaoPainel": ""
},
{
"id": 38,
"idCategoria": 15,
"idMarca": 11,
"tipoProduto": "c",
"produtoLider": true,
"idProdutoLider": 38,
"nome": "Vegeta SSJ 4",
"adicionalNome": "Action Figure",
"sku": "VEGETA_SSJ_4",
"servico": false,
"ativo": true,
"venda": true,
"precos": {
"precoDe": 275,
"precoPor": 220,
"precoCusto": 100,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"descricaoCurta": "Vestibulum aliquet odio vel maximus bibendum.",
"descricao": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum aliquet odio vel maximus bibendum. Ut accumsan, augue quis scelerisque vestibulum, dolor justo tristique erat, tincidunt mollis urna arcu non eros. Praesent urna lacus, vehicula a suscipit at, aliquam porttitor turpis. Fusce mollis eros ut pellentesque rhoncus. Fusce ullamcorper lorem ipsum, sit amet euismod lacus vehicula egestas. Donec egestas, mauris non viverra mattis, lacus elit varius eros, vitae dictum sapien urna at massa. Quisque a volutpat lorem, sed sagittis diam. Aliquam semper finibus velit id hendrerit. Duis lacinia congue leo ut ultricies. In consequat fringilla tortor aliquam eleifend.</p>\r\n<p>Nunc vulputate dictum varius. Etiam at tempor purus. Pellentesque ultrices gravida urna vitae dictum. Phasellus gravida facilisis risus, non lobortis dui luctus id. Praesent nec lectus sit amet sem suscipit pulvinar. Aliquam ullamcorper mollis dolor, non consectetur massa auctor nec. Praesent iaculis mi sapien, in dignissim nunc tempus id. Donec sagittis, massa mollis pretium fringilla, nunc ante bibendum diam, aliquam viverra nisi lorem sed purus. Vestibulum sed tempus augue, pharetra convallis nisl.</p>\r\n<p>Aenean maximus tempus elit in tincidunt. Curabitur accumsan justo eget mauris pulvinar facilisis. Donec sed magna enim. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Integer eget condimentum leo. Nunc pharetra vulputate justo quis gravida. Nunc ac semper ligula.</p>",
"video": "",
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"estoque": 1009,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": {},
"estoque": 1000
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": {},
"estoque": 9
}
],
"prazoProducao": 0,
"prazoFornecedor": 0,
"vendaSemEstoque": false,
"busca": "",
"quantidadeVendida": 3,
"googleDescription": "",
"googleCondition": "",
"googleAgeGroup": "",
"googleGender": "",
"ncm": "",
"mpn": "VEGETA_SSJ_4",
"ean": "VEGETA_SSJ_4",
"exclusivo": false,
"url": "http://localhost/modelos/site",
"avaliacao": {
"media": 0,
"quantidade": 0
},
"categoriasAdicionais": [],
"landingPages": [],
"filtros": [
1
],
"caracteristicas": [],
"atributoUnico": {},
"atributosSimples": [
{
"id": 21,
"sku": "VEGETA_SSJ_4",
"ean": "VEGETA_SSJ_4",
"estoque": 503,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": [],
"estoque": 500
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": [],
"estoque": 3
}
],
"precos": {
"precoDe": 275,
"precoPor": 220,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"dataCriacao": "2022-02-10 10:02:12"
},
{
"id": 22,
"sku": "VEGETA_SSJ_4",
"ean": "VEGETA_SSJ_4",
"estoque": 506,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Loja Scrum",
"principal": true,
"seller": [],
"estoque": 500
},
{
"id": 8,
"codigoInterno": "0002",
"nome": "Armazém Canoas",
"principal": false,
"seller": [],
"estoque": 6
}
],
"precos": {
"precoDe": 275,
"precoPor": 220,
"precoEspecial": 0
},
"canais": [
{
"id": 1,
"nome": "Loja 1",
"codigo": "loja-1",
"precos": {
"precoDe": 32.99,
"precoPor": 11.50
}
},
{
"id": 2,
"nome": "Loja 2",
"codigo": "loja-2",
"precos": {
"precoDe": 987.99,
"precoPor": 654.56
}
}
],
"dimensoes": {
"altura": 0.3,
"largura": 0.3,
"comprimento": 0.3,
"peso": 0.3
},
"dataCriacao": "2022-02-10 10:02:12"
}
],
"produtosVinculados": [],
"selos": [],
"midias": {
"imagens": [
{
"id": 122,
"url": "http://localhost/modelos/site/upload/produto/imagem/vegeta-ssj-4.webp",
"ordem": 1,
"label": ""
},
{
"id": 123,
"url": "http://localhost/modelos/site/upload/produto/imagem/vegeta-ssj-4-1.webp",
"ordem": 2,
"label": ""
}
],
"full": [],
"arquivos": [],
"manuais": []
},
"dataCriacao": "2022-02-10 10:01:29",
"dataAtualizacao": "2022-10-04 19:08:35",
"dataAtualizacaoPainel": ""
}
],
"identificadoresFila": [
37,
38
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/products/queue?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 2,
"total": 2
}
}
Campo | Tipo | Descrição |
---|---|---|
produtos | Data Collection | Produtos listados |
id | Number | ID único do produto |
idCategoria | Number | ID da categoria principal do produto |
idMarca | Number | ID da marca do produto |
tipoProduto | String | Tipo do produto ('s' = simples/sem variação | 'c' = configurável/com variação) |
produtoLider | Boolean | Define se o produto é o líder das variações |
idProdutoLider | Number | ID do produto líder |
nome | String | Nome do produto |
adicionalNome | String | Informações adicionais ao nome do produto (não aparecem na URL) |
sku | String | SKU do produto |
tipo | String | Tipo de produto (produto, servico, lista ou conjunto) |
ativo | Boolean | Define se o produto está ativo |
venda | Boolean | Define se o produto pode ser vendido |
assinatura | Boolean | Define se permite assinar o produto |
precos | Object | Detalhes dos preços do produto |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
precoCusto | Number | Preço de custo |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
editarPreco | Boolean | Define se permite a edição do preço do produto (apenas para modelos de negócio B2B2C) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
id | Number | Identificador único do Canal de Vendas |
codigo | String | Código do Canal de Vendas |
nome | String | Nome do Canal de Vendas |
precos | Object | Detalhes dos preços do produto nos Canais de Venda |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda) |
descricaoCurta | String | Descrição curta do produto (sem HTML) |
descricao | String | Descrição longa do produto (pode conter HTML) |
video | String | URL do vídeo do produto |
dimensoes | Object | Detalhes das dimensões do produto |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
estoque | Number | Estoque disponível do produto |
armazens | Data Collection | Estoques do produto detalhado por armazém |
id | Number | ID do armazém |
codigoInterno | String | Código interno do armazém |
nome | String | Razão social do armazém |
principal | Boolean | Determina se o armazém é o principal |
seller | Object | Seller de marketplace do armazém |
id | Number | ID do seller |
nome | String | Nome do seller |
cnpj | String | CNPJ do seller |
String | E-mail do seller | |
telefone | String | Telefone do seller |
estoque | Number | Estoque disponível no armazém |
tipoPrazoProducao | String | Tipo de prazo de produção |
prazoProducao | Number | Prazo de produção em dias somado ao tempo de entrega (só será considerado caso o prazo não seja tabelado) |
idPrazoProducao | Number | ID da tabela de prazo de produção (caso seja tabelado) |
prazoFornecedor | Number | Prazo do fornecedor em dias (somado ao tempo de entrega caso o produto tenha sido vendido sem estoque) |
vendaSemEstoque | Boolean | Define se o produto pode ser vendido mesmo se não tiver estoque disponível |
busca | String | Palavras de busca do produto |
quantidadeVendida | Number | Quantidade total já vendida do produto |
googleDescription | String | Meta tag de descrição para buscadores |
googleCondition | String | Condição do produto |
googleAgeGroup | String | Faixa etária indicada do produto |
googleGender | String | Gênero indicado do produto |
ncm | String | Código da Nomenclatura Comum do Mercosul |
mpn | String | Código do fabricante (manufacturer part number) |
ean | String | Código GTIN/EAN do produto |
exclusivo | Boolean | Define se o produto é exclusivo (produtos exclusivos não possuem EAN) |
url | String | URL pública do produto |
avaliacao | Object | Detalhes das avaliações |
media | Number | Média de todas as avaliações |
quantidade | Number | Quantidade total de avaliações |
categoriasAdicionais | Array de números | Categorias adicionais do produto |
landingPages | Array de números | Landing pages vinculadas ao produto |
filtros | Array de números | Filtros que podem ser aplicados no produto (IDs dos valores dos filtros) |
caracteristicas | Array de strings | Características do produto seguindo o padrão {'id':'valor'} |
atributoUnico | Object | Detalhes do atributo único do produto |
id | Number | ID do valor do atributo único |
dataCriacao | String | Data de criação do atributo no produto |
atributosSimples | Data Collection | Detalhes dos atributos simples do produto |
id | Number | ID do valor do atributo simples |
sku | String | SKU da variação |
ean | String | EAN da variação |
estoque | Number | Estoque da variação |
armazens | Data Collection | Estoques do atributo simples detalhado por armazém |
precos | Object | Detalhes dos preços dos produtos |
precoDe | Number | Preço 'de' |
precoPor | Number | Preço 'por' (preço de venda)' |
precoEspecial | Number | Preço especial (aplicado em páginas promocionais) |
dadosDescontoVista | Object | Dados do desconto à vista do produto |
canais | Data Collection | Detalhes dos Canais de Venda Associados ao Produto |
dimensoes | Object | Detalhes das dimensões |
altura | Number | Altura em cm |
largura | Number | Largura em cm |
comprimento | Number | Comprimento em cm |
peso | Number | Peso em kg |
dataCriacao | String | Data de criação do atributo no produto Formato esperado: 2019-05-11 22:15:00 |
listaCompra | Object | Dados da lista de compras vinculada ao produto do tipo lista |
id | Number | ID da lista de compras vinculada ao produto do tipo lista |
venderProdutoIndisponivel | Boolean | Define se a lista poderá ser comprada mesmo que seus produtos não permitam venda quando indisponível |
preco | Object | Detalhes da precificação da lista de compras |
aplicacaoDesconto | String | Determina como será a aplicação de desconto na lista de compras (lista: em toda a lista, produto: por produto) |
tipoDesconto | String | Determina o tipo do desconto que será aplicado (fixo: valor fixo em reais, desconto: percentual de desconto) |
tipoPrecoProduto | String | Determina o tipo de precificação do produto (default: preço padrão do produto, percentual: preço do produto assumirá o valor de uma porcentagem do valor da lista de compras) |
valor | Number | Valor do desconto (percentual) aplicado à lista de compras |
descontoVista | Number | Percentual de desconto aplicado para pagamentos à vista |
itens | Data Collection | Dados dos itens pertencentes à lista de compras |
id | Number | Identificador do item (produto) |
sku | String | SKU do item (produto) |
nome | String | Nome do item (produto) |
idAtributoSimples | Number | Identificador do atributo simples do item |
quantidade | Number | Quantidade do item na lista de compras Valor mínimo: 1 |
precoPor | Number | Preço por original do item |
precoFinal | Number | Preço final que o item assume de acordo com as configurações de precificação da lista |
percentualDesconto | Number | Percentual de desconto aplicado ao preço por do item |
percentualRepresentadoLista | Number | Percentual, do valor total da lista de compras, que o valor do item representará (o somatório dos percentuais dos itens deve ser 100%) |
conjunto | Object | Detalhes do conjunto vinculado ao produto do tipo conjunto |
id | Number | Identificador do conjunto vinculado ao produto |
venderProdutoIndisponivel | Boolean | Define se o conjunto permite a venda de produtos que estejam com a venda inativa |
componentes | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto e componente |
idComponente | Number | Identificador do componente |
label | String | Label do componente no conjunto |
configurarPorProduto | Boolean | Define se o componente possui sua configuração por produto ativa |
permitirMultiplaEscolha | Boolean | Define se o componente permite a compra de mais de um produto |
permitirAlterarQuantidade | Boolean | Define se o componente permite a alteração de quantidade no momento da compra (Quando a configuração por produto do componente estiver inativa) |
quantidade | Number | Quantidade base de compra do componente (Quando impossível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do componente (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do componente (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do componente no detalhe do conjunto (Quando possível alterar quantidade) |
produtos | Data Collection | Detalhes dos componentes pertencentes ao conjunto |
id | Number | Identificador do vínculo criado entre conjunto, componente e produto |
idProduto | Number | Identificador do produto |
permitirAlterarQuantidade | Boolean | Define se é possível alterar a quantidade do produto no momento da compra (Quando a configuração por produto do componente estiver ativa) |
quantidade | Number | Quantidade base de compra do produto (Quando impossível alterar quantidade) |
quantidadeInicial | Number | Quantidade inicial de compra do produto no detalhe do conjunto (Quando possível alterar quantidade) |
quantidadeMinima | Number | Quantidade mínima de compra do produto (Quando possível alterar quantidade) |
quantidadeMaxima | Number | Quantidade máxima de compra do produto (Quando possível alterar quantidade) |
valorIncremento | Number | Valor de incremento de quantidade do produto no detalhe do conjunto (Quando possível alterar quantidade) |
produtosVinculados | Array de números | IDs dos produtos vinculados (demais variações com atributos únicos) |
selos | Data Collection | Detalhes dos selos vinculados ao produto |
id | Number | ID do selo |
posicao | Object | Detalhes do posicionamento do selo |
horizontal | String | Eixo horizontal |
vertical | String | Eixo vertical |
periodo | Object | Período de aplicação do selo |
inicio | String | Data de início |
fimIndeterminado | Boolean | Define se o selo não terá uma data de finalização neste produto |
fim | String | Data de finalização |
midias | Object | Mídias e arquivos do produto |
imagens | Data Collection | Imagens do produto |
id | Number | ID da imagem |
url | String | URL da imagem |
ordem | Number | Ordem de exibição da imagem |
label | String | Label da imagem (texto alternativo) |
full | Data Collection | Fotos full |
id | Number | ID da foto full |
url | String | URL da foto full |
ordem | Number | Ordem de exibição da foto full |
label | String | Label da foto (texto alternativo) |
descricao | String | Descrição da foto (texto complementar) |
arquivos | Data Collection | Arquivos (.doc,.pdf,etc) |
id | Number | ID do arquivo |
url | String | URL do arquivo |
ordem | Number | Ordem de exibição do arquivo |
label | String | Label do arquivo |
manuais | Data Collection | manuais |
id | Number | ID do manual |
url | String | URL do manual |
ordem | Number | Ordem de exibição do manual |
label | String | Label do manual |
aparecerSite | Boolean | Define se o produto deve aparecer no site (listagens de categorias, marcas, vitrines e landing pages) |
aparecerBusca | Boolean | Define se o produto deve aparecer como resultado de buscas no site |
aparecerXml | Boolean | Define se o produto deve constar nos XMLs de produtos |
sincronizarApi | Boolean | Define se o produto deve sincronizar por API |
sincronizarHub | Boolean | Define se o produto deve sincronizar pelo hub (Omni) |
dataCriacao | String | Data de criação do produto na plataforma |
dataAtualizacao | String | Data da última atualização do produto |
dataAtualizacaoPainel | String | Data da última atualização feita pelo painel da Wapstore no produto |
identificadoresFila | Array de números | Lista com os produtos presentes na paginação |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por remover produtos da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/products/queue/{idSkuProduto} | ID ou SKU do produto a ser removido da fila. |
Filtros | identificador: Define qual o identificador será utilizado para a busca do produto. Os valores aceitos são 'id' ou 'sku' Exemplo de requisição: /v2/products/queue/{idSkuProduto}?identificador=sku |
Limite de requisições por minuto | 12000 |
Recurso responsável por remover produtos da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 1000 |
{
"produtos": [
37,
38
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
produtos | Array de strings | Sim | Lista com os IDs ou SKUs dos produtos a serem removidos da fila |
Recurso responsável por cadastrar novas mídias a um produto.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/media/products/{idSkuProduto} | ID ou SKU do produto que receberá as mídias |
Filtros | identificador: Define qual o identificador será utilizado para a busca do produto. Os valores aceitos são 'id' ou 'sku' Exemplo de requisição: /v2/media/products/{idSkuProduto}?identificador=sku |
Limite de requisições por minuto | 10 |
{
"midias": [
{
"tipo": "imagem",
"idAtributoSimples": 0,
"url": "https://lojascrum.wapstore.com.br/upload/produto/imagem/luvas-de-beisebol.jpg",
"label": "Luva de beisebol marrom",
"ordem": 1
},
{
"tipo": "imagem",
"idAtributoSimples": 21,
"arquivoCodificado": "iVBORw0KGgoAAAANSUhEUgAAAjEAAAIxBAMAAABOQfTHAAAABGdBTUEAALGPC/x/E3u+WOY5Z3sVwAAAAASUVORK5CYII=",
"label": "Luva de Boxe",
"ordem": 2
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
midias | Data Collection | Sim | Mídias a serem cadastradas Tamanho máximo: 5 |
tipo | String | Sim | Tipo da mídia. Valores aceitos: imagem |
idAtributoSimples | Number | Não | Id do atributo simples que receberá a mídia sendo cadastrada |
url | String | Sim | URL da mídia a ser cadastrada (Proibido quando 'arquivoCodificado' está presente no objeto de mídia da requisição) URL válida: e.g. https://sualoja.com.br/retorno |
arquivoCodificado | String | Sim | Base64 da mídia a ser cadastrada (Proibido quando 'url' está presente no objeto de mídia da requisição) |
label | String | Não | Label da mídia sendo cadastrada |
ordem | Number | Não | Ordem para a mídia (A ordem da mídia será ajustada, automaticamente, de acordo com as mídias já existentes no produto. Valores muito altos serão adequados ao último valor possível. Indicar um valor que já esteja vinculado a alguma outra mídia causará a readequação da ordem da nova mídia para o próximo valor disponível e a readequação das ordens das mídias conseguintes) |
[
{
"id": 697,
"idProduto": 244,
"idAtributoSimples": 0,
"ordem": 1,
"label": "Luva de beisebol marrom",
"arquivo": "vegeta-ssj-blue-3.jpg",
"url": "https://lojascrum.wapstore.com.br/upload/produto/imagem/vegeta-ssj-blue-3.jpg"
},
{
"id": 698,
"idProduto": 244,
"idAtributoSimples": 21,
"ordem": 2,
"label": "Luva de Boxe",
"arquivo": "vegeta-ssj-blue-4.jpg",
"url": "https://lojascrum.wapstore.com.br/upload/produto/imagem/vegeta-ssj-blue-4.jpg"
}
]
Recurso responsável por atualizar a ordem, label ou atributo simples vinculados a mídias de um produto.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/media/products/{idSkuProduto} | ID ou SKU do produto que pai das mídias sendo atualizadas |
Limite de requisições por minuto | 120 |
{
"midias": [
{
"id": 693,
"ordem": 2,
"label": "Batman Begins"
},
{
"id": 696,
"idAtributoSimples": 22,
"ordem": 1,
"label": "Pinguins dançando"
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
midias | Data Collection | Sim | Mídias a serem atualizadas Tamanho máximo: 5 |
id | Number | Sim | Id da mídia que será atualizada |
idAtributoSimples | Number | Não | Atributo simples para ser vinculado à mídia |
label | String | Não | Nova label para a mídia |
ordem | Number | Não | Nova ordem para a mídia (A ordem da mídia será ajustada, automaticamente, de acordo com as mídias já existentes no produto. Valores muito altos serão adequados ao último valor possível. Indicar um valor que já esteja vinculado a alguma outra mídia causará a readequação da ordem da nova mídia para o próximo valor disponível e a readequação das ordens das mídias conseguintes) |
[
{
"id": 693,
"idProduto": 244,
"idAtributoSimples": 0,
"ordem": 2,
"label": "Batman Begins",
"arquivo": "vegeta-ssj-blue-1.jpg",
"url": "https://lojascrum.wapstore.com.br/upload/produto/imagem/vegeta-ssj-blue-1.jpg"
},
{
"id": 696,
"idProduto": 244,
"idAtributoSimples": 22,
"ordem": 1,
"label": "Pinguins dançando",
"arquivo": "vegeta-ssj-blue-2.png",
"url": "https://lojascrum.wapstore.com.br/upload/produto/imagem/vegeta-ssj-blue-2.png"
}
]
Recurso responsável por excluir mídias de produtos da loja.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 120 |
{
"midias": [
693,
696
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
midias | Array de números | Sim | Ids das mídias a serem removidas |
Recurso responsável por listar os componentes de conjunto existentes na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os componentes pelo seu status de atividade. Exemplo de requisição: /v2/components?status=ativo produtosVinculados: Filtra os componentes pelos seus produtos vinculados. Envie um ou mais SKUs ou Identificadores de produtos separados por '|'. Exemplo de requisição: /v2/components?produtosVinculados=264|PLACAMAEMSI nome: Filtra os componentes de acordo com o nome. Exemplo de requisição: /v2/components?nome=Processadores |
Limite de requisições por minuto | 120 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/components?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"componentes": [
{
"id": 2,
"nome": "Placas mãe",
"status": "ativo",
"produtos": [
{
"id": 264,
"sku": "PLACAMAEASUS",
"nome": "Placa Mãe Asus Prime H510M-E, Intel LGA 1200, microATX, DDR4 - 90MB17E0-C1BAY0"
},
{
"id": 265,
"sku": "PLACAMAEMSI",
"nome": "Placa-Mãe MSI B450M Pro-M2 Max p/ AMD AM4, m-ATX, DDR4"
}
]
},
{
"id": 3,
"nome": "MemoriasRAM",
"status": "ativo",
"produtos": [
{
"id": 262,
"sku": "MEMORIARAMPATRIOT",
"nome": "Memoria Ram Patriot Viper Steel Rgb 32gb Ddr4 1x32gb 3200 Mhz - Pvsr432g320c8"
},
{
"id": 263,
"sku": "MEMORIARAMKZAZUK",
"nome": "Memória Notebook Kazuk 8gb - 1600 Mhz Ddr3 Ram Kzrn-d3168g"
}
]
},
{
"id": 4,
"nome": "Processadores",
"status": "ativo",
"produtos": [
{
"id": 259,
"sku": "INTELCOREI3",
"nome": "Processador Intel Core i3-10100F, Cache 6MB, 4.30 GHz, LGA 1200 - BX8070110100F"
},
{
"id": 260,
"sku": "AMDRYZEN53600",
"nome": "Processador AMD Ryzen 5 3600 Cache 32MB 3.6GHz(4.2GHz Max Turbo) AM4, Sem Vídeo - 100-100000031BOX"
},
{
"id": 261,
"sku": "INTELCOREI5",
"nome": "Processador Intel Core i5-10400, Cache 12MB, 2.9GHz (4.3GHz Max Turbo), LGA 1200 - BX8070110400"
}
]
},
{
"id": 8,
"nome": "Controladora",
"status": "ativo",
"produtos": [
{
"id": 10604,
"sku": "controladora-pioneer-xdj-xz",
"nome": "Controladora Pioneer DJ"
},
{
"id": 10605,
"sku": "controladora-hercules-inpulse",
"nome": "Controladora Hercules DJControl Inpulse"
}
]
},
{
"id": 9,
"nome": "Microfone",
"status": "ativo",
"produtos": [
{
"id": 10608,
"sku": "mic-jbl-dinamico",
"nome": "Microfone Dinâmico JBL"
},
{
"id": 10609,
"sku": "mic-shure-sv200",
"nome": "Microfone Shure SV200"
}
]
},
{
"id": 10,
"nome": "Fone",
"status": "ativo",
"produtos": [
{
"id": 10606,
"sku": "fone-hercules-hdp",
"nome": "Fone de Ouvido Hercules"
},
{
"id": 10607,
"sku": "headphone-k92-akg",
"nome": "Fone de Ouvido AKG K92"
}
]
},
{
"id": 11,
"nome": "Som",
"status": "ativo",
"produtos": [
{
"id": 10610,
"sku": "caixa-edifier-2.0",
"nome": "Caixa de Som Edifier"
}
]
},
{
"id": 12,
"nome": "Disco",
"status": "ativo",
"produtos": [
{
"id": 271,
"sku": "igor-tyler",
"nome": "IGOR - Tyler, the creator."
},
{
"id": 272,
"sku": "awaken-my-love-vinil",
"nome": "Awaken, my love! - Childish Gambino"
},
{
"id": 273,
"sku": "cozytapes-2",
"nome": "Cozy Tapes Vol.2 - A$AP Mob"
},
{
"id": 274,
"sku": "flowerboy",
"nome": "Flower boy - Tyler, the creator."
}
]
},
{
"id": 15,
"nome": "Outros",
"status": "ativo",
"produtos": [
{
"id": 212,
"sku": "tenis-adidas-lite-racer",
"nome": "Tênis Adidas Lite Racer 2.0"
}
]
},
{
"id": 16,
"nome": "Eletrônicos",
"status": "ativo",
"produtos": [
{
"id": 264,
"sku": "PLACAMAEASUS",
"nome": "Placa Mãe Asus Prime H510M-E, Intel LGA 1200, microATX, DDR4 - 90MB17E0-C1BAY0"
},
{
"id": 10604,
"sku": "controladora-pioneer-xdj-xz",
"nome": "Controladora Pioneer DJ"
},
{
"id": 10605,
"sku": "controladora-hercules-inpulse",
"nome": "Controladora Hercules DJControl Inpulse"
}
]
},
{
"id": 17,
"nome": "Gabinetes",
"status": "ativo",
"produtos": [
{
"id": 251,
"sku": "gabinete_CGR-5LMHO",
"nome": "Gabinete Cougar Gamer Blazer Essence, Mid Tower, Vidro temperado"
},
{
"id": 10824,
"sku": "RM-GA-GG-FW",
"nome": "Gabinete Gamer Rise Mode Galaxy Glass"
},
{
"id": 10825,
"sku": "LKS06S",
"nome": "Gabinete Gamer Gs Standard Atx Vidro Robozao"
}
]
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/components?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 11,
"total": 11
}
}
Campo | Tipo | Descrição |
---|---|---|
componentes | Data Collection | Componentes listados |
id | Number | Identificador do componente |
nome | String | Nome do componente |
status | String | Define se o componente está ativo Valores aceitos: ativo, inativo |
produtos | Data Collection | Produtos pertencentes ao componente |
id | Number | Identificador do produto |
sku | String | Sku do produto |
nome | String | Nome do produto |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
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.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/batch/{id} | ID do lote |
Limite de requisições por minuto | 60 |
{
"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"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
batchId | Number | ID do lote |
requestId | String | ID da requisição |
tipo | String | Tipo do lote (produto, pedido, etc) |
acao | String | Ação do lote (atualizarEstoque, atualizarProduto, etc) |
data | String | Data de processamento do lote |
status | String | Status do lote Valores aceitos: aguardando, processando, processado |
contemErros | Boolean | Define se foram encontrado erros no processametno |
observacoes | Data Collection | Observações sobre o processamento do lote |
identificador | String | Identficador do item no lote (SKU do produto/variação, por exemplo) |
sucesso | Boolean | Define se o item foi processado com sucesso |
info | String | Informação sobre o processamento (retornado apenas em caso de sucesso) |
error | String | Informação sobre o erro apresentado (retornado apenas em caso de erro) |
details | Array de strings | Detalhes sobre o erro apresentado (retornado em alguns casos de erro) |
data | String | Data de processamento do item |
Recurso responsável por retornar todas as recuperações de venda de acordo com os filtros.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | tipo: Tipo da recuperação (carrinho, pagamento, orcamento) pode ser passado mais de um valor separado por '|' Exemplo de requisição: /v2/sales-recovery?tipo=carrinho|pagamento ativo: Recuperações ativas (true) ou não (false) Exemplo de requisição: /v2/sales-recovery?ativo=true emailEnviado: Recuperações com e-mails enviados (true) ou não (false) Exemplo de requisição: /v2/sales-recovery?emailEnviado=false clienteRetornou: Recuperações que o cliente retornou (true) ou não (false) Exemplo de requisição: /v2/sales-recovery?clienteRetornou=false data: Filtro por data pode ser passado mais de um valor separado por '|' Exemplo de requisição: /v2/sales-recovery?data=2022-03-01|2022-03-07 situacaoAtendimento: Filtro do status de atendimento de uma recuperação de venda. Pode ser passado mais de uma valor, separado por '|' Exemplo de requisição: /v2/sales-recovery?situacaoAtendimento=Finalizado|Pendente idCanalVenda: Filtro do canal de vendas de uma recuperação de venda. Pode ser passado mais de uma valor, separado por '|' Exemplo de requisição: /v2/sales-recovery?idCanalVenda=0|3|17 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/sales-recovery?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"recuperacoesVenda": [
{
"id": 2177,
"numeroPedido": "SCR-1891749686",
"tipo": "carrinho",
"data": "2022-02-02 13:47:02",
"dataEmail": "",
"dataRetorno": "",
"situacaoAtendimento": "",
"urlRecuperacao": "http://sandbox.wapstore.com.br/checkout/recuperacao?sessao=ilfg9jamaq9pc4sbq7gh7oaosr&utm_source=recuperacao&utm_medium=carrinho",
"paginaAbandono": "http://sandbox.wapstore.com.br/checkout/carrinho",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"cliente": {
"id": 283194,
"nome": "Cliente Teste",
"email": "teste@wapstore.com.br",
"celular": "(99) 99999-9999",
"telefone": "",
"cpfCnpj": "85668863169",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"produtos": [
{
"idProduto": 62,
"idAtributoValor": 0,
"nome": "Ar Condicionado",
"atributo": "",
"quantidade": 1,
"precoUnitario": 199,
"foto": "http://sandbox.wapstore.com.br/upload/lista-compra/imagem/m_arcondicionado.webp",
"personalizacoes": [],
"tipo": "produto"
}
]
}
],
"info": {
"filtros": {
"tipo": "carrinho|pagamento|orcamento"
},
"prev": "",
"self": "http://sandbox.wapstore.com.br/api/v2/sales-recovery?offset=0&limit=100&tipo=carrinho|pagamento|orcamento",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
recuperacoesVenda | Data Collection | Recuperações de venda encontradas |
id | Number | ID da recuperação de venda |
numeroPedido | String | Número do pedido da recuperação do tipo pagamento |
tipo | String | Tipo da recuperação de venda Valores aceitos: carrinho, pagamento, orcamento |
data | String | Data da recuperação de venda |
dataEmail | String | Data de envio do e-mail da recuperação de venda |
dataRetorno | String | Data de retorno da recuperação de venda |
situacaoAtendimento | String | Informa a situação do atendimento que a recuperação de venda está |
urlRecuperacao | String | URL da recuperação de venda |
paginaAbandono | String | URL da página de abandono |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
cliente | Object | Cliente da recuperação de venda |
id | Number | ID do cliente da recuperação de venda |
nome | String | Nome do cliente da recuperação de venda |
String | E-mail do cliente da recuperação de venda | |
celular | String | Número de celular do cliente |
telefone | String | Número de telefone do cliente |
cpfCnpj | String | CPF/CNPJ do cliente da recuperação de venda |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
produtos | Data Collection | Produtos da recuperação de venda |
idProduto | Number | ID do produto da recuperação de venda |
idAtributoValor | Number | ID do atributo do produto da recuperação de venda |
nome | String | Nome do produto da recuperação de venda |
atributo | String | Atributo do produto da recuperação de venda |
quantidade | Number | Quantidade do produto da recuperação de venda |
precoUnitario | Number | Preço unitário do produto da recuperação de venda |
foto | String | Foto do produto/lista de compra da recuperação de venda |
personalizacoes | Data Collection | Personalizações do produto da recuperação de venda |
id | Number | ID da personalização do produto da recuperação de venda |
nome | String | Nome da personalização do produto da recuperação de venda |
tipo | String | Tipo da personalização do produto da recuperação de venda Valores aceitos: text, upload, select, checkbox |
valor | String | Valor da personalização do produto da recuperação de venda |
precoUnitario | Number | Preço unitário da personalização do produto da recuperação de venda |
tipo | String | Tipo do produto da recuperação de venda Valores aceitos: produto, listaCompra |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de recuperação de vendas.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sales-recovery/{idRecuperacaoVenda} | ID da recuperação de vendas |
{
"id": 2177,
"numeroPedido": "SCR-1891749686",
"tipo": "carrinho",
"data": "2022-02-02 13:47:02",
"dataEmail": "",
"dataRetorno": "",
"situacaoAtendimento": "",
"urlRecuperacao": "http://sandbox.wapstore.com.br/checkout/recuperacao?sessao=ilfg9jamaq9pc4sbq7gh7oaosr&utm_source=recuperacao&utm_medium=carrinho",
"paginaAbandono": "http://sandbox.wapstore.com.br/checkout/carrinho",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"cliente": {
"id": 283194,
"nome": "Cliente Teste",
"email": "teste@wapstore.com.br",
"celular": "(99) 99999-9999",
"telefone": "",
"cpfCnpj": "85668863169",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"produtos": [
{
"idProduto": 62,
"idAtributoValor": 0,
"nome": "Ar Condicionado",
"atributo": "",
"quantidade": 1,
"precoUnitario": 199,
"foto": "http://sandbox.wapstore.com.br/upload/lista-compra/imagem/m_arcondicionado.webp",
"personalizacoes": [],
"tipo": "produto"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID da recuperação de venda |
numeroPedido | String | Número do pedido da recuperação do tipo pagamento |
tipo | String | Tipo da recuperação de venda Valores aceitos: carrinho, pagamento, orcamento |
data | String | Data da recuperação de venda |
dataEmail | String | Data de envio do e-mail da recuperação de venda |
dataRetorno | String | Data de retorno da recuperação de venda |
situacaoAtendimento | String | Informa a situação do atendimento que a recuperação de venda está |
urlRecuperacao | String | URL da recuperação de venda |
paginaAbandono | String | URL da página de abandono |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
cliente | Object | Cliente da recuperação de venda |
id | Number | ID do cliente da recuperação de venda |
nome | String | Nome do cliente da recuperação de venda |
String | E-mail do cliente da recuperação de venda | |
celular | String | Número de celular do cliente |
telefone | String | Número de telefone do cliente |
cpfCnpj | String | CPF/CNPJ do cliente da recuperação de venda |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
produtos | Data Collection | Produtos da recuperação de venda |
idProduto | Number | ID do produto da recuperação de venda |
idAtributoValor | Number | ID do atributo do produto da recuperação de venda |
nome | String | Nome do produto da recuperação de venda |
atributo | String | Atributo do produto da recuperação de venda |
quantidade | Number | Quantidade do produto da recuperação de venda |
precoUnitario | Number | Preço unitário do produto da recuperação de venda |
foto | String | Foto do produto/lista de compra da recuperação de venda |
personalizacoes | Data Collection | Personalizações do produto da recuperação de venda |
id | Number | ID da personalização do produto da recuperação de venda |
nome | String | Nome da personalização do produto da recuperação de venda |
tipo | String | Tipo da personalização do produto da recuperação de venda Valores aceitos: text, upload, select, checkbox |
valor | String | Valor da personalização do produto da recuperação de venda |
precoUnitario | Number | Preço unitário da personalização do produto da recuperação de venda |
tipo | String | Tipo do produto da recuperação de venda Valores aceitos: produto, listaCompra |
Recurso responsável por retornar todas as recuperações de venda de acordo com os filtros.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | tipo: Tipo da recuperação (carrinho, pagamento, orcamento) pode ser passado mais de um valor separado por '|' Exemplo de requisição: /v2/sales-recovery/queue?tipo=carrinho|pagamento ativo: Recuperações ativas (true) ou não (false) Exemplo de requisição: /v2/sales-recovery/queue?ativo=true emailEnviado: Recuperações com e-mails enviados (true) ou não (false) Exemplo de requisição: /v2/sales-recovery/queue?emailEnviado=false clienteRetornou: Recuperações que o cliente retornou (true) ou não (false) Exemplo de requisição: /v2/sales-recovery/queue?clienteRetornou=false data: Filtro por data pode ser passado mais de um valor separado por '|' Exemplo de requisição: /v2/sales-recovery/queue?data=2022-03-01|2022-03-07 situacaoAtendimento: Filtro do status de atendimento de uma recuperação de venda. Pode ser passado mais de uma valor, separado por '|' Exemplo de requisição: /v2/sales-recovery/queue?situacaoAtendimento=Finalizado|Pendente idCanalVenda: Filtro do canal de vendas de uma recuperação de venda. Pode ser passado mais de uma valor, separado por '|' Exemplo de requisição: /v2/sales-recovery/queue?idCanalVenda=0|3|17 |
Offset/Limit | Obrigatório o envio do parâmetro limit na URL da requisição (não é permitido enviar o parâmetro offset para essa requisição). Exemplo de requisição: /v2/sales-recovery/queue?limit=100 Valor máximo para o parâmetro limit: 100 |
{
"recuperacoesVenda": [
{
"id": 2177,
"numeroPedido": "SCR-1891749686",
"tipo": "carrinho",
"data": "2022-02-02 13:47:02",
"dataEmail": "",
"dataRetorno": "",
"situacaoAtendimento": "",
"urlRecuperacao": "http://sandbox.wapstore.com.br/checkout/recuperacao?sessao=ilfg9jamaq9pc4sbq7gh7oaosr&utm_source=recuperacao&utm_medium=carrinho",
"paginaAbandono": "http://sandbox.wapstore.com.br/checkout/carrinho",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
},
"cliente": {
"id": 283194,
"nome": "Cliente Teste",
"email": "teste@wapstore.com.br",
"celular": "(99) 99999-9999",
"telefone": "",
"cpfCnpj": "85668863169",
"site": {
"id": 0,
"nome": "Principal",
"dominio": "localhost",
"tipo": "principal"
}
},
"produtos": [
{
"idProduto": 62,
"idAtributoValor": 0,
"nome": "Ar Condicionado",
"atributo": "",
"quantidade": 1,
"precoUnitario": 199,
"foto": "http://sandbox.wapstore.com.br/upload/lista-compra/imagem/m_arcondicionado.webp",
"personalizacoes": [],
"tipo": "produto"
}
]
}
],
"info": {
"filtros": {
"tipo": "carrinho|pagamento|orcamento"
},
"prev": "",
"self": "http://sandbox.wapstore.com.br/api/v2/sales-recovery?offset=0&limit=100&tipo=carrinho|pagamento|orcamento",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
recuperacoesVenda | Data Collection | Fila das recuperações vendas |
id | Number | ID da recuperação de venda |
numeroPedido | String | Número do pedido da recuperação do tipo pagamento |
tipo | String | Tipo da recuperação de venda Valores aceitos: carrinho, pagamento, orcamento |
data | String | Data da recuperação de venda |
dataEmail | String | Data de envio do e-mail da recuperação de venda |
dataRetorno | String | Data de retorno da recuperação de venda |
situacaoAtendimento | String | Informa a situação do atendimento que a recuperação de venda está |
urlRecuperacao | String | URL da recuperação de venda |
paginaAbandono | String | URL da página de abandono |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
cliente | Object | Cliente da recuperação de venda |
id | Number | ID do cliente da recuperação de venda |
nome | String | Nome do cliente da recuperação de venda |
String | E-mail do cliente da recuperação de venda | |
celular | String | Número de celular do cliente |
telefone | String | Número de telefone do cliente |
cpfCnpj | String | CPF/CNPJ do cliente da recuperação de venda |
site | Object | Canal da recuperação de venda (Deprecated) |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
canalVenda | Object | Canal da recuperação de venda |
id | Number | Id do canal de venda. |
nome | String | Nome do canal de venda. |
dominio | String | Domínio do canal de venda. |
tipo | String | Tipo do canal de venda. |
produtos | Data Collection | Produtos da recuperação de venda |
idProduto | Number | ID do produto da recuperação de venda |
idAtributoValor | Number | ID do atributo do produto da recuperação de venda |
nome | String | Nome do produto da recuperação de venda |
atributo | String | Atributo do produto da recuperação de venda |
quantidade | Number | Quantidade do produto da recuperação de venda |
precoUnitario | Number | Preço unitário do produto da recuperação de venda |
foto | String | Foto do produto/lista de compra da recuperação de venda |
personalizacoes | Data Collection | Personalizações do produto da recuperação de venda |
id | Number | ID da personalização do produto da recuperação de venda |
nome | String | Nome da personalização do produto da recuperação de venda |
tipo | String | Tipo da personalização do produto da recuperação de venda Valores aceitos: text, upload, select, checkbox |
valor | String | Valor da personalização do produto da recuperação de venda |
precoUnitario | Number | Preço unitário da personalização do produto da recuperação de venda |
tipo | String | Tipo do produto da recuperação de venda Valores aceitos: produto, listaCompra |
identificadoresFila | Array de números | Lista com os IDs das recuperações de vendas presentes na paginação |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por remover uma recuperação de vendas da fila de sincronização.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/sales-recovery/queue/{idRecuperacaoVenda} | ID da recuperação de vendas |
Limite de requisições por minuto | 12000 |
Recurso responsável por remover as recuperações de vendas em lote da fila de sincronização.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
Limite de requisições por minuto | 1000 |
{
"recuperacoesVenda": [
2000,
2001,
2002,
2003
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
recuperacoesVenda | Array de strings | Sim | Identificadores das recuperações vendas |
Recurso responsável por listar todos os detalhes sobre os armazéns.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | codigo: Filtra os armazéns pelos códigos internos. Envie um ou mais códigos separados por '|' Exemplo de requisição: /v2/warehouses?codigo=0001|armazem-0002 |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/warehouses?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"armazens": [
{
"id": 1,
"codigo": "0001",
"razaoSocial": "Armazém Principal",
"nomeFantasia": "São Paulo - SP",
"cnpj": "28.482.898/0001-09",
"email": "saopaulo@armazem.com.br",
"cep": "04664-000",
"cidade": "São Paulo",
"estado": "SP",
"endereco": "Avenida Manoel dos Reis Araújo",
"bairro": "Jardim Marajoara",
"numero": "201",
"telefone": "(11)99999-9999",
"ativo": true,
"principal": true,
"retirarNaLoja": true,
"sincronizarEstoqueWapConnect": false,
"cnaesBloqueados": [
"4322302",
"4753900",
"4757100",
"4755503"
],
"idMarketplaceSeller": "0",
"numeroTabela": "0",
"idTipoEstoque": 0,
"observacao": "Teste de observação"
},
{
"id": 5,
"codigo": "0005",
"razaoSocial": "Armazém Viamão",
"nomeFantasia": "Viamão - RS",
"cnpj": "41.454.024/0001-06",
"email": "viamao@armazem.com.br",
"cep": "94760-000",
"cidade": "Viamão",
"estado": "RS",
"endereco": "Rua das Azaléias",
"bairro": "Águas Claras",
"numero": "777",
"telefone": "(51)99999-9999",
"ativo": true,
"principal": false,
"retirarNaLoja": false,
"sincronizarEstoqueWapConnect": false,
"cnaesBloqueados": [],
"idMarketplaceSeller": "0",
"numeroTabela": "0",
"idTipoEstoque": 1,
"observacao": ""
}
],
"info":{
"filtros":[],
"prev":"",
"self":"https://sandbox.wapstore.com.br/api/v2/warehouses?offset=0&limit=100",
"next":"",
"offset":0,
"limit":100,
"exibindo":2,
"total":2
}
}
Campo | Tipo | Descrição |
---|---|---|
armazens | Data Collection | Armazéns disponíveis |
id | Number | ID do armazém |
codigo | String | Código único para identificação do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia do armazém |
cnpj | String | CNPJ do armazém |
String | E-mail do armazém | |
cep | String | CEP do armazém (somente números) |
cidade | String | Cidade do armazém |
estado | String | Estado (UF) do armazém |
endereco | String | Endereço do armazém |
bairro | String | Bairro do armazém |
numero | String | Número do endereço do armazém |
telefone | String | Telefone de contato do armazém |
ativo | Boolean | Define se o armazém está ativo |
principal | Boolean | Define se o armazém é principal |
retirarNaLoja | Boolean | Define se o armazém permite retirada na loja |
sincronizarEstoqueWapConnect | Boolean | Define se o estoque do armazém será sincronizado com o wap.connect |
idMarketplaceSeller | String | ID do seller vinculado ao armazém |
numeroTabela | String | Identificador da tabela de frete |
idTipoEstoque | Number | Identificador do tipo de estoque |
cnaesBloqueados | Array de números | CNAEs bloqueados |
observacao | String | Observação do armazém |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso de consulta individual de armazéns.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/warehouses/{idArmazem} | ID do Armazém |
Limite de requisições por minuto | 60 |
{
"id": 1,
"codigo": "0001",
"razaoSocial": "Armazém Principal",
"nomeFantasia": "São Paulo - SP",
"cnpj": "28.482.898/0001-09",
"email": "saopaulo@armazem.com.br",
"cep": "04664-000",
"cidade": "São Paulo",
"estado": "SP",
"endereco": "Avenida Manoel dos Reis Araújo",
"bairro": "Jardim Marajoara",
"numero": "201",
"telefone": "(11)99999-9999",
"ativo": true,
"principal": true,
"retirarNaLoja": true,
"sincronizarEstoqueWapConnect": false,
"cnaesBloqueados": [
"4322302",
"4753900",
"4757100",
"4755503"
],
"idMarketplaceSeller": "0",
"numeroTabela": "0",
"idTipoEstoque": 0,
"observacao": ""
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do armazém |
codigo | String | Código único para identificação do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia do armazém |
cnpj | String | CNPJ do armazém |
String | E-mail do armazém | |
cep | String | CEP do armazém (somente números) |
cidade | String | Cidade do armazém |
estado | String | Estado (UF) do armazém |
endereco | String | Endereço do armazém |
bairro | String | Bairro do armazém |
numero | String | Número do endereço do armazém |
telefone | String | Telefone de contato do armazém |
ativo | Boolean | Define se o armazém está ativo |
principal | Boolean | Define se o armazém é principal |
retirarNaLoja | Boolean | Define se o armazém permite retirada na loja |
sincronizarEstoqueWapConnect | Boolean | Define se o estoque do armazém será sincronizado com o wap.connect |
idMarketplaceSeller | String | ID do seller vinculado ao armazém |
numeroTabela | String | Identificador da tabela de frete |
idTipoEstoque | Number | Identificador do tipo de estoque |
cnaesBloqueados | Array de números | CNAEs bloqueados |
observacao | String | Observação do armazém |
Recurso responsável por cadastrar armazéns na plataforma.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"codigo": "025655418",
"razaoSocial": "Armazém Teste",
"nomeFantasia": "Novo Armazém",
"cnpj": "06447198000132",
"cep": "01153000",
"endereco": "Rua das Petúnias",
"numero": "111",
"bairro": "Bandeiras",
"telefone": "(18)99999-9999",
"email": "armazemteste@mail.com",
"principal": false,
"retirarNaLoja": false,
"sincronizarEstoqueWapConnect": false,
"cnaesBloqueados": [
4322302,
4753900
],
"observacao": "Teste de observação"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Sim | Código único para identificação do armazém Tamanho mínimo: 1 | Tamanho máximo: 50 |
razaoSocial | String | Sim | Razão social do armazém Tamanho mínimo: 1 | Tamanho máximo: 250 |
nomeFantasia | String | Sim | Nome fantasia do armazém Tamanho mínimo: 1 | Tamanho máximo: 250 |
cnpj | Number | Sim | CNPJ do armazém Tamanho mínimo: 14 | Tamanho máximo: 14 |
cep | String | Sim | CEP do armazém (somente números) Tamanho mínimo: 8 | Tamanho máximo: 8 |
endereco | String | Sim | Endereço do armazém Tamanho mínimo: 1 | Tamanho máximo: 250 |
numero | String | Sim | Número do endereço do armazém Tamanho mínimo: 1 | Tamanho máximo: 50 |
bairro | String | Sim | Bairro do armazém Tamanho mínimo: 1 | Tamanho máximo: 250 |
telefone | String | Não | Telefone de contato do armazém Tamanho máximo: 50 |
String | Sim | E-mail do armazém Tamanho máximo: 100 |
|
numeroTabela | Number | Não | Identificador da tabela de frete |
principal | Boolean | Não | Define se o armazém é principal (Redefine, caso true, o armazém principal da loja, o que irá impactar diretamente o funcionamento da mesma) |
retirarNaLoja | Boolean | Não | Define se o armazém permite retirada na loja |
sincronizarEstoqueWapConnect | Boolean | Não | Define se o estoque do armazém será sincronizado com o wap.connect |
cnaesBloqueados | Array de números | Não | CNAEs bloqueados |
observacao | String | Não | Observação do armazém |
{
"id": 1,
"codigo": "0001",
"razaoSocial": "Armazém Principal",
"nomeFantasia": "São Paulo - SP",
"cnpj": "28.482.898/0001-09",
"email": "saopaulo@armazem.com.br",
"cep": "04664-000",
"cidade": "São Paulo",
"estado": "SP",
"endereco": "Avenida Manoel dos Reis Araújo",
"bairro": "Jardim Marajoara",
"numero": "201",
"telefone": "(11)99999-9999",
"ativo": true,
"principal": true,
"retirarNaLoja": true,
"sincronizarEstoqueWapConnect": false,
"cnaesBloqueados": [
"4322302",
"4753900",
"4757100",
"4755503"
],
"idMarketplaceSeller": "0",
"numeroTabela": "0",
"idTipoEstoque": 0,
"observacao": ""
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do armazém |
codigo | String | Código único para identificação do armazém |
razaoSocial | String | Razão social do armazém |
nomeFantasia | String | Nome fantasia do armazém |
cnpj | String | CNPJ do armazém |
String | E-mail do armazém | |
cep | String | CEP do armazém (somente números) |
cidade | String | Cidade do armazém |
estado | String | Estado (UF) do armazém |
endereco | String | Endereço do armazém |
bairro | String | Bairro do armazém |
numero | String | Número do endereço do armazém |
telefone | String | Telefone de contato do armazém |
ativo | Boolean | Define se o armazém está ativo |
principal | Boolean | Define se o armazém é principal |
retirarNaLoja | Boolean | Define se o armazém permite retirada na loja |
sincronizarEstoqueWapConnect | Boolean | Define se o estoque do armazém será sincronizado com o wap.connect |
idMarketplaceSeller | String | ID do seller vinculado ao armazém |
numeroTabela | String | Identificador da tabela de frete |
idTipoEstoque | Number | Identificador do tipo de estoque |
cnaesBloqueados | Array de números | CNAEs bloqueados |
observacao | String | Observação do armazém |
Recurso responsável por listar todos os cupons cadastrados.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os cupons pelo seu status. Os status disponíveis são 'ativo' ou 'inativo' Exemplo de requisição: /v2/promotional/coupons/v2/promotional/coupons?status=ativo tipoCupom: Filtra os cupons pelo seu tipo. Os tipos disponíveis são 'manual' ou 'especial' Exemplo de requisição: /v2/promotional/coupons/v2/promotional/coupons?tipoCupom=manual conceder: Filtra os cupons pelo que ele irá conceder ao ser aplicado ao carrinho. Os filtros disponíveis são 'desconto' ou 'brinde' Exemplo de requisição: /v2/promotional/coupons/v2/promotional/coupons?conceder=desconto codigoUsuario: Filtra os cupons que tem vínculo com o usuário Exemplo de requisição: /v2/promotional/coupons?codigoUsuario=gerente emailUsuario: Filtra os cupons que tem vínculo com o usuário Exemplo de requisição: /v2/promotional/coupons?emailUsuario=maria@gmail.com idUsuario: Filtra os cupons que tem vínculo com o usuário Exemplo de requisição: /v2/promotional/coupons?idUsuario=550 |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/promotional/coupons?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"cupons": [
{
"id": 1,
"titulo": "Cupom Teste",
"hash": "cupomTeste",
"usuario": {
"id": 1,
"nome": "Roberto",
"email": "roberto.vendas@hotmail.com"
},
"ativo": "s",
"conceder": "desconto",
"tipoCupom": "m",
"idCupomBase": 0,
"tipoValorDesconto": "porcentagem",
"tipoDesconto": "p",
"descontoMenorFrete": "n",
"aplicacao": "total",
"valorDesconto": 15,
"valorMinimo": 400,
"qtdPodeSerUsado": 0,
"qtdUsado": 2,
"dataInicial": "2022-10-01 00:00:00",
"dataFinal": "2023-10-30 23:59:00",
"validadeDias": 0,
"observacao": "Cupom teste",
"clienteMinimoCompra": 0,
"clienteMaximoCompra": 5,
"clienteQuantidadeUtilizada": 0,
"segmentacao": {
"todasCategorias": true,
"todasLandingPages": true,
"todasMarcas": true,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"clientes": {
"minimo": 10,
"maximo": 100
},
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"segmentacaoNegativa": {
"excluirCategorias": false,
"excluirLandingPages": false,
"excluirMarcas": false,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"canaisVenda": [
0,3
],
"dataCriacao": "2022-06-09 12:00:00",
"dataEdicao": "2022-10-28 09:50:02",
"usuarioCriacao": "Usuário Teste",
"usuarioEdicao": "Usuário Teste",
"descontoProgressivo": [
{
"valor": "10.00",
"itens": "1"
},
{
"valor": "20.00",
"itens": "2"
},
{
"valor": "30.00",
"itens": "3"
}
]
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/promotional/coupons?offset=0&limit=1",
"next": "https://sandbox.wapstore.com.br/api/v2/promotional/coupons?offset=1&limit=1",
"offset": 0,
"limit": 1,
"exibindo": 1,
"total": 13
}
}
Campo | Tipo | Descrição |
---|---|---|
cupons | Data Collection | Listagem de cupons disponíveis |
id | Number | Identificador único do Cupom |
titulo | String | Título do cupom |
hash | String | Hash do cupom |
usuario | Object | Usuário representante vinculado no cupom |
id | Number | Id do usuário |
nome | String | Nome do usuário |
String | E-mail do usuário | |
ativo | String | Define se o cupom está ativo |
conceder | String | Define o que o cupom irá conceder ao ser aplicado no carrinho (desconto, brinde) |
tipoCupom | String | Define qual o tipo do cupom (manual - m, especial - e) |
idCupomBase | Number | Define qual o cupom que foi utilizado para gerar o cupom atual |
tipoValorDesconto | String | Tipo do valor do desconto (porcentagem, valor) |
tipoDesconto | String | Define se o desconto dado será simples ou progressivo (s, p) |
descontoMenorFrete | String | Define se irá conceder desconto no menor frete (s, n) |
aplicacao | String | Define onde será aplicado o desconto do frete (produtos, frete, total) |
valorDesconto | Number | Valor do desconto concedido pelo cupom |
valorMinimo | Number | Valor mínimo para um determinado cupom ser aplicado |
qtdPodeSerUsado | String | Quantidade de vezes que um cupom pode ser usado. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
qtdUsado | Number | Quantidade de vezes que o cupom foi usado |
dataInicial | String | Define a data que o cupom poderá ser aplicado |
dataFinal | String | Define a data que o cupom não poderá ser aplicado |
validadeDias | Number | Define a validade do cupom em dias |
observacao | String | Nota de observação de um cupom |
clienteMinimoCompra | Number | Define a quantidade mínima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteMaximoCompra | Number | Define a quantidade máxima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteQuantidadeUtilizar | String | Define a quantidade de vezes que um cupom pode ser utilizado pelo. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
segmentacao | Object | Define a segmentação e um cupom |
todasCategorias | Boolean | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Define se a segmentação será aplicada em todos os clientes |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
clientes | Object | Define as regras de segmentação de clientes |
minimo | Number | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Define as marcas segmentadas |
listasCompra | Object | Define as marcas segmentadas |
segmentacaoNegativa | Object | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Define se o cupom atual terá segmentação negativa de marcas |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
produtos | Object | Define os produtos da segmentação negativa |
listasCompra | Object | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Define os IDs dos canais de venda vinculado ao cupom |
dataCriacao | String | Data de criação do cupom |
dataEdicao | String | Data em que o cupom foi editado |
usuarioCriacao | String | Mostra qual o usuário que cadastrou determinado cupom |
usuarioEdicao | String | Mostra qual o último usuário que editou determinado cupom |
descontoProgressivo | Object | Valores do desconto progressivo de um cupom |
valor | Number | Define o valor do desconto |
itens | Number | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por buscar a informação de um cupom individualmente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/coupons/{idCupom} | ID do Cupom |
Limite de requisições por minuto | 240 |
{
"id": 1,
"titulo": "Cupom Teste",
"hash": "cupomTeste",
"usuario": {
"id": 1,
"nome": "Roberto",
"email": "roberto.vendas@hotmail.com"
},
"ativo": "s",
"conceder": "desconto",
"tipoCupom": "m",
"idCupomBase": 0,
"tipoValorDesconto": "porcentagem",
"tipoDesconto": "p",
"descontoMenorFrete": "n",
"aplicacao": "total",
"valorDesconto": 15,
"valorMinimo": 400,
"qtdPodeSerUsado": 0,
"qtdUsado": 2,
"dataInicial": "2022-10-01 00:00:00",
"dataFinal": "2023-10-30 23:59:00",
"validadeDias": 0,
"observacao": "Cupom teste",
"clienteMinimoCompra": 0,
"clienteMaximoCompra": 5,
"clienteQuantidadeUtilizada": 0,
"segmentacao": {
"todasCategorias": true,
"todasLandingPages": true,
"todasMarcas": true,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"clientes": {
"minimo": 10,
"maximo": 100
},
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"segmentacaoNegativa": {
"excluirCategorias": false,
"excluirLandingPages": false,
"excluirMarcas": false,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"canaisVenda": [
0,3
],
"dataCriacao": "2022-06-09 12:00:00",
"dataEdicao": "2022-10-28 09:50:02",
"usuarioCriacao": "Usuário Teste",
"usuarioEdicao": "Usuário Teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Cupom |
titulo | String | Título do cupom |
hash | String | Hash do cupom |
usuario | Object | Usuário representante vinculado no cupom |
id | Number | Id do usuário |
nome | String | Nome do usuário |
String | E-mail do usuário | |
ativo | String | Define se o cupom está ativo |
conceder | String | Define o que o cupom irá conceder ao ser aplicado no carrinho (desconto, brinde) |
tipoCupom | String | Define qual o tipo do cupom (manual - m, especial - e) |
idCupomBase | Number | Define qual o cupom que foi utilizado para gerar o cupom atual |
tipoValorDesconto | String | Tipo do valor do desconto (porcentagem, valor) |
tipoDesconto | String | Define se o desconto dado será simples ou progressivo (s, p) |
descontoMenorFrete | String | Define se irá conceder desconto no menor frete (s, n) |
aplicacao | String | Define onde será aplicado o desconto do frete (produtos, frete, total) |
valorDesconto | Number | Valor do desconto concedido pelo cupom |
valorMinimo | Number | Valor mínimo para um determinado cupom ser aplicado |
qtdPodeSerUsado | String | Quantidade de vezes que um cupom pode ser usado. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
qtdUsado | Number | Quantidade de vezes que o cupom foi usado |
dataInicial | String | Define a data que o cupom poderá ser aplicado |
dataFinal | String | Define a data que o cupom não poderá ser aplicado |
validadeDias | Number | Define a validade do cupom em dias |
observacao | String | Nota de observação de um cupom |
clienteMinimoCompra | Number | Define a quantidade mínima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteMaximoCompra | Number | Define a quantidade máxima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteQuantidadeUtilizar | String | Define a quantidade de vezes que um cupom pode ser utilizado pelo. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
segmentacao | Object | Define a segmentação e um cupom |
todasCategorias | Boolean | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Define se a segmentação será aplicada em todos os clientes |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
clientes | Object | Define as regras de segmentação de clientes |
minimo | Number | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Define as marcas segmentadas |
listasCompra | Object | Define as marcas segmentadas |
segmentacaoNegativa | Object | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Define se o cupom atual terá segmentação negativa de marcas |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
produtos | Object | Define os produtos da segmentação negativa |
listasCompra | Object | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Define os IDs dos canais de venda vinculado ao cupom |
dataCriacao | String | Data de criação do cupom |
dataEdicao | String | Data em que o cupom foi editado |
usuarioCriacao | String | Mostra qual o usuário que cadastrou determinado cupom |
usuarioEdicao | String | Mostra qual o último usuário que editou determinado cupom |
descontoProgressivo | Object | Valores do desconto progressivo de um cupom |
valor | Number | Define o valor do desconto |
itens | Number | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
Recurso responsável gerar um novo cupom.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 240 |
{
"titulo": "Cupom Teste",
"hash": "cupomTeste",
"tipo": "m",
"conceder": "desconto",
"valorMinimoCompra": 200,
"qtdPodeSerUsado": 10,
"limitePorCliente": 1,
"desconto": {
"aplicacao": "total",
"tipo": "s",
"unidade": "valor",
"valor": 100,
"progressivo": [
{
"valor": 10,
"itens": 1
},
{
"valor": 20,
"itens": 2
},
{
"valor": 30,
"itens": 3
}
]
},
"segmentacao": {
"todasCategorias": false,
"todasLandingPages": true,
"todasMarcas": false,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"marcas": [
81, 26
]
},
"segmentacaoNegativa": {
"excluirCategorias": false,
"excluirLandingPages": true,
"excluirMarcas": false,
"excluirProdutos": true,
"excluirListas": true,
"landingPages": [
4, 5, 6
],
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"canaisVenda": [
0,3
],
"validade": {
"inicio": "2023-02-01 00:00:00",
"fim": "2023-02-10 00:00:00"
},
"observacao": "Nota de observação do cupom",
"idUsuario": 1,
"ativo": true
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
titulo | String | Sim | Título do cupom |
hash | String | Sim | Define qual será a hash usada no cupom |
tipo | String | Sim | Define qual o tipo do cupom (m - manual, e - especial) Valores aceitos: m, e |
conceder | String | Sim | Define o que será adicionado quando o cupom for aplicado (desconto) Valores aceitos: desconto |
valorMinimoCompra | Number | Sim | Define qual o valor mínimo da compara para que o cupom seja aplicado |
qtdPodeSerUsado | String | Não | Define a quantidade máxima de cupons que poderão ser usadas |
limitePorCliente | String | Não | Define a quantidade máxima de cupons que um cliente poderá usar |
hashBrinde | String | Não | Define qual o brinde que será aplicado ao carrinho, quando o cupom for usado |
desconto | Object | Não | Configura os descontos que serão aplicados |
aplicacao | String | Não | Define onde será aplicado o desconto (produto, frete, total) Valores aceitos: produtos, frete, total |
menorFrete | Boolean | Não | Define onde será aplicado o desconto será aplicado no menor frete |
tipo | String | Não | Define o tipo do desconto (s - simples, p - progressivo) Valores aceitos: s, p |
unidade | String | Não | Define qual a unidade do desconto Valores aceitos: valor, porcentagem |
valor | Number | Não | Define o valor do desconto do cupom |
progressivo | Object | Não | Configura o desconto progressivo do cupom |
valor | Number | Não | Define o valor do desconto |
itens | Number | Não | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
validade | Object | Sim | Define a validade do cupom |
inicio | String | Não | Define a data inicial em que o cupom poderá ser usado |
fim | String | Não | Define a data em que o cupom não poderá ser mais usado |
dias | Number | Não | Define a validade do cupom em dias |
segmentacao | Object | Não | Define a segmentação e um cupom |
todasCategorias | Boolean | Não | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Não | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Não | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Não | Define se a segmentação será aplicada em todos os clientes |
todosProdutos | Boolean | Não | Define se a segmentação será aplicada em todos os produtos |
todasListas | Boolean | Não | Define se a segmentação será aplicada em todas as listas de compra |
categorias | Object | Não | Define as categorias segmentadas |
landingPages | Object | Não | Define as landing pages segmentadas |
marcas | Object | Não | Define as marcas segmentadas |
clientes | Object | Não | Define as regras de segmentação de clientes |
minimo | Number | Não | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Não | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Não | Define as marcas segmentadas |
listasCompra | Object | Não | Define as marcas segmentadas |
segmentacaoNegativa | Object | Não | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Não | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Não | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Não | Define se o cupom atual terá segmentação negativa de marcas |
excluirProdutos | Boolean | Não | Define se o cupom não poderá ser aplicado, quando alguns produtos estiverem no carrinho |
excluirListas | Boolean | Não | Define se o cupom não poderá ser aplicado, quando algumas listas de compra estiverem no carrinho |
categorias | Object | Não | Define as categorias segmentadas |
landingPages | Object | Não | Define as landing pages segmentadas |
marcas | Object | Não | Define as marcas segmentadas |
produtos | Object | Não | Define os produtos da segmentação negativa |
listasCompra | Object | Não | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Não | Define os IDs dos canais de venda vinculado ao cupom |
observacao | String | Não | Nota de observação do cupom |
idUsuario | Number | Não | Id do usuário, para vincular no cupom |
ativo | Boolean | Sim | Define se o cupom está ativo ou inativo |
{
"id": 1,
"titulo": "Cupom Teste",
"hash": "cupomTeste",
"usuario": {
"id": 1,
"nome": "Roberto",
"email": "roberto.vendas@hotmail.com"
},
"ativo": "s",
"conceder": "desconto",
"tipoCupom": "m",
"idCupomBase": 0,
"tipoValorDesconto": "porcentagem",
"tipoDesconto": "p",
"descontoMenorFrete": "n",
"aplicacao": "total",
"valorDesconto": 15,
"valorMinimo": 400,
"qtdPodeSerUsado": 0,
"qtdUsado": 2,
"dataInicial": "2022-10-01 00:00:00",
"dataFinal": "2023-10-30 23:59:00",
"validadeDias": 0,
"observacao": "Cupom teste",
"clienteMinimoCompra": 0,
"clienteMaximoCompra": 5,
"clienteQuantidadeUtilizada": 0,
"segmentacao": {
"todasCategorias": true,
"todasLandingPages": true,
"todasMarcas": true,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"clientes": {
"minimo": 10,
"maximo": 100
},
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"segmentacaoNegativa": {
"excluirCategorias": false,
"excluirLandingPages": false,
"excluirMarcas": false,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"canaisVenda": [
0,3
],
"dataCriacao": "2022-06-09 12:00:00",
"dataEdicao": "2022-10-28 09:50:02",
"usuarioCriacao": "Usuário Teste",
"usuarioEdicao": "Usuário Teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Cupom |
titulo | String | Título do cupom |
hash | String | Hash do cupom |
usuario | Object | Usuário representante vinculado no cupom |
id | Number | Id do usuário |
nome | String | Nome do usuário |
String | E-mail do usuário | |
ativo | String | Define se o cupom está ativo |
conceder | String | Define o que o cupom irá conceder ao ser aplicado no carrinho (desconto, brinde) |
tipoCupom | String | Define qual o tipo do cupom (manual - m, especial - e) |
idCupomBase | Number | Define qual o cupom que foi utilizado para gerar o cupom atual |
tipoValorDesconto | String | Tipo do valor do desconto (porcentagem, valor) |
tipoDesconto | String | Define se o desconto dado será simples ou progressivo (s, p) |
descontoMenorFrete | String | Define se irá conceder desconto no menor frete (s, n) |
aplicacao | String | Define onde será aplicado o desconto do frete (produtos, frete, total) |
valorDesconto | Number | Valor do desconto concedido pelo cupom |
valorMinimo | Number | Valor mínimo para um determinado cupom ser aplicado |
qtdPodeSerUsado | String | Quantidade de vezes que um cupom pode ser usado. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
qtdUsado | Number | Quantidade de vezes que o cupom foi usado |
dataInicial | String | Define a data que o cupom poderá ser aplicado |
dataFinal | String | Define a data que o cupom não poderá ser aplicado |
validadeDias | Number | Define a validade do cupom em dias |
observacao | String | Nota de observação de um cupom |
clienteMinimoCompra | Number | Define a quantidade mínima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteMaximoCompra | Number | Define a quantidade máxima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteQuantidadeUtilizar | String | Define a quantidade de vezes que um cupom pode ser utilizado pelo. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
segmentacao | Object | Define a segmentação e um cupom |
todasCategorias | Boolean | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Define se a segmentação será aplicada em todos os clientes |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
clientes | Object | Define as regras de segmentação de clientes |
minimo | Number | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Define as marcas segmentadas |
listasCompra | Object | Define as marcas segmentadas |
segmentacaoNegativa | Object | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Define se o cupom atual terá segmentação negativa de marcas |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
produtos | Object | Define os produtos da segmentação negativa |
listasCompra | Object | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Define os IDs dos canais de venda vinculado ao cupom |
dataCriacao | String | Data de criação do cupom |
dataEdicao | String | Data em que o cupom foi editado |
usuarioCriacao | String | Mostra qual o usuário que cadastrou determinado cupom |
usuarioEdicao | String | Mostra qual o último usuário que editou determinado cupom |
descontoProgressivo | Object | Valores do desconto progressivo de um cupom |
valor | Number | Define o valor do desconto |
itens | Number | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
Recurso responsável atualizar os dados de um cupom.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/coupons/{idCupom} | ID do Cupom |
Limite de requisições por minuto | 240 |
{
"desconto": {
"valor": 75
},
"segmentacao": {
"todasCategorias": false,
"todasLandingPages": true,
"todasMarcas": false,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"marcas": [
81, 26
]
},
"canaisVenda": [
0,3
],
"idUsuario": 0
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
titulo | String | Não | Título do cupom |
hash | String | Não | Define qual será a hash usada no cupom |
tipo | String | Não | Define qual o tipo do cupom (m - manual, e - especial) Valores aceitos: m, e |
conceder | String | Não | Define o que será adicionado quando o cupom for aplicado (desconto) Valores aceitos: desconto |
valorMinimoCompra | Number | Não | Define qual o valor mínimo da compara para que o cupom seja aplicado |
qtdPodeSerUsado | String | Não | Define a quantidade máxima de cupons que poderão ser usadas |
limitePorCliente | String | Não | Define a quantidade máxima de cupons que um cliente poderá usar |
hashBrinde | String | Não | Define qual o brinde que será aplicado ao carrinho, quando o cupom for usado |
desconto | Object | Não | Configura os descontos que serão aplicados |
aplicacao | String | Não | Define onde será aplicado o desconto (produto, frete, total) Valores aceitos: produtos, frete, total |
menorFrete | Boolean | Não | Define onde será aplicado o desconto será aplicado no menor frete |
tipo | String | Não | Define o tipo do desconto (s - simples, p - progressivo) Valores aceitos: s, p |
unidade | String | Não | Define qual a unidade do desconto Valores aceitos: valor, porcentagem |
valor | Number | Não | Define o valor do desconto do cupom |
progressivo | Object | Não | Configura o desconto progressivo do cupom |
valor | Number | Não | Define o valor do desconto |
itens | Number | Não | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
validade | Object | Não | Define a validade do cupom |
inicio | String | Não | Define a data inicial em que o cupom poderá ser usado |
fim | String | Não | Define a data em que o cupom não poderá ser mais usado |
dias | Number | Não | Define a validade do cupom em dias |
segmentacao | Object | Não | Define a segmentação e um cupom |
todasCategorias | Boolean | Não | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Não | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Não | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Não | Define se a segmentação será aplicada em todos os clientes |
todosProdutos | Boolean | Não | Define se a segmentação será aplicada em todos os produtos |
todasListas | Boolean | Não | Define se a segmentação será aplicada em todas as listas de compra |
categorias | Object | Não | Define as categorias segmentadas |
landingPages | Object | Não | Define as landing pages segmentadas |
marcas | Object | Não | Define as marcas segmentadas |
clientes | Object | Não | Define as regras de segmentação de clientes |
minimo | Number | Não | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Não | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Não | Define as marcas segmentadas |
listasCompra | Object | Não | Define as marcas segmentadas |
segmentacaoNegativa | Object | Não | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Não | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Não | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Não | Define se o cupom atual terá segmentação negativa de marcas |
excluirProdutos | Boolean | Não | Define se o cupom não poderá ser aplicado, quando alguns produtos estiverem no carrinho |
excluirListas | Boolean | Não | Define se o cupom não poderá ser aplicado, quando algumas listas de compra estiverem no carrinho |
categorias | Object | Não | Define as categorias segmentadas |
landingPages | Object | Não | Define as landing pages segmentadas |
marcas | Object | Não | Define as marcas segmentadas |
produtos | Object | Não | Define os produtos da segmentação negativa |
listasCompra | Object | Não | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Não | Define os IDs dos canais de venda vinculado ao cupom |
observacao | String | Não | Nota de observação do cupom |
idUsuario | Number | Não | Id do usuário, para vincular no cupom |
ativo | Boolean | Não | Define se o cupom está ativo ou inativo |
{
"id": 1,
"titulo": "Cupom Teste",
"hash": "cupomTeste",
"usuario": {
"id": 1,
"nome": "Roberto",
"email": "roberto.vendas@hotmail.com"
},
"ativo": "s",
"conceder": "desconto",
"tipoCupom": "m",
"idCupomBase": 0,
"tipoValorDesconto": "porcentagem",
"tipoDesconto": "p",
"descontoMenorFrete": "n",
"aplicacao": "total",
"valorDesconto": 15,
"valorMinimo": 400,
"qtdPodeSerUsado": 0,
"qtdUsado": 2,
"dataInicial": "2022-10-01 00:00:00",
"dataFinal": "2023-10-30 23:59:00",
"validadeDias": 0,
"observacao": "Cupom teste",
"clienteMinimoCompra": 0,
"clienteMaximoCompra": 5,
"clienteQuantidadeUtilizada": 0,
"segmentacao": {
"todasCategorias": true,
"todasLandingPages": true,
"todasMarcas": true,
"todosClientes": true,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"clientes": {
"minimo": 10,
"maximo": 100
},
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"segmentacaoNegativa": {
"excluirCategorias": false,
"excluirLandingPages": false,
"excluirMarcas": false,
"categorias": [
1, 2, 3
],
"landingPages": [
4, 5, 6
],
"marcas": [
81, 26
],
"produtos": [
"produto1", "produto2"
],
"listasCompra": [
"lista1", "lista2"
]
},
"canaisVenda": [
0,3
],
"dataCriacao": "2022-06-09 12:00:00",
"dataEdicao": "2022-10-28 09:50:02",
"usuarioCriacao": "Usuário Teste",
"usuarioEdicao": "Usuário Teste"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Cupom |
titulo | String | Título do cupom |
hash | String | Hash do cupom |
usuario | Object | Usuário representante vinculado no cupom |
id | Number | Id do usuário |
nome | String | Nome do usuário |
String | E-mail do usuário | |
ativo | String | Define se o cupom está ativo |
conceder | String | Define o que o cupom irá conceder ao ser aplicado no carrinho (desconto, brinde) |
tipoCupom | String | Define qual o tipo do cupom (manual - m, especial - e) |
idCupomBase | Number | Define qual o cupom que foi utilizado para gerar o cupom atual |
tipoValorDesconto | String | Tipo do valor do desconto (porcentagem, valor) |
tipoDesconto | String | Define se o desconto dado será simples ou progressivo (s, p) |
descontoMenorFrete | String | Define se irá conceder desconto no menor frete (s, n) |
aplicacao | String | Define onde será aplicado o desconto do frete (produtos, frete, total) |
valorDesconto | Number | Valor do desconto concedido pelo cupom |
valorMinimo | Number | Valor mínimo para um determinado cupom ser aplicado |
qtdPodeSerUsado | String | Quantidade de vezes que um cupom pode ser usado. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
qtdUsado | Number | Quantidade de vezes que o cupom foi usado |
dataInicial | String | Define a data que o cupom poderá ser aplicado |
dataFinal | String | Define a data que o cupom não poderá ser aplicado |
validadeDias | Number | Define a validade do cupom em dias |
observacao | String | Nota de observação de um cupom |
clienteMinimoCompra | Number | Define a quantidade mínima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteMaximoCompra | Number | Define a quantidade máxima de compras que um cliente precisa ter efetuado, para que o cupom possa ser aplicado |
clienteQuantidadeUtilizar | String | Define a quantidade de vezes que um cupom pode ser utilizado pelo. Pode ser o valor 'i' (ilimitado) ou valores numéricos |
segmentacao | Object | Define a segmentação e um cupom |
todasCategorias | Boolean | Define se a segmentação será aplicada em todas as categorias |
todasLandingPages | Boolean | Define se a segmentação será aplicada em todas as landing pages |
todasMarcas | Boolean | Define se a segmentação será aplicada em todas as marcas |
todosClientes | Boolean | Define se a segmentação será aplicada em todos os clientes |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
clientes | Object | Define as regras de segmentação de clientes |
minimo | Number | Define o valor mínimo de compras que o cliente efetuou para aplicar o cupom |
maximo | Number | Define o valor máximo de compras que o cliente efetuou para aplicar o cupom |
produtos | Object | Define as marcas segmentadas |
listasCompra | Object | Define as marcas segmentadas |
segmentacaoNegativa | Object | Define a segmentação negativa e um cupom |
excluirCategorias | Boolean | Define se o cupom atual terá segmentação negativa de categorias |
excluirLandingPages | Boolean | Define se o cupom atual terá segmentação negativa de landing pages |
excluirMarcas | Boolean | Define se o cupom atual terá segmentação negativa de marcas |
categorias | Object | Define as categorias segmentadas |
landingPages | Object | Define as landing pages segmentadas |
marcas | Object | Define as marcas segmentadas |
produtos | Object | Define os produtos da segmentação negativa |
listasCompra | Object | Define as listas de compras com segmentação negativa |
canaisVenda | Object | Define os IDs dos canais de venda vinculado ao cupom |
dataCriacao | String | Data de criação do cupom |
dataEdicao | String | Data em que o cupom foi editado |
usuarioCriacao | String | Mostra qual o usuário que cadastrou determinado cupom |
usuarioEdicao | String | Mostra qual o último usuário que editou determinado cupom |
descontoProgressivo | Object | Valores do desconto progressivo de um cupom |
valor | Number | Define o valor do desconto |
itens | Number | Define a quantidade de itens no carrinho para que o desconto seja aplicado |
Recurso responsável remover um cupom.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/promotional/coupons/{idCupom} | ID do Cupom |
Limite de requisições por minuto | 240 |
Recurso responsável por listar todos os vouchers cadastrados.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os vouchers pelo seu status. Os status disponíveis são 'disponivel' ou 'indisponivel' Exemplo de requisição: /v2/promotional/vouchers/v2/promotional/vouchers?status=disponivel freteGratis: Filtra os vouchers pelo frete grátis. Os tipos disponíveis são 's' ou 'n' Exemplo de requisição: /v2/promotional/vouchers/v2/promotional/vouchers?freteGratis=n idCliente: Filtra os dados pelo id do cliente Exemplo de requisição: /v2/promotional/vouchers/v2/promotional/vouchers?idCliente=1 codigoCliente: Filtra os dados pelo código do cliente Exemplo de requisição: /v2/promotional/vouchers/v2/promotional/vouchers?codigoCliente=codigo123 |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/promotional/vouchers?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"voucher": [
{
"id": 1,
"hash": "f510fb0a",
"valor": 390,
"idPedido": 0,
"disponivel": false,
"freteGratis": true,
"usuario": "wapstore (api)",
"observacao": "Utilizado no pedido SCR-28650",
"ativo": true,
"dataCriacao": "2023-08-30 14:03:52",
"dataAtualizacao": "2023-08-30 17:50:30",
"cliente": {
"nome": "Cliente Teste",
"id": 1
}
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/promotional/vouchers?offset=0&limit=1",
"next": "",
"offset": 0,
"limit": 1,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
voucher | Data Collection | Listagem de vouchers disponíveis |
id | Number | Identificador único do Voucher |
hash | String | Hash do voucher |
valor | Number | Valor do voucher |
idPedido | Number | Identificador único do Pedido |
disponivel | Boolean | Define se o voucher está disponível para uso |
freteGratis | Boolean | Define se o voucher aplicará frete grátis |
usuario | String | Usuário de criação do voucher |
observacao | String | Observação do voucher |
ativo | Boolean | Define se o voucher está ativo |
dataCriacao | String | Data de criação do voucher |
dataAtualizacao | String | Data de atualização do voucher |
cliente | Object | Informações do cliente |
nome | String | Nome do cliente que possui o voucher |
id | Number | Identificador único do Cliente |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por buscar a informação de um voucher individualmente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/vouchers/{idHashVoucher} | ID ou HASH do Voucher |
Filtros | identificador: Faz a busca pelo id ou hash do voucher. Os status disponíveis são 'id' ou 'hash' Exemplo de requisição: /v2/promotional/vouchers/{idHashVoucher}/v2/promotional/vouchers/1?identificador=id |
Limite de requisições por minuto | 240 |
{
"id": 91,
"hash": "9c3c0897",
"valor": 390,
"idPedido": 0,
"disponivel": true,
"freteGratis": false,
"usuario": "wapstore (api)",
"observacao": "Utilizado no pedido SCR-28650",
"ativo": true,
"dataCriacao": "2023-08-30 14:03:57",
"dataAtualizacao": "",
"cliente": {
"nome": "Cliente Teste",
"id": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Voucher |
hash | String | Hash do voucher |
valor | Number | Valor do voucher |
idPedido | Number | Identificador único do Pedido |
disponivel | Boolean | Define se o voucher está disponível para uso |
freteGratis | Boolean | Define se o voucher aplicará frete grátis |
usuario | String | Usuário de criação do voucher |
observacao | String | Observação do voucher |
ativo | Boolean | Define se o voucher está ativo |
dataCriacao | String | Data de criação do voucher |
dataAtualizacao | String | Data de atualização do voucher |
cliente | Object | Informações do cliente |
nome | String | Nome do cliente que possui o voucher |
id | Number | Identificador único do Cliente |
Recurso responsável gerar um novo voucher.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 240 |
{
"cliente": {
"id": 1,
"codigo": "codigo123",
"email": "usuario@email.com",
"cpfCnpj": "99999999999"
},
"valor": 390,
"freteGratis": "n",
"observacao": "Ainda não utilizado"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cliente | Object | Sim | Objeto do Cliente |
id | Number | Não | Identificador único do cliente |
codigo | String | Não | Código do cliente |
String | Não | Email do cliente | |
cpfCnpj | String | Não | CPF ou CNPJ do cliente |
valor | Number | Sim | Define o valor do voucher |
freteGratis | String | Não | Define se o voucher aplicará frete grátis Valores aceitos: s, n |
observacao | String | Não | Observação do voucher |
{
"id": 91,
"hash": "9c3c0897",
"valor": 390,
"idPedido": 0,
"disponivel": true,
"freteGratis": false,
"usuario": "wapstore (api)",
"observacao": "Utilizado no pedido SCR-28650",
"ativo": true,
"dataCriacao": "2023-08-30 14:03:57",
"dataAtualizacao": "",
"cliente": {
"nome": "Cliente Teste",
"id": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Voucher |
hash | String | Hash do voucher |
valor | Number | Valor do voucher |
idPedido | Number | Identificador único do Pedido |
disponivel | Boolean | Define se o voucher está disponível para uso |
freteGratis | Boolean | Define se o voucher aplicará frete grátis |
usuario | String | Usuário de criação do voucher |
observacao | String | Observação do voucher |
ativo | Boolean | Define se o voucher está ativo |
dataCriacao | String | Data de criação do voucher |
dataAtualizacao | String | Data de atualização do voucher |
cliente | Object | Informações do cliente |
nome | String | Nome do cliente que possui o voucher |
id | Number | Identificador único do Cliente |
Recurso responsável por atualizar um voucher.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/vouchers/{idHashVoucher} | ID ou HASH do Voucher |
Filtros | identificador: Define qual o identificador será utilizado para a consulta do voucher. Os valores aceitos são 'id' ou 'hash' Exemplo de requisição: /v2/promotional/vouchers/{idHashVoucher}?identificador=id |
Limite de requisições por minuto | 240 |
{
"disponivel": false,
"observacao":"Utilizado no pedido SCR-28650"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
disponivel | Boolean | Sim | Define se o voucher está disponível ou não |
observacao | String | Não | Observação do voucher |
{
"id": 91,
"hash": "9c3c0897",
"valor": 390,
"idPedido": 0,
"disponivel": true,
"freteGratis": false,
"usuario": "wapstore (api)",
"observacao": "Utilizado no pedido SCR-28650",
"ativo": true,
"dataCriacao": "2023-08-30 14:03:57",
"dataAtualizacao": "",
"cliente": {
"nome": "Cliente Teste",
"id": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do Voucher |
hash | String | Hash do voucher |
valor | Number | Valor do voucher |
idPedido | Number | Identificador único do Pedido |
disponivel | Boolean | Define se o voucher está disponível para uso |
freteGratis | Boolean | Define se o voucher aplicará frete grátis |
usuario | String | Usuário de criação do voucher |
observacao | String | Observação do voucher |
ativo | Boolean | Define se o voucher está ativo |
dataCriacao | String | Data de criação do voucher |
dataAtualizacao | String | Data de atualização do voucher |
cliente | Object | Informações do cliente |
nome | String | Nome do cliente que possui o voucher |
id | Number | Identificador único do Cliente |
Recurso responsável remover um voucher.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/promotional/vouchers/{id} | ID do Voucher |
Limite de requisições por minuto | 240 |
Recurso responsável por listar todos os lotes de gift cards disponíveis.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os lotes de gift cards pelo seu prefixo. Exemplo de requisição: /v2/promotional/gift-cards/batch/v2/promotional/gift-cards?prefixo=DIA-DOS-PAIS|DIA-DAS-MAES |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/promotional/gift-cards/batch?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"lotes": [
{
"id": 7,
"prefixo": "DIA-DOS-PAIS",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 12:58:19"
},
{
"id": 8,
"prefixo": "DIA-DAS-MAES",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 13:17:23"
},
{
"id": 10,
"prefixo": "NATAL-ANO-NOVO",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 13:31:59"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/promotional/gift-cards/batch?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 3,
"total": 3
}
}
Campo | Tipo | Descrição |
---|---|---|
lotes | Data Collection | Listagem de lotes de gift cards disponíveis |
id | Number | ID do lote de gift card |
prefixo | String | Prefixo do lote de gift card |
usuario | Object | Dados do usuário que criou o lote de gift cards |
id | Number | ID do usuário que criou o lote de gift cards |
nome | String | Nome do usuário que criou o lote de gift cards |
dataCriacao | String | Data de criação do lote de gift cards |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por buscar a informação de um lote de gift card individualmente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/gift-cards/batch/{idLote} | ID do lote do gift card |
Limite de requisições por minuto | 240 |
{
"id": 7,
"prefixo": "DIA-DOS-PAIS",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 12:58:19"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote de gift card |
prefixo | String | Prefixo do lote de gift card |
usuario | Object | Dados do usuário que criou o lote de gift cards |
id | Number | ID do usuário que criou o lote de gift cards |
nome | String | Nome do usuário que criou o lote de gift cards |
dataCriacao | String | Data de criação do lote de gift cards |
Recurso responsável por criar um lote e seus gift cards.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 240 |
{
"prefixo": "NATAL-ANO-NOVO",
"valor": 100,
"quantidade": 300
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
prefixo | String | Sim | Prefixo do lote de gift card |
valor | Number | Sim | Valor dos gift cards do lote |
quantidade | Number | Sim | Quantidade de gift cards que serão gerados no lote |
{
"id": 7,
"prefixo": "DIA-DOS-PAIS",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 12:58:19"
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do lote de gift card |
prefixo | String | Prefixo do lote de gift card |
usuario | Object | Dados do usuário que criou o lote de gift cards |
id | Number | ID do usuário que criou o lote de gift cards |
nome | String | Nome do usuário que criou o lote de gift cards |
dataCriacao | String | Data de criação do lote de gift cards |
Recurso responsável remover todos os gift cards disponíveis de um lote, caso lote fique vazio após a remoção ele também será removido.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/promotional/gift-cards/batch/{idLote} | ID do lote do gift card |
Limite de requisições por minuto | 240 |
Recurso responsável por listar todos os gift cards disponíveis.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra os gift cards pelo seu status. Os status disponíveis são 'disponivel' ou 'resgatado' Exemplo de requisição: /v2/promotional/gift-cards/v2/promotional/gift-cards?status=disponivel|resgatado prefixoLote: Filtra os gift cards através dos prefixos de lote. Exemplo de requisição: /v2/promotional/gift-cards/v2/promotional/gift-cards?prefixoLote=DIA-DOS-PAIS|DIA-DAS-MAES idLote: Filtra os gift cards através dos IDs de lote. Exemplo de requisição: /v2/promotional/gift-cards/v2/promotional/gift-cards?idLote=1|2|3 |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/promotional/gift-cards?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"giftCards": [
{
"id": 7,
"codigo": "DIA-DOS-PAIS-1eaa98ba",
"valor": 200.34,
"status": "disponivel",
"idLote": 7
},
{
"id": 7,
"codigo": "DIA-DOS-PAIS-d3d650a7",
"valor": 200.34,
"status": "disponivel",
"idLote": 7
},
{
"id": 7,
"codigo": "DIA-DOS-PAIS-1b50960c",
"valor": 200.34,
"status": "disponivel",
"idLote": 7
},
{
"id": 7,
"codigo": "DIA-DOS-PAIS-261d26f6",
"valor": 200.34,
"status": "disponivel",
"idLote": 7
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/promotional/gift-cards?offset=0&limit=100",
"next": "http://localhost/v2/promotional/gift-cards?offset=100&limit=100",
"offset": 0,
"limit": 100,
"exibindo": 4,
"total": 4
}
}
Campo | Tipo | Descrição |
---|---|---|
giftCards | Data Collection | Listagem de gift cards disponíveis |
id | Number | Identificador único do gift card |
codigo | String | Codigo do gift card |
valor | Number | Valor do gift card |
status | String | Status do gift card Valores aceitos: disponivel, resgatado |
idLote | Number | Id do lote do gift card |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por buscar a informação de um gift card individualmente.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/promotional/gift-cards/{idCodigoGiftCard} | ID ou código do gift card |
Filtros | identificador: Faz a busca pelo id ou código do gift card. Exemplo de requisição: /v2/promotional/gift-cards/{idCodigoGiftCard}/v2/promotional/gift-cards/1?identificador=id |
Limite de requisições por minuto | 240 |
{
"id": 7,
"codigo": "DIA-DOS-PAIS-86f628fd",
"valor": 200.34,
"status": "disponivel",
"lote": {
"id": 7,
"prefixo": "DIA-DOS-PAIS",
"usuario": {
"id": 12,
"nome": "Integração completa"
},
"dataCriacao": "2023-09-14 12:58:19"
}
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Identificador único do gift card |
codigo | String | Codigo do gift card |
valor | Number | Valor do gift card |
status | String | Status do gift card Valores aceitos: disponivel, resgatado |
lote | Object | Lote em que o gift card foi criado |
id | Number | ID do lote de gift card |
prefixo | String | Prefixo do lote de gift card |
usuario | Object | Dados do usuário que criou o lote de gift cards |
id | Number | ID do usuário que criou o lote de gift cards |
nome | String | Nome do usuário que criou o lote de gift cards |
dataCriacao | String | Data de criação do lote de gift cards |
Recurso responsável remover um gift card.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/promotional/gift-cards/{idGiftCard} | ID do gift card |
Limite de requisições por minuto | 240 |
Recurso responsável por listar todas as análises de comissões.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | status: Filtra as análises de comissão por status. Os status disponíveis são 'aguardando', 'aprovado' ou 'negado' Exemplo de requisição: /v2/commission-analysis/v2/commission-analysis?status=aguardando idIntermediador: Filtra as análises de comissão pelo id do cliente intermediador Exemplo de requisição: /v2/commission-analysis/v2/commission-analysis?idIntermediador=123 codigoIntermediador: Filtra as análises de comissão pelo código do cliente intermediador Exemplo de requisição: /v2/commission-analysis/v2/commission-analysis?codigoIntermediador=desconto |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/commission-analysis?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"analises": [
{
"id": 1,
"codigo": "analise-1",
"titulo": "Análise de Comissão de Maio",
"status": "aguardando",
"observacao": "",
"canalVenda": {
"id": 0,
"codigo": "",
"nome": "Loja Uappi Modelo",
"dominio": "www.loja-uappi.com.br",
"principal": true,
"canalPai": {}
},
"idCliente": 89,
"valorTotalVenda": 0,
"valorTotalComissao": 136.97,
"competencia": "",
"dataInicialEnvioNota": "2024-05-01",
"dataFinalEnvioNota": "2024-05-05"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://www.loja-uappi.com.br/api/v2/commission-analysis?offset=0&limit=1",
"next": "http://www.loja-uappi.com.br/api/v2/commission-analysis?offset=1&limit=1",
"offset": 0,
"limit": 1,
"exibindo": 1,
"total": 12
}
}
Campo | Tipo | Descrição |
---|---|---|
analises | Data Collection | Listagem das análise de comissão |
id | Number | ID da análise de comissão |
codigo | String | Código externo da análise de comissão |
titulo | String | Título da análise de comissão |
status | String | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Mensagem de observação da análise de comissão |
canalVenda | Object | Dados do canal de venda vinculado |
id | Number | Id do canal |
codigo | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
idCliente | Number | ID do cliente intermediador |
competencia | String | Data da análise de comissão |
dataInicialEnvioNota | String | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
pedidos | Array | Array com os dados dos pedidos gerados pelo cliente intermediador |
0 | ||
valorTotalComissao | Number | Valor total da comissões |
valorTotalVenda | Number | Valor total de venda |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por mostrar as informações detalhadas de uma análise de comissão.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/commission-analysis/{idCodigoAnalise} | ID ou o código externo da análise de comissão buscada |
Filtros | identificador: Define qual o identificador será utilizado para a consulta da análise. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/commission-analysis/{idCodigoAnalise}?identificador=id |
Limite de requisições por minuto | 240 |
{
"id": 1,
"codigo": "analise-1",
"titulo": "Análise de Comissão de Maio",
"status": "aguardando",
"observacao": "",
"canalVenda": {
"id": 7,
"codigo": "",
"nome": "Loja Scrum",
"dominio": "www.loja-uappi.com.br",
"principal": false,
"canalPai": {
"id": 6,
"nome": "www.loja.com.br"
}
},
"idCliente": 89,
"valorTotalVenda": 336.82,
"valorTotalComissao": 15,
"competencia": "2024-04",
"dataInicialEnvioNota": "2024-05-26",
"dataFinalEnvioNota": "2024-06-04",
"pedidos": [
{
"id": 2,
"numeroPedido": "",
"nomeCliente": "",
"cpfCnpj": "",
"nf": "132456789",
"valorComissao": 100,
"porcentagemComissao": 5,
"tipo": "devolucao",
"dataEmissao": "2023-04-29"
},
{
"id": 59,
"numeroPedido": "WAP-123",
"nomeCliente": "Cliente Final",
"cpfCnpj": "81160811288",
"nf": "1231",
"valorTotal": 118.94,
"valorComissao": 5,
"porcentagemComissao": 5,
"tipo": "venda",
"dataEmissao": "2024-05-26"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID da análise de comissão |
codigo | String | Código externo da análise de comissão |
titulo | String | Título da análise de comissão |
status | String | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Mensagem de observação da análise de comissão |
canalVenda | Object | Dados do canal de venda vinculado |
id | Number | Id do canal |
codigo | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
idCliente | Number | ID do cliente intermediador |
competencia | String | Data da análise de comissão |
dataInicialEnvioNota | String | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
pedidos | Array | Array com os dados dos pedidos gerados pelo cliente intermediador |
0 | ||
valorTotalComissao | Number | Valor total da comissões |
valorTotalVenda | Number | Valor total de venda |
Recurso responsável por cadastrar uma nova análise de comissão.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 240 |
{
"titulo": "Análise de Comissão de Maio",
"codigo": "analise-1",
"idCanalVenda": 7,
"pedidos": [
{
"numeroPedido": "WAP-123",
"dataEmissao": "2024-05-26",
"cliente": {
"nome": "Cliente Teste",
"cpfCnpj": "12345678910"
},
"nf": "123456789",
"comissao": {
"valor": 5.00,
"porcentagem": 5.0
},
"tipo": "venda",
"valorTotal": 118.94
}
],
"idCliente": 89,
"competencia": "2024-05",
"dataInicialEnvioNota": "2024-05-15",
"dataFinalEnvioNota": "2024-05-26"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
titulo | String | Sim | Título da análise de comissão |
codigo | String | Não | Código externo da análise de comissão |
pedidos | Data Collection | Sim | Array com os dados dos pedidos gerados pelo cliente intermediador |
numeroPedido | String | Não | Número do pedido gerado |
dataEmissao | String | Sim | Data de criação do pedido |
cliente | Object | Não | Objeto com os dados do cliente final |
nome | String | Não | Nome do cliente que foi intermediado |
cpfCnpj | String | Não | CPF ou CNPJ do cliente que foi intermediado |
nf | String | Sim | Número da nota fiscal do pedido |
comissao | Object | Sim | Dados da comissão do pedido |
valor | Number | Sim | Valor da comissão recebida pelo cliente intermediador Valor mínimo: 0 |
porcentagem | Number | Sim | Percentual da comissão recebida pelo cliente intermediador Valor mínimo: 0 | Valor máximo: 100 |
tipo | String | Não | Define qual a operação do pedido atual Valores aceitos: venda, devolucao |
valorTotal | Number | Não | Valor total do pedido |
idCanalVenda | Number | Não | ID do canal de venda |
idCliente | Number | Sim | ID do cliente intermediador |
codigoCliente | String | Não | Código externo do cliente |
competencia | String | Sim | Identifica a data da análise de comissão |
dataInicialEnvioNota | String | Sim | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Sim | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
status | String | Não | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Não | Mensagem de observação da análise de comissão. A observação só será cadastrada caso o status seja diferente de 'aguardando' |
{
"id": 1,
"codigo": "analise-1",
"titulo": "Análise de Comissão de Maio",
"status": "aguardando",
"observacao": "",
"canalVenda": {
"id": 7,
"codigo": "",
"nome": "Loja Scrum",
"dominio": "www.loja-uappi.com.br",
"principal": false,
"canalPai": {
"id": 6,
"nome": "www.loja.com.br"
}
},
"idCliente": 89,
"valorTotalVenda": 336.82,
"valorTotalComissao": 15,
"competencia": "2024-04",
"dataInicialEnvioNota": "2024-05-26",
"dataFinalEnvioNota": "2024-06-04",
"pedidos": [
{
"id": 2,
"numeroPedido": "",
"nomeCliente": "",
"cpfCnpj": "",
"nf": "132456789",
"valorComissao": 100,
"porcentagemComissao": 5,
"tipo": "devolucao",
"dataEmissao": "2023-04-29"
},
{
"id": 59,
"numeroPedido": "WAP-123",
"nomeCliente": "Cliente Final",
"cpfCnpj": "81160811288",
"nf": "1231",
"valorTotal": 118.94,
"valorComissao": 5,
"porcentagemComissao": 5,
"tipo": "venda",
"dataEmissao": "2024-05-26"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID da análise de comissão |
codigo | String | Código externo da análise de comissão |
titulo | String | Título da análise de comissão |
status | String | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Mensagem de observação da análise de comissão |
canalVenda | Object | Dados do canal de venda vinculado |
id | Number | Id do canal |
codigo | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
idCliente | Number | ID do cliente intermediador |
competencia | String | Data da análise de comissão |
dataInicialEnvioNota | String | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
pedidos | Array | Array com os dados dos pedidos gerados pelo cliente intermediador |
0 | ||
valorTotalComissao | Number | Valor total da comissões |
valorTotalVenda | Number | Valor total de venda |
Recurso responsável por atualizar uma nova análise de comissão.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/commission-analysis/{idCodigoAnalise} | ID ou código externo da análise de comissão a ser atualizada |
Filtros | identificador: Define qual o identificador será utilizado para a consulta da análise. Os valores aceitos são 'id' ou 'codigo' Exemplo de requisição: /v2/commission-analysis/{idCodigoAnalise}?identificador=id |
Limite de requisições por minuto | 240 |
{
"codigo": "analise-1",
"idCanalVenda": 7,
"pedidos": [
{
"numeroPedido": "WAP-123",
"dataEmissao": "2024-05-26",
"cliente": {
"nome": "Cliente Teste",
"cpfCnpj": "12345678910"
},
"nf": "123456789",
"comissao": {
"valor": 5.00,
"porcentagem": 5.0
},
"tipo": "venda",
"valorTotal": 118.94
}
],
"status": "negado"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
codigo | String | Não | Código externo da análise de comissão |
pedidos | Data Collection | Não | Array com os dados dos pedidos gerados pelo cliente intermediador |
numeroPedido | String | Não | Número do pedido gerado |
dataEmissao | String | Sim | Data de criação do pedido |
cliente | Object | Não | Objeto com os dados do cliente final |
nome | String | Não | Nome do cliente que foi intermediado |
cpfCnpj | String | Não | CPF ou CNPJ do cliente que foi intermediado |
nf | String | Sim | Número da nota fiscal do pedido |
comissao | Object | Sim | Dados da comissão do pedido |
valor | Number | Sim | Valor da comissão recebida pelo cliente intermediador Valor mínimo: 0 |
porcentagem | Number | Sim | Percentual da comissão recebida pelo cliente intermediador Valor mínimo: 0 | Valor máximo: 100 |
tipo | String | Não | Define qual a operação do pedido atual Valores aceitos: venda, devolucao |
valorTotal | Number | Não | Valor total do pedido |
idCanalVenda | Number | Não | ID do canal de venda |
competencia | String | Não | Identifica a data da análise de comissão |
dataInicialEnvioNota | String | Não | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Não | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
status | String | Não | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Não | Mensagem de observação da análise de comissão. A observação só será cadastrada caso o status seja diferente de 'aguardando' |
{
"id": 1,
"codigo": "analise-1",
"titulo": "Análise de Comissão de Maio",
"status": "aguardando",
"observacao": "",
"canalVenda": {
"id": 7,
"codigo": "",
"nome": "Loja Scrum",
"dominio": "www.loja-uappi.com.br",
"principal": false,
"canalPai": {
"id": 6,
"nome": "www.loja.com.br"
}
},
"idCliente": 89,
"valorTotalVenda": 336.82,
"valorTotalComissao": 15,
"competencia": "2024-04",
"dataInicialEnvioNota": "2024-05-26",
"dataFinalEnvioNota": "2024-06-04",
"pedidos": [
{
"id": 2,
"numeroPedido": "",
"nomeCliente": "",
"cpfCnpj": "",
"nf": "132456789",
"valorComissao": 100,
"porcentagemComissao": 5,
"tipo": "devolucao",
"dataEmissao": "2023-04-29"
},
{
"id": 59,
"numeroPedido": "WAP-123",
"nomeCliente": "Cliente Final",
"cpfCnpj": "81160811288",
"nf": "1231",
"valorTotal": 118.94,
"valorComissao": 5,
"porcentagemComissao": 5,
"tipo": "venda",
"dataEmissao": "2024-05-26"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID da análise de comissão |
codigo | String | Código externo da análise de comissão |
titulo | String | Título da análise de comissão |
status | String | Define o status de atendimento da análise de comissão Valores aceitos: aguardando, aprovado, negado |
observacao | String | Mensagem de observação da análise de comissão |
canalVenda | Object | Dados do canal de venda vinculado |
id | Number | Id do canal |
codigo | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
idCliente | Number | ID do cliente intermediador |
competencia | String | Data da análise de comissão |
dataInicialEnvioNota | String | Data inicial do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
dataFinalEnvioNota | String | Data final do período onde o intermediador poderá realizar o upload da nota fiscal daquela análise de comissão |
pedidos | Array | Array com os dados dos pedidos gerados pelo cliente intermediador |
0 | ||
valorTotalComissao | Number | Valor total da comissões |
valorTotalVenda | Number | Valor total de venda |
Recurso responsável por cadastrar um novo assunto de SAC. Os assuntos de SAC são requeridos para o cadastro dos SACs propriamente ditos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
{
"nome": "Problemas com o Pedido",
"ativo": true,
"taxonomia": [
{
"label": "Problemas com o pedido",
"sub": [
{
"label": "Meu pedido foi estornado sem motivo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"anexos"
]
}
},
{
"label": "Quero trocar a forma de pagamento",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"label": "Problemas com o rastreio de pedido",
"sub": [
{
"label": "O pedido não foi entregue no prazo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
}
},
{
"label": "Não recebi o código de rastreio por E-mail",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"label": "Meu produto apresentou erros na entrega",
"dadosAcao": {},
"sub": [
{
"label": "Meu produto veio quebrado ou adulterado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
},
{
"label": "Meu produto veio errado ou trocado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
}
]
}
]
}
]
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
nome | String | Sim | Nome do Assunto |
ativo | Boolean | Sim | Define se o assunto está ativo |
taxonomia | Data Collection | Não | Taxonomia do assunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
{
"id": 131,
"nome": "Problemas com o Pedido",
"ativo": true,
"dataCriacao": "2023-12-22 14:10:30",
"dataAtualizacao": "2023-12-22 14:10:30",
"taxonomia": [
{
"itemId": 489,
"label": "Problemas com o pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 490,
"label": "Meu pedido foi estornado sem motivo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"anexos"
]
},
"sub": []
},
{
"itemId": 491,
"label": "Quero trocar a forma de pagamento",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 492,
"label": "Problemas com o rastreio de pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 493,
"label": "O pedido não foi entregue no prazo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 494,
"label": "Não recebi o código de rastreio por E-mail",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 495,
"label": "Meu produto apresentou erros na entrega",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 496,
"label": "Meu produto veio quebrado ou adulterado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
},
{
"itemId": 497,
"label": "Meu produto veio errado ou trocado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
}
]
}
]
}
]
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do assunto |
nome | String | Nome do Assunto |
ativo | Boolean | Define se o assunto está ativo |
dataCriacao | String | Data de criação do assunto |
dataAtualizacao | String | Data de atualização do assunto |
taxonomia | Data Collection | Dados de taxonomia |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
Recurso responsável por atualizar assunto de SAC. Os assuntos de SAC são requeridos para o cadastro dos SACs propriamente ditos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/subjects/{idSubject} | ID do assunto a ser atualizado |
Limite de requisições por minuto | 240 |
{
"nome": "Problemas com o Pedido",
"ativo": false,
"taxonomia": [
{
"label": "Problemas com o pedido",
"sub": [
{
"label": "Meu pedido foi estornado sem motivo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"anexos"
]
}
},
{
"label": "Quero trocar a forma de pagamento",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"label": "Problemas com o rastreio de pedido",
"sub": [
{
"label": "O pedido não foi entregue no prazo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
}
},
{
"label": "Não recebi o código de rastreio por E-mail",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"label": "Meu produto apresentou erros na entrega",
"dadosAcao": {},
"sub": [
{
"label": "Meu produto veio quebrado ou adulterado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
},
{
"label": "Meu produto veio errado ou trocado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
}
]
}
]
}
]
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
nome | String | Sim | Nome do Assunto |
ativo | Boolean | Sim | Define se o assunto está ativo |
taxonomia | Data Collection | Não | Taxonomia do assunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
label | String | Sim | Label do item de assunto |
acao | String | Não | Ação a ser executada no item de assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. Valores aceitos: criar-protocolo, |
dadosAcao | Object | Não | Detalhes da ação a ser executada nesse item do assunto. Campo obrigatório apenas quando este item estiver na base da taxonomia de assuntos. |
informacoesNecessarias | Array de strings | Não | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Não | Dados de subassunto |
{
"id": 133,
"nome": "Problemas com o Pedido",
"ativo": true,
"dataCriacao": "2023-12-22 14:17:52",
"dataAtualizacao": "2023-12-22 14:17:52",
"taxonomia": [
{
"itemId": 498,
"label": "Problemas com o pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 499,
"label": "Meu pedido foi estornado sem motivo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"anexos"
]
},
"sub": []
},
{
"itemId": 500,
"label": "Quero trocar a forma de pagamento",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 501,
"label": "Problemas com o rastreio de pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 502,
"label": "O pedido não foi entregue no prazo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 503,
"label": "Não recebi o código de rastreio por E-mail",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 504,
"label": "Meu produto apresentou erros na entrega",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 505,
"label": "Meu produto veio quebrado ou adulterado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
},
{
"itemId": 506,
"label": "Meu produto veio errado ou trocado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
}
]
}
]
}
]
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do assunto |
nome | String | Nome do Assunto |
ativo | Boolean | Define se o assunto está ativo |
dataCriacao | String | Data de criação do assunto |
dataAtualizacao | String | Data de atualização do assunto |
taxonomia | Data Collection | Dados de taxonomia |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
Recurso responsável por remover assunto de SAC. Os assuntos de SAC são requeridos para o cadastro dos SACs propriamente ditos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/subjects/{idSubject} | ID do assunto a ser removido |
Limite de requisições por minuto | 240 |
Recurso responsável por obter os assuntos de SAC cadastrados.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | busca: Termo de busca de assuntos de assuntos de SAC Exemplo de requisição: /v2/sac/subjects/v2/sac/subjects?offset=0&limit=100&busca=Pós-venda |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/sac/subjects?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"assuntos": [
{
"id": 126,
"nome": "Pós-venda",
"ativo": true,
"dataCriacao": "2023-12-21 13:59:58",
"dataAtualizacao": "2023-12-21 13:59:58"
},
{
"id": 125,
"nome": "Pagamento",
"ativo": true,
"dataCriacao": "2023-12-20 17:14:54",
"dataAtualizacao": "2023-12-20 17:14:54"
}
],
"info": {
"filtros": {
"ativo": "1"
},
"prev": "",
"self": "http://localhost/v2/sac/subjects?offset=0&limit=100&ativo=1",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 2,
"total": 5
}
}
Campo | Tipo | Descrição |
---|---|---|
assuntos | Data Collection | Assuntos disponíveis |
id | Number | ID do assunto |
nome | String | Nome do Assunto |
ativo | Boolean | Define se o assunto está ativo |
dataCriacao | String | Data de criação do assunto |
dataAtualizacao | String | Data de atualização do assunto |
taxonomia | Data Collection | Dados de taxonomia |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por consultar um assunto de SAC cadastrado.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/subjects/{idSubject} | ID do assunto a ser consultado |
Limite de requisições por minuto | 240 |
{
"id": 131,
"nome": "Problemas com o Pedido",
"ativo": true,
"dataCriacao": "2023-12-22 14:10:30",
"dataAtualizacao": "2023-12-22 14:10:30",
"taxonomia": [
{
"itemId": 489,
"label": "Problemas com o pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 490,
"label": "Meu pedido foi estornado sem motivo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"anexos"
]
},
"sub": []
},
{
"itemId": 491,
"label": "Quero trocar a forma de pagamento",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 492,
"label": "Problemas com o rastreio de pedido",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 493,
"label": "O pedido não foi entregue no prazo",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 494,
"label": "Não recebi o código de rastreio por E-mail",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido"
]
},
"sub": []
},
{
"itemId": 495,
"label": "Meu produto apresentou erros na entrega",
"acao": "",
"dadosAcao": {},
"sub": [
{
"itemId": 496,
"label": "Meu produto veio quebrado ou adulterado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
},
{
"itemId": 497,
"label": "Meu produto veio errado ou trocado",
"acao": "criar-protocolo",
"dadosAcao": {
"informacoesNecessarias": [
"pedido",
"pedidoItem"
]
},
"sub": []
}
]
}
]
}
]
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do assunto |
nome | String | Nome do Assunto |
ativo | Boolean | Define se o assunto está ativo |
dataCriacao | String | Data de criação do assunto |
dataAtualizacao | String | Data de atualização do assunto |
taxonomia | Data Collection | Dados de taxonomia |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
itemId | Number | ID do item de assunto |
label | String | Label do item de assunto |
acao | String | Ação a ser executada no item de assunto Valores aceitos: criar-protocolo, |
dadosAcao | Object | Detalhes da ação a ser executada nesse item do assunto |
informacoesNecessarias | Array de strings | Informações necessárias no item de assunto. As informações necessárias aceitas são: ['pedido', 'pedidoItem', 'anexos']. Caso 'pedido' esteja entre as informações necessárias, o campo 'idPedido' será requerido na criação dos SACs, e assim por diante |
sub | Data Collection | Dados de subassunto |
Recurso responsável por cadastrar um novo SAC.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
{
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 43398,
"idAssuntoItem": 224,
"tipoSolicitante": "api",
"status": "aberto",
"mensagens": [
{
"idEmissor": 25,
"tipoEmissor": "api",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"https://img.bb/gowuirWtf.png"
]
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
idAssuntoItem | Number | Sim | ID do item na taxonomia do assunto |
idCanalVenda | Number | Não | ID do Canal de Vendas. Se não informado, por padrão será utilizado o Canal Principal. |
idPedido | Number | Não | ID do pedido. Campo obrigatório apenas caso 'pedido' esteja entre os campos requeridos no cadastro do assunto. Não precisa ser informado em conjunto com 'numeroPedido' |
numeroPedido | String | Não | Número do pedido. Campo obrigatório apenas caso 'pedido' esteja entre os campos requeridos no cadastro do assunto. Não precisa ser informado em conjunto com 'idPedido'. Será utilizado apenas caso 'idPedido' não for informado. |
idPedidoItem | Number | Não | ID do item do pedido. Campo obrigatório apenas caso 'pedidoItem' esteja entre os campos requeridos no cadastro do assunto |
idCliente | Number | Não | ID do cliente. Não precisa ser informado em conjunto com 'codigoCliente' |
codigoCliente | String | Não | Código do cliente. Não precisa ser informado em conjunto com 'idCliente'. Será utilizado apenas caso 'idCliente' não for informado. |
tipoSolicitante | String | Sim | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
idSolicitante | Number | Não | ID do solicitante. Caso seja um usuário, o ID do usuário, e assim por diante. |
status | String | Sim | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
mensagem | Object | Sim | Dados da mensagem |
idEmissor | Number | Não | ID do emissor da mensagem |
tipoEmissor | String | Sim | Tipo do emissor da mensagem |
conteudo | String | Sim | Conteúdo da mensagem |
anexos | Array de strings | Não | Anexo da mensagem |
{
"id": 50,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 43398,
"idAssuntoItem": 224,
"labelAssuntoItem": "O pedido não foi entregue no prazo",
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"tipoSolicitante": "api",
"idSolicitante": 3,
"status": "aberto",
"statusResposta": "respondido",
"dataCriacao": "2023-12-13 13:00:21",
"dataUltimaInteracao": "2023-12-13 10:00:21",
"mensagens": [
{
"idMensagem": 64,
"idEmissor": 25,
"tipoEmissor": "api",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"https://img.bb/gowuirWtf.png"
],
"dataEnvio": "2023-12-13 13:00:21"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do SAC |
idAssunto | Number | ID do assunto de SAC |
idAssuntoItem | Number | ID do item na taxonomia do assunto |
labelAssuntoItem | String | Label do item na taxonomia do assunto |
idCanalVenda | Number | ID do Canal de Vendas |
idPedido | Number | ID do pedido |
numeroPedido | String | Número do pedido |
numeroSubpedido | String | Número do subpedido |
idPedidoItem | Number | ID do item do pedido |
idItem | Number | ID do produto |
idAtributoValorItem | Number | ID do valor de atributo do item |
skuItem | String | SKU do item do pedido |
idCliente | Number | ID do cliente |
codigoCliente | String | Código do cliente |
idSolicitante | Number | ID do solicitante |
tipoSolicitante | String | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
nomeSolicitante | String | Nome do solicitante |
status | String | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
statusResposta | String | Status de resposta do SAC ("respondido", "nao_respondido") Valores aceitos: respondido, nao_respondido |
mensagens | Data Collection | Dados da mensagem |
idMensagem | Number | ID do emissor da mensagem |
idEmissor | Number | ID do emissor da mensagem |
tipoEmissor | String | Tipo do emissor da mensagem |
nomeEmissor | String | Nome do emissor da mensagem |
conteudo | String | Conteúdo da mensagem |
anexos | Array de strings | Anexo da mensagem |
dataEnvio | String | Data de envio da mensagem |
dataCriacao | String | Data de criação do SAC |
dataUltimaInteracao | String | Data da última interação |
Recurso responsável por atualizar um SAC.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/{idSac} | ID do SAC a ser atualizado |
Limite de requisições por minuto | 240 |
{
"mensagem": {
"idEmissor": 35,
"tipoEmissor": "usuario",
"conteudo": "Testando",
"anexos": []
},
"status": "em_atendimento"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
status | String | Não | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
mensagem | Object | Não | Dados da mensagem |
idEmissor | Number | Não | ID do emissor da mensagem |
tipoEmissor | String | Sim | Tipo do emissor da mensagem |
conteudo | String | Sim | Conteúdo da mensagem |
anexos | Array de strings | Não | Anexo da mensagem |
{
"id": 50,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 43398,
"idAssuntoItem": 224,
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"labelAssuntoItem": "O pedido não foi entregue no prazo",
"tipoSolicitante": "usuario",
"idSolicitante": 33,
"status": "em_atendimento",
"statusResposta": "respondido",
"dataCriacao": "2023-12-13 13:00:21",
"dataUltimaInteracao": "2023-12-13 10:00:21",
"mensagens": [
{
"idMensagem": 64,
"idEmissor": 25,
"tipoEmissor": "api",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"https://img.bb/gowuirWtf.png"
],
"dataEnvio": "2023-12-13 13:00:21"
},
{
"idMensagem": 65,
"idEmissor": 35,
"tipoEmissor": "usuario",
"conteudo": "Testando",
"anexos": []
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do SAC |
idAssunto | Number | ID do assunto de SAC |
idAssuntoItem | Number | ID do item na taxonomia do assunto |
labelAssuntoItem | String | Label do item na taxonomia do assunto |
idCanalVenda | Number | ID do Canal de Vendas |
idPedido | Number | ID do pedido |
numeroPedido | String | Número do pedido |
numeroSubpedido | String | Número do subpedido |
idPedidoItem | Number | ID do item do pedido |
idItem | Number | ID do produto |
idAtributoValorItem | Number | ID do valor de atributo do item |
skuItem | String | SKU do item do pedido |
idCliente | Number | ID do cliente |
codigoCliente | String | Código do cliente |
idSolicitante | Number | ID do solicitante |
tipoSolicitante | String | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
nomeSolicitante | String | Nome do solicitante |
status | String | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
statusResposta | String | Status de resposta do SAC ("respondido", "nao_respondido") Valores aceitos: respondido, nao_respondido |
mensagens | Data Collection | Dados da mensagem |
idMensagem | Number | ID do emissor da mensagem |
idEmissor | Number | ID do emissor da mensagem |
tipoEmissor | String | Tipo do emissor da mensagem |
nomeEmissor | String | Nome do emissor da mensagem |
conteudo | String | Conteúdo da mensagem |
anexos | Array de strings | Anexo da mensagem |
dataEnvio | String | Data de envio da mensagem |
dataCriacao | String | Data de criação do SAC |
dataUltimaInteracao | String | Data da última interação |
Recurso responsável por enviar uma mensagem em um SAC.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/{idSac}/message | ID do SAC a ser atualizado |
Limite de requisições por minuto | 240 |
{
"mensagem": {
"idEmissor": 1,
"tipoEmissor": "usuario",
"conteudo": "Beleza, combinado."
}
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
mensagem | Object | Não | Dados da mensagem |
idEmissor | Number | Não | ID do emissor da mensagem |
tipoEmissor | String | Sim | Tipo do emissor da mensagem |
conteudo | String | Sim | Conteúdo da mensagem |
anexos | Array de strings | Não | Anexo da mensagem |
{
"id": 50,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 43398,
"idAssuntoItem": 224,
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"labelAssuntoItem": "O pedido não foi entregue no prazo",
"tipoSolicitante": "api",
"idSolicitante": 3,
"status": "aberto",
"statusResposta": "respondido",
"dataCriacao": "2023-12-13 13:00:21",
"dataUltimaInteracao": "2023-12-13 10:00:21",
"mensagens": [
{
"idMensagem": 64,
"idEmissor": 25,
"tipoEmissor": "api",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"https://img.bb/gowuirWtf.png"
],
"dataEnvio": "2023-12-13 13:00:21"
},
{
"idMensagem": 64,
"idEmissor": 1,
"tipoEmissor": "usuario",
"conteudo": "Beleza, combinado.",
"anexos": [],
"dataEnvio": "2023-12-13 14:00:21"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do SAC |
idAssunto | Number | ID do assunto de SAC |
idAssuntoItem | Number | ID do item na taxonomia do assunto |
labelAssuntoItem | String | Label do item na taxonomia do assunto |
idCanalVenda | Number | ID do Canal de Vendas |
idPedido | Number | ID do pedido |
numeroPedido | String | Número do pedido |
numeroSubpedido | String | Número do subpedido |
idPedidoItem | Number | ID do item do pedido |
idItem | Number | ID do produto |
idAtributoValorItem | Number | ID do valor de atributo do item |
skuItem | String | SKU do item do pedido |
idCliente | Number | ID do cliente |
codigoCliente | String | Código do cliente |
idSolicitante | Number | ID do solicitante |
tipoSolicitante | String | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
nomeSolicitante | String | Nome do solicitante |
status | String | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
statusResposta | String | Status de resposta do SAC ("respondido", "nao_respondido") Valores aceitos: respondido, nao_respondido |
mensagens | Data Collection | Dados da mensagem |
idMensagem | Number | ID do emissor da mensagem |
idEmissor | Number | ID do emissor da mensagem |
tipoEmissor | String | Tipo do emissor da mensagem |
nomeEmissor | String | Nome do emissor da mensagem |
conteudo | String | Conteúdo da mensagem |
anexos | Array de strings | Anexo da mensagem |
dataEnvio | String | Data de envio da mensagem |
dataCriacao | String | Data de criação do SAC |
dataUltimaInteracao | String | Data da última interação |
Recurso responsável por obter os SACs cadastrados.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | order: Ordenação de SACs Exemplo de requisição: /v2/sac/v2/sac/subjects?offset=0&limit=100&order=dataCriacao DESC|tipoSolicitante DESC dataCriacao: Filtragem por intervalo de data de criação do SAC Exemplo de requisição: /v2/sac/v2/sac/subjects?dataCriacao=2023-12-11|2023-12-13 idCliente: ID do Cliente a ser filtrado os SACs Exemplo de requisição: /v2/sac/v2/sac/subjects?offset=0&limit=100&idCliente=7 idPedido: ID do pedido a ser filtrado os SACs Exemplo de requisição: /v2/sac/v2/sac/subjects?offset=0&limit=100&idPedido=475 status: Status do SAC Exemplo de requisição: /v2/sac/v2/sac/subjects?offset=0&limit=100&status=em_atendimento statusResposta: Status de resposta do SAC Exemplo de requisição: /v2/sac/v2/sac/subjects?offset=0&limit=100&busca=Pós-venda&statusResposta=nao_respondido |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/sac?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"sacs": [
{
"id": 135,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 0,
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"idAssunto": 93,
"idAssuntoItem": 314,
"labelAssuntoItem": "Meu produto veio quebrado ou adulterado",
"tipoSolicitante": "api",
"idSolicitante": 25,
"status": "atendido",
"statusResposta": "respondido",
"dataCriacao": "2023-12-20 12:44:20",
"dataUltimaInteracao": "2023-12-22 10:09:06"
},
{
"id": 136,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 0,
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"idAssunto": 93,
"idAssuntoItem": 314,
"labelAssuntoItem": "Meu produto veio quebrado ou adulterado",
"tipoSolicitante": "api",
"idSolicitante": 25,
"status": "em_atendimento",
"statusResposta": "respondido",
"dataCriacao": "2023-12-20 12:44:58",
"dataUltimaInteracao": "2023-12-20 09:52:12"
}
],
"info": {
"filtros": [],
"prev": "",
"self": "http://localhost/v2/sac?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 3,
"total": 3
}
}
Campo | Tipo | Descrição |
---|---|---|
sacs | Data Collection | SACs disponíveis |
id | Number | ID do SAC |
idAssunto | Number | ID do assunto de SAC |
idAssuntoItem | Number | ID do item na taxonomia do assunto |
labelAssuntoItem | String | Label do item na taxonomia do assunto |
idCanalVenda | Number | ID do Canal de Vendas |
idPedido | Number | ID do pedido |
numeroPedido | String | Número do pedido |
numeroSubpedido | String | Número do subpedido |
idPedidoItem | Number | ID do item do pedido |
idItem | Number | ID do produto |
idAtributoValorItem | Number | ID do valor de atributo do item |
skuItem | String | SKU do item do pedido |
idCliente | Number | ID do cliente |
codigoCliente | String | Código do cliente |
tipoSolicitante | String | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
idSolicitante | Number | ID do solicitante |
status | String | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
statusResposta | String | Status de resposta do SAC ("respondido", "nao_respondido") Valores aceitos: respondido, nao_respondido |
dataCriacao | String | Data de criação do SAC |
dataUltimaInteracao | String | Data da última interação |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por consultar um SAC cadastrado.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/detail/{idSac} | ID do SAC a ser consultado |
Limite de requisições por minuto | 240 |
{
"id": 50,
"idCanalVenda": 0,
"idCliente": 253,
"idPedido": 27765,
"idPedidoItem": 43398,
"idAssuntoItem": 224,
"labelAssuntoItem": "O pedido não foi entregue no prazo",
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"tipoSolicitante": "api",
"idSolicitante": 3,
"status": "aberto",
"statusResposta": "respondido",
"dataCriacao": "2023-12-13 13:00:21",
"dataUltimaInteracao": "2023-12-13 10:00:21",
"mensagens": [
{
"idMensagem": 64,
"idEmissor": 25,
"tipoEmissor": "api",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"https://img.bb/gowuirWtf.png"
],
"dataEnvio": "2023-12-13 13:00:21"
}
]
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | ID do SAC |
idAssunto | Number | ID do assunto de SAC |
idAssuntoItem | Number | ID do item na taxonomia do assunto |
labelAssuntoItem | String | Label do item na taxonomia do assunto |
idCanalVenda | Number | ID do Canal de Vendas |
idPedido | Number | ID do pedido |
numeroPedido | String | Número do pedido |
numeroSubpedido | String | Número do subpedido |
idPedidoItem | Number | ID do item do pedido |
idItem | Number | ID do produto |
idAtributoValorItem | Number | ID do valor de atributo do item |
skuItem | String | SKU do item do pedido |
idCliente | Number | ID do cliente |
codigoCliente | String | Código do cliente |
idSolicitante | Number | ID do solicitante |
tipoSolicitante | String | Tipo do solicitante ("usuario", "cliente", "api") Valores aceitos: usuario, cliente, api |
nomeSolicitante | String | Nome do solicitante |
status | String | Status do SAC ("aberto", "em_atendimento", "atendido") Valores aceitos: aberto, em_atendimento, atendido |
statusResposta | String | Status de resposta do SAC ("respondido", "nao_respondido") Valores aceitos: respondido, nao_respondido |
mensagens | Data Collection | Dados da mensagem |
idMensagem | Number | ID do emissor da mensagem |
idEmissor | Number | ID do emissor da mensagem |
tipoEmissor | String | Tipo do emissor da mensagem |
nomeEmissor | String | Nome do emissor da mensagem |
conteudo | String | Conteúdo da mensagem |
anexos | Array de strings | Anexo da mensagem |
dataEnvio | String | Data de envio da mensagem |
dataCriacao | String | Data de criação do SAC |
dataUltimaInteracao | String | Data da última interação |
Recurso responsável por obter fila dos SACs.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | order: Ordenação de SACs Exemplo de requisição: /v2/sac/detail/queue?order=dataCriacao DESC|tipoSolicitante DESC dataCriacao: Filtragem por intervalo de data de criação do SAC Exemplo de requisição: /v2/sac/detail/queue?dataCriacao=2023-12-11|2023-12-13 idCliente: ID do Cliente a ser filtrado os SACs Exemplo de requisição: /v2/sac/detail/queue?idCliente=7 idPedido: ID do pedido a ser filtrado os SACs Exemplo de requisição: /v2/sac/detail/queue?idPedido=475 status: Status do SAC Exemplo de requisição: /v2/sac/detail/queue?status=em_atendimento statusResposta: Status de resposta do SAC Exemplo de requisição: /v2/sac/detail/queue?busca=Pós-venda&statusResposta=nao_respondido |
Limite de requisições por minuto | 240 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/sac/detail/queue?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"sacs": [
{
"id": 1,
"idCanalVenda": 0,
"idCliente": 403,
"idPedido": 28547,
"idPedidoItem": 0,
"idItem": 10572,
"idAtributoValorItem": 96,
"skuItem": "camiseta_termica",
"numeroPedido": "MDL-00310-00306",
"numeroSubpedido": "MDL-00310-00306",
"idAssunto": 1,
"idAssuntoItem": 3,
"labelAssuntoItem": "Quero troca a forma de pagamento",
"tipoSolicitante": "cliente",
"idSolicitante": 403,
"nomeSolicitante": "WSTORE TECNOLOGIA S.A.",
"status": "aberto",
"statusResposta": "respondido",
"dataCriacao": "2023-12-18 15:24:25",
"dataUltimaInteracao": "2023-12-18 12:24:25",
"mensagens": [
{
"idMensagem": 23,
"idEmissor": 10,
"tipoEmissor": "api",
"nomeEmissor": "Equipe wap.store",
"conteudo": "Preciso trocar o meio de pagamento de boleto para cartão, tem como?",
"anexos": [
"confirmacao-pagamento.png"
],
"dataEnvio": "2023-12-18 15:24:25"
}
]
}
],
"identificadoresFila": [
"1"
],
"info": {
"filtros": [],
"limit": 100,
"exibindo": 1,
"total": 1
}
}
Campo | Tipo | Descrição |
---|---|---|
sacs | Data Collection | Mensagens do SAC |
identificadoresFila | Array de strings | Lista com os IDs das mensagens de SAC presentes na paginação |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por remover SACs da fila de atualizações.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/sac/detail/queue/{idSac} | ID do SAC a ser removido da fila |
Limite de requisições por minuto | 12000 |
Recurso responsável por retornar informações do usuário logado.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
{
"id": 2,
"codigoInterno": "código interno",
"codigoLoja": "código da loja",
"nome": "Gabriel",
"email": "gabriel@gmail.com",
"telefone": "9999999999",
"celular": "99999999999",
"perfil": {
"id": 2,
"nome": "vendedor",
"tipoPerfil": "representante",
"perfilPai": {
"id": 1,
"nome": "lider de vendas"
}
},
"usuarioResponsavel": {
"id": 1,
"nome": "Arnaldo"
},
"segmentarCanalVenda": true,
"canais": [
{
"id": 0,
"codigoCanal": "",
"nome": "Loja 1",
"dominio": "wwww.loja1.com.br",
"principal": true,
"canalPai": {}
},
{
"id": 2,
"codigoCanal": "código loja",
"nome": "Loja 3",
"dominio": "www.loja3.com.br",
"principal": false,
"canalPai": {
"id": 1,
"nome": "Loja numérica"
}
}
],
"informacoesAdicionais": [
{
"titulo": "numero do pix",
"tipo": "numerico",
"hash": "numero-do-pix",
"valor": "3323432462326242",
"minimoCaracteres": 5,
"maximoCaracteres": 20,
"valoresSelect": []
},
{
"titulo": "cargo",
"tipo": "select",
"hash": "cargo",
"valor": "cargo-c",
"minimoCaracteres": 0,
"maximoCaracteres": 0,
"valoresSelect": [
{
"titulo": "cargo A",
"hash": "cargo-a"
},
{
"titulo": "cargo B",
"hash": "cargo-b"
},
{
"titulo": "cargo C",
"hash": "cargo-c"
}
]
}
],
"identificadorRastreamento": "gabriel",
"percentualComissao": 3.75,
"status": true
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Id do usuário |
codigoInterno | String | Código interno |
codigoLoja | String | Código da loja |
nome | String | Nome do usuário |
String | E-mail do usuário | |
telefone | String | Telefone do usuário |
celular | String | Celular do usuário |
perfil | Object | Perfil do usuário |
id | Number | Id do perfil |
nome | String | Nome do perfil |
tipoPerfil | String | Tipo do perfil |
perfilPai | Object | Dados do perfil pai |
id | Number | Id do perfil pai |
nome | String | Nome do perfil pai |
usuarioResponsavel | Object | Usuário responsável |
id | Number | Id do usuário responsável |
nome | String | Nome do usuário responsável |
segmentarCanalVenda | Boolean | Se o usuário esta segmentando por canal de venda |
canais | Data Collection | Canais de venda vinculados ao usuário |
id | Number | Id do canal |
codigoCanal | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
informacoesAdicionais | Data Collection | Informações adicionais de usuário |
titulo | String | Título do campo |
tipo | String | Tipo do campo |
hash | String | Hash do campo |
valor | String | Valor escolhido do usuário para o campo |
minimoCaracteres | Number | Mínimo de caracteres permitidos para campos do tipo numérico |
maximoCaracteres | Number | Máximo de caracteres permitidos para campos do tipo numérico |
valoresSelect | Data Collection | Opções de escolha para campo do tipo select |
titulo | String | Título da opção |
hash | String | Hash da opção |
identificadorRastreamento | String | Identificador de rastreamento do usuário representante |
percentualComissao | Number | Percentual de comissão do usuário representante |
status | Boolean | Status do usuário |
Recurso responsável por logar um usuário.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
{
"email": "fulanodetal@gmail.com",
"senha": "123"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
String | Sim | E-mail do usuário | |
senha | String | Sim | Senha do usuário |
{
"id": 2,
"codigoInterno": "código interno",
"codigoLoja": "código da loja",
"nome": "Gabriel",
"email": "gabriel@gmail.com",
"telefone": "9999999999",
"celular": "99999999999",
"perfil": {
"id": 2,
"nome": "vendedor",
"tipoPerfil": "representante",
"perfilPai": {
"id": 1,
"nome": "lider de vendas"
}
},
"usuarioResponsavel": {
"id": 1,
"nome": "Arnaldo"
},
"segmentarCanalVenda": true,
"canais": [
{
"id": 0,
"codigoCanal": "",
"nome": "Loja 1",
"dominio": "wwww.loja1.com.br",
"principal": true,
"canalPai": {}
},
{
"id": 2,
"codigoCanal": "código loja",
"nome": "Loja 3",
"dominio": "www.loja3.com.br",
"principal": false,
"canalPai": {
"id": 1,
"nome": "Loja numérica"
}
}
],
"informacoesAdicionais": [
{
"titulo": "numero do pix",
"tipo": "numerico",
"hash": "numero-do-pix",
"valor": "3323432462326242",
"minimoCaracteres": 5,
"maximoCaracteres": 20,
"valoresSelect": []
},
{
"titulo": "cargo",
"tipo": "select",
"hash": "cargo",
"valor": "cargo-c",
"minimoCaracteres": 0,
"maximoCaracteres": 0,
"valoresSelect": [
{
"titulo": "cargo A",
"hash": "cargo-a"
},
{
"titulo": "cargo B",
"hash": "cargo-b"
},
{
"titulo": "cargo C",
"hash": "cargo-c"
}
]
}
],
"identificadorRastreamento": "gabriel",
"percentualComissao": 3.75,
"status": true
}
Campo | Tipo | Descrição |
---|---|---|
id | Number | Id do usuário |
codigoInterno | String | Código interno |
codigoLoja | String | Código da loja |
nome | String | Nome do usuário |
String | E-mail do usuário | |
telefone | String | Telefone do usuário |
celular | String | Celular do usuário |
perfil | Object | Perfil do usuário |
id | Number | Id do perfil |
nome | String | Nome do perfil |
tipoPerfil | String | Tipo do perfil |
perfilPai | Object | Dados do perfil pai |
id | Number | Id do perfil pai |
nome | String | Nome do perfil pai |
usuarioResponsavel | Object | Usuário responsável |
id | Number | Id do usuário responsável |
nome | String | Nome do usuário responsável |
segmentarCanalVenda | Boolean | Se o usuário esta segmentando por canal de venda |
canais | Data Collection | Canais de venda vinculados ao usuário |
id | Number | Id do canal |
codigoCanal | String | Código do canal |
nome | String | Nome do canal |
dominio | String | Domínio do canal |
principal | Boolean | Se é o canal principal |
canalPai | Object | Canal pai |
id | Number | Id do canal pai |
nome | String | Nome do canal pai |
informacoesAdicionais | Data Collection | Informações adicionais de usuário |
titulo | String | Título do campo |
tipo | String | Tipo do campo |
hash | String | Hash do campo |
valor | String | Valor escolhido do usuário para o campo |
minimoCaracteres | Number | Mínimo de caracteres permitidos para campos do tipo numérico |
maximoCaracteres | Number | Máximo de caracteres permitidos para campos do tipo numérico |
valoresSelect | Data Collection | Opções de escolha para campo do tipo select |
titulo | String | Título da opção |
hash | String | Hash da opção |
identificadorRastreamento | String | Identificador de rastreamento do usuário representante |
percentualComissao | Number | Percentual de comissão do usuário representante |
status | Boolean | Status do usuário |
Recurso responsável por atualizar a senha do usuário logado.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Limite de requisições por minuto | 240 |
{
"senha": "123",
"novaSenha": "321"
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
senha | String | Sim | Senha do usuário |
novaSenha | String | Sim | Nova senha do usuário |
Recurso responsável por retornar todas as listas de produtos cadastradas.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
Filtros | campoOrdenacao: Campo em que ocorrerá a ordenação dos dados. Valores aceitos (id | dataCriacao | dataAtualizacao). Exemplo de requisição: /v2/lists/v2/lists/?campoOrdenacao=id ordem: Define a ordenação dos dados. Valores aceitos (ASC | DESC). Exemplo de requisição: /v2/lists/v2/lists/?ordem=ASC idCliente: Filtra as listas vinculadas a um ID de cliente. Exemplo de requisição: /v2/lists/v2/lists/?idCliente=123 codigoCliente: Filtra as listas vinculadas a um código de cliente. Exemplo de requisição: /v2/lists/v2/lists/?codigoCliente=123 tipoLista: Filtra as listas pelo seu tipo. Valores aceitos (recomendada | cliente). Exemplo de requisição: /v2/lists/v2/lists/?tipoLista=recomendada |
Limite de requisições por minuto | 60 |
Offset/Limit | Obrigatório o envio dos parâmetros offset e limit na URL da requisição. Exemplo de requisição: /v2/lists?offset=0&limit=100 Valor máximo para o parâmetro limit: 100 |
{
"listas": [
{
"id": 1,
"nome": "Lista de produtos 1",
"tipoLista": "cliente",
"dataCriacacao": "2024-08-15 09:58:52",
"dataUltimaAtualizacao": "2024-08-16 17:50:36",
"quantidade": 1
},
{
"id": 2,
"nome": "Lista de produtos 2",
"tipoLista": "recomendada",
"dataCriacacao": "2024-08-15 09:58:53",
"dataUltimaAtualizacao": "2024-08-16 17:50:38",
"quantidade": 4
}
],
"info": {
"filtros": [],
"prev": "",
"self": "https://sandbox.wapstore.com.br/api/v2/lists?offset=0&limit=100",
"next": "",
"offset": 0,
"limit": 100,
"exibindo": 2,
"total": 2
}
}
Campo | Tipo | Descrição |
---|---|---|
listas | Data Collection | Listas disponíveis |
id | Number | ID da lista |
nome | String | Nome da lista |
tipoLista | String | Tipo da lista da lista |
quantidade | Number | Quantidade total de produtos vinculado a lista |
dataCriacacao | String | Data de criação da lista |
dataUltimaAtualizacao | String | Data da última atualização da lista |
info | Object | Informações sobre a listagem (paginação, filtros, total de itens, etc.) |
filtros | Object (key/value) | Filtros aplicados na URL |
prev | String | Página anterior |
self | String | Página atual |
next | String | Próxima página |
offset | Number | Offset solicitado |
limit | Number | Limit solicitado |
exibindo | Number | Quantidade de registros sendo exibidos na página atual |
total | Number | Total de registros em todas as páginas |
Recurso responsável por retornar o detalhamento de uma lista de produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/list/{idLista} | ID da lista de produtos |
Filtros | idProduto: Busca um produto da lista pelo seu ID. Exemplo de requisição: /v2/list/{idLista}/v2/list/{idLista}?idProduto=id skuProduto: Busca um produto da lista pelo seu SKU. Exemplo de requisição: /v2/list/{idLista}/v2/list/{idLista}?skuProduto=ASC eanProduto: Busca um produto da lista pelo seu EAN. Exemplo de requisição: /v2/list/{idLista}/v2/list/{idLista}?eanProduto=123 campoOrdenacao: Campo em que ocorrerá a ordenação dos dados. Valores aceitos (id | nome). Exemplo de requisição: /v2/list/{idLista}/v2/list/{idLista}?campoOrdenacao=id ordem: Define a ordenação dos dados. Valores aceitos (ASC | DESC). Exemplo de requisição: /v2/list/{idLista}/v2/list/{idLista}?ordem=ASC |
Limite de requisições por minuto | 60 |
{
"detalhesLista": {
"id": 1,
"nome": "Lista de produtos 1",
"tipoLista": "cliente",
"dataCriacacao": "2024-08-15 09:58:52",
"dataUltimaAtualizacao": "2024-08-16 17:50:36",
"quantidade": 1
},
"cliente": {
"id": 250,
"codigo": "cli 250",
"nome": "Teste Uappi",
"email": "teste@uappi.com.br",
"cpfCnpj": "12345678910"
},
"produtos": [
{
"id": 1,
"nome": "Produto Teste 1",
"sku": "produto_teste_1",
"ean": "7892089514386",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 2,
"nome": "Produto Teste 2",
"sku": "produto_teste_2",
"ean": "7892089514387",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 3,
"nome": "Produto Teste 3",
"sku": "produto_teste_3",
"ean": "7892089514388",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
}
],
"produtosNaoAdicionados": []
}
Campo | Tipo | Descrição |
---|---|---|
detalhesLista | Object | Dados referente a lista |
id | Number | ID da lista |
nome | String | Nome da lista |
tipoLista | String | Tipo da lista da lista |
quantidade | Number | Quantidade total de produtos vinculado a lista |
dataCriacacao | String | Data de criação da lista |
dataUltimaAtualizacao | String | Data da última atualização da lista |
cliente | Object | Dados do cliente vinculado a lista |
id | Number | ID do cliente |
codigo | String | Código do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
cpfCnpj | String | Código do cliente |
produtos | Data Collection | Produtos que estão vinculados a lista |
id | Number | ID do produto |
nome | String | Nome do produto |
idAtributo | Number | ID atributo do produto |
nomeAtributo | String | Nome do atributo do produto |
sku | String | SKU do produto ou do atributo |
ean | String | EAN do produto ou do atributo |
quantidade | Number | Quantidade do produto que está na lista |
disponivel | Boolean | Disponibilidade do produto |
estoqueSellers | Number | Estoque do produto no Seller |
estoqueMarketplace | Number | Estoque do produto no Marketplace |
armazens | Data Collection | Estoques do produto detalhado por armazém |
produtosNaoAdicionados | Data Collection | Informa os produtos que não puderam ser processados |
id | Number | ID do produto que não pôde ser vinculado a lista |
ean | String | Informa o EAN do produto que não pôde ser vinculado a lista |
sku | String | Informa o SKU do produto que não pôde ser vinculado a lista |
quantidade | Number | Quantidade do produto que não pôde ser vinculado a lista |
Recurso responsável por cadastrar uma lista de produtos. Esse recurso suporta o envio de até 10.000 itens de produtos por lista.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 201 Created |
Limite de requisições por minuto | 60 |
{
"nome": "Lista de produtos 1",
"cpfCnpj": 48962584875,
"produtos": [
{
"ean": "7892089514386",
"quantidade": 500
},
{
"sku": "produto_teste_2",
"quantidade": 500
},
{
"id": 3,
"quantidade": 500
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
nome | String | Sim | Nome da lista |
cpfCnpj | String | Não | CPF/CNPJ do cliente que será vinculado a lista |
idCliente | String | Não | ID do cliente que será vinculado a lista |
codigoCliente | String | Não | Código do cliente vinculado a lista |
produtos | Data Collection | Sim | Tipo da lista gerada |
id | Number | Não | Informa o ID do produto que será vinculado a lista |
ean | String | Não | Informa o EAN do produto que será vinculado a lista |
sku | String | Não | Informa o SKU do produto que será vinculado a lista |
quantidade | Number | Sim | Quantidade do item que será adicionada a lista |
{
"detalhesLista": {
"id": 1,
"nome": "Lista de produtos 1",
"tipoLista": "cliente",
"dataCriacacao": "2024-08-15 09:58:52",
"dataUltimaAtualizacao": "2024-08-16 17:50:36",
"quantidade": 1
},
"cliente": {
"id": 250,
"codigo": "cli 250",
"nome": "Teste Uappi",
"email": "teste@uappi.com.br",
"cpfCnpj": "12345678910"
},
"produtos": [
{
"id": 1,
"nome": "Produto Teste 1",
"sku": "produto_teste_1",
"ean": "7892089514386",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 2,
"nome": "Produto Teste 2",
"sku": "produto_teste_2",
"ean": "7892089514387",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 3,
"nome": "Produto Teste 3",
"sku": "produto_teste_3",
"ean": "7892089514388",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
}
],
"produtosNaoAdicionados": []
}
Campo | Tipo | Descrição |
---|---|---|
detalhesLista | Object | Dados referente a lista |
id | Number | ID da lista |
nome | String | Nome da lista |
tipoLista | String | Tipo da lista da lista |
quantidade | Number | Quantidade total de produtos vinculado a lista |
dataCriacacao | String | Data de criação da lista |
dataUltimaAtualizacao | String | Data da última atualização da lista |
cliente | Object | Dados do cliente vinculado a lista |
id | Number | ID do cliente |
codigo | String | Código do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
cpfCnpj | String | Código do cliente |
produtos | Data Collection | Produtos que estão vinculados a lista |
id | Number | ID do produto |
nome | String | Nome do produto |
idAtributo | Number | ID atributo do produto |
nomeAtributo | String | Nome do atributo do produto |
sku | String | SKU do produto ou do atributo |
ean | String | EAN do produto ou do atributo |
quantidade | Number | Quantidade do produto que está na lista |
disponivel | Boolean | Disponibilidade do produto |
estoqueSellers | Number | Estoque do produto no Seller |
estoqueMarketplace | Number | Estoque do produto no Marketplace |
armazens | Data Collection | Estoques do produto detalhado por armazém |
produtosNaoAdicionados | Data Collection | Informa os produtos que não puderam ser processados |
id | Number | ID do produto que não pôde ser vinculado a lista |
ean | String | Informa o EAN do produto que não pôde ser vinculado a lista |
sku | String | Informa o SKU do produto que não pôde ser vinculado a lista |
quantidade | Number | Quantidade do produto que não pôde ser vinculado a lista |
Recurso responsável por atualizar uma lista de produtos. Esse recurso suporta o envio de até 10.000 itens de produtos por lista. Caso a lista já possua a quantidade limite de 10.000 itens vinculados a ela, novos produtos não serão vinculados a lista.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 200 Ok |
/v2/lists/{idLista} | ID da lista de produtos que será atualizada. |
Limite de requisições por minuto | 60 |
{
"nome": "Lista de produtos 1",
"produtos": [
{
"ean": "7892089514386",
"quantidade": 500
},
{
"sku": "produto_teste_2",
"quantidade": 500
},
{
"id": 3,
"quantidade": 500
}
]
}
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
nome | String | Não | Nome da lista |
produtos | Data Collection | Sim | Tipo da lista gerada |
id | Number | Não | Informa o ID do produto que será vinculado a lista |
ean | String | Não | Informa o EAN do produto que será vinculado a lista |
sku | String | Não | Informa o SKU do produto que será vinculado a lista |
quantidade | Number | Sim | Quantidade do item que será adicionada a lista |
{
"detalhesLista": {
"id": 1,
"nome": "Lista de produtos 1",
"tipoLista": "cliente",
"dataCriacacao": "2024-08-15 09:58:52",
"dataUltimaAtualizacao": "2024-08-16 17:50:36",
"quantidade": 1
},
"cliente": {
"id": 250,
"codigo": "cli 250",
"nome": "Teste Uappi",
"email": "teste@uappi.com.br",
"cpfCnpj": "12345678910"
},
"produtos": [
{
"id": 1,
"nome": "Produto Teste 1",
"sku": "produto_teste_1",
"ean": "7892089514386",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 2,
"nome": "Produto Teste 2",
"sku": "produto_teste_2",
"ean": "7892089514387",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
},
{
"id": 3,
"nome": "Produto Teste 3",
"sku": "produto_teste_3",
"ean": "7892089514388",
"quantidade": 500,
"disponivel": true,
"estoqueSellers": 0,
"estoqueMarketplace": 0,
"armazens": [
{
"id": 1,
"codigoInterno": "0001",
"nome": "Armazém Principal",
"principal": true,
"seller": [],
"estoque": 3000
}
]
}
],
"produtosNaoAdicionados": []
}
Campo | Tipo | Descrição |
---|---|---|
detalhesLista | Object | Dados referente a lista |
id | Number | ID da lista |
nome | String | Nome da lista |
tipoLista | String | Tipo da lista da lista |
quantidade | Number | Quantidade total de produtos vinculado a lista |
dataCriacacao | String | Data de criação da lista |
dataUltimaAtualizacao | String | Data da última atualização da lista |
cliente | Object | Dados do cliente vinculado a lista |
id | Number | ID do cliente |
codigo | String | Código do cliente |
nome | String | Nome do cliente |
String | E-mail do cliente | |
cpfCnpj | String | Código do cliente |
produtos | Data Collection | Produtos que estão vinculados a lista |
id | Number | ID do produto |
nome | String | Nome do produto |
idAtributo | Number | ID atributo do produto |
nomeAtributo | String | Nome do atributo do produto |
sku | String | SKU do produto ou do atributo |
ean | String | EAN do produto ou do atributo |
quantidade | Number | Quantidade do produto que está na lista |
disponivel | Boolean | Disponibilidade do produto |
estoqueSellers | Number | Estoque do produto no Seller |
estoqueMarketplace | Number | Estoque do produto no Marketplace |
armazens | Data Collection | Estoques do produto detalhado por armazém |
produtosNaoAdicionados | Data Collection | Informa os produtos que não puderam ser processados |
id | Number | ID do produto que não pôde ser vinculado a lista |
ean | String | Informa o EAN do produto que não pôde ser vinculado a lista |
sku | String | Informa o SKU do produto que não pôde ser vinculado a lista |
quantidade | Number | Quantidade do produto que não pôde ser vinculado a lista |
Recurso responsável por remover uma lista de produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/lists/{idLista} | ID da lista de produtos que será removida. |
Limite de requisições por minuto | 60 |
Recurso responsável por remover os produtos de uma lista de produtos.
Informações do endpoint | |
---|---|
Ambiente | Sandbox / Produção |
Status de Sucesso | 204 No Content |
/v2/lists/products/{idLista} | ID da lista que terá os seus produtos removidos. |
Limite de requisições por minuto | 60 |
{
"produtos": [
{
"idProduto": 1,
"idAtributoValor": 0
}
]
}
Códigos de retorno HTTP para os recursos da API.
Código | Status | Descrição | Tipo |
---|---|---|---|
200 | OK | Retorno de sucesso para consulta e alterações de dados (exceto em lote) | Sucesso |
201 | Created | Retorno de sucesso para criação de dados (pedidos, produtos, lotes, etc) | Sucesso |
204 | No Content | Retorno de sucesso para os métodos para ações que não necessitam de um corpo de retorno, como exclusões, por exemplo. | Sucesso |
400 | Bad Request | Retorno de erro quando algo na requisição enviada não está de acordo com o esperado pelas APIs. | Erro |
401 | Unauthorized | Retorno de erro quando o token do app ou da integração são inválidos ou não foram informados. | Erro |
404 | Not Found | Retorno de erro quando o recurso solicitado não existe (endpoint, produto, pedido, etc). | Erro |
406 | Not Acceptable | Retorno de erro quando o endpoint for acessado sem HTTPS. | Erro |
429 | Too Many Requests | Retorno de erro quando o limite de requisições para o recurso solicitado for atigindo. | Erro |
500 | Internal Server Error | Retorno de erro quando o um problema inesperado impedir o funcionamento correto da API. Caso o erro persista, entre em contato com o suporte. | Erro |
503 | Service Unavailable | Retorno de erro quando o serviço de um recurso ou do sistema não estiver disponível. Caso o erro persista, entre em contato com o suporte. | Erro |