Assign driver

You can use the endpoint to assign a driver to delivery or route.

If a delivery belongs to a route, you must assign the driver to the route, not the delivery.

Endpoint

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

Request

Params

Property	Type	Description	Required	Constraints
id	string	Id of the route or delivery created within the system	YES

Body

Only one of the following parameters is required.

Property	Type	Description	Required	Constraints
courierId	int	Driver id in the system	YES
vehicleId	int	Assigns the driver associated with the vehicle identifier in the system.	NO
vehicleReferenceId	string	Assigns the driver associated with the vehicle's external identifier	NO

Response

Property	Type	Description
code	string	Result code.

Example

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