API Produits
Principes de base
Cet objet représente un produit connu de votre entreprise. Utilisez-le pour suivre les informations relatives aux produits vendus à travers SmartBills. Un produit doit être unique par son identifiant SKU ou par une autre clé unique définie par l'entreprise.
Portées
products:read
products:write
Créer un produit
Permet de créer un produit de votre entreprise. Nécéssite la portée products:write
POST https://api.smartbills.io/v1/products
Requête
Corps de la requête
Vous devez fournir un corps de requête de type ProductCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom du produit | string | obligatoire |
description | Description du produit | string | |
price | Prix du produit | decimal | obligatoire |
currency | Devise utilisée | string | obligatoire |
sku | Identifiant unique (SKU) du produit | string | obligatoire |
category | Catégorie du produit | string | |
stock | Quantité en stock | int | |
isAvailable | Disponibilité du produit | bool | obligatoire |
Réponse
Corps de la réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
201 | Le produit a été créé avec succès |
400 | La requête envoyée n'est pas valide. Veuillez corriger les erreurs. |
Récupérer un produit
Récupère un produit de l'entreprise. Nécéssite la portée products:read
GET https://api.smartbills.io/v1/products/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du produit | long | obligatoire |
Réponse
Récupérer une liste de produits
Récupère une liste de produits de l'entreprise. Nécéssite la portée products:read
GET https://api.smartbills.io/v1/products
Paramètres de requête
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
page | Numéro de la page | long | obligatoire |
pageSize | Nombre d'enregistrements à retourner | long | obligatoire |
Réponse
Mettre à jour un produit
Permet de mettre à jour les informations d'un produit de votre entreprise. Nécéssite la portée products:write
PUT https://api.smartbills.io/v1/products/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du produit | long | obligatoire |
Corps de la requête
Vous devez fournir un corps de requête de type ProductCreateRequest.
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
name | Nom du produit | string | obligatoire |
description | Description du produit | string | |
price | Prix du produit | decimal | obligatoire |
currency | Devise utilisée | string | obligatoire |
sku | Identifiant unique (SKU) du produit | string | obligatoire |
category | Catégorie du produit | string | |
stock | Quantité en stock | int | |
isAvailable | Disponibilité du produit | bool | obligatoire |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | Le produit a été mis à jour avec succès |
400 | La requête envoyée n'est pas valide |
404 | Aucun produit n'a été trouvé |
Supprimer un produit
Permet de supprimer un produit de votre entreprise. Toutes les factures associées à ce produit deviendront orphelines.
Nécéssite la portée products:write.
DELETE https://api.smartbills.io/v1/products/:id
Paramètre de route
| Attribut | Descriptif | Type | Obligatoire |
|---|---|---|---|
id | Identifiant unique du produit | long | obligatoire |
Réponse
Code d'état HTTP
| Paramètre | Description |
|---|---|
200 | Le produit a été supprimé avec succès |
404 | Aucun produit n'a été trouvé |