Creación de una ruta

Este proceso es asíncrono, puedes entrar en el sistema para ver su progreso o la ruta creada.

Endpoint

POST {{SHIPPIFY_API_URL}}/v1/routes/create

Request

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
routes	arreglo de objetos	Objeto con datos de rutas.	SI
routes[n].deliveries	arreglo de strings	Lista de todas las entregas para las que deseas crear una ruta.	SI
iterations	número	Nivel de optimización.	SI	Puede ser 1-10, cuando es 1 la ruta toma el orden de la lista.

Response

Propiedad	Tipo	Descripción
code	string	Código del resultado.
message	string	Descripción del resultado.
data	objeto	Datos sobre el proceso de ejecución.

Ejemplo

Request

curl --location --request POST 'https://api.shippify.co/v1/routes/create' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
    "routes": [
        {
            "deliveries": [
              "t-pruaas-4973",
              "t-pruaas-4972"
            ]
        }
    ],
    "iterations": 1
}'

200 Success

{
    "code": "OK",
    "data": {
        "jobs": [
            {
                "id": "SF_2101542",
                "percentage": 0,
                "userId": "ijuk8rfq5fctwrtp6m20rudi",
                "totalDeliveries": 2
            }
        ],
        "routes": []
    },
    "message": "Proceso creado exitosamente"
}