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:* string
Marqueur de produit
exemple : my-marker

langCode: string
code de langue
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
identifiant de l'objet
exemple : 1764

version number
numéro de version de modification de l'objet
exemple : 10

identifier: string
identifiant textuel pour un champ dans l'enregistrement
exemple : catalog

localizeInfos: Record<string, any>
description json de l'objet de données de la page principale tenant compte de la langue "en_US" (par exemple)
exemple :

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