Atribuir motorista

Você pode usar esse endpoint para atribuir um motorista a uma entrega ou rota.

Se uma entrega pertence a uma rota, você deve atribuir o motorista à rota, não à entrega.

Endpoint

POST {{SHIPPIFY_API_URL}}/v1/routes/:id/assign

Request

Parâmetro

Propriedade	Tipo	Descrição	Obrigatório	Restrições
id	string	ID da rota ou entrega criada dentro do sistema.	SIM

Body

Only one of the following parameters is required.

Propriedade	Tipo	Descrição	Obrigatório	Restrições
courierId	int	ID do motorista no sistema.	SIM
vehicleId	int	Atribui o motorista associado ao identificador do veículo no sistema.	NÃO
vehicleReferenceId	string	Atribui o motorista associado ao identificador externo do veículo.	NÃO

Response

Propriedade	Tipo	Descrição
code	string	Resultado do código.

Exemplo

Request

curl --location --request POST 'https://api.shippify.co/v1/routes/r-shiinc-2216524/assign' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
    "courierId": 396930
}'

200 Success

{
    "code": "OK"
}