Référence
Produits
Catalogue du compte : produits, variantes, codes et prix. Le stock n'en fait pas partie.
Adresses
Parcourir tout le catalogue
GET
/v1/products
Permission read_products
Créer un produit
POST
/v1/products
Permission write_products
Identifier un produit par un code, une référence ou sa désignation
GET
/v1/products/lookup
Permission read_products
Lire un produit par son identifiant
GET
/v1/products/{id}
Permission read_products
Le produit
Tous les champs renvoyés, identiques d'une adresse à l'autre.
| Champ | Type | Description |
|---|---|---|
id |
entier |
Identifiant du produit. C'est le id_product des lignes de vente. |
designation |
texte | Nom du produit (50 caractères au plus). |
description |
texte | Description du produit. |
notes |
texte | Notes internes du commerçant. |
ref_four |
texte | Référence du produit chez le fournisseur. |
ref_interne |
texte | Référence interne du commerçant. |
image_url |
texte | Adresse de l'image du produit (fichier JPEG), lisible sans clé. Chaîne vide si le produit n'a pas d'image. L'adresse ne change pas quand le commerçant remplace l'image. |
gestion_stock |
booléen |
true si le stock de ce produit est suivi. |
variantes |
booléen |
true si le produit se décline en variantes (tailles, couleurs…). false : il n'a que sa variante « produit seul ». |
favorite |
booléen |
true si le commerçant l'a placé dans ses favoris de caisse. |
archived |
booléen |
true si le produit est archivé : il n'est plus proposé à la vente, mais il reste lisible. |
pa_ht |
nombre |
Prix d'achat hors taxes du produit. Chaque variante peut s'en écarter (impact_pa). |
pv_ttc |
nombre |
Prix de vente de base, toutes taxes comprises. Ce n'est pas forcément le prix payé en caisse : chaque variante et chaque magasin peuvent s'en écarter. Le prix réellement appliqué se lit dans variantes_product[].prix. |
eco_ttc |
nombre | Montant de l'éco-participation, toutes taxes comprises, inclus dans le prix de vente. 0 s'il n'y en a pas. |
fournisseur |
objet | Fournisseur du produit. |
fournisseur.id |
entier | Identifiant du fournisseur. 0 si le produit n'en a pas. |
fournisseur.name |
texte | Nom du fournisseur. Chaîne vide si le produit n'en a pas. |
collec |
objet | Collection du produit. |
collec.id |
entier | Identifiant de la collection. 0 si le produit n'en a pas. |
collec.name |
texte | Nom de la collection. Chaîne vide si le produit n'en a pas. |
categories |
liste | Catégories du produit, du niveau le plus général au plus précis (cinq niveaux au plus). Liste vide si le produit n'est pas classé. |
categories[].niveau |
entier | Niveau de la catégorie, de 1 (le plus général) à 5. |
categories[].id |
entier | Identifiant de la catégorie. |
categories[].name |
texte | Nom de la catégorie. |
libre_1 |
texte | Champ personnalisé texte n° 1. |
libre_2 |
texte | Champ personnalisé texte n° 2. |
libre_3 |
texte | Champ personnalisé texte n° 3. |
id_custom_list_1 |
entier |
Champ personnalisé liste n° 1 : identifiant de la valeur choisie, 0 si aucune. La valeur en clair est dans champs_personnalises. |
id_custom_list_2 |
entier | Champ personnalisé liste n° 2 : identifiant de la valeur choisie, 0 si aucune. |
id_custom_list_3 |
entier | Champ personnalisé liste n° 3 : identifiant de la valeur choisie, 0 si aucune. |
custom_io_1 |
booléen | Champ personnalisé oui/non n° 1. |
custom_io_2 |
booléen | Champ personnalisé oui/non n° 2. |
custom_io_3 |
booléen | Champ personnalisé oui/non n° 3. |
custom_date_1 |
texte | Champ personnalisé date n° 1 (AAAA-MM-JJ). Chaîne vide si non renseigné. |
custom_date_2 |
texte | Champ personnalisé date n° 2 (AAAA-MM-JJ). Chaîne vide si non renseigné. |
custom_date_3 |
texte | Champ personnalisé date n° 3 (AAAA-MM-JJ). Chaîne vide si non renseigné. |
magasins |
liste |
Ce que chaque magasin du compte change à ce produit : son écart de prix et son taux de TVA. Une entrée par magasin non archivé, dans l'ordre de GET /v1/me. |
magasins[].id_shop |
entier |
Identifiant du magasin (voir GET /v1/me). |
magasins[].impact_pv |
nombre | Écart de prix de vente appliqué à ce produit dans ce magasin. 0 le plus souvent. |
magasins[].tva_taux |
nombre | Taux de TVA du produit dans ce magasin, en pourcentage (exemple : 20, 5.5). |
variantes_product |
liste |
Variantes en service. Toujours au moins une : pour un produit sans variante, c'est sa variante « produit seul ». Les codes (bc_ext, ean_int, sku) et les prix par magasin sont ici, jamais sur le produit. |
variantes_product[].id |
entier |
Identifiant de la variante. C'est le id_variante_product des lignes de vente. |
variantes_product[].is_product |
booléen |
true pour la variante « produit seul » d'un produit sans variante. |
variantes_product[].name |
texte |
Nom de la variante (exemple : M, Bleu / 42). Chaîne vide pour la variante « produit seul ». |
variantes_product[].position |
entier | Rang d'affichage choisi par le commerçant. |
variantes_product[].bc_ext |
texte | Code-barres externe, celui du fabricant (32 caractères au plus). Chaîne vide si non renseigné. |
variantes_product[].ean_int |
texte | Code-barres interne, généré par Wanapos (13 chiffres). Chaîne vide si non renseigné. |
variantes_product[].sku |
texte | Référence de la variante (SKU, 32 caractères au plus). Chaîne vide si non renseignée. |
variantes_product[].impact_pa |
nombre |
Écart de prix d'achat de cette variante par rapport au pa_ht du produit. 0 le plus souvent. |
variantes_product[].pa_ht |
nombre |
Prix d'achat hors taxes de cette variante : pa_ht du produit plus impact_pa. |
variantes_product[].impact_pv |
nombre |
Écart de prix de vente de cette variante par rapport au pv_ttc du produit (exemple : 3 pour une taille vendue 3 de plus). |
variantes_product[].prix |
liste |
Prix de vente de cette variante dans chaque magasin du compte, déjà calculé : pv_ttc du produit, plus impact_pv de la variante, plus impact_pv du magasin. Hors promotion. Une entrée par magasin, dans l'ordre de magasins. |
variantes_product[].prix[].id_shop |
entier |
Identifiant du magasin (voir GET /v1/me). |
variantes_product[].prix[].pv_ttc |
nombre | Prix de vente toutes taxes comprises dans ce magasin, hors promotion. |
variantes_product[].actif |
booléen |
true pour une variante en service, false pour une variante désactivée. |
variantes_product[].date_creation |
texte | Date de création, ISO 8601. |
variantes_product[].date_update |
texte | Date de dernière modification de la variante, ISO 8601. Chaîne vide si inconnue. |
variantes_inactives |
liste | Variantes désactivées : le commerçant les a retirées, Wanapos les conserve parce qu'elles ont déjà été vendues. Elles ne sont plus proposées à la vente et n'ont plus de stock. Liste vide le plus souvent. Utile pour retrouver le nom d'une variante citée dans une ancienne vente. |
variantes_inactives[].id |
entier |
Identifiant de la variante. C'est le id_variante_product des lignes de vente. |
variantes_inactives[].is_product |
booléen |
true pour la variante « produit seul » d'un produit sans variante. |
variantes_inactives[].name |
texte |
Nom de la variante (exemple : M, Bleu / 42). Chaîne vide pour la variante « produit seul ». |
variantes_inactives[].position |
entier | Rang d'affichage choisi par le commerçant. |
variantes_inactives[].bc_ext |
texte | Code-barres externe, celui du fabricant (32 caractères au plus). Chaîne vide si non renseigné. |
variantes_inactives[].ean_int |
texte | Code-barres interne, généré par Wanapos (13 chiffres). Chaîne vide si non renseigné. |
variantes_inactives[].sku |
texte | Référence de la variante (SKU, 32 caractères au plus). Chaîne vide si non renseignée. |
variantes_inactives[].impact_pa |
nombre |
Écart de prix d'achat de cette variante par rapport au pa_ht du produit. 0 le plus souvent. |
variantes_inactives[].pa_ht |
nombre |
Prix d'achat hors taxes de cette variante : pa_ht du produit plus impact_pa. |
variantes_inactives[].impact_pv |
nombre |
Écart de prix de vente de cette variante par rapport au pv_ttc du produit (exemple : 3 pour une taille vendue 3 de plus). |
variantes_inactives[].prix |
liste |
Prix de vente de cette variante dans chaque magasin du compte, déjà calculé : pv_ttc du produit, plus impact_pv de la variante, plus impact_pv du magasin. Hors promotion. Une entrée par magasin, dans l'ordre de magasins. |
variantes_inactives[].prix[].id_shop |
entier |
Identifiant du magasin (voir GET /v1/me). |
variantes_inactives[].prix[].pv_ttc |
nombre | Prix de vente toutes taxes comprises dans ce magasin, hors promotion. |
variantes_inactives[].actif |
booléen |
true pour une variante en service, false pour une variante désactivée. |
variantes_inactives[].date_creation |
texte | Date de création, ISO 8601. |
variantes_inactives[].date_update |
texte | Date de dernière modification de la variante, ISO 8601. Chaîne vide si inconnue. |
champs_personnalises |
liste |
Les douze champs personnalisés du produit, avec le libellé que le commerçant leur a donné. Mêmes valeurs que libre_N, id_custom_list_N, custom_io_N et custom_date_N, présentées de façon lisible. Pour une liste, valeur est la valeur choisie en clair. |
champs_personnalises[].cle |
texte |
Nom du champ dans l'objet produit (exemple : libre_1). |
champs_personnalises[].libelle |
texte | Libellé choisi par le commerçant. |
champs_personnalises[].type |
texte | Nature du champ. |
champs_personnalises[].affiche |
booléen | Le commerçant affiche ce champ dans son application. |
champs_personnalises[].valeur |
Valeur du champ : texte, valeur de liste en clair, booléen ou date (AAAA-MM-JJ) selon type. |
|
date_creation |
texte | Date de création du produit, ISO 8601. |
date_update |
texte | Date de dernière modification de la fiche du produit, ISO 8601. Elle ne suit pas les changements de variantes ni de prix : ne vous en servez pas pour détecter ce qui a changé. |
Une question ? contact@wanapos.com
