Aller au contenu principal

getProductsPriceByPageUrl

Recherchez des informations sur les produits et les prix pour la catégorie sélectionnée.

Description

Cette méthode recherche des informations sur les produits et les prix pour la catégorie sélectionnée, en fonction des paramètres de requête fournis (userQuery). Elle renvoie une promesse qui se résout en un objet IProductsInfo.

Produits.getProductsPriceByPageUrl( url, langCode, userQuery );

Schéma des paramètres

Schéma

url: string
URL de la page
exemple : "23-laminat-floorwood-maxima"

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

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

{
"limit": 30,
"offset": 0,
"sortOrder": "DESC",
"signPrice": "orders",
"statusMarker": "in_stock"
}

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

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

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

userQuery.signPrice: string
Marqueur de stockage de commande pour la fixation du prix.

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

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.

💲 signPrice verrouille le prix retourné pour une durée limitée — définissez-le sur votre marqueur de stockage de commande. Voir Fixation du prix (signPrice).

Exemples

Exemple minimal

const response = await Products.getProductsPriceByPageUrl('catalog');

Exemple avec des attributs

const userQuery = {
"offset": 0,
"limit": 30,
"statusMarker": "in_stock",
"conditionValue": "new",
"conditionMarker": "equals",
"attributeMarker": "color",
"sortOrder": "DESC",
"sortKey": "id",
};

const response = await Products.getProductsPriceByPageUrl('catalog', 'en_US', userQuery);
Utilisez des filtres pour trouver des 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.

MarqueurSignificationExemple
eqÉgalstatusId = 1 (actif uniquement)
neqPas égalrole ≠ "Viewer"
inContient (un des)role in ["Editor", "Manager"]
ninNe contient pasemail not in ["@temp.com"]
exsExiste (a une valeur)A un lastLogin
nexsN'existe pasJamais connecté
patCorrespond au modèlel'identifiant correspond à "man"
sameCorrespond exactement à la valeurl'identifiant est exactement "admin1"
same_partCorrespond à une partie de la valeur exactementune partie de l'identifiant est exactement "adm"

conditionValue : La valeur à comparer.

Exemple de réponse

{
"items": [
{
"id": 2960,
"price": 180
},
{
"id": 3445,
"price": 150
},
{
"id": 2957,
"price": 150
},
"..."
],
"total": 6
}

Schéma de réponse

Schéma : IProductsInfo

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

items: IProductInfo[]
Un tableau d'objets d'information sur les produits.
exemple :

[
{
"id": 12345,
"price": 150
},
{
"id": 67890,
"price": 200
}
]

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

items.price: number
Le prix du produit.
exemple : 150

items.signedPrice: string
Le prix signé (fixé) du produit, retourné lorsque signPrice est défini.
voir : Prix fixe du produit
exemple : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."