Tulip API (v2)

Download OpenAPI specification:Download

Renters

Afficher les loueurs

Authorizations:

key

Responses

Request samples

cURL

curl -X GET --location 'https://api.mytulip.io/v2/renters' -H 'Key: MY_API_KEY'

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"renters": {"1BCIJ03aqLArez4oEqbkBM1IwwE3": true,
"whAC3jBSE2MeVLPkeAcO1cIv6kW4": true
}
}

Lier un loueur à la clef API

Authorizations:

key

Request Body schema: application/json

renter_id

string

L'identifiant Tulip du loueur

Responses

Request samples

Payload

Content type

application/json

{"renter_id": "2BCIJ03aqLArez4oEqbkBM1IwwE3"
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success"
}

Obtenir des informations sur le loueur

Authorizations:

key

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"renter": {"uid": "PrBvAU986dksDi2FS14L",
"company": {"company_name": "My Company",
"last_name": "Doe",
"first_name": "John",
"email": "john.doe@mycompany.com",
"phone_number": "0606060606",
"address": "3 rue laffite",
"city": "Paris",
"zipcode": "7502",
"country": "France"
},
"options": {"option": true,
"inclusion": false,
"LCD": true,
"LMD": false,
"LLD": true,
"products": [{"bike": {"translations": {"en": "Bike",
"fr": "Vélo"
},
"subtypes": [{"type": "standard",
"translations": {"en": "Standard",
"fr": "Musculaire"
}
},
{"type": "electric",
"translations": {"en": "Electric",
"fr": "Electrique"
}
}
]
}
}
]
}
}
}

Products

Afficher les produits

Authorizations:

key

query Parameters

uid	string L'identifiant Tulip de l'utilisateur
skip	number Le nombre d'éléments à passer (pagination)
limit	number Le nombre maximum d'éléments à afficher (pagination)

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"products": [{"product_id": "string",
"uid": "string",
"title": "string",
"product_type": "bike",
"description": "string",
"value_excl": 0,
"documents": ["string"
],
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"purchased_date": "2019-08-24T14:15:22Z",
"data": {"product_subtype": "string",
"brand": "string",
"model": "string"
}
}
]
}

Créer un produit

Authorizations:

key

Request Body schema: application/json

Body

uid required	string L'identifiant Tulip de l'utilisateur
product_type required	string Value: "bike" Le type de produit
title required	string Le titre du produit
description	string Une description du produit
required	object (product_data) Les informations spécifique à un type de produit
purchased_date	string <date-time> La date d'achat du produit
value_excl required	number La valeur HTT du produit

Responses

Request samples

Payload

Content type

application/json

{"uid": "dsqjdyunppoi978nklj",
"product_type": "bike",
"title": "mon titre de produit",
"description": "La description de mon produit",
"data": {"product_subtype": "electric",
"brand": "MADE",
"model": "Made x Veloretti"
},
"value_excl": 525
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"product": {"product_id": "string",
"uid": "string",
"title": "string",
"product_type": "bike",
"description": "string",
"value_excl": 0,
"documents": ["string"
],
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"purchased_date": "2019-08-24T14:15:22Z",
"data": {"product_subtype": "string",
"brand": "string",
"model": "string"
}
}
}

Afficher un produit

Authorizations:

key

path Parameters

product_id

required

string

L'identifiant Tulip du produit

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"product": {"product_id": "string",
"uid": "string",
"title": "string",
"product_type": "bike",
"description": "string",
"value_excl": 0,
"documents": ["string"
],
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"purchased_date": "2019-08-24T14:15:22Z",
"data": {"product_subtype": "string",
"brand": "string",
"model": "string"
}
}
}

Mettre à jour un produit

Authorizations:

key

path Parameters

product_id

required

string

L'identifiant Tulip du produit

Request Body schema: application/json

Body

uid	string L'identifiant Tulip de l'utilisateur
product_type	string Value: "bike" Le type de produit
title	string Le titre du produit
description	string La description du produit
	object (product_data) Les informations spécifique à un type de produit
purchased_date	string <date-time> La date d'achat du produit
value_excl	number La valeur HTT du produit

Responses

Request samples

Payload

Content type

application/json

{"uid": "string",
"product_type": "bike",
"title": "string",
"description": "string",
"data": {"product_subtype": "string",
"brand": "string",
"model": "string"
},
"purchased_date": "2019-08-24T14:15:22Z",
"value_excl": 0
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"product": {"product_id": "string",
"uid": "string",
"title": "string",
"product_type": "bike",
"description": "string",
"value_excl": 0,
"documents": ["string"
],
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"purchased_date": "2019-08-24T14:15:22Z",
"data": {"product_subtype": "string",
"brand": "string",
"model": "string"
}
}
}

Supprimer un produit

Authorizations:

key

path Parameters

product_id

required

string

L'identifiant Tulip du produit

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success"
}

Contracts

Afficher les contrats

Authorizations:

key

query Parameters

uid	string L'identifiant Tulip de l'utilisateur
skip	number Le nombre d'éléments à passer (pagination)
limit	number Le nombre maximum d'éléments à afficher (pagination)
test	number Afficher les éléments en test

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contracts": [{"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
]
}

Créer un contrat

Authorizations:

key

query Parameters

preview

boolean

Lancer la requête en mode devis (La requête ne sera pas appliqué)

Request Body schema: application/json

Body

uid required	string L'identifiant Tulip de l'utilisateur
start_date	string <date-time> La date de début du contrat
end_date required	string <date-time> La date de fin du contrat (La date actuel sera appliqué par défaut)
contract_type required	string Enum: "LCD" "LMD" "LLD"
options required	Array of strings Items Enum: "break" "theft" "individual" "company" "home_to_work" "pro" "transporter" "sharing" "assistance" "loa" "ia" "rc"
	object (contract_company) Informations sur la compagnie lié au contrat
	object (contract_individual) Information sur l'individu associé au contrat
required	Array of Définir le produit dans le contrat (object) or Définir un produit existant (object) (contract_products) La liste des produits

Responses

Request samples

Payload

Content type

application/json

Example

LCD

{"contract_type": "LCD",
"uid": "qBaWdy6r3Lc3GkXTn374dFrnoN22",
"start_date": "2022-11-24T14:36:41.136Z",
"end_date": "2022-11-25T14:36:41.136Z",
"options": ["break",
"theft"
],
"products": [{"product_id": "UIYTYGjdsgqdhgq9867gdh",
"data": {"product_marked": "75657",
"user_name": "Jean Germain"
}
},
{"product_id": "UIYTYGjdg3Qdhgq9867gdh",
"data": {"product_marked": "1",
"user_name": "Jeanne Germain"
}
}
]
}

Response samples

200
400
401
500

Content type

application/json

Example

LCD

{"status": "success",
"contract": {"cid": "8640RJKN5W509",
"uid": "qBaWdy6r3Lc3GkXTn374dFrnoN22",
"created_date": "2022-11-24T14:36:41.136Z",
"updated_date": "2022-11-24T14:36:41.136Z",
"start_date": "2022-11-24T14:36:41.136Z",
"end_date": "2022-11-25T14:36:41.136Z",
"status": "open",
"contract_type": "LCD",
"test": true,
"products": {"030ff0c7-1f2c-4f8f-978b-d0212214a015": {"product_id": "UIYTYGjdsgqdhgq9867gdh",
"start_date": "2022-11-24T14:36:41.136Z",
"end_date": "2022-11-25T14:36:41.136Z",
"status": "open",
"data": {"product_marked": "75657",
"user_name": "Jean Germain"
},
"price": 1
},
"130ff0c7-1f2c-4f8f-978b-d0212214a015": {"product_id": "UIYTYGjdsgqdhgq9867gdh",
"start_date": "2022-11-24T14:36:41.136Z",
"end_date": "2022-11-25T14:36:41.136Z",
"status": "open",
"data": {"product_marked": "1",
"user_name": "Jeanne Germain"
},
"price": 1
}
},
"options": ["break",
"theft"
],
"pricing_version": "T2022A",
"price": 1
},
"execution_id": "qu9gi31zrkfn"
}

Afficher un contrat

Authorizations:

key

path Parameters

cid

required

string

L'identifiant Tulip du contrat

query Parameters

uid	string L'identifiant Tulip de l'utilisateur

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contract": {"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
}

Résilier un contrat

Authorizations:

key

path Parameters

cid

required

string

L'identifiant Tulip du contrat

query Parameters

preview

boolean

Lancer la requête en mode devis (La requête ne sera pas appliqué)

Request Body schema: application/json

Body

reason required	string La raison de la résilation
end_date	string <date-time> La date de résiliation (la date actuel par défaut)

Responses

Request samples

Payload

Content type

application/json

{"reason": "string",
"end_date": "2019-08-24T14:15:22Z"
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contract": {"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
}

Mettre à jour un contrat

Authorizations:

key

path Parameters

cid

required

string

L'identifiant Tulip du contrat

query Parameters

preview

boolean

Lancer la requête en mode devis (La requête ne sera pas appliqué)

Request Body schema: application/json

start_date	string <date-time> La date de début du contrat
end_date	string <date-time> La date de fin du contrat
	object La liste de produits
	object (company_in_contract) Les informations sur la companie associé au contrat
	object (individual_in_contrat) Les informations relative au particulier

Responses

Request samples

Payload

Content type

application/json

Example

Mise à jour des dates du contrat

{"uid": "qBaWdy6r3Lc3GkXTn374dFrnoN22",
"start_date": "2022-11-24T14:36:41.136Z",
"end_date": "2022-11-25T14:36:41.136Z"
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contract": {"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
}

Ajouter un produit à un contrat existant

Authorizations:

key

path Parameters

cid

required

string

L'identifiant Tulip du contrat

Request Body schema: application/json

uid required	string L'identifiant Tulip de l'utilisateur
start_date	string <date-time> La date de début des produits ajoutés
required	Array of objects La liste des produits

Responses

Request samples

Payload

Content type

application/json

{"uid": "string",
"start_date": "2019-08-24T14:15:22Z",
"products": [{"product_id": "string",
"data": {"product_marked": "string",
"user_name": "string",
"internal_id": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contract": {"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
}

Résilier un produit existant dans un contrat

Authorizations:

key

path Parameters

cid

required

string

L'identifiant Tulip du contrat

query Parameters

preview

boolean

Lancer la requête en mode devis (La requête ne sera pas appliqué)

Request Body schema: application/json

Body

reason required	string La raison de la résiliation
end_date	string <date-time> La date de résiliation (la date actuel par défaut)
products required	Array of strings La liste des produits à résilier

Responses

Request samples

Payload

Content type

application/json

{"reason": "string",
"end_date": "2019-08-24T14:15:22Z",
"products": ["string"
]
}

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"contract": {"uid": "string",
"cid": "string",
"created_date": "string",
"updated_date": "string",
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "open",
"reason": "string",
"contract_type": "LLD",
"test": true,
"price": 0,
"pricing_version": "string",
"products": {"contract_product_id_1": {"product_history": "string",
"product_type": "bike",
"product_title": "string",
"documents": ["string"
],
"price": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"status": "terminated",
"reason": "string",
"data": {"product_marked": "string",
"internal_id": "string",
"user_name": "string",
"purchased_date": "2019-08-24T14:15:22Z"
}
}
},
"options": ["break"
],
"company": {"address": "string",
"zipcode": "string",
"city": "string",
"company_name": "string",
"siren": "string",
"first_name": "string",
"last_name": "string"
},
"individual": {"first_name": "string",
"last_name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"country": "FR",
"phone_number": "string",
"email": "string"
},
"receipts": ["string"
],
"documents": ["string"
]
}
}

Geo

Récupérer un format de ville

Récupéré le bon format de ville

Authorizations:

key

path Parameters

zipcode

required

string

Le Code postal

Responses

Response samples

200
400
401
500

Content type

application/json

{"status": "success",
"cities": ["PARIS-15E-ARRONDISSEMENT"
],
"execution_id": "dsd978kljkl"
}