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
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • 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
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
    • Return order detail
    • 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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/products/list?page=1&page_size=5&keyword=' \
--header 'Authorization;'
Response Response Example
Success
{
  "status_code": 200,
  "data": [
    {
      "id": 38402,
      "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,
      "partner_reserved_stock": 0,
      "partner_available_stock": 0,
      "sku": "V1A9-W19L",
      "name": "peppers",
      "original_name": null,
      "image_url": "https://via.placeholder.com/890x855/0dca9f/330d9b.jpg",
      "original_price": "7081576.39",
      "discounted_price": "1670032.65",
      "days_to_ship": 0,
      "condition": "NEW",
      "wholesale": {},
      "tier_index": {},
      "config": {},
      "status": 200,
      "status_update_time": 1745899853,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_dangerous": false,
      "is_pre_order": false,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745899853,
      "updated_time": 1745899853,
      "last_sync_time": 0,
      "user": 190,
      "business": 276,
      "parent": null,
      "updated_by": 190,
      "created_by": 190,
      "store": {
        "id": 336,
        "name": "Hary Trần",
        "logo": null,
        "platform": "retail",
        "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
      },
      "product_brand": 242397,
      "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,
      "is_bundle": false,
      "total_linked": 1,
      "linked_sku_list": "V1A9-W19L",
      "product_variant": []
    },
    {
      "id": 38401,
      "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,
      "partner_reserved_stock": 0,
      "partner_available_stock": 0,
      "sku": "8GA7-OU14",
      "name": "swiss chard",
      "original_name": null,
      "image_url": "https://via.placeholder.com/1715x1277/f7db1f/00ad8f.jpg",
      "original_price": "661244.30",
      "discounted_price": "2303072.95",
      "days_to_ship": 0,
      "condition": "NEW",
      "wholesale": {},
      "tier_index": {},
      "config": {},
      "status": 200,
      "status_update_time": 1745899101,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_dangerous": false,
      "is_pre_order": false,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745899101,
      "updated_time": 1745899101,
      "last_sync_time": 0,
      "user": 190,
      "business": 276,
      "parent": null,
      "updated_by": 190,
      "created_by": 190,
      "store": {
        "id": 336,
        "name": "Hary Trần",
        "logo": null,
        "platform": "retail",
        "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
      },
      "product_brand": 242397,
      "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,
      "is_bundle": false,
      "total_linked": 1,
      "linked_sku_list": "8GA7-OU14",
      "product_variant": []
    },
    {
      "id": 38400,
      "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,
      "partner_reserved_stock": 0,
      "partner_available_stock": 0,
      "sku": "ESDF-V3UF",
      "name": "bok choy",
      "original_name": null,
      "image_url": "https://via.placeholder.com/1235x499/2eaecc/2154ca.png",
      "original_price": "489133.75",
      "discounted_price": "7851990.90",
      "days_to_ship": 0,
      "condition": "NEW",
      "wholesale": {},
      "tier_index": {},
      "config": {},
      "status": 200,
      "status_update_time": 1745898479,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_dangerous": false,
      "is_pre_order": false,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745898479,
      "updated_time": 1745898479,
      "last_sync_time": 0,
      "user": 190,
      "business": 276,
      "parent": null,
      "updated_by": 190,
      "created_by": 190,
      "store": {
        "id": 336,
        "name": "Hary Trần",
        "logo": null,
        "platform": "retail",
        "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
      },
      "product_brand": 242397,
      "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,
      "is_bundle": false,
      "total_linked": 0,
      "linked_sku_list": "",
      "product_variant": []
    },
    {
      "id": 38399,
      "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,
      "partner_reserved_stock": 0,
      "partner_available_stock": 0,
      "sku": "88D4-7NGF",
      "name": "cos lettuce",
      "original_name": null,
      "image_url": "https://via.placeholder.com/1102x1916/c7f1fd/c0d2fb.gif",
      "original_price": "9032958.69",
      "discounted_price": "1883794.29",
      "days_to_ship": 0,
      "condition": "NEW",
      "wholesale": {},
      "tier_index": {},
      "config": {},
      "status": 200,
      "status_update_time": 1745898417,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_dangerous": false,
      "is_pre_order": false,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745898417,
      "updated_time": 1745898417,
      "last_sync_time": 0,
      "user": 190,
      "business": 276,
      "parent": null,
      "updated_by": 190,
      "created_by": 190,
      "store": {
        "id": 336,
        "name": "Hary Trần",
        "logo": null,
        "platform": "retail",
        "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,
      "is_bundle": false,
      "total_linked": 0,
      "linked_sku_list": "",
      "product_variant": []
    },
    {
      "id": 38398,
      "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,
      "partner_reserved_stock": 0,
      "partner_available_stock": 0,
      "sku": "T9C9-98O6",
      "name": "jicama",
      "original_name": null,
      "image_url": "https://via.placeholder.com/1048x166/db8168/f2a4ff.jpeg",
      "original_price": "245885.19",
      "discounted_price": "149431.09",
      "days_to_ship": 0,
      "condition": "NEW",
      "wholesale": {},
      "tier_index": {},
      "config": {},
      "status": 200,
      "status_update_time": 1745898397,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_dangerous": false,
      "is_pre_order": false,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745898397,
      "updated_time": 1745898397,
      "last_sync_time": 0,
      "user": 190,
      "business": 276,
      "parent": null,
      "updated_by": 190,
      "created_by": 190,
      "store": {
        "id": 336,
        "name": "Hary Trần",
        "logo": null,
        "platform": "retail",
        "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,
      "is_bundle": false,
      "total_linked": 0,
      "linked_sku_list": "",
      "product_variant": []
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 512
}

Request

Query Params
page
integer 
required
Example:
1
page_size
integer 
required
<= 50
Example:
5
keyword
string 
optional
The keyword to search by SKU or product name.
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
HTTP status code (200 = success)
data
array [object {51}] 
optional
id
integer 
optional
country
string 
optional
currency
string 
optional
platform
string 
optional
partner_variant_id
integer 
optional
partner_promotion_id
integer 
optional
partner_inventory_id
integer 
optional
partner_product_id
integer 
optional
parent_partner_product_id
integer 
optional
partner_reserved_stock
integer 
optional
partner_available_stock
integer 
optional
sku
string 
optional
name
string 
optional
image_url
string 
optional
original_price
string 
optional
discounted_price
string 
optional
days_to_ship
integer 
optional
condition
string 
optional
status
integer 
optional
status_update_time
integer 
optional
weight
integer 
optional
package_length
integer 
optional
package_width
integer 
optional
package_height
integer 
optional
has_variant
boolean 
optional
is_dangerous
boolean 
optional
is_pre_order
boolean 
optional
is_active
boolean 
optional
is_delete
boolean 
optional
created_time
integer 
optional
updated_time
integer 
optional
last_sync_time
integer 
optional
user
integer 
optional
business
integer 
optional
parent
string 
optional
updated_by
integer 
optional
created_by
integer 
optional
store
object 
optional
product_brand
integer 
optional
product_category
integer 
optional
condition_display
string 
optional
status_display
string 
optional
platform_logo
string 
optional
is_single
boolean 
optional
is_variant
boolean 
optional
can_cancel
boolean 
optional
can_re_sync
boolean 
optional
can_edit
boolean 
optional
status_css
string 
optional
is_bundle
boolean 
optional
product_variant
array[integer]
optional
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
Previous
Create Product From Product Inventory
Next
Product detail
Built with