Eventos de Notificação - Versão 1.0

Especificação para exposição de recurso Restful para eventos de notificação vindas do Marketplace.

Notas da versão

Versão inicial da especificação.

Tipos de notificação

Para essa versão, apenas a notificação em eventos de pedidos está disponível.

Eventos de notificação para pedidos

Os seguintes tipos de eventos de notificação de pedidos serão enviados pelo Marketplace:

NEW: Criação de novo pedido

RAA: Risco de aprovação - Pagamento pendente
APPROVED: Aprovação de um pedido
CANCELED: Cancelamento de pedido
CANCELED DENIED: Cancelamento de pedido negado (casos onde ocorreu algum problema no cancelamento)

Exemplo de Chamada

POST https://<dominio_lojista>/<uri_opcional>

Dados de Entrada

Campo Tipo Descrição Exemplo Obrigatório
eventDate Data e Hora Data de ocorrência do evento notificado. 2013-06-28T08:54:00.000-03:00 Sim
sellerId Numérico Inteiro Identificador do Lojista. 3 Sim
eventType Texto Tipo do evento ocorrido para a ordem notificada.
Valores permitidos: NEW, APPROVED, CANCELED ou CANCELED DENIED
NEW Sim
resourceType Texto Recurso da API que foi afetado. Nessa caso, será 'Orders' Orders Sim
resourceId Numérico Inteiro Identificador da ordem afetada. 5 Sim
uriResource Texto URI para consulta do recurso afetado. /orders/5 Sim

Exemplo de Request

Exemplo de um evento de criação de Pedido

Toda vez que um pedido é criado no Marketplace, um evento é gerado. Então é enviada a seguinte mensagem para a URL de Callback cadastrada:

{
    "eventDate" : "2013-06-28T08:54:00.000-03:00",
    "sellerId" : "3",
    "eventType" : "New",
    "resourceType" : "Orders",
    "resourceId" : "5",
    "uriResource" : "/orders/5"
}

Sobre a utilização

O Marketplace realiza o reenvio do Evento caso sua aplicação esteja indisponível. São realizadas 5 tentativas e, não havendo sucesso, o envio do Evento é cancelado.

Recomendamos que, duas ou três vezes ao dia, sejam realizadas consultas nos serviços que você aguarda receber Eventos. Por exemplo, consultando a lista de pedidos novos (GET /orders/status/new) duas vezes ao dia, é possível garantir que, caso tenha ocorrido alguma falha no envio de evento de um novo pedido, o mesmo não deixará de ser integrado no seu sistema.

Os Eventos são apenas notificações. Para obter as informações é necessário buscá-las no serviço relacionado ao Evento recebido. O recurso fica disponível no campo uriResource.

Configuração

Para utilizar um recurso de eventos no Marketplace, basta informar o campo ULR de Callback disponível na tela de cadastro da APP. Esse campo pode ser alterado a qualquer momento no painel do desenvolvedor.

Português, Brasil