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.

Créer un produit

Create a new product

post

Autorisations

bearer

AuthorizationstringRequis

Bearer authentication header of the form Bearer <token>.

Corps

application/json

typeall ofRequis

The type of the product

Example: service_delivery

number · enumOptionnelValeurs possibles:

unitall ofRequis

The unit of measurement for the product

Example: unit

number · enumOptionnelValeurs 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

vatCodeall ofOptionnel

The VAT code applicable to the product

Default: FR_00HTExample: FR_00HT

string · 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

post

/v2/catalog/product

HTTPcURLJavaScriptPython

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
}