getRelatedProductsById

Recherchez tous les objets de produits associés par identifiant de page.

Description

Cette méthode récupère tous les objets de page de produit associés pour un produit spécifique basé sur son identifiant (id) depuis l'API. Elle accepte un paramètre optionnel userQuery pour des paramètres de requête supplémentaires tels que offset, limit, sortOrder et sortKey. Elle renvoie une Promise qui se résout en un objet IProductsResponse.

Produits.getRelatedProductsById( id, langCode, userQuery );

Schéma des paramètres

Schéma

id: number
Identifiant de la page produit pour laquelle trouver la relation
exemple : 12345

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

userQuery: IProductsQuery
Paramètres de requête optionnels
exemple :

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "statusId": 123,
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "equals",
  "attributeMarker": "color"
}

userQuery.offset(required): number
Paramètre pour la pagination. Par défaut : 0.

userQuery.limit(required): number
Paramètre pour la pagination. Par défaut : 30.

userQuery.sortOrder(required): string
Ordre de tri "DESC" | "ASC". Par défaut : "DESC".

userQuery.sortKey(required): string
Champ pour le tri (par défaut - null). Valeurs possibles : "id", "position", "title", "date", "price". Par défaut : null.

userQuery.signPrice: string
Signe de prix. Par défaut : null.

userQuery.templateMarker: string | null
Marqueur de modèle de page produit, par défaut null.
exemple : "template_12345"

userQuery.statusMarker: string | null
Marqueur de statut de page produit, par défaut null.
exemple : "in_stock"

userQuery.conditionValue: string | null
La valeur recherchée, par défaut null.
exemple : "new"

userQuery.attributeMarker: string | null
L'identifiant textuel de l'attribut indexé par lequel les valeurs sont filtrées, par défaut null.
exemple : "color"

userQuery.conditionMarker: string | null
Marqueur de la condition de filtre par laquelle les valeurs sont filtrées, par défaut null.
exemple : "equals"

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer Permissions du module selon vos besoins dans la section correspondante.

Exemples

Exemple minimal

const response = await Products.getRelatedProductsById(1);

Exemple avec des attributs

const userQuery = {
  "offset": 0,
  "limit": 30,
  "sortOrder": "DESC",
  "sortKey": "id"
};
const response = await Produits.getRelatedProductsById(1, 'en_US', userQuery);

Utilisez des conditions pour trouver des données de produits spécifiques :

attributeMarker : L'identifiant textuel de l'attribut indexé par lequel les valeurs sont filtrées. conditionMarker : Le type de condition à appliquer à la valeur de l'attribut.

Marqueur	Signification	Exemple
eq	Égal	statusId = 1 (actif uniquement)
neq	Pas égal	role ≠ "Viewer"
in	Contient (un des)	role in ["Editor", "Manager"]
nin	Ne contient pas	email not in ["@temp.com"]
exs	Existe (a une valeur)	A un lastLogin
nexs	N'existe pas	Jamais connecté

conditionValue : La valeur à comparer.

Exemple de réponse

{
  "items": [],
  "total": 0
}

Schéma de réponse

Schéma : IProductsResponse

total: number
Le nombre total de produits trouvés.
exemple : 100

items: IProductsEntity[]
Un tableau d'entités de produits.
exemple :

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

items.id: number
L'identifiant unique.
exemple : 12345

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

items.statusIdentifier: string | null
Identifiants de statut de page produit (peut être null).
exemple : "in_stock"

items.statusLocalizeInfos: Record<string, any>
Description JSON de l'objet de statut de l'élément, en tenant compte de la langue.
exemple :

items.attributeSetIdentifier: string | null
Ensemble d'identifiants d'attributs.
exemple : "set_12345"

items.position: number
Numéro de l'élément (pour le tri).
exemple : 1

items.price: number | null
La valeur du prix de la page produit prise de l'index.
exemple : 150.00

items.additional: object
Valeur supplémentaire de l'index.
exemple :

{
  "en": "In Stock",
  "de": "Auf Lager"
}

items.sku: string | null
SKU du produit (Stock Keeping Unit), peut être null.
exemple : "SKU_12345"

items.isSync: boolean
Indication de l'indexation de la page.
exemple : true

items.attributeValues: AttributeType
Tableau de valeurs d'attributs de l'index, représenté.
exemple :

[
  {
    "id": "color",
    "value": "red"
  }
]

items.categories: string[]
Catégories de produits.
exemple :

[
  1,
  2,
  3
]

items.isVisible: boolean
Un signe de visibilité de la page.
exemple : true

items.moduleFormConfigs: Array<IFormConfig>
Configurations de formulaire du module (optionnel).

items.isPositionLocked: boolean
Indicateur de verrouillage de la position de tri (optionnel).
exemple : false

items.relatedIds: number[]
Identifiants des pages de produits associés.
exemple :

[
  12345,
  67890
]

items.templateIdentifier: string | null
Identifiant utilisateur du modèle lié.
exemple : "template_12345"

items.shortDescTemplateIdentifier: string | null
Identifiant utilisateur du modèle lié pour une courte description.
exemple : "short_desc_template_12345"

items.signedPrice: string
Signe de prix.

items.productPages: Array<Record<string, any>> | Record<string, any>
Tableau de pages de produits ou un seul objet de page de produit.
exemple : []

items.blocks: string[]
Tableau d'identifiants de blocs.
exemple :

[
  "block_12345",
  "block_67890"
]

---