Mastransporte API Tarifas

Introducción

API de tarifas para conectarse a Mastransporte.

Overview

Esta documentación es una guía de cómo se debe crear el servicio rest para disponibilizar a Mastransporte.

Se dejará un ejemplo de lo que Mastransporte espera enviar a dicha API.

Estructura base del body

Plain Text

{
    "packages": [
        {
            "withdrawalCommune": "",
            "items": [
                {
                    "sku": "",
                    "name": "",
                    "price": "",
                    "piledUp": "", // Apilado
                    "piledUpQuantity": "", // Cantidad apilada
                    "weight": "",
                    "rawWeight": "",
                    "volume": {
                        "height": "",
                        "width": "",
                        "long": ""
                    },
                    "density": "",
                    "quantity": ""
                }
            ]
        }
    ],
    "dispatchAddress": {
        "commune": "",
        "address": "", // Ejemplo: Av. La Travesia
        "addressNumber": "", // Ejemplo: 858
        "locationNumber": "" // Número de departamento/oficina. Ejemplo: 408
    },
    "totalWeight": "",
    "totalVolume": "",
    "totalDensity": ""
}

Estructura base de la respuesta

Plain Text

{
    "carrier": {
        "code": "",
        "name": "",
        "image": ""
    },
    "widthdrawalAddreses": [
        {
            "commune": "",
            "packages": [
                {
                    "products": [
                        {
                            "code": "",
                            "name": "",
                            "price": "",
                            "quantity": ""
                        }
                    ],
                    "weight": "",
                    "volume": {
                        "height": "",
                        "width": "",
                        "long": ""
                    },
                    "density": "",
                    "feePrice": ""
                }
            ]
        }
    ],
    "orderMode": "",
    "totalFeePrice": "",
    "adicionalService": "",
    "observation": "",
    "success": true
}

Posibles códigos HTTP de respuesta

Códigos HTTP	Significado
200	Se hizo la petición de manera exitosa
403	Acceso denegado. No se envió el token vía header
400	No se enviaron los datos correctos
500	Error interno. Problema no manejado por la API

Notas

Se debe enviar un token vía header, el cual será proporcionado por Mastransporte. Dicho header se debe llamar "X-AUTH-TOKEN".

El token y dominio de la api usados en el ejemplo de abajo, son meramente una referencia, no es un caso real.