Products

This object represents a product of your business. Use it to manage products sold through SmartBills.

Scopes

products.read products.write

Core principles

A product should be unique by name within a merchant context.

Create a product

Create a new product. Requires scope products.write

POST https://api.smartbills.io/v1/products

Request Body

Requires body of type ProductCreateRequest

Parameter	Description	Type	Required
`name`	Name of product	`string`	`required`
`description`	Description	`string`
`slug`	Unique slug	`string`
`vendorId`	Vendor ID	`long`
`category`	Category	`string`
`tags`	Tags	`string[]`
`publishedAt`	Publish date	`date`
`locale`	Locale	`string`
`images`	Images	`Image[]`
`variants`	Variants	`ProductVariantCreateRequest[]`

ProductCreateRequest

{
  "name": "string",
  "description": "string", 
  "slug": "string",
  "vendorId": 0,
  "category": "string",
  "tags": ["string"],
  "publishedAt": "2024-01-25T00:00:00.000Z",
  "locale": "string",
  "images": [],
  "variants": []
}

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

SBProduct

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

SBListRequest

Attribut	Descriptif	Type	Obligatoire
`page`	Numéro de la page	`long`	`obligatoire`
`pageSize`	Nombre d'enregistrements à retourner	`long`	`obligatoire`

Réponse

SBProduct

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é

SBProduct

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é

Employees API Product Variants | Smartbills API Documentation