Produits

Créez des produits dans le catalogue et configurez type, unité et code TVA.

Créez et gérez des produits dans votre catalogue.

Lister les produits

Récupère les produits du catalogue, paginés et filtrables.

List products with pagination

get

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de requête

pagenumber · min: 1Requis

The page number to retrieve

Example: 1

limitnumber · min: 1Requis

The number of items per page

Example: 20

searchstringOptionnel

Optional search term to filter the catalog

Example: widget

orderBystring · enumOptionnel

Optional order by to filter the catalog

Valeurs possibles:

orderDirectionstring · enumOptionnel

Optional order direction to filter the catalog

Valeurs possibles:

sapCompatiblebooleanOptionnel

Optional sap compatible to filter the catalog

Example: true

Réponses

200Succès

application/json

countWithoutFiltersnumberRequis

totalDocsnumberRequis

limitnumberRequis

totalPagesnumberRequis

hasNextPagebooleanRequis

hasPrevPagebooleanRequis

nextPagenumberRequis

pagenumberRequis

prevPagenumberRequis

get/v2/catalog

GET /v2/catalog?page=1&limit=20 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Succès

{
  "countWithoutFilters": 1,
  "totalDocs": 1,
  "limit": 1,
  "totalPages": 1,
  "hasNextPage": true,
  "hasPrevPage": true,
  "nextPage": 1,
  "page": 1,
  "prevPage": 1,
  "docs": [
    {
      "id": "text",
      "type": 1,
      "unit": 14,
      "designation": "text",
      "description": "text",
      "reference": "text",
      "vatCode": "FR_210",
      "personalServiceActivity": "GARDE_ENFANT_HANDICAPE",
      "isDeliveryOfGood": true,
      "taxesIncluded": true,
      "purchasePrice": 1,
      "productMargin": 1,
      "unitPrice": 1,
      "priceWithoutTaxes": 1,
      "vatAmount": 1,
      "priceWithTaxes": 1,
      "stock": 1
    }
  ]
}

Paramètres de requête

Champs requis :

page : numéro de page (à partir de 1)
limit : nombre d'éléments par page

Champs optionnels :

search : terme de recherche (filtre sur la désignation, la référence, etc.)
orderBy : champ de tri (voir valeurs ci-dessous)
orderDirection : sens du tri (ASC ou DESC)
sapCompatible : true pour ne lister que les produits compatibles avec une comptabilité SAP

`orderBy` (CatalogOrderBy)

createdAt (défaut)
designation

`orderDirection` (OrderDirection)

ASC
DESC

Exemple

GET /v2/catalog?page=1&limit=20&search=widget&orderBy=designation&orderDirection=ASC

Réponse (`ReadCatalogCollectionDto`)

Réponse paginée contenant un tableau docs de produits, ainsi que les métadonnées de pagination (total, page, limit, pages, etc.).

Récupérer un produit

Renvoie le détail complet d'un produit à partir de son identifiant.

Retrieve a product by id

get

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

productIdstringRequis

Réponses

200Succès

application/json

idstringRequis

typenumber · enumRequisValeurs possibles:

unitnumber · enumRequisValeurs possibles:

designationstringRequis

Name or title of the product

descriptionstring · nullableOptionnel

Detailed description of the product

referencestring · nullableOptionnel

Product reference code

vatCodestring · enumRequisValeurs possibles:

personalServiceActivitystring · enumOptionnelValeurs possibles:

isDeliveryOfGoodbooleanRequis

Indicates if the product involves delivery of physical goods

taxesIncludedbooleanRequis

Indicates if the prices include taxes

purchasePricenumberOptionnel

Purchase price per unit without taxes

productMarginnumberOptionnel

Product margin

lockUnitPricebooleanOptionnel

Indicates if the unit price is locked

unitPricenumberRequis

Price per unit without taxes

priceWithoutTaxesnumberRequis

Total price without taxes

vatAmountnumberRequis

VAT amount

priceWithTaxesnumberRequis

Total price including taxes

stocknumberRequis

Stock

get/v2/catalog/product/{productId}

GET /v2/catalog/product/{productId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Succès

{
  "id": "text",
  "type": 1,
  "unit": 14,
  "designation": "text",
  "description": "text",
  "reference": "text",
  "vatCode": "FR_210",
  "personalServiceActivity": "GARDE_ENFANT_HANDICAPE",
  "isDeliveryOfGood": true,
  "taxesIncluded": true,
  "purchasePrice": 1,
  "productMargin": 1,
  "lockUnitPrice": true,
  "unitPrice": 1,
  "priceWithoutTaxes": 1,
  "vatAmount": 1,
  "priceWithTaxes": 1,
  "stock": 1
}

Paramètres de chemin

productId : identifiant du produit

Réponse (`ReadProductDto`)

Renvoie l'objet produit complet avec ses prix, sa TVA, son stock, sa description, etc.

Créer un produit

Create a new product

post

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Corps

typenumber · enumRequisValeurs possibles:

unitnumber · enumRequisValeurs possibles:

designationstringRequis

The name or title of the product

Example: Premium Widget

amountInCentsnumberOptionnel

The price of the product in cents

Example: 1999

purchasePricenumberOptionnel

The purchase price of the product in cents

Example: 1000

productMarginnumberOptionnel

The margin of the product in percentage

Example: 10

lockUnitPricebooleanOptionnel

Whether the unit price is locked or not calculating from purchase price and product margin

Default: falseExample: true

taxesIncludedbooleanOptionnel

Whether the amount includes taxes

Example: true

vatCodestring · enumOptionnelValeurs possibles:

isDeliveryOfGoodbooleanOptionnel

Whether the product involves delivery of a physical good

Example: true

descriptionstringOptionnel

Detailed description of the product

Example: High-quality widget for various applications

referencestringOptionnel

Product reference or SKU

Example: WIDGET-001

stocknumberOptionnel

The stock quantity

Example: 20

Réponses

201Succès

application/json

idstringRequis

typenumber · enumRequisValeurs possibles:

unitnumber · enumRequisValeurs possibles:

designationstringRequis

Name or title of the product

descriptionstring · nullableOptionnel

Detailed description of the product

referencestring · nullableOptionnel

Product reference code

vatCodestring · enumRequisValeurs possibles:

personalServiceActivitystring · enumOptionnelValeurs possibles:

isDeliveryOfGoodbooleanRequis

Indicates if the product involves delivery of physical goods

taxesIncludedbooleanRequis

Indicates if the prices include taxes

purchasePricenumberOptionnel

Purchase price per unit without taxes

productMarginnumberOptionnel

Product margin

lockUnitPricebooleanOptionnel

Indicates if the unit price is locked

unitPricenumberRequis

Price per unit without taxes

priceWithoutTaxesnumberRequis

Total price without taxes

vatAmountnumberRequis

VAT amount

priceWithTaxesnumberRequis

Total price including taxes

stocknumberRequis

Stock

post/v2/catalog/product

POST /v2/catalog/product HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "type": "service_delivery",
  "unit": "unit",
  "designation": "Premium Widget",
  "amountInCents": 1999,
  "purchasePrice": 1000,
  "productMargin": 10,
  "lockUnitPrice": true,
  "taxesIncluded": true,
  "vatCode": "FR_00HT",
  "isDeliveryOfGood": true,
  "description": "High-quality widget for various applications",
  "reference": "WIDGET-001",
  "stock": 20
}

201Succès

{
  "id": "text",
  "type": 1,
  "unit": 14,
  "designation": "text",
  "description": "text",
  "reference": "text",
  "vatCode": "FR_210",
  "personalServiceActivity": "GARDE_ENFANT_HANDICAPE",
  "isDeliveryOfGood": true,
  "taxesIncluded": true,
  "purchasePrice": 1,
  "productMargin": 1,
  "lockUnitPrice": true,
  "unitPrice": 1,
  "priceWithoutTaxes": 1,
  "vatAmount": 1,
  "priceWithTaxes": 1,
  "stock": 1
}

Corps de requête (`CreateProductDto`)

Champs requis :

type : type de produit (ex: service_delivery)
unit : unité de mesure (ex: unit)
designation : libellé du produit

Champs optionnels :

amountInCents : prix de vente en centimes
purchasePrice : prix d'achat en centimes
productMargin : marge en pourcentage
lockUnitPrice : bloque le prix unitaire
taxesIncluded : prix TTC si true
vatCode : code TVA (défaut FR_00HT)
isDeliveryOfGood : livraison d'un bien physique
description : description détaillée (HTML nettoyé)
reference : référence / SKU
stock : stock disponible

Valeurs possibles

Les champs type et unit attendent des chaînes (string) en snake_case.

`type` (ProductType)

sale_of_goods
service_delivery
commercial_or_craft_services
sale_of_manufactured_goods
disbursement

`unit` (ProductUnit)

Voir toutes les valeurs

unit
gram
hour
day
week
fixed_rate
year
character
line
license
article
month
kilogram
kilometer
liter
batch
meter
square_meter
cubic_meter
linear_meter
person
ton
word
page
leaflet
paragraph
minute
overnight_stay

`vatCode` (VatCode)

Le champ vatCode attend une chaîne (string).

Valeurs disponibles :

FR_210
FR_550
FR_850
FR_1000
FR_2000
FR_00HT (défaut)
FR_00UE
FR_0HUE

Exemple

{
  "type": "service_delivery",
  "unit": "unit",
  "designation": "Premium Widget",
  "amountInCents": 1999,
  "taxesIncluded": true,
  "vatCode": "FR_00HT",
  "isDeliveryOfGood": true,
  "description": "High-quality widget for various applications",
  "reference": "WIDGET-001",
  "stock": 20
}

Mettre à jour un produit

Le verbe HTTP est PUT. Tous les champs requis de UpdateProductDto doivent être envoyés à chaque appel (pas uniquement les champs modifiés), sinon ils seront écrasés ou refusés en validation.

Update a product

put

Autorisations

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Paramètres de chemin

productIdstringRequis

Corps

typenumber · enumRequisValeurs possibles:

unitnumber · enumRequisValeurs possibles:

designationstringRequis

amountInCentsnumberOptionnel

The price of the product in cents

Example: 1999

purchasePricenumberOptionnel

The purchase price of the product in cents

Example: 1000

productMarginnumberOptionnel

The margin of the product in percentage

Example: 10

lockUnitPricebooleanOptionnel

Whether the unit price is locked or not calculating from purchase price and product margin

Default: falseExample: true

taxesIncludedbooleanOptionnel

vatCodestring · enumRequisValeurs possibles:

isDeliveryOfGoodbooleanOptionnel

descriptionstringOptionnel

referencestringOptionnel

stocknumberOptionnel

Réponses

200Succès

application/json

idstringRequis

typenumber · enumRequisValeurs possibles:

unitnumber · enumRequisValeurs possibles:

designationstringRequis

Name or title of the product

descriptionstring · nullableOptionnel

Detailed description of the product

referencestring · nullableOptionnel

Product reference code

vatCodestring · enumRequisValeurs possibles:

personalServiceActivitystring · enumOptionnelValeurs possibles:

isDeliveryOfGoodbooleanRequis

Indicates if the product involves delivery of physical goods

taxesIncludedbooleanRequis

Indicates if the prices include taxes

purchasePricenumberOptionnel

Purchase price per unit without taxes

productMarginnumberOptionnel

Product margin

lockUnitPricebooleanOptionnel

Indicates if the unit price is locked

unitPricenumberRequis

Price per unit without taxes

priceWithoutTaxesnumberRequis

Total price without taxes

vatAmountnumberRequis

VAT amount

priceWithTaxesnumberRequis

Total price including taxes

stocknumberRequis

Stock

put/v2/catalog/product/{productId}

PUT /v2/catalog/product/{productId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "type": 1,
  "unit": 14,
  "designation": "text",
  "amountInCents": 1999,
  "purchasePrice": 1000,
  "productMargin": 10,
  "lockUnitPrice": true,
  "taxesIncluded": true,
  "vatCode": "FR_210",
  "isDeliveryOfGood": true,
  "description": "text",
  "reference": "text",
  "stock": 1
}

200Succès

{
  "id": "text",
  "type": 1,
  "unit": 14,
  "designation": "text",
  "description": "text",
  "reference": "text",
  "vatCode": "FR_210",
  "personalServiceActivity": "GARDE_ENFANT_HANDICAPE",
  "isDeliveryOfGood": true,
  "taxesIncluded": true,
  "purchasePrice": 1,
  "productMargin": 1,
  "lockUnitPrice": true,
  "unitPrice": 1,
  "priceWithoutTaxes": 1,
  "vatAmount": 1,
  "priceWithTaxes": 1,
  "stock": 1
}

Paramètres de chemin

productId : identifiant du produit à mettre à jour

Corps de requête (`UpdateProductDto`)

Champs requis :

type : type de produit (voir valeurs)
unit : unité de mesure (voir valeurs)
designation : libellé du produit
vatCode : code TVA (voir valeurs)

Champs optionnels :

amountInCents : prix de vente en centimes
purchasePrice : prix d'achat en centimes
productMargin : marge en pourcentage
lockUnitPrice : bloque le prix unitaire (défaut false)
taxesIncluded : prix TTC si true
isDeliveryOfGood : livraison d'un bien physique
description : description détaillée (HTML nettoyé)
reference : référence / SKU
stock : stock disponible

Exemple

{
  "type": "service_delivery",
  "unit": "unit",
  "designation": "Premium Widget",
  "amountInCents": 2499,
  "vatCode": "FR_00HT",
  "taxesIncluded": true,
  "isDeliveryOfGood": true,
  "description": "Updated description",
  "reference": "WIDGET-001",
  "stock": 15
}

Réponse

Renvoie le produit mis à jour (ReadProductDto).

PrécédentDevis SuivantLivre des recettes

Mis à jour il y a 2 mois

Ce contenu vous a-t-il été utile ?

Lister les produits

List products with pagination

Paramètres de requête

orderBy (CatalogOrderBy)

orderDirection (OrderDirection)

Exemple

Réponse (ReadCatalogCollectionDto)

Récupérer un produit

Retrieve a product by id

Paramètres de chemin

Réponse (ReadProductDto)

Créer un produit

Create a new product

Corps de requête (CreateProductDto)

Valeurs possibles

type (ProductType)

unit (ProductUnit)

vatCode (VatCode)

Exemple

Mettre à jour un produit

Update a product

Paramètres de chemin

Corps de requête (UpdateProductDto)

Exemple

Réponse

`orderBy` (CatalogOrderBy)

`orderDirection` (OrderDirection)

Réponse (`ReadCatalogCollectionDto`)

Réponse (`ReadProductDto`)

Corps de requête (`CreateProductDto`)

`type` (ProductType)

`unit` (ProductUnit)

`vatCode` (VatCode)

Corps de requête (`UpdateProductDto`)