OVIRO LogoOVIRO
Quản lý sản phẩm (PIM)Sản phẩm

Product Object

Cấu trúc đối tượng sản phẩm trả về từ API Storefront.

Product Object là cấu trúc dữ liệu mô tả một sản phẩm. Nó được sử dụng chung cho cả Search Listing và Product Detail, tuy nhiên một số trường chỉ xuất hiện ở ngữ cảnh cụ thể.

Schema

{
  "id": 10,
  "name": "Iphone 15 Pro Max",
  "type": 1,
  "status": 3,
  "seo_url": "iphone-15-pro-max",
  "brand_id": 5,
  "badge": "Mới",
  "category": {
    "id": 1,
    "name": "Điện thoại",
    "seo_url": "dien-thoai",
    "parent_id": 0
  },
  "installment": [],
  "selectable_options": [
    // Xem Selectable Options Schema bên dưới
  ],
  "variants": [
    // Xem Variant Object Schema
  ],
  "thumbnails": [
    {
      "id": 501,
      "url": "https://example.com/thumb.jpg"
    }
  ],
  "gallery": [
    {
      "id": 502,
      "url": "https://example.com/image1.jpg"
    }
  ],
  "social_videos": [
    {
      "platform": "tiktok",
      "video_id": "123456789",
      "description": "Video review"
    }
  ],
  "product_uoms": [
    // Xem Product UOM Schema bên dưới
  ],
  "info_promotion_note": "Giảm 10%...",
  "avg_rating": 4.5,
  "count_rating": 100,

  // Weight & Dimension
  "weight_type": 0,
  "weight_sale_mode": 0,
  "weight_presets": [],
  "physical_catch_weight_uom_id": 0,
  "length": 0,
  "width": 0,
  "height": 0,

  // Pricing & Procurement
  "pricing_type": 0,
  "procurement_type": 0,
  "allow_preorder": 0,
  "default_variant_id": 100,
  "sell_on_zero": 0,

  // Capabilities & Flags
  "booking_attachable": 0,
  "need_customize": 0,
  "mockup_supported": 0,
  "config_3d_supported": 0,
  "material_type": 0,
  "expiry_tracked": 0,
  "page_id": 0,
  "lead_time": 0,

  // === Chỉ có ở Search Listing ===
  "_score": 1.5,

  // === Chỉ có ở Product Detail ===
  "category_id_list": [1, 2, 3],
  "description": "<p>Chi tiết sản phẩm (HTML)</p>",
  "summary": "Tóm tắt sản phẩm",
  "info_promotion": "Thông tin khuyến mãi chi tiết",
  "info_package": "Thông tin đóng gói",
  "info_warranty": "Thông tin bảo hành",
  "country_of_origin": "Việt Nam",
  "hs_code": "",
  "certification": "",
  "seo_title": "Iphone 15 Pro Max - Chính hãng",
  "seo_meta_description": "...",
  "seo_meta_keyword": "...",
  "seo_graph_file": { "id": 0, "url": "" },
  "seo_canonical": "",
  "seo_options": {},
  "attribute_detail": [
    {
      "name": "Màn hình",
      "value": "6.7 inch"
    }
  ],
  "group": [
    {
      "product_id": 11,
      "name": "Iphone 15 Pro",
      "seo_url": "iphone-15-pro"
    }
  ]
}

Field Descriptions

Thông tin chung (Listing + Detail)

TrườngKiểuMô tả
idintegerID sản phẩm
namestringTên sản phẩm
typeintegerLoại sản phẩm
statusintegerTrạng thái (3 = Active)
seo_urlstringĐường dẫn thân thiện (Slug)
brand_idintegerID thương hiệu
badgestringNhãn hiển thị (VD: "Mới", "Hot"...)
categoryobjectThông tin danh mục chính (id, name, seo_url, parent_id)
installmentarrayThông tin trả góp
selectable_optionsarrayCác tùy chọn cấu hình (Màu, Size) để chọn biến thể. Xem chi tiết
variantsarrayDanh sách biến thể. Xem Variant Object
thumbnailsarrayẢnh đại diện (File Object)
galleryarrayAlbum ảnh chi tiết (File Object)
social_videosarrayVideo nhúng (platform, video_id, description)
product_uomsarrayDanh sách đơn vị tính khả bán. Xem chi tiết
info_promotion_notestringGhi chú khuyến mãi ngắn
avg_ratingfloatĐiểm đánh giá trung bình
count_ratingintegerTổng số lượt đánh giá
default_variant_idintegerID biến thể mặc định

Weight & Dimensions

TrườngKiểuMô tả
weight_typeintegerLoại cân nặng
weight_sale_modeintegerChế độ bán theo cân (0 = Không bán theo cân)
weight_presetsarrayDanh sách preset cân nặng
physical_catch_weight_uom_idintegerID đơn vị tính cho catch weight
lengthintegerChiều dài sản phẩm
widthintegerChiều rộng sản phẩm
heightintegerChiều cao sản phẩm

Pricing & Procurement

TrườngKiểuMô tả
pricing_typeintegerLoại hình định giá
procurement_typeintegerLoại hình mua hàng
allow_preorderintegerCho phép đặt trước (1 = Có)
sell_on_zerointegerCho phép bán khi hết hàng (1 = Có)

Capabilities & Feature Flags

TrườngKiểuMô tả
booking_attachableintegerCó thể gắn vào booking (1 = Có)
need_customizeintegerSản phẩm cần tuỳ chỉnh trước khi mua (1 = Có)
mockup_supportedintegerHỗ trợ xem trước mockup (1 = Có)
config_3d_supportedintegerHỗ trợ cấu hình 3D (1 = Có)
material_typeintegerLoại vật liệu
expiry_trackedintegerTheo dõi hạn sử dụng (1 = Có)
page_idintegerID trang tĩnh (landing page) liên kết
lead_timeintegerThời gian giao hàng/sản xuất dự kiến

Chỉ có ở Search Listing

TrườngKiểuMô tả
_scorefloatĐiểm phù hợp từ ElasticSearch (chỉ có khi tìm kiếm)

Chỉ có ở Product Detail

TrườngKiểuMô tả
category_id_listarrayTất cả ID danh mục mà sản phẩm thuộc về
descriptionstringMô tả đầy đủ (HTML)
summarystringMô tả ngắn
info_promotionstringThông tin chi tiết khuyến mãi
info_packagestringThông tin đóng gói
info_warrantystringThông tin bảo hành
country_of_originstringQuốc gia xuất xứ
hs_codestringMã HS (Harmonized System)
certificationstringChứng nhận
seo_titlestringTiêu đề SEO
seo_meta_descriptionstringMô tả meta SEO
seo_meta_keywordstringTừ khoá meta SEO
seo_graph_fileobjectẢnh Open Graph (File Object)
seo_canonicalstringURL canonical
seo_optionsobjectTuỳ chọn SEO bổ sung
attribute_detailarrayThông số kỹ thuật chi tiết (name, value)
grouparrayCác sản phẩm cùng nhóm (product_id, name, seo_url)

Selectable Options Schema

Mỗi item trong selectable_options đại diện cho một nhóm tuỳ chọn (VD: Màu sắc, Kích thước).

{
  "option_id": 1,
  "option_name": "Màu sắc",
  "option_type": 1,
  "use_image": 1,
  "layout_name": "Color Swatch",
  "layout_identifier": "color-swatch",
  "layout_type": 1,
  "layout_hide_disabled_value": 0,
  "option_values": [
    {
      "option_id": 1,
      "option_value_id": 101,
      "option_value_name": "Titan Tự nhiên",
      "uuid": "abc-123",
      "file_id_list": [501],
      "file_list": [{ "id": 501, "url": "..." }],
      "base_option_value_hexcolor": "#C4B8A5",
      "base_option_value_metadata": "",
      "base_option_value_file_id_list": [502],
      "base_option_value_file_list": [{ "id": 502, "url": "..." }]
    }
  ]
}

Option Fields

TrườngKiểuMô tả
option_idintegerID option
option_namestringTên option (VD: "Màu sắc", "Kích thước")
option_typeintegerKiểu option
use_imageintegerSử dụng hình ảnh cho option value (1 = Có)
layout_namestringTên layout tuỳ chỉnh
layout_identifierstringIdentifier layout
layout_typeintegerKiểu layout
layout_hide_disabled_valueintegerẨn giá trị không khả dụng (1 = Có)

Option Value Fields

TrườngKiểuMô tả
option_idintegerID option cha
option_value_idintegerID giá trị option
option_value_namestringTên giá trị (VD: "Đen", "XL")
uuidstringUUID duy nhất
file_id_listarrayDanh sách File ID đính kèm cấp variant-option
file_listarrayDanh sách File Object tương ứng
base_option_value_hexcolorstringMã màu HEX gốc (VD: #FF0000)
base_option_value_metadatastringMetadata bổ sung gốc
base_option_value_file_id_listarrayDanh sách File ID gốc của option value
base_option_value_file_listarrayDanh sách File Object gốc

Product UOM Schema

Danh sách đơn vị tính khả bán. Chỉ trả về khi sản phẩm không ở chế độ bán theo cân (weight_sale_mode = 0).

{
  "uom_id": 1,
  "uom_name": "Hộp",
  "factor": 12,
  "weight": 500,
  "is_default": 1,
  "display_order": 1.0,
  "allow_sale": 1,
  "icon_svg": "<svg>...</svg>",
  "file_id_list": [601],
  "file_list": [{ "id": 601, "url": "..." }]
}
TrườngKiểuMô tả
uom_idintegerID đơn vị tính
uom_namestringTên đơn vị tính
factorintegerHệ số quy đổi so với đơn vị cơ bản
weightintegerTrọng lượng
is_defaultintegerĐơn vị mặc định (1 = Có)
display_orderfloatThứ tự hiển thị
allow_saleintegerCho phép bán (1 = Có)
icon_svgstringIcon SVG
file_id_listarrayDanh sách File ID
file_listarrayDanh sách File Object

Lấy cài đặt website

API lấy toàn bộ cấu hình website/storefront của công ty hiện tại. Dùng khi khởi tạo giao diện frontend.

Variant Object

Cấu trúc đối tượng biến thể sản phẩm (Product Variant).

On this page

Schema
Field Descriptions
Thông tin chung (Listing + Detail)
Weight & Dimensions
Pricing & Procurement
Capabilities & Feature Flags
Chỉ có ở Search Listing
Chỉ có ở Product Detail
Selectable Options Schema
Option Fields
Option Value Fields
Product UOM Schema