Aller au contenu principal

Obtenir des produits par URL de page

Dans cet exemple, nous démontrons comment récupérer tous les produits appartenant à une page de catalogue spécifique en utilisant l'API OneEntry.

✅ Objectif du scénario :

  • Se connecter à l'API OneEntry
  • Récupérer les produits filtrés par l'URL de leur page de catalogue
  • Examiner la liste des produits retournés

✅ Ce dont vous avez besoin :

  • Un PROJECT_URL et un APP_TOKEN valides pour l'authentification avec l'API OneEntry.
  • Une page de catalogue configurée dans OneEntry avec une URL connue (par exemple, "products").
  • Des produits assignés à cette page de catalogue.

📌 Important :

  • Retourne { items, total } — pas un tableau simple.
  • Le paramètre url doit correspondre à la pageUrl d'une page de type catalog_page.
  • Ces exemples n'incluent pas la gestion des erreurs.
  • Vous pouvez gérer les erreurs en utilisant un bloc try-catch ou en employant une construction comme await Promise.catch((error) => error).

📚 Voir dans la documentation :

📦 Référence SDK :

Essayez-le en direct​

Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre Project URL et App Token lors de votre première visite, puis ouvrez :

  • Obtenir des produits par URL de page — Dans cet exemple, nous démontrons comment récupérer tous les produits appartenant à une page de catalogue spécifique en utilisant l'API OneEntry.

Scénario​

1. Importer defineOneEntry depuis le SDK et définir PROJECT_URL et APP_TOKEN​

Exemple :

import { defineOneEntry } from 'oneentry';
import type { IProductsQuery } from 'oneentry/dist/products/productsInterfaces';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Créer un client API avec defineOneEntry()​

Exemple :

const { Products } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Définir les paramètres de la requête​

Exemple :

const userQuery: IProductsQuery = {
  offset: 0,
  limit: 20,
  sortKey: 'price',
  sortOrder: 'ASC',
};

4. Obtenir des produits par URL de page avec Products.getProductsByPageUrl()​

Exemple :

const data = await Products.getProductsByPageUrl('products', [], 'en_US', userQuery);

if ('statusCode' in data) {
  throw new Error(data.message);
}

console.log('Products: ', data.items);
console.log('Total: ', data.total);
Résultat :
{
  "items": [
    {
      "id": 13,
      "attributeSetIdentifier": "product",
      "localizeInfos": {
        "title": "Red ball"
      },
      "statusLocalizeInfos": {},
      "isVisible": true,
      "statusIdentifier": null,
      "position": 1,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 300,
      "additional": {
        "prices": {
          "min": 100,
          "max": 999
        }
      },
      "sku": null,
      "isSync": true,
      "categories": [
        "products"
      ],
      "paymentStages": null,
      "rating": {},
      "isPositionLocked": false,
      "attributeValues": {
        "price": {
          "type": "real",
          "value": "300",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "image": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "moduleFormConfigs": [],
      "discountConfig": {}
    },
    {
      "id": 14,
      "attributeSetIdentifier": "product",
      "localizeInfos": {
        "title": "Green ball"
      },
      "statusLocalizeInfos": {},
      "isVisible": true,
      "statusIdentifier": null,
      "position": 2,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 340,
      "additional": {
        "prices": {
          "min": 100,
          "max": 999
        }
      },
      "sku": null,
      "isSync": true,
      "categories": [
        "products"
      ],
      "paymentStages": null,
      "rating": {},
      "isPositionLocked": false,
      "attributeValues": {
        "price": {
          "type": "real",
          "value": "340",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "image": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "moduleFormConfigs": [],
      "discountConfig": {}
    },
    {
      "id": 15,
      "attributeSetIdentifier": "product",
      "localizeInfos": {
        "title": "Orange ball"
      },
      "statusLocalizeInfos": {},
      "isVisible": true,
      "statusIdentifier": null,
      "position": 3,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 400,
      "additional": {
        "prices": {
          "min": 100,
          "max": 999
        }
      },
      "sku": null,
      "isSync": true,
      "categories": [
        "products"
      ],
      "paymentStages": null,
      "rating": {},
      "isPositionLocked": false,
      "attributeValues": {
        "price": {
          "type": "real",
          "value": "400",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "image": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "moduleFormConfigs": [],
      "discountConfig": {}
    }
  ],
  "total": 3
}

Exemple final​

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';
import type { IProductsQuery } from 'oneentry/dist/products/productsInterfaces';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client with [defineOneEntry()](/docs/index/#Installation)
const { Products } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Define request parameters
const userQuery: IProductsQuery = {
  offset: 0,
  limit: 20,
  sortKey: 'price',
  sortOrder: 'ASC',
};

// 4. Get products by page URL with [Products.getProductsByPageUrl()](/docs/products/getProductsByPageUrl)
const data = await Products.getProductsByPageUrl('products', [], 'en_US', userQuery);

if ('statusCode' in data) {
  throw new Error(data.message);
}

console.log('Products: ', data.items);
console.log('Total: ', data.total);