Documentação API

Setup

Início

Bem vindo à documentação da Api da Moove.

Para qualquer chamada à nossa API, é necessário utilizar a vossa chave única.

Primeiros Passos

Para integrar a vossa plataforma com a nossa API, deve ter a vossa chave de API em mãos.

De seguida, basta configurar o vosso sistema para enviar / receber requisições conforme descrito nas próximas secções desta documentação.

Postagens

Criação de postagens

Endpoint para ambiente de testes

 POST "https://stg-api.moovelogistica.pt/moove_api/v1/criar_postagem"

Endpoint para ambiente de produção

 POST "https://api.moovelogistica.pt/moove_api/v1/criar_postagem"

Para criação de postagens, o usuário deve enviar uma requisição de api para o endereço acima com os parametros necessários.

Headers

            {
                "Content-Type": "application/json",
                "Authorization": "YOUR_API_KEY_HERE"
            }

Body

            {
            "posts":
                [
                    {
                        "post": {
                        "client_number": "000000000",
                        "dispatch_date": "2020-11-25",
                        "weight_in_grams": 60.5,
                        "width_in_centimeters": 60.5,
                        "length_in_centimeters": 60.5,
                        "height_in_centimeters": 60.0,
                        "invoice_number": "12345",
                        "note_1": "YOUR_NOTES_HERE",
                        "note_2": "INTERNAL_NOTES",
                        "recipient_charge": 50.75,
                        "volumes": 1,
                        },
                        "recipient_address": {
                        "country":"RECIPIENT_COUNRTY",
                        "zipcode":"RECIPIENT_ZIPCODE",
                        "street_name":"RECIPIENT_STREET_NAME",
                        "city":"RECIPIENT_CITY",
                        "state":"RECIPIENT_STATE"
                        },
                        "recipient_data": {
                        "name": "RECIPIENT_NAME",
                        "phone_1": "RECIPIENT_PHONE",
                        "email": "RECIPIENT_EMAIL"
                        }
                    },
                    {
                        "post": {
                        "client_number": "000000001",
                        "dispatch_date": "2020-11-25",
                        "weight_in_grams": 60.5,
                        "width_in_centimeters": 60.5,
                        "length_in_centimeters": 60.5,
                        "height_in_centimeters": 60.0,
                        "invoice_number": "12345",
                        "note_1": "YOUR_NOTES_HERE",
                        "note_2": "INTERNAL_NOTES",
                        "recipient_charge": 50.75,
                        "volumes": 2,
                        },
                        "recipient_address": {
                        "country":"RECIPIENT_COUNRTY",
                        "zipcode":"RECIPIENT_ZIPCODE",
                        "street_name":"RECIPIENT_STREET_NAME",
                        "city":"RECIPIENT_CITY",
                        "state":"RECIPIENT_STATE"
                        },
                        "recipient_data": {
                        "name": "RECIPIENT_NAME",
                        "phone_1": "RECIPIENT_PHONE",
                        "email": "RECIPIENT_EMAIL"
                        },
                        "additional_services": ["fragile"]
                    }
                ]
            }
Atributo Tipo Descrição Preenchimento
client_number String Número do pedido Obrigatório
dispatch_date String Data de envio do objeto Obrigatório
weight_in_grams Float Peso do objeto em gramas Obrigatório
width_in_centimeters Float Largura do objeto em centímetros Opcional
length_in_centimeters Float Comprimento do objeto em centímetros Opcional
height_in_centimeters Float Altura do objeto em centímetros Opcional
invoice_number String Número do documento Opcional
note_1 String Observações acerca da postagem Opcional
note_2 String Observações internas acerca da postagem Opcional
recipient_charge String Valor a ser cobrado no destino, se aplicável. Só pode ser preenchido caso 'cobrar no destino' tenha sido selecionado como serviço adicional Opcional
volumes Integer Quantidade de volumes da postagem Opcional
country String País do destinatário Obrigatório
zipcode String Código postal do destinatário Obrigatório
street_name String Morada do destinatário Obrigatório
city String Concelho do destinatário Obrigatório
state String Distrito do destinatário Obrigatório
name String Nome de contacto do destinatário Obrigatório
phone_1 String Número de contacto do destinatário Opcional
email String Email do destinatário Opcional
additional_services Array Lista de serviços adicionais solicitados pelo cliente para a postagem Opcional

Consulta de uma postagem

Endpoint para ambiente de testes

 GET "https://stg-api.moovelogistica.pt/moove_api/v1/post_status/:tracking_code"

Endpoint para ambiente de produção

 GET "https://api.moovelogistica.pt/moove_api/v1/post_status/:tracking_code"

Para consulta de uma postagem, o usuário deve enviar uma requisição de api para o endereço acima com os parâmetros necessários.

Deve, também, substituir o parâmetro :tracking_code pelo código de rastreio único da Moove.

Headers

            {
                "Content-Type": "application/json",
                "Authorization": "YOUR_API_KEY_HERE"
            }
Atributo Tipo Descrição Exemplo
tracking_code Parâmetro na url Código de rastreio único da Moove MO1606423693

Resposta em caso de sucesso

            {
                "tracking_code": "MO1606423693",
                "carrier_status": "aguardando envio transportadora",
                "client_number": "MRR3456",
                "volumes": 1,
                "label": "WyJ7OmJlc3RfZW5jb2Rpbmc9PlwiODUwXCIsIDpmaWxlX25hbWU9PlwiRVRV
                QiwwXkZTXFxy\nXFxuXkZPNjU3LDEwMDBeR0I1MCwxNzUsNTAsQiwwXkZTXFxyXFxuXkZ
                PNjU3\nLDY3NV5HQjUwLDUwMCVEIsMzQsMzhe...pcXHJcIn0iXQ==\n",
                "dispatch_date": "25/11/2020 00:00:00",
                "post_status": "Sem status"
            }

Observação: a resposta devolvida no campo "label" está encriptada em base64.

Resposta em caso de falha na pesquisa da postagem

            {
                "error": "Post not found",
                "message": "Please check the tracking code"
            }

Resposta em caso de falha na validação da vossa chave de API

           
            {
                "error": "Invalid Token key",
                "status": "403"
            }