API Docs
List product inventory
DevelopingGET/api/v1/public/products/inventory/listLast modified: 4 months ago
Request
Query Params
page
string
optional
Example:
1
page_size
string
optional
max 100
Example:
5
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
status_code
integer
required
data
array [object {58}]
required
id
integer
required
country
string
required
currency
string
required
sku
string
required
name
string
required
image_url
string
required
barcode
string | null
required
storage_method
string
required
outbound_strategy
string
required
nhsin
string
required
reference_product_id
string | null
required
reference_variant_id
null
required
sku_uuid
string
required
tier_index
object
required
cost
string
required
sale_price
string
required
status
integer
required
status_update_time
integer
required
qc_guide
null
required
packing_note
string | null
required
weight
integer
required
package_length
integer
required
package_width
integer
required
package_height
integer
required
has_variant
boolean
required
is_serial_number
boolean
required
is_batch_control
boolean
required
is_bubble_wrap
boolean
required
is_expiration_control
boolean
required
is_kraft_paper
boolean
required
is_fragile
boolean
required
min_shelf_life_inbound
integer | null
required
min_shelf_life_outbound
integer | null
required
material
string
required
product_type
string
required
is_active
boolean
required
is_delete
boolean
required
created_time
integer
required
updated_time
integer
required
user
integer
required
business
integer
required
parent
null
required
product_brand
integer | null
required
product_category
integer | null
required
unit
integer
required
status_display
string
required
is_single
boolean
required
can_map_product
boolean
required
can_publish_product
boolean
required
can_cancel
boolean
required
can_edit
boolean
required
can_inactive
boolean
required
can_active
boolean
required
status_css
string
required
product_inventory_variant
array[integer]
required
product_map
array[integer]
required
product_inventory_stock
array[integer]
required
stock_info
object
required
error
boolean
required
error_code
null
required
log_id
null
required
messages
string
required
total
integer
required
Example
{
"status_code": 0,
"data": [
{
"id": 0,
"country": "string",
"currency": "string",
"sku": "string",
"name": "string",
"image_url": "string",
"barcode": "string",
"storage_method": "string",
"outbound_strategy": "string",
"nhsin": "string",
"reference_product_id": "string",
"reference_variant_id": null,
"sku_uuid": "string",
"tier_index": {},
"cost": "string",
"sale_price": "string",
"status": 0,
"status_update_time": 0,
"qc_guide": null,
"packing_note": "string",
"weight": 0,
"package_length": 0,
"package_width": 0,
"package_height": 0,
"has_variant": true,
"is_serial_number": true,
"is_batch_control": true,
"is_bubble_wrap": true,
"is_expiration_control": true,
"is_kraft_paper": true,
"is_fragile": true,
"min_shelf_life_inbound": 0,
"min_shelf_life_outbound": 0,
"material": "string",
"product_type": "string",
"is_active": true,
"is_delete": true,
"created_time": 0,
"updated_time": 0,
"user": 0,
"business": 0,
"parent": null,
"product_brand": 0,
"product_category": 0,
"unit": 0,
"status_display": "string",
"is_single": true,
"can_map_product": true,
"can_publish_product": true,
"can_cancel": true,
"can_edit": true,
"can_inactive": true,
"can_active": true,
"status_css": "string",
"product_inventory_variant": [
0
],
"product_map": [
0
],
"product_inventory_stock": [
0
],
"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,
"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
}
}
],
"error": true,
"error_code": null,
"log_id": null,
"messages": "string",
"total": 0
}Last modified: 4 months ago