API v1 Hub de Marketplaces - Marketplaces In

Para começar a desenvolver a integração do seu sistema com o Hub de Marketplaces, você precisará de uma conta no ambiente sandbox, para que possa testar todos os recursos disponíveis na API antes de ir para produção. Assim que finalizar os testes, você deverá enviar um e-mail para suporte.omni@wapstore.com.br e solicitar a homologação de sua aplicação.

Após isso, o time de suporte da Uappi solicitará alguns testes de requisições a API e, caso esteja tudo certo, sua aplicação será homologada e você receberá o AppToken de produção que deverá ser utilizado para integrar todos os marketplaces Uappi de seu sistema em produção. O processo de homologação será feito apenas uma vez e, a partir da homologação, sua aplicação estará apta a trabalhar em produção.

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

Solicite sua conta de homologação pelo suporte.omni@wapstore.com.br

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

Sandbox

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

Produção

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

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

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

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

Autenticação da aplicação

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

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

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

Autenticação da integração

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

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

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

POST /v1/auth

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

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

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

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

Request

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

Detalhes da Request

Response

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

Detalhes do Response

GET /v1/ping

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

GET /v1/sellers

Recurso responsável por listar todos os sellers vinculados ao marketplace, ordenados alfabeticamente pelo nome.

Nesse recurso serão retornados todos os dados dos sellers.

Response

{
    "sellers": [
        {
            "idSeller": "17",
            "nome": "Seller de Teste",
            "documento": "11217233000167",
            "ativo": true,
            "criadoWapstore": true,
            "sincronizadoWapstore": true,
            "dataVinculo": "2019-06-03 10:00:18",
            "contato": {
                "email": "seller@teste.com.br",
                "telefone": "1136987412"
            },
            "endereco": {
                "endereco": "Avenida Paulista",
                "numero": "507",
                "complemento": "Sala 10",
                "bairro": "Bela Vista",
                "cidade": "São Paulo",
                "estado": "SP",
                "cep": "01310940"
            },
            "cicloRepasse": {
                "statusLiberacao": "entregue",
                "diaFechamento": "4",
                "diaRelatorioFechamento": "5",
                "prazoContestacao": "3",
                "prazoContestacaoResposta": "5",
                "tipoRepasse": "mensal",
                "fechamentoCiclo": [
                    31
                ],
                "diaRepasse": "1",
                "dadosBancarios": [
                    {
                        "nomeBanco": "Caixa",
                        "numeroBanco": "104",
                        "agencia": "12345",
                        "conta": "1234567-1",
                        "titular": "Seller de teste LTDA",
                        "cnpj": "11217233000167"
                    },
                    {
                        "nomeBanco": "Santander ",
                        "numeroBanco": "033",
                        "agencia": "5678",
                        "conta": "5678-8",
                        "titular": "Seller de teste LTDA",
                        "cnpj": "11217233000167"
                    }
                ]
            }
        }
    ],
    "info": {
        "filtros": [],
        "prev": "",
        "self": "https://api.sandbox.omni.wapstore.com.br/v1/sellers?offset=0&limit=100",
        "next": "",
        "offset": 0,
        "limit": 100,
        "exibindo": 1,
        "total": 1
    }
}

Detalhes do Response

GET /v1/sellers/{id}

Recurso de consulta individual de sellers responsável por retornar todos os dados cadastrados de um seller.

Response

{
    "idSeller": "17",
    "nome": "Seller de Teste",
    "documento": "11217233000167",
    "ativo": true,
    "criadoWapstore": true,
    "sincronizadoWapstore": true,
    "dataVinculo": "2019-06-03 10:00:18",
    "contato": {
        "email": "seller@teste.com.br",
        "telefone": "1136987412"
    },
    "endereco": {
        "endereco": "Avenida Paulista",
        "numero": "507",
        "complemento": "Sala 10",
        "bairro": "Bela Vista",
        "cidade": "São Paulo",
        "estado": "SP",
        "cep": "01310940"
    },
    "cicloRepasse": {
        "statusLiberacao": "entregue",
        "diaFechamento": "4",
        "diaRelatorioFechamento": "5",
        "prazoContestacao": "3",
        "prazoContestacaoResposta": "5",
        "tipoRepasse": "mensal",
        "fechamentoCiclo": [
            31
        ],
        "diaRepasse": "1",
        "dadosBancarios": [
            {
                "nomeBanco": "Caixa",
                "numeroBanco": "104",
                "agencia": "12345",
                "conta": "1234567-1",
                "titular": "Seller de teste LTDA",
                "cnpj": "11217233000167"
            },
            {
                "nomeBanco": "Santander ",
                "numeroBanco": "033",
                "agencia": "5678",
                "conta": "5678-8",
                "titular": "Seller de teste LTDA",
                "cnpj": "11217233000167"
            }
        ]
    }
}

Detalhes do Response

GET /v1/sellers/queue

Recurso responsável por listar a fila de sellers vinculados ao marketplace que foram criados ou que sofreram alguma atualização para que seu sistema interno possa obter todas as atualizações dos sellers.

Nesse recurso serão retornados todos os dados dos sellers.

Response

{
    "sellers": [
        {
            "idSeller": "17",
            "nome": "Seller de Teste",
            "documento": "11217233000167",
            "ativo": true,
            "criadoWapstore": true,
            "sincronizadoWapstore": true,
            "dataVinculo": "2019-06-03 10:00:18",
            "contato": {
                "email": "seller@teste.com.br",
                "telefone": "1136987412"
            },
            "endereco": {
                "endereco": "Avenida Paulista",
                "numero": "507",
                "complemento": "Sala 10",
                "bairro": "Bela Vista",
                "cidade": "São Paulo",
                "estado": "SP",
                "cep": "01310940"
            },
            "cicloRepasse": {
                "statusLiberacao": "entregue",
                "diaFechamento": "4",
                "diaRelatorioFechamento": "5",
                "prazoContestacao": "3",
                "prazoContestacaoResposta": "5",
                "tipoRepasse": "mensal",
                "fechamentoCiclo": [
                    31
                ],
                "diaRepasse": "1",
                "dadosBancarios": [
                    {
                        "nomeBanco": "Caixa",
                        "numeroBanco": "104",
                        "agencia": "12345",
                        "conta": "1234567-1",
                        "titular": "Seller de teste LTDA",
                        "cnpj": "11217233000167"
                    },
                    {
                        "nomeBanco": "Santander ",
                        "numeroBanco": "033",
                        "agencia": "5678",
                        "conta": "5678-8",
                        "titular": "Seller de teste LTDA",
                        "cnpj": "11217233000167"
                    }
                ]
            }
        }
    ],
    "info": {
        "filtros": [],
        "limit": 100,
        "exibindo": 1,
        "total": 1
    }
}

Detalhes do Response

DELETE /v1/sellers/queue/{id}

Recurso responsável por confirmar a leitura de um seller da fila. Esse recurso deve ser utilizado sempre que as atualizações do seller forem lidas pelo seu sistema para que o seller seja removido da fila de atualizações.

POST /v1/sellers/transaction-batch

Recurso de criação em lote de transações, responsável por inserir várias transações na conta corrente dos sellers de uma única vez.

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

Request

{
	"transacoes":[
		{
			"cnpj":"20542763000171",
			"idPedidoCanal":"MKTP-5682",
			"tipoOperacao":"multa",
			"descricao":"Multa por atraso na entrega",
			"valor":57.90
		},
		{
			"cnpj":"20542763000171",
			"idPedidoCanal":"MKTP-5682",
			"tipoOperacao":"outros-debitos",
			"descricao":"Correção de cobrança jan/2019",
			"valor":437.26
		},
		{
			"cnpj":"20542763000171",
			"idPedidoCanal":"MKTP-5682",
			"tipoOperacao":"bonus",
			"descricao":"Prêmio Seller do Ano",
			"valor":100.00
		},
		{
			"cnpj":"20542763000171",			
			"idPedidoCanal":"MKTP-5682",
			"tipoOperacao":"outros-creditos",
			"descricao":"Cobrança inválida de comissão",
			"valor":37.95
		},
	]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

POST /v1/sellers/invoice-batch

Recurso de criação em lote de notas fiscais, responsável por inserir várias notas fiscais na conta dos sellers de uma única vez.

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

Request

{
	"notasFiscais":[
		{
			"documento":"20542763000171",
			"numero":"12312312",
			"serie":"1",
			"chave":"12312312312",
			"descricao":"Intermediação de vendas",
			"valor":100.00,
			"dataEmissao":"2019-05-01 00:00:00",
			"link":"http://www.nfe.fazenda.gov.br/portal/consultaRecaptcha.aspx?tipoConteudo=XbSeqxE8pl8=&tipoConsulta=completa&nfe=12345678945612345612654687985653215461265",
			"arquivoNfe": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL09..."
		}
	]
}

Detalhes da Request

Response

{
    "id": 80
}

Detalhes do Response

POST /v1/sellers/invitations

Recurso de criação em lote de convites de seller, responsável por inserir vários lotes de convite na fila para envio de e-mails em massa.

Após o lote cadastrado uma tarefa será agendada para envio dos convites por e-mail, podendo verificar os sellers vinculados ou aguardando no painel

Request

{
  "convites": [
    {
      "email": "email@dominio.com",
      "loja": {
        "nome": "Loja de teste",
        "id": "strteste",
        "nomeSeller": "Caio",
        "tipoDoc": "cpf",
        "numeroDoc": "xxx.xxx.xxx-xx",
        "telContato": 18996976737,
        "cep": 16204370,
        "endereco": "Rua de testes",
        "numero": 101,
        "bairro": "Centro",
        "cidade": "São Paulo",
        "pais": "Brasil",
        "estado": "SP"
      }
    },
    {
        "email": "example@dominio.com"
    }
  ]
}

Detalhes da Request

Response

{
  "resultados": {
    "processados": [
      "seller@uappi.com",
      "example@dominio.com"
    ],
    "erros": {
      "emailsInvalidos": []
    }
  }
}

Detalhes do Response

GET /v1/batch/{id}

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

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

Response

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

Detalhes do Response

GET /v1/protocols

Recurso responsável por listar todos os protocolos vinculados ao marketplace, ordenados por data de criação.

Neste recurso serão retornados os dados principais dos protocolos, e para mais detalhes poderá ser utilizado o endpoint de consulta individual de protocolos.

Response

{
  "protocolos": [
      {
        "id": 23,
        "assunto": "Garantia - Entrega Superior a 7 dias",
        "origem": {
            "perfil": "cliente",
            "nome": "Alexandre Medeiros",
            "email": "alexandremedeiros@omni.com.br"
        },
        "destino": {
            "perfil": "seller",
            "nome": "Seller Omni",
            "email": "atendimento@selleromni.com.br"
        },
        "produto": {},
        "pedido": {
            "id": 192052,
            "idPlataforma": 1052,
            "idCanal": "123123176",
            "referenciaCanal": "3737-1"
        },
        "seller": {
            "id": 16,
            "nome": "Seller Omni",
            "cnpj": "11217233000167"
        },
        "ultimoInteragente": "cliente",
        "status": "aberto",
        "atendimento": "normal",
        "cancelamentoPedido": false,
        "devolucaoPedido": false,
        "contestacaoRepasse": false,
        "vencido": false,
        "datas": {
            "criacao": "2019-10-28 15:50:38",
            "ultimaInteracao": "2019-10-28 15:50:38",
            "vencimento": "2019-10-30 15:50:38"
        }
    }
  ],
  "info": {
      "filtros": {
          "perfil": "cliente"
      },
      "prev": "",
      "self": "https://api.sandbox.omni.wapstore.com.br/v1/protocols?offset=0&limit=100&perfil=cliente",
      "next": "",
      "offset": 0,
      "limit": 100,
      "exibindo": 1,
      "total": 1
  }
}

Detalhes do Response

GET /v1/protocols/{id}

Recurso de consulta individual de protocolos responsável por retornar todos os dados de um protocolo.

Este pode estar vinculado a um pedido, produto, contrato, financeiro ou geral.

Utilize o recurso de consulta de mensagens para buscar as mensagens referentes a um protocolo.

Response

{
    "id": 30,
    "assunto": "Cancelamento - Desistência",
    "origem": {
        "perfil": "cliente",
        "nome": "Alexandre Medeiros",
        "email": "alexandremedeiros@omni.com.br"
    },
    "destino": {
        "perfil": "seller",
        "nome": "Seller Omni",
        "email": "atendimento@selleromni.com.br"
    },
    "pedido": {
        "idPedido": 192052,
        "idPlataforma": 1052,
        "idPedidoCanal": "123123176",
        "referenciaPedidoCanal": "3737-1",
        "dataEmissao": "2019-08-09 14:32:28",
        "dataIntegracao": "2019-08-09 15:00:20",
        "status": 1,
        "canal": {
            "canal": "Wapstore Marketplace",
            "canalIntegracao": "Loja marketplace",
            "hashCanal": "wapstoremarketplace"
        },
        "cliente": {
            "nome": "Alexandre Medeiros",
            "email": "alexandremedeiros@omni.com.br",
            "cpfCnpj": "45925807022",
            "pessoa": "m",
            "telefone": "",
            "celular": "(11) 99123-4567"
        },
        "entrega": {
            "cep": "16202999",
            "destinatario": "Alexandre Medeiros",
            "endereco": "Rua Teste",
            "bairro": "Centro",
            "cidade": "São Paulo",
            "uf": "SP",
            "numero": "123",
            "complemento": "Fundos",
            "referencia": "",
            "prazoEntrega": "7 dias úteis",
            "tipoFrete": "1972",
            "codigoRastreio": "",
            "linkRastreio": ""
        },
        "valores": {
            "subtotal": 900,
            "frete": 12.87,
            "desconto": 0,
            "total": 912.87
        },
        "fiscal": {
            "nfeSerie": "",
            "nfeNumero": "",
            "nfeChave": ""
        }
    },
    "produto": {},
    "seller": {
        "id": 16,
        "nome": "Seller Omni",
        "cnpj": "11217233000167"
    },
    "cancelamentoPedido": {
        "status": "aberto",
        "comissaoRetida": false
    },
    "devolucaoPedido": {},
    "contestacaoRepasse": {},
    "ultimoInteragente": "cliente",
    "status": "aberto",
    "atendimento": "normal",
    "vencido": false,
    "datas": {
        "criacao": "2019-10-28 15:50:38",
        "ultimaInteracao": "2019-10-28 15:50:38",
        "vencimento": "2019-10-30 15:50:38",
        "finalizacao": ""
    }
}

{
	"id": 30,
	"assunto": "Cadastro de produto - Outros",
	"origem": {
		"perfil": "seller",
		"nome": "Seller Omni",
		"email": "atendimento@selleromni.com.br"
	},
	"destino": {
		"perfil": "marketplace",
		"nome": "Wapstore Marketplace",
		"email": "atendimento@marketplacewapstore.com.br"
	},
	"pedido": {},
	"produto": {
		"skuProduto": "testecsv",
		"nome": "Primeiro produto P",
		"ativo": true,
		"precoDe": "459.99",
		"precoPor": "429.00",
		"precoDeMidia": "459.99",
		"precoPorMidia": "429.00",
		"estoque": "12"
	},
	"seller": {
		"id": 16,
		"nome": "Seller Omni",
		"cnpj": "11217233000167"
	},
    "cancelamentoPedido": {},
    "devolucaoPedido": {},
    "contestacaoRepasse": {},
    "ultimoInteragente": "seller",
    "status": "aberto",
    "atendimento": "normal",
    "vencido": false,
    "datas": {
        "criacao": "2019-10-28 15:50:38",
        "ultimaInteracao": "2019-10-28 15:50:38",
        "vencimento": "2019-10-30 15:50:38",
        "finalizacao": ""
	}
}

Detalhes do Response

GET /v1/protocols/{id}/messages

Recurso responsável por listar todas as mensagens de um protocolo, ordenados por data de envio.

Response

{
    "mensagens": [
        {
            "id": 84,
            "nome": "Alexandre Medeiros",
            "email": "alexandremedeiros@omni.com.br",
            "tipo": "texto",
            "texto": "Conteúdo da mensagem",
            "anexos": [],
            "origem": "cliente",
            "destino": "seller",
            "mediacao": false,
            "mensagemAutomatica": false,
            "data": "2019-09-16 14:33:23"
        }
    ],
    "info": {
        "filtros": [],
        "prev": "",
        "self": "https://api.sandbox.omni.wapstore.com.br/v1/protocols/30/message?offset=0&limit=100",
        "next": "",
        "offset": 0,
        "limit": 100,
        "exibindo": 1,
        "total": 1
    }
}

Detalhes do Response

POST /v1/protocols

Recurso responsável por criar protocolos. Cada protocolo poderá ser referente a um pedido, produto, contrato, financeiro ou geral.

Importante:

Protocolos vinculados a um pedido, deverá conter um valor válido no campo idPedidoPlataforma.

Protocolos vinculado a um produto, deverá conter um valor válido no campo skuProduto.

Protocolos de cancelamento e devolução de pedidos:

Como regra de negócio, todo cancelamento e devolução de pedido que contenha um ou mais produtos de marketplace, deverá passar pela abertura de um protocolo.

Para isso, é necessário preencher o campo acao com a ação responsável por cancelamento e devolução de pedidos.

Protocolos de contestação de repasses:

Outra modalidade de protocolo disponível é a de contestação de repasses. Através dela, é possível contestar os lançamentos na conta corrente referentes a um pedido.

Para isso, é necessário preencher o campo acao com a ação responsável por contestação de repasse de pedidos.

Importante: Ao iniciar uma contestação de repasse, os lançamentos do pedido ficarão com status 'bloqueado' até que o protocolo seja finalizado.

Request

{
  "idSeller": 16,
  "pedido": "3737-1",
  "skuProduto": "",
  "assunto": "Cancelamento de pedido",
  "acao": "cancelamentoPedido",
  "origem": {
    "tipo": "cliente",
    "nome": "Alexandre Medeiros",
    "email": "alexandremedeiros@omni.com.br"
  },
  "destino": {
    "tipo": "seller",
    "nome": "Seller Omni",
    "email": "atendimento@selleromni.com.br"
  },
  "mensagem": {
    "texto": "Mensagem de teste",
    "anexos": [
      "https://api.sandbox.omni.wapstore.com.br/upload/protocolo/chat/imagem.jpg",
      "https://api.sandbox.omni.wapstore.com.br/upload/protocolo/chat/arquivo.pdf"
    ]
  }
}

Detalhes da Request

Response

{
    "id": 30,
    "assunto": "Cancelamento - Desistência",
    "origem": {
        "perfil": "cliente",
        "nome": "Alexandre Medeiros",
        "email": "alexandremedeiros@omni.com.br"
    },
    "destino": {
        "perfil": "seller",
        "nome": "Seller Omni",
        "email": "atendimento@selleromni.com.br"
    },
    "pedido": {
        "idPedido": 192052,
        "idPlataforma": 1052,
        "idPedidoCanal": "123123176",
        "referenciaPedidoCanal": "3737-1",
        "dataEmissao": "2019-08-09 14:32:28",
        "dataIntegracao": "2019-08-09 15:00:20",
        "status": 1,
        "canal": {
            "canal": "Wapstore Marketplace",
            "canalIntegracao": "Loja marketplace",
            "hashCanal": "wapstoremarketplace"
        },
        "cliente": {
            "nome": "Alexandre Medeiros",
            "email": "alexandremedeiros@omni.com.br",
            "cpfCnpj": "45925807022",
            "pessoa": "m",
            "telefone": "",
            "celular": "(11) 99123-4567"
        },
        "entrega": {
            "cep": "16202999",
            "destinatario": "Alexandre Medeiros",
            "endereco": "Rua Teste",
            "bairro": "Centro",
            "cidade": "São Paulo",
            "uf": "SP",
            "numero": "123",
            "complemento": "Fundos",
            "referencia": "",
            "prazoEntrega": "7 dias úteis",
            "tipoFrete": "1972",
            "codigoRastreio": "",
            "linkRastreio": ""
        },
        "valores": {
            "subtotal": 900,
            "frete": 12.87,
            "desconto": 0,
            "total": 912.87
        },
        "fiscal": {
            "nfeSerie": "",
            "nfeNumero": "",
            "nfeChave": ""
        }
    },
    "produto": {},
    "seller": {
        "id": 16,
        "nome": "Seller Omni",
        "cnpj": "11217233000167"
    },
    "cancelamentoPedido": {
        "status": "aberto",
        "comissaoRetida": false
    },
    "devolucaoPedido": {},
    "contestacaoRepasse": {},
    "ultimoInteragente": "cliente",
    "status": "aberto",
    "atendimento": "normal",
    "vencido": false,
    "datas": {
        "criacao": "2019-10-28 15:50:38",
        "ultimaInteracao": "2019-10-28 15:50:38",
        "vencimento": "2019-10-30 15:50:38",
        "finalizacao": ""
    }
}

Detalhes do Response

POST /v1/protocols/{id}/messages

Recurso responsável por criar mensagens em um protocolo.

A cada envio, o nó 'mensagem' poderá conter uma mensagem de texto e um ou mais anexos.

Request

{
	"idSeller": 16,
	"origem": "cliente",
	"destino": "seller",
	"mensagem": {
		"texto": "Mensagem de teste",
		"anexos": [
			"https://api.sandbox.omni.wapstore.com.br/upload/protocolo/chat/imagem.jpg",
			"https://api.sandbox.omni.wapstore.com.br/upload/protocolo/chat/arquivo.pdf"
		]
	}
}

Detalhes da Request

Response

{
  "status": true
}

Detalhes do Response

PUT /v1/protocols/{id}/cancel-order

Recurso responsável por confirmar ou revogar uma solicitação de cancelamento de pedido.

Request

{
  "status": "confirmado",
  "comissaoRetida": true
}

Detalhes da Request

PUT /v1/protocols/{id}/devolution-order

Recurso responsável por confirmar ou revogar uma solicitação de devolução de pedido.

Request

{
  "status": "confirmado",
  "comissaoRetida": false
}

Detalhes da Request

POST /v1/shipment

Recurso responsável por víncular uma etiqueta ao pedido na loja.

Request

{
    "orderId": "175XPCAP21564564QE",
    "sellerId": 1,
    "shipmentContent": "JVBERi0xLjQKJcTl8uXrp/Og0MTGCjEgMCBvYmoKPDwgL1R5cGUgL0NhdGFsb2cgL1BhZ2VzIDIgMCBSCj4+CmVuZG9iagoKMiAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzMgMCBSXQovQ291bnQgMQo+PgplbmRvYmoKCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovQ29udGVudHMgNCAwIFIKL1Jlc291cmNlcyA8PCAvRm9udCA8PCAvRjEgNSAwIFI+PiA+Pgo+PgplbmRvYmoKCjQgMCBvYmoKPDwgL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDI0IFRmCjEwMCA3MDAgVGQKKFBERiBURVNURSBCQVNFMjQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKCjUgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDk3IDAwMDAwIG4gCjAwMDAwMDAxNjUgMDAwMDAgbiAKMDAwMDAwMDI2NSAwMDAwMCBuIAowMDAwMDAwMzU0IDAwMDAwIG4gCjAwMDAwMDA0NDQgMDAwMDAgbiAKdHJhaWxlcgo8PCAvUm9vdCAxIDAgUgovU2l6ZSA2Cj4+CnN0YXJ0eHJlZgo1NTIKJSVFT0YK",
    "type": "pdf"
}

Detalhes da Request

Status de pedido

Status válidos para pedidos no Hub de Marketplaces.

Marketplaces Integrados

Canais de Marketplace integrados com o Hub de Marketplaces.

Status de resposta HTTP

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