getAllTemplates

Lấy tất cả các đối tượng mẫu của một loại cụ thể.

Mô tả

Phương thức này truy xuất tất cả các đối tượng mẫu được nhóm theo loại từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng GroupedTemplatesObject, chứa một mảng các đối tượng mẫu.

Templates.getAllTemplates(

langCode

);

Sơ đồ tham số

Sơ đồ

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

Ví dụ

Ví dụ tối thiểu

const response = await Templates.getAllTemplates();

Ví dụ với thuộc tính

const response = await Templates.getAllTemplates('en_US');

Phản hồi ví dụ

{
  "frequently_ordered_block": [
    {
      "id": 7,
      "attributeSetIdentifier": null,
      "title": "Default frequently ordered block template",
      "generalTypeId": 24,
      "identifier": "frequently_ordered_block_default",
      "version": 0,
      "generalTypeName": "frequently_ordered_block",
      "attributeValues": {},
      "position": 1
    }
  ],
  "slider_block": [
    {
      "id": 8,
      "attributeSetIdentifier": null,
      "title": "Default slider block template",
      "generalTypeId": 25,
      "identifier": "slider_block_default",
      "version": 0,
      "generalTypeName": "slider_block",
      "attributeValues": {},
      "position": 2
    }
  ],
  "trending_block": [
    {
      "id": 9,
      "attributeSetIdentifier": null,
      "title": "Default trending block template",
      "generalTypeId": 26,
      "identifier": "trending_block_default",
      "version": 0,
      "generalTypeName": "trending_block",
      "attributeValues": {},
      "position": 3
    }
  ],
  "recently_viewed_block": [
    {
      "id": 10,
      "attributeSetIdentifier": null,
      "title": "Default recently viewed block template",
      "generalTypeId": 27,
      "identifier": "recently_viewed_block_default",
      "version": 0,
      "generalTypeName": "recently_viewed_block",
      "attributeValues": {},
      "position": 4
    }
  ],
  "repeat_purchase_block": [
    {
      "id": 11,
      "attributeSetIdentifier": null,
      "title": "Default repeat purchase block template",
      "generalTypeId": 28,
      "identifier": "repeat_purchase_block_default",
      "version": 0,
      "generalTypeName": "repeat_purchase_block",
      "attributeValues": {},
      "position": 5
    }
  ],
  "personal_recommendations_block": [
    {
      "id": 12,
      "attributeSetIdentifier": null,
      "title": "Default personal recommendations block template",
      "generalTypeId": 29,
      "identifier": "personal_recommendations_block_default",
      "version": 0,
      "generalTypeName": "personal_recommendations_block",
      "attributeValues": {},
      "position": 6
    }
  ],
  "cart_complement_block": [
    {
      "id": 13,
      "attributeSetIdentifier": null,
      "title": "Default cart complement block template",
      "generalTypeId": 30,
      "identifier": "cart_complement_block_default",
      "version": 0,
      "generalTypeName": "cart_complement_block",
      "attributeValues": {},
      "position": 7
    }
  ],
  "cart_similar_block": [
    {
      "id": 14,
      "attributeSetIdentifier": null,
      "title": "Default cart similar block template",
      "generalTypeId": 31,
      "identifier": "cart_similar_block_default",
      "version": 0,
      "generalTypeName": "cart_similar_block",
      "attributeValues": {},
      "position": 8
    }
  ],
  "wishlist_similar_block": [
    {
      "id": 15,
      "attributeSetIdentifier": null,
      "title": "Default wishlist similar block template",
      "generalTypeId": 32,
      "identifier": "wishlist_similar_block_default",
      "version": 0,
      "generalTypeName": "wishlist_similar_block",
      "attributeValues": {},
      "position": 9
    }
  ],
  "catalog_page": [
    {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Template",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 12
    }
  ]
}

Sơ đồ phản hồi

Sơ đồ: Record<Types, ITemplateEntity[]>

id: number
Định danh duy nhất của vị trí.
ví dụ: 12345

attributeSetIdentifier: string | null
Tập hợp các id thuộc tính.
ví dụ: "attribute_set_1"

title: string
Tên của mẫu.
ví dụ: "Mẫu Sản Phẩm"

generalTypeId: number
Id thực thể loại chung.
ví dụ: 67890

identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "template_12345"

version: number
Số phiên bản của đối tượng.
ví dụ: 1

generalTypeName: BlockType
Tên loại chung.
ví dụ: "sản phẩm"

attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được khóa theo dấu hiệu; đối tượng rỗng khi không có.
ví dụ:

{
  "id": 1,
  "value": "some"
}

position: number
Vị trí của đối tượng.
ví dụ: 1

---