getCartComplement

Dapatkan produk "lengkapi keranjang Anda" berdasarkan keranjang dari konteks (pengguna terotorisasi atau tamu).

Deskripsi

Metode ini mengembalikan produk "lengkapi keranjang Anda" untuk keranjang yang diambil dari konteks saat ini - pengguna terotorisasi atau tamu (diselesaikan melalui header x-guest-id, lihat Mode tamu). Ini mengembalikan Promise yang menyelesaikan menjadi objek IProductsResponse - sebuah wadah dengan items (produk), total, dan totalFound - bukan array kosong.

Blocks.getCartComplement(

marker*, langCode, signPrice, limit

);

Skema parameter

Skema

marker(required): string
Penanda blok
contoh: "cart_complement_block"

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

signPrice: string
Penanda penyimpanan pesanan untuk penetapan harga. Jika parameter ini diatur, harga akan tetap untuk waktu tertentu
lihat: Menetapkan harga

limit: number
Jumlah maksimum produk yang akan dikembalikan. Jika diabaikan, pengaturan jumlah blok itu sendiri yang berlaku
contoh: 10

💲 signPrice mengunci harga yang dikembalikan untuk waktu terbatas — atur ke penanda penyimpanan pesanan Anda. Lihat Menetapkan harga (signPrice).

Contoh

Contoh minimal

const response = await Blocks.getCartComplement('cart_complement_block');

Contoh dengan atribut

const response = await Blocks.getCartComplement('cart_complement_block', 'en_US');

Contoh dengan batas

const response = await Blocks.getCartComplement('cart_complement_block', 'en_US', undefined, 4);

🔢 limit membatasi berapa banyak produk yang dikembalikan. Abaikan dan pengaturan jumlah blok itu sendiri dari panel admin tetap berlaku. Lihat Membatasi jumlah produk (limit).

Contoh respons

{
  "items": [
    {
      "id": 2954,
      "localizeInfos": {
        "title": "Box"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": "product_preview",
      "price": 51,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "product-name",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 51,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "usd",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": {
            "size": 742690,
            "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "contentType": "image/jpeg",
            "previewLink": {
              "default": [
                "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
                "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
              ]
            },
            "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "defaultPreview": "default"
          },
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "categories": [
        "catalog"
      ],
      "rating": {},
      "isVisible": true,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 688,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 688
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    }
  ],
  "total": 1,
  "totalFound": 1
}

Skema respons

Skema: IProductsResponse

total: number
Jumlah total produk yang ditemukan.
contoh: 100

items: IProductsEntity[]
Array entitas produk.
contoh:

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

items.id: number
Pengidentifikasi unik.
contoh: 12345

items.localizeInfos: ILocalizeInfo
Nama produk, dengan mempertimbangkan lokalisasi.
contoh:

{}

items.statusIdentifier: string | null
Pengidentifikasi status halaman produk (mungkin null).
contoh: "in_stock"

items.statusLocalizeInfos: ILocalizeInfo
Nama status yang dilokalisasi untuk produk.
contoh:

{ "title": "Sale" }

items.attributeSetIdentifier: string | null
Id set atribut.
contoh: "set_12345"

items.position: number
Nomor item (untuk pengurutan).
contoh: 1

items.price: number | null
Nilai harga halaman produk yang diambil dari indeks.
contoh: 150.00

items.additional: object
Nilai tambahan dari indeks.
contoh:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

items.sku: string | null
SKU produk (Stock Keeping Unit), mungkin null.
contoh: "SKU_12345"

items.isSync: boolean
Indikasi pengindeksan halaman.
contoh: true

items.attributeValues: IAttributeValues
Array nilai atribut dari indeks, yang direpresentasikan.
contoh:

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

items.categories: string[]
Kategori produk.
contoh:

[
  1,
  2,
  3
]

items.isVisible: boolean
Tanda visibilitas halaman.
contoh: true

items.moduleFormConfigs: Array<IFormConfig>
Konfigurasi formulir modul (opsional).

items.rating: IRating
Data penilaian.

items.isPositionLocked: boolean
Indikator penguncian posisi pengurutan (opsional).
contoh: false

items.relatedIds: number[]
Id halaman produk terkait.
contoh:

[
  12345,
  67890
]

items.paymentStages: unknown
Data tahap pembayaran (mungkin null).
contoh: null

items.distance: number
Jarak relevansi pencarian vektor (semantik). Hanya ada dalam hasil pencarian vektor.
contoh: 0.42

items.discountConfig: Record<string, unknown>
Objek konfigurasi diskon.
contoh:

{}

items.templateIdentifier: string | null
Id pengguna dari template yang terhubung.
contoh: "template_12345"

items.shortDescTemplateIdentifier: string | null
Id pengguna dari template yang terhubung untuk deskripsi singkat.
contoh: "short_desc_template_12345"

items.signedPrice: string
Harga yang ditandatangani dari produk diperoleh bersama dengan data produk ketika signPrice diatur.
lihat: Harga produk tetap
contoh: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

items.productPages: IProductPageRef[]
Array referensi halaman produk yang menghubungkan produk ke halamannya.
contoh:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

items.blocks: string[]
Array pengidentifikasi blok.
contoh:

[
  "block_12345",
  "block_67890"
]

totalFound: number
Jumlah produk yang cocok sebelum batas diterapkan; dikembalikan oleh endpoint produk blok (similarProducts, rekomendasi keranjang/daftar keinginan, sering dipesan). Opsional.
contoh: 2

🔒 signedPrice adalah token yang ditandatangani yang membawa harga yang terkunci — kirimkan kembali saat Anda membuat pesanan. Lihat Harga produk tetap (signedPrice).

---