Deliveries API
Search
K
Comment on page

Create

This process is asynchronous, you can enter the system to see its progress or the route created.

Endpoint

POST /v1/routes/create

Request

Property
Type
Description
Required
Constraints
routes
array of objects
Object with routes data
YES
routes[n].deliveries
array of strings
List all the deliveries you want to create a route.
YES
iterations
number
Optimization level
YES
It can be 1-10, when it is 1 the route takes the order of the list

Response

Property
Type
Description
code
string
Result code.
message
string
Result description.
data
object
Execution process data.

Example

Request
200 Success
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"
}
Last modified 1mo ago