IZIVAN API (1.0.0)

Download OpenAPI specification:

E-mail: hello@izivan.co URL: https://izivan.co

Authentication

Use this to get the token for authentication

Authentication

Request Body schema: application/json

Body of the POST request

username required	string
password required	string
grantType	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"grantType": "string"
}

Available Days

Use this to check available days

Returns available dates, hours, slots and holidays

Returns available dates, hours, slots and holidays for a truck type starting from a give date

Authorizations:

token

query Parameters

startDate required	string <date-time> Query parameter startDate (yyyy-mm-dd HH:MM:ss)
truckTypeId required	string Query parameter truckTypeId ('trucktype' represented by a unique ID)

Responses

Returns next available delivery dates

Authorizations:

token

query Parameters

estimate

required

string

Query parameter estimate ('estimate' represented by a unique ID)

Responses

Estimates

Operations related to Estimates

Request a transport estimate

Authorizations:

token

Request Body schema: application/json

Body of the POST request

required	object (GeographicAddress)
required	object (GeographicAddress)
truckTypeId required	string Identifier for the truck type from GET /truck-types
exactSenderAddr required	string Full sender address
senderName required	string Sender name or company
senderPhoneNumber required	string Sender phone number
exactRecipientAddr required	string Full recipient address
recipientName required	string Recipient name or company
recipientPhoneNumber required	string Recipient phone number
additionnalInfo	string
truckNumber required	integer Number of trucks requested
articleType required	string Type/category of transported goods from GET /article-types
loadingDate required	string <date> Requested loading date (YYYY-MM-DD)
loadingIsFixedHour required	boolean Whether loading is at a fixed hour
loadingFixedHour	string^([01]\\d\|2[0-3]):([0-5]\\d)$ Fixed loading hour (HH:mm) when loadingIsFixedHour is true
loadingTimeSlot	string Loading time slot range from GET /next-available-days
needLoadingAssist	boolean Whether loading assistance is required
needUnloadingAssist	boolean Whether unloading assistance is required
needTailgate	boolean Whether a tailgate is required
needInsurance required	boolean if the transport needs an insurance or not
articleValue	number The value of the articles

Responses

Request samples

Payload

Content type

application/json

{"senderAddrPoint": {"address": "string",
"lat": 0.1,
"lng": 0.1
},
"recipientAddrPoint": {"address": "string",
"lat": 0.1,
"lng": 0.1
},
"truckTypeId": "1687874819944x812594600271066900",
"exactSenderAddr": "pharmacie totot, Bouaké, Côte d'ivoire'",
"senderName": "SENDER NAME",
"senderPhoneNumber": "0123456789",
"exactRecipientAddr": "pharmacie tata, Abidjan, Côte d'ivoire",
"recipientName": "RECIPIENT NAME",
"recipientPhoneNumber": "0123456789",
"additionnalInfo": "string",
"truckNumber": 2,
"articleType": "Alimentaire",
"loadingDate": "2025-10-06",
"loadingIsFixedHour": true,
"loadingFixedHour": "13:00",
"loadingTimeSlot": "12:00 - 16:00",
"needLoadingAssist": true,
"needUnloadingAssist": false,
"needTailgate": false,
"needInsurance": false,
"articleValue": 1500000
}

Request a transport estimate without loading date

Authorizations:

token

Request Body schema: application/json

Body of the POST request

required	object (GeographicAddress)
required	object (GeographicAddress)
truckTypeId required	string Identifier for the truck type from GET /truck-types
exactSenderAddr required	string Full sender address
senderName required	string Sender name or company
senderPhoneNumber required	string Sender phone number
exactRecipientAddr required	string Full recipient address
recipientName required	string Recipient name or company
recipientPhoneNumber required	string Recipient phone number
additionnalInfo	string
truckNumber required	integer Number of trucks requested
articleType required	string Type/category of transported goods from GET /article-types
needLoadingAssist	boolean Whether loading assistance is required
needUnloadingAssist	boolean Whether unloading assistance is required
needTailgate	boolean Whether a tailgate is required
needInsurance required	boolean if the transport needs an insurance or not
articleValue	number The value of the articles

Responses

Request samples

Payload

Content type

application/json

{"senderAddrPoint": {"address": "string",
"lat": 0.1,
"lng": 0.1
},
"recipientAddrPoint": {"address": "string",
"lat": 0.1,
"lng": 0.1
},
"truckTypeId": "1687874819944x812594600271066900",
"exactSenderAddr": "pharmacie totot, Bouaké, Côte d'ivoire'",
"senderName": "SENDER NAME",
"senderPhoneNumber": "0123456789",
"exactRecipientAddr": "pharmacie tata, Abidjan, Côte d'ivoire",
"recipientName": "RECIPIENT NAME",
"recipientPhoneNumber": "0123456789",
"additionnalInfo": "string",
"truckNumber": 2,
"articleType": "Alimentaire",
"needLoadingAssist": true,
"needUnloadingAssist": false,
"needTailgate": false,
"needInsurance": false,
"articleValue": 1500000
}

Accept an Estimate

Authorizations:

token

Request Body schema: application/json

Body of the POST request

id

required

string

Unique estimate identifier

Responses

Request samples

Payload

Content type

application/json

{"id": "1759607930750x141523411231504690"
}

Refuse an Estimate

Authorizations:

token

Request Body schema: application/json

Body of the POST request

id

required

string

Unique estimate identifier

Responses

Request samples

Payload

Content type

application/json

{"id": "1759607930750x141523411231504690"
}

Update loading Date

Authorizations:

token

Request Body schema: application/json

Body of the POST request

estimateId required	string Unique estimate identifier
loadingDate required	string <date> Requested loading date (YYYY-MM-DD)
loadingIsFixedHour required	boolean Whether loading is at a fixed hour
loadingFixedHour	string^([01]\\d\|2[0-3]):([0-5]\\d)$ Fixed loading hour (HH:mm) when loadingIsFixedHour is true
loadingTimeSlot	string Loading time slot range from GET /next-available-days
exactSenderAddr	string Full sender address
senderName	string Sender name or company
senderPhoneNumber	string Sender phone number
additionnalInfo	string

Responses

Request samples

Payload

Content type

application/json

{"estimateId": "1759607930750x141523411231504690",
"loadingDate": "2025-10-06",
"loadingIsFixedHour": true,
"loadingFixedHour": "13:00",
"loadingTimeSlot": "12:00 - 16:00",
"exactSenderAddr": "pharmacie totot, Bouaké, Côte d'ivoire'",
"senderName": "SENDER NAME",
"senderPhoneNumber": "0123456789",
"additionnalInfo": "string"
}

Update delivery Date

Authorizations:

token

Request Body schema: application/json

Body of the POST request

estimateId required	string Unique estimate identifier
deliveryDate required	string <date> Delivery date (YYYY-MM-DD)
deliveryIsFixedHour required	boolean Indicates if the delivery time is fixed
deliveryFixedHour	string Fixed delivery hour (HH:mm)
deliveryTimeSlot	string Delivery time slot
exactRecipientAddr	string Full recipient address
recipientName	string Recipient name or company
recipientPhoneNumber	string Recipient phone number
additionnalInfo	string

Responses

Request samples

Payload

Content type

application/json

{"estimateId": "1759607930750x141523411231504690",
"deliveryDate": "2025-07-08",
"deliveryIsFixedHour": false,
"deliveryFixedHour": "",
"deliveryTimeSlot": "08:00 - 12:00",
"exactRecipientAddr": "pharmacie tata, Abidjan, Côte d'ivoire",
"recipientName": "RECIPIENT NAME",
"recipientPhoneNumber": "0123456789",
"additionnalInfo": "string"
}

Get all estimates

Authorizations:

token

query Parameters

id	string Query parameter id (estimateId)
truckTypeId	string Query parameter truckTypeId ('trucktype' represented by a unique ID)
status	string Query parameter status
exactSenderAddr	string Query parameter exactSenderAddr
senderName	string Query parameter senderName
exactRecipientAddr	string Query parameter exactRecipientAddr
recipientName	string Query parameter recipientName
senderPhoneNumber	string Query parameter senderPhoneNumber
recipientPhoneNumber	string Query parameter recipientPhoneNumber
loadingDateFrom	string <date-time> Query parameter loadingDateFrom
loadingDateTo	string <date-time> Query parameter loadingDateTo
cursor	number <float> Query parameter cursor
truckName	string Query parameter truckName
articleType	string Query parameter articleType
numOrder	string Query parameter numOrder

Responses

Data

Use this to get all needed data to send an Estimate

Get truck categories

Authorizations:

token

query Parameters

Responses

Ge available article-types

Authorizations:

token

Responses

Get all truck types

Authorizations:

token

query Parameters

category	string Query parameter category of the truck type (get truck-categories)
id	string Query parameter id (unique id of the truck type)

Responses

Throtling

check the Rate Limits of the user

Authorizations:

token

query Parameters

user

required

string

Query parameter user ('user' represented by a unique ID)