Criar rota

Este processo é assíncrono; você pode acessar o sistema para ver seu progresso ou a rota criada.

Endpoint

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

Request

Propriedade	Tipo	Descrição	Obrigatório	Restrições
routes	array de objetos	Objeto com dados das rotas.	SIM
routes[n].deliveries	array de strings	Lista todas as entregas que deseja criar uma rota.	SIM
iterations	número	Nível de otimização	SIM	Pode ser de 1 a 10, quando é 1 a rota segue a ordem da lista.

Propriedade

Tipo

Descrição

Obrigatório

Restrições

routes

array de objetos

Objeto com dados das rotas.

SIM

routes[n].deliveries

array de strings

Lista todas as entregas que deseja criar uma rota.

SIM

iterations

número

Nível de otimização

SIM

Pode ser de 1 a 10, quando é 1 a rota segue a ordem da lista.

Response

Propriedade	Tipo	Descrição
code	string	Resultado do código.
message	string	Descrição do resultado.
data	object	Dados do processo de execução.

Propriedade

Tipo

Descrição

code

string

Resultado do código.

message

string

Descrição do resultado.

data

object

Dados do processo de execução.

Exemplo

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
}'

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

AnteriorRota SiguienteEditar