Product
Get Products
GET
https://open-api.zortout.com/v4/Product/GetProducts
Get list of products.
Query Parameters
Name | Type | Description |
---|---|---|
warehousecode | String | Warehouse Code |
createdafter | String | Created Date After ….. |
createdbefore | String | Created Date Before ….. |
updatedafter | String | Updated Date After ….. |
updatedbefore | String | Updated Date Before ….. |
keyword | String | Keyword to search at least 3 characters |
searchsku | String | Keyword of SKU to search |
variationid | Int | Variation ID |
categoryid | Int | Category ID |
activestatus | Int | Active status (Default = All) 1 = Active only |
page | Int | Page (Default = 1) |
limit | Int | Limit per page (Max = 500) |
Headers
Name | Type | Description |
---|---|---|
apisecret* | String | API Secret |
storename* | String | Store Name |
apikey* | String | API Key |
skulist | String | Sku List Ex. P0001,P0002 |
productidlist | String | Product ID List Ex. 1234,5678 |
Parameter | Type | Description/Example |
---|---|---|
res | String | Response Code 200- Success |
list | Product (Array) | Product List (Array) |
count | Int | Total product number by filter |
Product (Array) | Type | Description/Example |
---|---|---|
id | Int | Product ID |
name | String | Product Name |
description | String | Description |
sku | String | Product Sku |
sellprice | String | Sell price |
purchaseprice | String | Purchase price |
sell_vat_status | Int | Sell vat status 0 - Undefined 1 - No Vat 2- Have Vat 3 - Vat 0% |
purchase_vat_status | Int | Purchase vat status 0 - Undefined 1 - No Vat 2- Have Vat |
barcode | String | Barcode |
stock | String | Stock |
availablestock | String | Available Stock |
unittext | String | Unit |
imagepath | String | Image Url |
weight | String | Weight (Gram) |
width | String | Width (CM) |
length | String | Length (CM) |
height | String | Height (CM) |
categoryid | Int | Category ID |
category | String | Category Name |
producttype | Int | Product Type 0 - Product (Default) 1 - Service |
variationid | Int | Variation ID |
variant | Variant (Array) | Variant List (Array) |
tag | String (Array) | Tag List (Array) |
active | Boolean | Active status |
imageList | String (Array) | Image Url List |
sharelink | String | Share Link Url |
properties | Property (Array) | Custom Properties List |
Variant (Array) | Type | Description/Example |
---|---|---|
variantid | Int | Variant ID |
variantname | String | Variant Name |
name | String | Attribute Name |
Property (Array) | Type | Description/Example |
---|---|---|
id | Int | Property ID |
name | String | Property Name |
value | String | Property Value |
Get Product Detail
GET
https://open-api.zortout.com/v4/Product/GetProductDetail
Get product detail.
Query Parameters
Name | Type | Description |
---|---|---|
id* | Int | Product ID |
warehousecode | String | Warehouse Code |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
id | Int | Product ID |
name | String | Product Name |
description | String | Description |
sku | String | Product Sku |
sellprice | String | Sell price |
purchaseprice | String | Purchase price |
sell_vat_status | Int | Sell vat status 0 - Undefined 1 - No Vat 2- Have Vat 3 - Vat 0% |
purchase_vat_status | Int | Purchase vat status 0 - Undefined 1 - No Vat 2- Have Vat |
barcode | String | Barcode |
stock | String | Stock |
availablestock | String | Available Stock |
unittext | String | Unit |
imagepath | String | Image Url |
weight | String | Weight (Gram) |
width | String | Width (CM) |
length | String | Length (CM) |
height | String | Height (CM) |
categoryid | Int | Category ID |
category | String | Category Name |
producttype | Int | Product Type 0 - Product (Default) 1 - Service |
variationid | Int | Variation ID |
variant | Variant (Array) | Variant List (Array) |
tag | String (Array) | Tag List (Array) |
active | Boolean | Active status |
imageList | String (Array) | Image Url List |
sharelink | String | Share Link Url |
properties | Property (Array) | Custom Properties List |
Variant (Array) | Type | Description/Example |
---|---|---|
variantid | Int | Variant ID |
variantname | String | Variant Name |
name | String | Attribute Name |
Property (Array) | Type | Description/Example |
---|---|---|
id | Int | Property ID |
name | String | Property Name |
value | String | Property Value |
Get Variations
GET
https://open-api.zortout.com/v4/Product/GetVariations
Get list of variation products.
Query Parameters
Name | Type | Description |
---|---|---|
page | Int | Page (Default = 1) |
limit | Int | Limit per page (Max = 500) |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
res | Response | Response Code 200- Success |
list | Variation (Array) | Variation List (Array) |
count | Int | Total variation number |
Variation (Array) | Type | Description/Example |
---|---|---|
id | Int | Variation ID |
sku | String | Variation Sku |
name | String | Variation Name |
variants | Variant (Array) | Variant List (Array) |
Variant (Array) | Type | Description/Example |
---|---|---|
variantid | Int | Variant ID |
variantname | String | Variant Name |
Get Categories
GET
https://open-api.zortout.com/v4/Product/GetCategorys
Get list of product categories.
Query Parameters
Name | Type | Description |
---|---|---|
page | Int | Page (Default = 1) |
limit | Int | Limit per page (Max = 500) |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
res | Response | Response Code 200- Success |
list | Category (Array) | Category List (Array) |
count | Int | Total category number by filter |
Parameter | Type | Description/Example |
---|---|---|
id | Int | Category ID |
name | String | Category Name |
Add Product
POST
https://open-api.zortout.com/v4/Product/AddProduct
Add product.
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Product Name |
description | String | Description |
sku* | String | Product Sku |
sellprice | String | Sell price |
purchaseprice | String | Purchase price |
sell_vat_status | Int | Sell vat status 0 - Undefined 1 - No Vat 2- Have Vat 3 - Vat 0% Remark: Only Merchant With Addon "Advance Vat". |
purchase_vat_status | Int | Purchase vat status 0 - Undefined 1 - No Vat 2- Have Vat Remark: Only Merchant With Addon "Advance Vat". |
barcode | String | Barcode |
stock | String | Stock |
unittext | String | Unit |
weight | String | Weight (Gram) |
width | String | Width (CM) |
length | String | Length (CM) |
height | String | Height (CM) |
tag | String(Array) | Tag List (Array) |
category | String | Category Name |
producttype | Int | Product Type 0 - Product (Default) 1 - Service |
properties | Property (Array) | Custom Properties List |
∟ name | String | Property Name Require if id = 0 or null *Must have either id or name |
∟ id | Int | Property ID *Must have either id or name |
∟ value | String | Property Value |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
detail | Detail | Detail |
Detail | Type | Description/Example |
---|---|---|
id | Int | Product ID |
Update Product
POST
https://open-api.zortout.com/v4/Product/UpdateProduct
Edit product info.
Query Parameters
Name | Type | Description |
---|---|---|
id* | Int | Product ID |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
name | String | Product Name |
description | String | Description |
tag | String(Array) | Tag List (Array) |
height | String | Height (CM) |
length | String | Length (CM) |
width | String | Weight (CM) |
weight | String | Weight (Gram) |
unittext | String | Unit |
barcode | String | Barcode |
sellprice | String | Sell price |
purchaseprice | String | Purchase price |
sell_vat_status | Int | Sell vat status 0 - Undefined 1 - No Vat 2- Have Vat 3 - Vat 0% Remark: Only Merchant With Addon "Advance Vat". |
purchase_vat_status | Int | Purchase vat status 0 - Undefined 1 - No Vat 2- Have Vat Remark: Only Merchant With Addon "Advance Vat". |
category | String | Category Name |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Update Product Image
POST
https://open-api.zortout.com/v4/Product/UpdateProductImage
Edit product image.
Query Parameters
Name | Type | Description |
---|---|---|
id* | Int | Product ID |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apisecret* | String | API Secret |
apikey* | String | API Key |
Request Body
Name | Type | Description |
---|---|---|
file* | File | File Binary Data |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Update Product Stock List
POST
https://open-api.zortout.com/v4/Product/UpdateProductStockList
Adjust current inventory of product.
Query Parameters
Name | Type | Description |
---|---|---|
warehousecode* | String | Warehouse Code |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
stocks* | Stock (Array) | Stock List (Array) |
∟ productid | Int | Product ID *Must have either productid or sku |
∟ stock* | Double | Stock |
∟ cost | Double | Cost Per Unit |
∟ sku | String | Product Sku Require if productid = 0 or null *Must have either productid or sku |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
detail | Detail | Detail |
Detail | Type | Description/Example |
---|---|---|
stockupdate | StockUpdate | Stock Updating Result |
StockUpdate | Type | Description/Example |
---|---|---|
success | Int | Total success number |
fail | Int | Total failure number |
notupdate | Int | Total not updating number |
successlist | Stock (Array) | Stock List (Array) |
faillist | Stock (Array) | Stock List (Array) |
notupdatelist | Stock (Array) | Stock List (Array) |
Stock | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
stock | Double | Stock |
Increase Product Stock List
POST
https://open-api.zortout.com/v4/Product/IncreaseProductStockList
Increase inventory of product.
Query Parameters
Name | Type | Description |
---|---|---|
warehousecode* | String | Warehouse Code |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
stocks* | Stock (Array) | Stock List (Array) |
∟ productid | Int | Product ID *Must have either productid or sku |
∟ sku | String | Product Sku Require if productid = 0 or null *Must have either productid or sku |
∟ stock* | Double | Stock to increase |
∟ cost | Double | Cost Per Unit |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
detail | Detail | Detail |
Detail | Type | Description/Example |
---|---|---|
stockupdate | StockUpdate | Stock Updating Result |
StockUpdate | Type | Description/Example |
---|---|---|
success | Int | Total success number |
fail | Int | Total failure number |
notupdate | Int | Total not updating number |
successlist | Stock (Array) | Stock List (Array) |
faillist | Stock (Array) | Stock List (Array) |
notupdatelist | Stock (Array) | Stock List (Array) |
Stock | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
stock | Double | Stock |
Decrease Product Stock List
POST
https://open-api.zortout.com/v4/Product/DecreaseProductStockList
Decrease inventory of product.
Query Parameters
Name | Type | Description |
---|---|---|
warehousecode* | String | Warehouse Code |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
stocks* | Stock (Array) | Stock List (Array) |
∟ productid | Int | Product ID *Must have either productid or sku |
∟ sku | String | Product Sku Require if productid = 0 or null *Must have either productid or sku |
∟ stock* | Double | Stock to decrease |
∟ cost | Double | Cost Per Unit |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
detail | Detail | Detail |
Detail | Type | Description/Example |
---|---|---|
stockupdate | StockUpdate | Stock Updating Result |
StockUpdate | Type | Description/Example |
---|---|---|
success | Int | Total success number |
fail | Int | Total failure number |
notupdate | Int | Total not updating number |
successlist | Stock (Array) | Stock List (Array) |
faillist | Stock (Array) | Stock List (Array) |
notupdatelist | Stock (Array) | Stock List (Array) |
Stock | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
stock | Double | Stock |
Update Product Available Stock List
POST
https://open-api.zortout.com/v4/Product/UpdateProductAvailableStockList
Adjust available/sellable inventory of product.
Query Parameters
Name | Type | Description |
---|---|---|
warehousecode* | String | Warehouse Code |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
stocks* | Stock (Array) | Stock List (Array) |
∟ productid | Int | Product ID *Must have either productid or sku |
∟ stock* | Double | Available Stock |
∟ cost | Double | Cost Per Unit |
∟ sku | String | Product Sku Require if productid = 0 or null *Must have either productid or sku |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
detail | Detail | Detail |
Detail | Type | Description/Example |
---|---|---|
stockupdate | StockUpdate | Stock Updating Result |
StockUpdate | Type | Description/Example |
---|---|---|
success | Int | Total success number |
fail | Int | Total failure number |
notupdate | Int | Total not updating number |
successlist | Stock (Array) | Stock List (Array) |
faillist | Stock (Array) | Stock List (Array) |
notupdatelist | Stock (Array) | Stock List (Array) |
Stock | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
stock | Double | Stock |
Delete Product
POST
https://open-api.zortout.com/v4/Product/DeleteProduct
Delete product.
Query Parameters
Name | Type | Description |
---|---|---|
id* | Int | Product ID |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Last updated