Dapatkan produk berdasarkan URL halaman

Dalam contoh ini, kami menunjukkan cara untuk mengambil semua produk yang termasuk dalam halaman katalog tertentu menggunakan API OneEntry.

✅ Tujuan skenario:

• Terhubung ke API OneEntry
• Mengambil produk yang difilter berdasarkan URL halaman katalog mereka
• Meninjau daftar produk yang dikembalikan

✅ Apa yang Anda butuhkan:

• PROJECT_URL dan APP_TOKEN yang valid untuk otentikasi dengan API OneEntry.
• Halaman katalog yang dikonfigurasi di OneEntry dengan URL yang diketahui (misalnya, "produk").
• Produk yang ditugaskan ke halaman katalog tersebut.

📌 Penting:

• Mengembalikan { items, total } — bukan array biasa.
• Parameter url harus cocok dengan pageUrl dari halaman tipe catalog_page.
• Contoh-contoh ini tidak mencakup penanganan kesalahan.
• Anda dapat mengelola kesalahan menggunakan blok try-catch atau dengan menggunakan konstruksi seperti await Promise.catch((error) => error).

📚 Lihat di dokumentasi:

• Katalog

📦 Referensi SDK:

• Produk

Coba secara langsung

Jalankan metode ini secara interaktif di JS SDK sandbox — sambungkan Project URL dan App Token Anda pada kunjungan pertama, lalu buka:

• Dapatkan produk berdasarkan URL halaman — Dalam contoh ini, kami menunjukkan cara untuk mengambil semua produk yang termasuk dalam halaman katalog tertentu menggunakan API OneEntry.

Skenario

1. Impor defineOneEntry dari SDK dan definisikan PROJECT_URL dan APP_TOKEN

Contoh:

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. Membuat klien API dengan defineOneEntry()

Contoh:

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

3. Definisikan parameter permintaan

Contoh:

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

4. Dapatkan produk berdasarkan URL halaman dengan Products.getProductsByPageUrl()

Contoh:

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);

Hasil:

{
  "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
}

Contoh akhir

// 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);