Skip to main content
POST
Ajouter des éléments au catalogue des prix

Supported products

Paramètres de chemin

priceBookId
integer<int64>
requis

L'identifiant unique du catalogue des prix auquel les éléments seront ajoutés.

Corps

application/json
productId
string
requis

L'identifiant unique du produit à ajouter au catalogue des prix. Il s'agit d'une chaîne de caractères et il est obligatoire.

Réponse

successful operation

customProperties
object
requis

Mappage des noms de propriétés personnalisées à leurs valeurs pour l'article du catalogue des prix.

id
string
requis

L'identifiant unique de l'article du catalogue des prix.

productId
string
requis

L'identifiant unique du produit associé à l'article du catalogue des prix.

archived
boolean

Un booléen indiquant si l'élément du catalogue de prix est archivé.

archivedAt
string<date-time>

La date et l'heure d'archivage de l'élément du catalogue des prix, au format ISO 8601.

billingFrequency
enum<string>

La fréquence de facturation de l’élément du catalogue des prix. Les valeurs valides incluent : « annuellement », « toutes les deux semaines », « mensuellement », « une seule fois », « tous les cinq ans », « tous les quatre ans », « tous les six mois », « tous les trois ans », « tous les deux ans », « trimestriellement » et « hebdomadairement ».

Options disponibles:
ANNUALLY,
BIWEEKLY,
MONTHLY,
PER_FIVE_YEARS,
PER_FOUR_YEARS,
PER_SIX_MONTHS,
PER_THREE_YEARS,
PER_TWO_YEARS,
QUARTERLY,
WEEKLY
billingPeriod
string

La période de facturation pour l'élément du catalogue des prix.

costOfGoodsSold
string

Le coût des marchandises vendues pour l'article du catalogue des prix.

createdAt
string<date-time>

La date et l'heure de création de l'article du catalogue des prix, au format ISO 8601.

description
string

Description de l'article du catalogue des prix.

images
string

Une chaîne représentant les images associées à l'article du catalogue des prix.

name
string

Le nom de l'article du catalogue des prix.

priceBookId
string

L'identifiant unique du catalogue des prix contenant cet article.

pricing
object
productClassification
enum<string>

La classification du produit. Les valeurs valides incluent « OFFRE GROUPÉE », « STANDALONE » et « VARIANT ».

Options disponibles:
BUNDLE,
STANDALONE,
VARIANT
productType
enum<string>

Le type de produit. Les valeurs valides incluent « INVENTORY », « NON_INVENTORY » et « SERVICE ».

Options disponibles:
INVENTORY,
NON_INVENTORY,
SERVICE
recurringBillingTerms
enum<string>

Les conditions de facturation récurrente pour l'article du catalogue des prix. Les valeurs valides incluent « AUTOMATICALLY_RENEW » et « FIXED ».

Options disponibles:
AUTOMATICALLY_RENEW,
FIXED
sku
string

Le numéro d'unité de gestion des stocks (UGS) de l'article du catalogue des prix.

status
enum<string>

Le statut actuel de l'article du catalogue des prix. Les valeurs valides incluent « actif »  et « inactif ».

Options disponibles:
active,
inactive
taxCategory
string

La catégorie fiscale de l'article du catalogue des prix.

updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour de l'article du catalogue des prix, au format ISO 8601.

url
string

Une URL associée à l'article du catalogue des prix.

Dernière modification le 6 octobre 2026