API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Product Inventory
  • 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. Product Inventory

List product inventory

GET
/api/v1/public/products/inventory/list
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/products/inventory/list?page=1&page_size=5' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": [
    {
      "id": 37312,
      "country": "VN",
      "currency": "VND",
      "sku": "HVH0-7395",
      "name": "celery",
      "image_url": "https://qc.nandh.vn/storage/no_image/no_image.jpg",
      "barcode": null,
      "storage_method": "normal",
      "outbound_strategy": "fifo",
      "nhsin": "NHSINV1909619993",
      "reference_product_id": null,
      "reference_variant_id": null,
      "sku_uuid": "SUUIDV1901999116063",
      "tier_index": {},
      "cost": "2007992.99",
      "sale_price": "2007992.99",
      "shelf_life": null,
      "status": 100,
      "status_update_time": 1746604422,
      "qc_guide": null,
      "packing_note": null,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_serial_number": false,
      "is_batch_control": false,
      "is_bubble_wrap": false,
      "is_expiration_control": false,
      "is_kraft_paper": false,
      "is_fragile": false,
      "min_shelf_life_inbound": null,
      "min_shelf_life_outbound": null,
      "min_shelf_life_inbound_percent": null,
      "min_shelf_life_outbound_percent": null,
      "is_high_value": false,
      "material": "3PF-BOX",
      "product_type": "NORMAL",
      "change_history": {},
      "last_update_special_fields": 0,
      "packaging_tape": "3PF-TAPE",
      "tape_image_url": null,
      "min_stock_warning": 0,
      "is_active": true,
      "is_delete": false,
      "created_time": 1746604422,
      "updated_time": 1746604422,
      "user": 190,
      "business": 276,
      "parent": null,
      "product_brand": 242397,
      "product_category": 2477,
      "unit": 1097,
      "status_display": "Unqualified",
      "is_single": true,
      "can_map_product": true,
      "can_publish_product": true,
      "can_cancel": true,
      "can_edit": true,
      "can_inactive": false,
      "can_active": false,
      "status_css": "warning",
      "is_changed_special_fields": false,
      "product_inventory_variant": [],
      "product_map": [
        40137
      ],
      "product_inventory_stock": [],
      "stock_info": {
        "stock": 0,
        "incoming": 0,
        "min_stock": 0,
        "waiting": 0,
        "waiting_shipment": 0,
        "unreal_stock": 0,
        "reserved_stock": 0,
        "available_stock": 0,
        "stock_for_approve": 0,
        "lost": 0,
        "stock_in_process": 0,
        "expired_stock": 0,
        "damaged_stock": 0,
        "waiting_damaged_stock_1": 0,
        "damaged_stock_2": 0,
        "waiting_damaged_stock_2": 0,
        "damaged_stock_3": 0,
        "waiting_damaged_stock_3": 0
      },
      "stock_advanced_info": {}
    },
    {
      "id": 37293,
      "country": "VN",
      "currency": "VND",
      "sku": "HT0979900",
      "name": "Bình nước giữ nhiệt",
      "image_url": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/chatgpt_image_apr_22_2025_02_57_28_pm_1745921583.png",
      "barcode": null,
      "storage_method": "normal",
      "outbound_strategy": "fifo",
      "nhsin": "NHSINV1901924791",
      "reference_product_id": null,
      "reference_variant_id": null,
      "sku_uuid": "SUUIDV1901864885020",
      "tier_index": {},
      "cost": "1000.00",
      "sale_price": "1000.00",
      "shelf_life": null,
      "status": 100,
      "status_update_time": 1745921692,
      "qc_guide": null,
      "packing_note": null,
      "weight": 278,
      "package_length": 16,
      "package_width": 5,
      "package_height": 15,
      "has_variant": false,
      "is_serial_number": false,
      "is_batch_control": false,
      "is_bubble_wrap": false,
      "is_expiration_control": false,
      "is_kraft_paper": false,
      "is_fragile": false,
      "min_shelf_life_inbound": null,
      "min_shelf_life_outbound": null,
      "min_shelf_life_inbound_percent": null,
      "min_shelf_life_outbound_percent": null,
      "is_high_value": false,
      "material": "3PF-BOX",
      "product_type": "NORMAL",
      "change_history": {},
      "last_update_special_fields": 0,
      "packaging_tape": "3PF-TAPE",
      "tape_image_url": null,
      "min_stock_warning": 0,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745921692,
      "updated_time": 1745921692,
      "user": 190,
      "business": 276,
      "parent": null,
      "product_brand": 242397,
      "product_category": 2477,
      "unit": 1097,
      "status_display": "Unqualified",
      "is_single": true,
      "can_map_product": true,
      "can_publish_product": true,
      "can_cancel": true,
      "can_edit": true,
      "can_inactive": false,
      "can_active": false,
      "status_css": "warning",
      "is_changed_special_fields": false,
      "product_inventory_variant": [],
      "product_map": [
        40125
      ],
      "product_inventory_stock": [],
      "stock_info": {
        "stock": 0,
        "incoming": 0,
        "min_stock": 0,
        "waiting": 0,
        "waiting_shipment": 0,
        "unreal_stock": 0,
        "reserved_stock": 0,
        "available_stock": 0,
        "stock_for_approve": 0,
        "lost": 0,
        "stock_in_process": 0,
        "expired_stock": 0,
        "damaged_stock": 0,
        "waiting_damaged_stock_1": 0,
        "damaged_stock_2": 0,
        "waiting_damaged_stock_2": 0,
        "damaged_stock_3": 0,
        "waiting_damaged_stock_3": 0
      },
      "stock_advanced_info": {}
    },
    {
      "id": 37286,
      "country": "VN",
      "currency": "VND",
      "sku": "V1A9-W19L",
      "name": "peppers",
      "image_url": "https://via.placeholder.com/890x855/0dca9f/330d9b.jpg",
      "barcode": null,
      "storage_method": "normal",
      "outbound_strategy": "fifo",
      "nhsin": "NHSINV1902298574",
      "reference_product_id": null,
      "reference_variant_id": null,
      "sku_uuid": "SUUIDV190798259702",
      "tier_index": {},
      "cost": "1670032.65",
      "sale_price": "1670032.65",
      "shelf_life": null,
      "status": 100,
      "status_update_time": 1745899854,
      "qc_guide": null,
      "packing_note": null,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_serial_number": false,
      "is_batch_control": false,
      "is_bubble_wrap": false,
      "is_expiration_control": false,
      "is_kraft_paper": false,
      "is_fragile": false,
      "min_shelf_life_inbound": null,
      "min_shelf_life_outbound": null,
      "min_shelf_life_inbound_percent": null,
      "min_shelf_life_outbound_percent": null,
      "is_high_value": false,
      "material": "3PF-BOX",
      "product_type": "NORMAL",
      "change_history": {},
      "last_update_special_fields": 0,
      "packaging_tape": "3PF-TAPE",
      "tape_image_url": null,
      "min_stock_warning": 0,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745899854,
      "updated_time": 1745899854,
      "user": 190,
      "business": 276,
      "parent": null,
      "product_brand": 242397,
      "product_category": 2477,
      "unit": 1097,
      "status_display": "Unqualified",
      "is_single": true,
      "can_map_product": true,
      "can_publish_product": true,
      "can_cancel": true,
      "can_edit": true,
      "can_inactive": false,
      "can_active": false,
      "status_css": "warning",
      "is_changed_special_fields": false,
      "product_inventory_variant": [],
      "product_map": [
        40123
      ],
      "product_inventory_stock": [],
      "stock_info": {
        "stock": 0,
        "incoming": 0,
        "min_stock": 0,
        "waiting": 0,
        "waiting_shipment": 0,
        "unreal_stock": 0,
        "reserved_stock": 0,
        "available_stock": 0,
        "stock_for_approve": 0,
        "lost": 0,
        "stock_in_process": 0,
        "expired_stock": 0,
        "damaged_stock": 0,
        "waiting_damaged_stock_1": 0,
        "damaged_stock_2": 0,
        "waiting_damaged_stock_2": 0,
        "damaged_stock_3": 0,
        "waiting_damaged_stock_3": 0
      },
      "stock_advanced_info": {}
    },
    {
      "id": 37285,
      "country": "VN",
      "currency": "VND",
      "sku": "8GA7-OU14",
      "name": "swiss chard",
      "image_url": "https://via.placeholder.com/1715x1277/f7db1f/00ad8f.jpg",
      "barcode": null,
      "storage_method": "normal",
      "outbound_strategy": "fifo",
      "nhsin": "NHSINV1904658815",
      "reference_product_id": null,
      "reference_variant_id": null,
      "sku_uuid": "SUUIDV190749988958",
      "tier_index": {},
      "cost": "2303072.95",
      "sale_price": "2303072.95",
      "shelf_life": null,
      "status": 100,
      "status_update_time": 1745899101,
      "qc_guide": null,
      "packing_note": null,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_serial_number": false,
      "is_batch_control": false,
      "is_bubble_wrap": false,
      "is_expiration_control": false,
      "is_kraft_paper": false,
      "is_fragile": false,
      "min_shelf_life_inbound": null,
      "min_shelf_life_outbound": null,
      "min_shelf_life_inbound_percent": null,
      "min_shelf_life_outbound_percent": null,
      "is_high_value": false,
      "material": "3PF-BOX",
      "product_type": "NORMAL",
      "change_history": {},
      "last_update_special_fields": 0,
      "packaging_tape": "3PF-TAPE",
      "tape_image_url": null,
      "min_stock_warning": 0,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745899101,
      "updated_time": 1745899101,
      "user": 190,
      "business": 276,
      "parent": null,
      "product_brand": 242397,
      "product_category": 2477,
      "unit": 1097,
      "status_display": "Unqualified",
      "is_single": true,
      "can_map_product": true,
      "can_publish_product": true,
      "can_cancel": true,
      "can_edit": true,
      "can_inactive": false,
      "can_active": false,
      "status_css": "warning",
      "is_changed_special_fields": false,
      "product_inventory_variant": [],
      "product_map": [
        40122
      ],
      "product_inventory_stock": [],
      "stock_info": {
        "stock": 0,
        "incoming": 0,
        "min_stock": 0,
        "waiting": 0,
        "waiting_shipment": 0,
        "unreal_stock": 0,
        "reserved_stock": 0,
        "available_stock": 0,
        "stock_for_approve": 0,
        "lost": 0,
        "stock_in_process": 0,
        "expired_stock": 0,
        "damaged_stock": 0,
        "waiting_damaged_stock_1": 0,
        "damaged_stock_2": 0,
        "waiting_damaged_stock_2": 0,
        "damaged_stock_3": 0,
        "waiting_damaged_stock_3": 0
      },
      "stock_advanced_info": {}
    },
    {
      "id": 37284,
      "country": "VN",
      "currency": "VND",
      "sku": "P736-Y7M8",
      "name": "lettuce",
      "image_url": "https://qc.nandh.vn/storage/no_image/no_image.jpg",
      "barcode": null,
      "storage_method": "normal",
      "outbound_strategy": "fifo",
      "nhsin": "NHSINV1906692562",
      "reference_product_id": null,
      "reference_variant_id": null,
      "sku_uuid": "SUUIDV1901756225951",
      "tier_index": {},
      "cost": "5163434.05",
      "sale_price": "5163434.05",
      "shelf_life": null,
      "status": 100,
      "status_update_time": 1745896990,
      "qc_guide": null,
      "packing_note": null,
      "weight": 100,
      "package_length": 10,
      "package_width": 15,
      "package_height": 11,
      "has_variant": false,
      "is_serial_number": false,
      "is_batch_control": false,
      "is_bubble_wrap": false,
      "is_expiration_control": false,
      "is_kraft_paper": false,
      "is_fragile": false,
      "min_shelf_life_inbound": null,
      "min_shelf_life_outbound": null,
      "min_shelf_life_inbound_percent": null,
      "min_shelf_life_outbound_percent": null,
      "is_high_value": false,
      "material": "3PF-BOX",
      "product_type": "NORMAL",
      "change_history": {},
      "last_update_special_fields": 0,
      "packaging_tape": "3PF-TAPE",
      "tape_image_url": null,
      "min_stock_warning": 0,
      "is_active": true,
      "is_delete": false,
      "created_time": 1745896990,
      "updated_time": 1745896990,
      "user": 190,
      "business": 276,
      "parent": null,
      "product_brand": 44003,
      "product_category": 2477,
      "unit": 1097,
      "status_display": "Unqualified",
      "is_single": true,
      "can_map_product": true,
      "can_publish_product": true,
      "can_cancel": true,
      "can_edit": true,
      "can_inactive": false,
      "can_active": false,
      "status_css": "warning",
      "is_changed_special_fields": false,
      "product_inventory_variant": [],
      "product_map": [
        40121
      ],
      "product_inventory_stock": [],
      "stock_info": {
        "stock": 0,
        "incoming": 0,
        "min_stock": 0,
        "waiting": 0,
        "waiting_shipment": 0,
        "unreal_stock": 0,
        "reserved_stock": 0,
        "available_stock": 0,
        "stock_for_approve": 0,
        "lost": 0,
        "stock_in_process": 0,
        "expired_stock": 0,
        "damaged_stock": 0,
        "waiting_damaged_stock_1": 0,
        "damaged_stock_2": 0,
        "waiting_damaged_stock_2": 0,
        "damaged_stock_3": 0,
        "waiting_damaged_stock_3": 0
      },
      "stock_advanced_info": {}
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 486
}

Request

Query Params
page
integer 
required
Example:
1
page_size
integer 
required
<= 50
Example:
5
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
array [object {58}] 
optional
id
integer 
optional
country
string 
optional
currency
string 
optional
sku
string 
optional
name
string 
optional
image_url
string 
optional
barcode
string 
optional
storage_method
string 
optional
outbound_strategy
string 
optional
nhsin
string 
optional
reference_product_id
string 
optional
reference_variant_id
string 
optional
sku_uuid
string 
optional
tier_index
object 
optional
cost
string 
optional
sale_price
string 
optional
status
integer 
optional
status_update_time
integer 
optional
qc_guide
string 
optional
packing_note
string 
optional
weight
integer 
optional
package_length
integer 
optional
package_width
integer 
optional
package_height
integer 
optional
has_variant
boolean 
optional
is_serial_number
boolean 
optional
is_batch_control
boolean 
optional
is_bubble_wrap
boolean 
optional
is_expiration_control
boolean 
optional
is_kraft_paper
boolean 
optional
is_fragile
boolean 
optional
min_shelf_life_inbound
integer 
optional
min_shelf_life_outbound
integer 
optional
material
string 
optional
product_type
string 
optional
is_active
boolean 
optional
is_delete
boolean 
optional
created_time
integer 
optional
updated_time
integer 
optional
user
integer 
optional
business
integer 
optional
parent
string 
optional
product_brand
integer 
optional
product_category
integer 
optional
unit
integer 
optional
status_display
string 
optional
is_single
boolean 
optional
can_map_product
boolean 
optional
can_publish_product
boolean 
optional
can_cancel
boolean 
optional
can_edit
boolean 
optional
can_inactive
boolean 
optional
can_active
boolean 
optional
status_css
string 
optional
product_inventory_variant
array[integer]
optional
product_map
array[integer]
optional
product_inventory_stock
array[integer]
optional
stock_info
object 
optional
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
Previous
List Storage Method
Next
Product inventory detail
Built with