Aller au contenu principal

getProductsByStatusMarker

Recherchez un objet de statut de produit par son identifiant textuel (marqueur).

Description​

Cette méthode recherche un objet de statut de produit basé sur son identifiant textuel (marqueur) depuis l'API. Elle renvoie une promesse qui se résout en un objet de statut de produit IProductStatusEntity.

ProductStatuses.getProductsByStatusMarker(

marker*, langCode

);

Schéma des paramètres​

Schéma

marker(obligatoire): string
Marqueur de produit
exemple : "in_stock"

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

Exemples​

Exemple minimal​

const response = await ProductStatuses.getProductsByStatusMarker('my-marker');

Exemple avec des attributs​

const response = await ProductStatuses.getProductsByStatusMarker('my-marker', 'en_US');

Exemple de réponse​

{
  "id": 2,
  "identifier": "sold",
  "localizeInfos": {
    "title": "Vendu"
  },
  "version": 0,
  "isDefault": false,
  "position": 1
}

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