API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Online Product
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
    • List category
      GET
    • List brand
      GET
    • List Outbound Strategy
      GET
    • List Product Type
      GET
    • List Material
      GET
    • List Storage Method
      GET
    • List Unit
      GET
    • Upload File
      POST
  • Online Product
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Create single inventory product
      POST
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Get Product Inventory in Warehouse
      GET
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
    • [Retail][Ship by self] Create shipment with item
    • Cancel shipment
    • List shipment
    • Shipment detail
    • List shipment of order
    • Shipment item
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
    • List addtional services
  • Order Return
    • List return order
    • Return order detail
    • Return order item
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Online Product

List product

GET
/api/v1/public/products/list
This API retrieves a list of products from the system, with support for pagination and keyword filtering. It is used to display or manage product data from different platforms such as retail, Shopee, Lazada, Tiktok, Shopify,.....

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/products/list?page=1&page_size=5&keyword=' \
--header 'Authorization: {{your_api_key_here}}'
Response Response Example
Success
{
    "status_code": 200,
    "data": [
        {
            "id": 45170,
            "country": "VN",
            "currency": "VND",
            "platform": "retail",
            "partner_variant_id": null,
            "partner_promotion_id": null,
            "partner_inventory_id": null,
            "partner_product_id": null,
            "parent_partner_product_id": null,
            "parent_partner_product_sku": null,
            "partner_reserved_stock": 0,
            "partner_available_stock": 0,
            "sku": "NB_001",
            "name": "Bánh Que No Brand Tẩm Mè Gói 187G",
            "original_name": null,
            "image_url": "https://emartmall.com.vn/image/cache/catalog/products/8809189924679/8809189924679-600x600.jpg",
            "original_price": "59000.00",
            "discounted_price": "59000.00",
            "days_to_ship": 0,
            "condition": "NEW",
            "wholesale": [],
            "tier_index": {},
            "config": {},
            "priority_sync_stock": 3,
            "status": 200,
            "status_update_time": 1758792424.0,
            "weight": 187,
            "package_length": 10.0,
            "package_width": 10.0,
            "package_height": 10.0,
            "has_variant": false,
            "is_dangerous": false,
            "is_pre_order": false,
            "is_active": true,
            "is_delete": false,
            "created_time": 1758792424.0,
            "updated_time": 1758792424.0,
            "last_sync_time": 0.0,
            "user": 190,
            "business": 276,
            "parent": null,
            "updated_by": 190,
            "created_by": 190,
            "store": {
                "id": 336,
                "name": "Hary Trần",
                "logo": null,
                "platform": "retail",
                "is_active": true,
                "currency": "VND",
                "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
            },
            "product_brand": 44003,
            "product_category": 2477,
            "condition_display": "New",
            "status_display": "On Sale",
            "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png",
            "is_single": true,
            "is_variant": false,
            "can_cancel": true,
            "can_re_sync": false,
            "can_edit": true,
            "status_css": "success",
            "is_retail": true,
            "syncable_stock_percent_config": [],
            "unreal_stock_config": [],
            "lock_sync_stock": false,
            "lock_sync_stock_with_wh": [],
            "is_bundle": true,
            "total_linked": 1,
            "linked_sku_list": "NB_001",
            "product_variant": []
        },
        {
            "id": 44856,
            "country": "VN",
            "currency": "VND",
            "platform": "b2b",
            "partner_variant_id": null,
            "partner_promotion_id": null,
            "partner_inventory_id": null,
            "partner_product_id": null,
            "parent_partner_product_id": null,
            "parent_partner_product_sku": null,
            "partner_reserved_stock": 0,
            "partner_available_stock": 0,
            "sku": "sku20250908",
            "name": "sku20250908",
            "original_name": null,
            "image_url": null,
            "original_price": "12000.00",
            "discounted_price": "11000.00",
            "days_to_ship": 0,
            "condition": "NEW",
            "wholesale": [],
            "tier_index": {},
            "config": {
                "lock_sync_stock": false,
                "lock_sync_stock_with_wh": []
            },
            "priority_sync_stock": 3,
            "status": 700,
            "status_update_time": 1757299885.0,
            "weight": 1,
            "package_length": 1.0,
            "package_width": 1.0,
            "package_height": 1.0,
            "has_variant": false,
            "is_dangerous": false,
            "is_pre_order": false,
            "is_active": true,
            "is_delete": false,
            "created_time": 1757299885.0,
            "updated_time": 1758094716.0,
            "last_sync_time": 0.0,
            "user": 190,
            "business": 276,
            "parent": null,
            "updated_by": 190,
            "created_by": 190,
            "store": {
                "id": 337,
                "name": "Hary Trần",
                "logo": null,
                "platform": "b2b",
                "is_active": true,
                "currency": "VND",
                "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/b2b_1739504341.png"
            },
            "product_brand": 242223,
            "product_category": 2084,
            "condition_display": "New",
            "status_display": "Deleted",
            "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/b2b_1739504341.png",
            "is_single": true,
            "is_variant": false,
            "can_cancel": false,
            "can_re_sync": false,
            "can_edit": false,
            "status_css": "danger",
            "is_retail": true,
            "syncable_stock_percent_config": [],
            "unreal_stock_config": [],
            "lock_sync_stock": false,
            "lock_sync_stock_with_wh": [],
            "is_bundle": false,
            "total_linked": 0,
            "linked_sku_list": "",
            "product_variant": []
        },
        {
            "id": 44855,
            "country": "VN",
            "currency": "VND",
            "platform": "shopify",
            "partner_variant_id": null,
            "partner_promotion_id": null,
            "partner_inventory_id": null,
            "partner_product_id": null,
            "parent_partner_product_id": null,
            "parent_partner_product_sku": null,
            "partner_reserved_stock": 0,
            "partner_available_stock": 0,
            "sku": "abc",
            "name": "abcasc",
            "original_name": null,
            "image_url": "https://qc.nandh.vn/storage/no_image/no_image.jpg",
            "original_price": "90000.00",
            "discounted_price": "90000.00",
            "days_to_ship": 0,
            "condition": "NEW",
            "wholesale": [],
            "tier_index": {},
            "config": {
                "lock_sync_stock": false,
                "lock_sync_stock_with_wh": []
            },
            "priority_sync_stock": 3,
            "status": 700,
            "status_update_time": 1757299740.0,
            "weight": 1,
            "package_length": 1.0,
            "package_width": 1.0,
            "package_height": 1.0,
            "has_variant": false,
            "is_dangerous": false,
            "is_pre_order": false,
            "is_active": true,
            "is_delete": false,
            "created_time": 1757299740.0,
            "updated_time": 1757299835.0,
            "last_sync_time": 0.0,
            "user": 190,
            "business": 276,
            "parent": null,
            "updated_by": 190,
            "created_by": 190,
            "store": {
                "id": 451,
                "name": "Abcd Bike",
                "logo": null,
                "platform": "shopify",
                "is_active": false,
                "currency": "VND",
                "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png"
            },
            "product_brand": 242396,
            "product_category": 2477,
            "condition_display": "New",
            "status_display": "Deleted",
            "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png",
            "is_single": true,
            "is_variant": false,
            "can_cancel": false,
            "can_re_sync": false,
            "can_edit": false,
            "status_css": "danger",
            "is_retail": false,
            "syncable_stock_percent_config": [],
            "unreal_stock_config": [],
            "lock_sync_stock": false,
            "lock_sync_stock_with_wh": [],
            "is_bundle": false,
            "total_linked": 0,
            "linked_sku_list": "",
            "product_variant": []
        },
        {
            "id": 44854,
            "country": "VN",
            "currency": "VND",
            "platform": "magento",
            "partner_variant_id": null,
            "partner_promotion_id": null,
            "partner_inventory_id": null,
            "partner_product_id": null,
            "parent_partner_product_id": null,
            "parent_partner_product_sku": null,
            "partner_reserved_stock": 0,
            "partner_available_stock": 0,
            "sku": "ASSSSSSS",
            "name": "abcascaaa",
            "original_name": null,
            "image_url": null,
            "original_price": "1200.00",
            "discounted_price": "1200.00",
            "days_to_ship": 0,
            "condition": "NEW",
            "wholesale": [],
            "tier_index": {},
            "config": {
                "lock_sync_stock": false,
                "lock_sync_stock_with_wh": []
            },
            "priority_sync_stock": 3,
            "status": 700,
            "status_update_time": 1757299547.0,
            "weight": 1,
            "package_length": 1.0,
            "package_width": 1.0,
            "package_height": 1.0,
            "has_variant": false,
            "is_dangerous": false,
            "is_pre_order": false,
            "is_active": true,
            "is_delete": false,
            "created_time": 1757299547.0,
            "updated_time": 1757299838.0,
            "last_sync_time": 0.0,
            "user": 190,
            "business": 276,
            "parent": null,
            "updated_by": 190,
            "created_by": 190,
            "store": {
                "id": 543,
                "name": "LUMA",
                "logo": null,
                "platform": "magento",
                "is_active": true,
                "currency": "VND",
                "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/images_1747976034.png"
            },
            "product_brand": 242397,
            "product_category": 2084,
            "condition_display": "New",
            "status_display": "Deleted",
            "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/images_1747976034.png",
            "is_single": true,
            "is_variant": false,
            "can_cancel": false,
            "can_re_sync": false,
            "can_edit": false,
            "status_css": "danger",
            "is_retail": false,
            "syncable_stock_percent_config": [],
            "unreal_stock_config": [],
            "lock_sync_stock": false,
            "lock_sync_stock_with_wh": [],
            "is_bundle": false,
            "total_linked": 0,
            "linked_sku_list": "",
            "product_variant": []
        },
        {
            "id": 44829,
            "country": "VN",
            "currency": "VND",
            "platform": "nhanh",
            "partner_variant_id": null,
            "partner_promotion_id": null,
            "partner_inventory_id": null,
            "partner_product_id": null,
            "parent_partner_product_id": null,
            "parent_partner_product_sku": null,
            "partner_reserved_stock": 0,
            "partner_available_stock": 0,
            "sku": "abc",
            "name": "abcasc",
            "original_name": null,
            "image_url": null,
            "original_price": "100000.00",
            "discounted_price": "90000.00",
            "days_to_ship": 0,
            "condition": "NEW",
            "wholesale": [],
            "tier_index": {},
            "config": {
                "lock_sync_stock": false,
                "lock_sync_stock_with_wh": []
            },
            "priority_sync_stock": 3,
            "status": 700,
            "status_update_time": 1756971435.0,
            "weight": 1,
            "package_length": 1.0,
            "package_width": 1.0,
            "package_height": 1.0,
            "has_variant": false,
            "is_dangerous": false,
            "is_pre_order": false,
            "is_active": true,
            "is_delete": false,
            "created_time": 1756971435.0,
            "updated_time": 1757299841.0,
            "last_sync_time": 0.0,
            "user": 190,
            "business": 276,
            "parent": null,
            "updated_by": 190,
            "created_by": 190,
            "store": {
                "id": 477,
                "name": "nhanh824045489667",
                "logo": null,
                "platform": "nhanh",
                "is_active": true,
                "currency": "USD",
                "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/nhanhvn_1734314088.png"
            },
            "product_brand": 242396,
            "product_category": 2477,
            "condition_display": "New",
            "status_display": "Deleted",
            "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/nhanhvn_1734314088.png",
            "is_single": true,
            "is_variant": false,
            "can_cancel": false,
            "can_re_sync": false,
            "can_edit": false,
            "status_css": "danger",
            "is_retail": false,
            "syncable_stock_percent_config": [],
            "unreal_stock_config": [],
            "lock_sync_stock": false,
            "lock_sync_stock_with_wh": [],
            "is_bundle": false,
            "total_linked": 0,
            "linked_sku_list": "",
            "product_variant": []
        }
    ],
    "error": false,
    "error_code": null,
    "log_id": null,
    "messages": "",
    "total": 564,
    "version": "1.0.14"
}
Previous
Create Product From Product Inventory
Next
Product detail
Built with