Aller au contenu principal

getProductStatuses

Recherchez tous les objets de statut de produit.

Description​

Cette méthode recherche tous les objets de statut de produit depuis l'API. Elle renvoie une promesse qui se résout en un tableau d'objets de statut de produit IProductStatusEntity.

ProductStatuses.getProductStatuses(

langCode

);

Schéma des paramètres​

Schéma

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await ProductStatuses.getProductStatuses();

Exemple avec des attributs​

const response = await ProductStatuses.getProductStatuses('en_US');

Exemple de réponse​

[
  {
    "id": 2,
    "identifier": "sold",
    "localizeInfos": {
      "title": "Vendu"
    },
    "isDefault": false,
    "version": 0,
    "position": 1
  },
  {
    "id": 1,
    "identifier": "sale",
    "localizeInfos": {
      "title": "En vente"
    },
    "isDefault": true,
    "version": 0,
    "position": 2
  }
]

Schéma de réponse​

Schéma : IProductStatusEntity[]

id: number
L'identifiant unique de la position.
exemple : 12345

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "in_stock"

localizeInfos: ILocalizeInfo
Le nom des statuts de produits, en tenant compte de la localisation.
exemple :

{
  "title": "Catalogue",
  "plainContent": "Contenu pour le catalogue",
  "htmlContent": "<b>Contenu pour le catalogue</b>",
  "menuTitle": "Catalogue"
}

isDefault: boolean
Indicateur de statut par défaut.
exemple : true

version: number
Le numéro de version de l'objet.
exemple : 1

position: number
Numéro de position.
exemple : 1