API de Relatórios - Lomadee Developers

Recursos:

Consulte suas vendas

Com este recurso você poderá consultar via API as vendas realizadas por você na SocialSoul, com período de até 90 dias a partir da data inicial informada.

O método abaixo deve ser utilizado para criar o token de autenticação para consultar suas vendas.

GET /api/lomadee/createToken/

URL

Produção	https://api.lomadee.com

HEADERS

Accept	application/json; charset=utf-8

REQUEST

Exemplo: https://api.lomadee.com/api/lomadee/createToken/?user=xxx@xxx.com&password=xxxx

Nome	Tipo		Descrição
user	QueryString	Obrigatório	E-mail de acesso na SocialSoul
password	QueryString	Obrigatório	Senha de acesso na SocialSoul

RESPONSE

Status Code: 200

Na resposta do callback deverá ser retornado o status, token e message, conforme exemplo abaixo:

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
status	Indice se o serviço criou o token corretamente (true).
token	Token de autenticação que deverá ser utilizado na consulta de transações.
message	Mensagem mostrada em caso de erro durante a execução do serviço.

O método abaixo deve ser utilizado para consultar todas as vendas de um consultor da SocialSoul.

GET /api/lomadee/reportTransaction

URL

Produção	https://api.lomadee.com

HEADERS

Accept	application/xml

Exemplo

https://api.lomadee.com/api/lomadee/reportTransaction?publisherId={publisherId}&token={token}

REQUEST

PARÂMETROS

Nome	Tipo		Descrição
token	QueryString	Obrigatório	Token gerado no serviço "/api/lomadee/createToken/"
startDate	QueryString	Obrigatório	Data inicial da consulta no formato ddMMaaaa
endDate	QueryString	Obrigatório	Data final da consulta no formato ddMMaaaa, com intervalo de até 90 dias a partir da data inicial.
eventStatus	QueryString	Obrigatório	Status das Transações: 0 - Pendente, 1 - Confirmado, 2 - Cancelado, 99 - Bônus
publisherId	QueryString	Obrigatório	ID do Publisher que se deseja visualizar o relatório

RESPONSE

Status Code: 200

Na resposta do callback deverá ser retornado o XML com as informações do Publisher para consulta, conforme exemplo abaixo:

BODY

Ver Modelo | Ver Atributos

Nome	Descrição
details.timestamp	Data e Hora da consulta.
details.code	Indice o status da requisição. Os status possíveis são: 0 - Sucesso, 112 - Erro Interno, 212 - Data inicial inválida, 213 - Data final inválida, 214 - Range de data inválido, 215 - Data inicial maior que a final, 217 - Parâmetro eventStatus inválido. 218 - Publisher ID não pertence ao usuário logado.
details.elapsedTime	Tempo de resposta em milissegundos.
details.message	Mensagem de sucesso ou erro.
details.status	Indica o status da requisição. Status possíveis são: 0 - Sucesso, 112 - Erro Interno, 212 - Data inicial inválida, 213 - Data final inválida, 214 - Range de data inválido, 215 - Data inicial maior que a final, 217 - Parâmetro eventStatus inválido. 218 - Publisher ID não pertence ao usuário logado.
item.date	Data do qual a transação foi realizada.
item.currency	Se refere à moeda utilizada para pagamento. Como grande parte dos nossos anunciantes são do Brasil esse campo possivelmente será BRL.
item.commission	Aqui será mostrado o valor total gerado de comissão somando todos os produtos de uma punica transação.
item.associateId	Esse campo carrega o parâmetro mdasc (Sub Id), caso você seja NetPublisher.
item.site.siteId	Esse campo retorna o ID do site (cadastrado na SocialSoul).
item.site.siteName	Aqui entra o nome do site do consultor onde a transação foi gerada. Se o consultor divulga em mais de um site, esse campo irá variar de acordo com o site.
item.advertiser.advertiserId	ID da marca.
item.advertiser.advertiserName	Nome da marca.
item.events.eventId	ID do evento na SocialSoul.
item.events.eventName	Nome do evento cadastrado na SocialSoul.
item.events.eventType	Tipo do evento cadastrado na SocialSoul.
item.events.comission	Valor da comissão gerada para aquele evento.
item.events.gmv	Valor do(s) produto(s) relacionados ao evento.
item.application.applicationId	ID da aplicação.
item.application.applicationName	Nome da aplicação.item.
item.gmv	Esse campo retorna o valor total da transação.
item.transactionCode	Código do pedido enviado pela marca.
item.transactionId	ID da transação informado pela SocialSoul (interno).
item.statusId	ID referente ao status da transação. Seus valores são: 0, 1, 2.
item.statusName	Status da Transação. Seus valores são: Pendente, Confirmada, Cancelada.
item.processedDate	Data em que houve alteração do status da transação.
item.clickDate	Data em que o usuário foi impactado pelo formato.
item.checkoutDate	Data em que a transação ocorreu.