Transportadora que tem equipe de desenvolvimento
AS etapas abaixo são para transportadoras que possuem equipe de desenvolvimento de software e que irão se integrar através das apis da open.
Etapa criação conta ID Magalu e Configuração Organização CNPJ
Nesta etapa, você deverá criar uma Conta ID Magalu, caso ainda não tenha uma.
Acesse o site https://id.magalu.com/ e realize o cadastro, informando seu e-mail e CPF (pessoa física) na primeira etapa.
Após o login no ID Magalu, será necessário criar sua organização, caso ela ainda não exista. Para isso:
- Acesse o menu Avançado;
- Clique em Organizações;
- Selecione Criar nova organização;
- Preencha os dados solicitados.
Etapa criação ClientID e geração de Token
Basta seguir o processo de solicitação de criação de aplicação.
Para geração de token basta seguir autenticação e autorização
Lembrar de utilizar o escopos open:logistic-carrier-shippings:read e open:logistic-carrier-trackings:create
Receber remessas para iniciar transporte
Toda vez que uma remessa for atribuída para sua transportadora e ela estiver pronta para ser Transportada, internamente mudaremos a remessa para uma etapa(step) de READY_TO_SHIP(pronto para transporte), portanto a transportadora deverá criar uma assinatura de webhook para o topico logistic_carrier_shippings_updated. Para este cadastro será necessário uma url de callback da transportadora para que ela possa receber as remessas.
Consultar remessa
Após receber a notificação via webhook a transportadora deverá fazer o GET na remessa que lá retornara todas as informações para realizar a coleta e transporte.
Aconselhamos a transportadora toda vez que consumir uma remessa a verificar seller e local de coleta(campo origin e origin.destination do payload) realmente existe na sua base. Caso a transportadora não tenha conhecimento deste poderá ser penalizada pela auto regulamentação (nível de serviço prestado).
Enviar eventos de Tracking da remessa
A transportadora deverá enviar os trackings de cada remessa de acordo com a evolução do transporte, para isto deverá utilizar esta lista abaixo com os devidos status, utilizando os endpoint POST tracking
| Event | Descrição |
|---|---|
| DELIVERED | Entregue |
| DELIVERYMAN_ARRIVE_AT_RECIPIENT | Entregador chegou no destinatário |
| DELIVERY_ATTEMPT | Tentativa de entrega |
| DELIVERY_RETURNED | Entregador retornando para local de coleta |
| IN_DELIVERED_ROUTE | Em rota de entrega |
| IN_ROUTE_PICKUP | Em rota para local de coleta |
| PICKED_UP | Coletado |
| RECIPIENT_ADDRESS_NOT_FOUND | Endereço do destinatário não encontrado |
| RECIPIENT_OUT | Destinatário ausente |
| UNKNOWN_RECIPIENT | Destinatário desconhecido |
| WAITING_PICKUP | Aguardando Coleta |
Ao enviar o status de DELIVERED, neste terá a opção de enviar mais campos com dados de quem recebeu o pacote e dados do canhoto de entrega. Caso será enviado informações consistente ajudará na auto regulamentação(nível de serviço de transporte)