Product

Get Products

GET https://api.zortout.com/api.aspx

Get list of products.

Query Parameters

Name	Type	Description
method*	String	“GETPRODUCTS”
format	String	json (Default), xml
version*	String	3
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 = 2000)

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

200: OK Success

Response

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
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
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
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://api.zortout.com/api.aspx

Get product detail.

Query Parameters

Name	Type	Description
method*	String	“GETPRODUCTDETAIL”
format	String	json (Default), xml
version*	String	3
id*	Int	Product ID
warehousecode	String	Warehouse Code

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

200: OK Success

Response

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
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
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
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 Bundles

GET https://api.zortout.com/api.aspx

Get list of bundle products.

Query Parameters

Name	Type	Description
method*	String	“GETBUNDLES”
format	String	json (Default), xml
version*	String	3
warehousecode	String	Warehouse Code
keyword	String	Keyword to search at least 3 characters
activestatus	Int	Active status (Default = All) 1 = Active only
page	Int	Page (Default = 1)
limit	Int	Limit per page (Max = 2000)

Headers

Name	Type	Description
apisecret*	String	API Secret
storename*	String	Store Name
apikey*	String	API Key
bundleidlist	String	Bundle ID List Ex. 1234,5678

200: OK Success

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	Bundle (Array)	Bundle List (Array)
count	Int	Total bundle number by filter

Bundle (Array)	Type	Description/Example
id	Int	Bundle ID
name	String	Bundle Name
sku	String	Bundle Sku
sellprice	String	Sell price
stock	String	Stock
availablestock	String	Available Stock
imagepath	String	Image Url
active	Boolean	Active status

Get Bundle Detail

GET https://api.zortout.com/api.aspx

Get list of products in bundle.

Query Parameters

Name	Type	Description
method*	String	“GETBUNDLEDETAIL”
format	String	json (Default), xml
version*	String	3
id*	Int	Bundle ID
warehousecode	String	Warehouse Code

Headers

Name	Type	Description
apisecret*	String	API Secret
storename*	String	Store Name
apikey*	String	API Key

200: OK Success

Response

Parameter	Type	Description/Example
id	Int	Bundle ID
name	String	Bundle Name
sku	String	Bundle Sku
sellprice	String	Sell price
stock	String	Stock
availablestock	String	Available Stock
imagepath	String	Image Url
active	Boolean	Active status
list	ProductBundle (Array)	Product List
imageList	String (Array)	Image Url List

ProductBundle (Array)	Type	Description/Example
id	Int	Product ID
name	String	Product Name
sku	String	Product Sku
quantity	Double	Product Quantity

Get Variations

GET https://api.zortout.com/api.aspx

Get list of variation products.

Query Parameters

Name	Type	Description
method*	String	“GETVARIATIONS”
format	String	json (Default), xml
version*	String	3
page	Int	Page (Default = 1)
limit	Int	Limit per page (Max = 2000)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

200: OK Success

Response

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

Add Product

POST https://api.zortout.com/api.aspx

Add product.

Query Parameters

Name	Type	Description
method*	String	“ADDPRODUCT”
format	String	json (Default), xml
version*	String	3

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
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
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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. URL

URL : https://api.zortout.com/api.aspx?method=ADDPRODUCT&version=3

Ex. Request JSON

{
  "sku": "P0001",
  "name": "Product1",
  "sellprice": "20.00",
  "purchaseprice": "10.00",
  "unittext": "Piece",
  "weight": "500",
  "barcode": "1234",
  "category": "test category"
}

Update Product

POST https://api.zortout.com/api.aspx

Edit product info.

Query Parameters

Name	Type	Description
method*	String	“UPDATEPRODUCT”
format	String	json (Default), xml
version*	String	3

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
purchaseprice	String	Purchase price
sellprice	String	Sell price
sku*	String	Product Sku
category	String	Category Name

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Update Product Image

POST https://api.zortout.com/api.aspx

Edit product image.

Query Parameters

Name	Type	Description
method*	String	“UPDATEPRODUCTIMAGE”
format	String	json (Default), xml
version*	String	3
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

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Update Product Stock List

POST https://api.zortout.com/api.aspx

Adjust current inventory of product.

Query Parameters

Name	Type	Description
method*	String	“UPDATEPRODUCTSTOCKLIST”
format	String	json (Default), xml
version*	String	3
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

200: OK Success

Response

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

Ex. URL

URL : https://api.zortout.com/api.aspx?method=UPDATEPRODUCTSTOCKLIST&version=3&warehousecode=W0001

Ex. Request JSON

{
  "stocks": [
    {
      "sku": "P0001",
      "stock": 10,
      "cost": 100
    }
  ]
}

Increase Product Stock List

POST https://api.zortout.com/api.aspx

Increase inventory of product.

Query Parameters

Name	Type	Description
method*	String	”INCREASEPRODUCTSTOCKLIST”
format	String	json (Default), xml
version*	String	3
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

200: OK Success

Response

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

Ex. URL

URL : https://api.zortout.com/api.aspx?method=INCREASEPRODUCTSTOCKLIST&version=3&warehousecode=W0001

Ex. Request JSON

{
  "stocks": [
    {
      "sku": "P0001",
      "stock": 10,
      "cost": 100
    }
  ]
}

Decrease Product Stock List

POST https://api.zortout.com/api.aspx

Decrease inventory of product.

Query Parameters

Name	Type	Description
method*	String	“DECREASEPRODUCTSTOCKLIST”
format	String	json (Default), xml
version*	String	3
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

200: OK Success

Response

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

Ex. URL

URL : https://api.zortout.com/api.aspx?method=DECREASEPRODUCTSTOCKLIST&version=3&warehousecode=W0001

Ex. Request JSON

{
  "stocks": [
    {
      "sku": "P0001",
      "stock": 10,
      "cost": 100
    }
  ]
}

Update Product Available Stock List

POST https://api.zortout.com/api.aspx

Adjust available/sellable inventory of product.

Query Parameters

Name	Type	Description
method*	String	“UPDATEPRODUCTAVAILABLESTOCKLIST”
format	String	json (Default), xml
version*	String	3
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

200: OK Success

Response

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

Ex. URL

URL : https://api.zortout.com/api.aspx?method=UPDATEPRODUCTAVAILABLESTOCKLIST&version=3&warehousecode=W0001

Ex. Request JSON

{
  "stocks": [
    {
      "sku": "P0001",
      "stock": 10,
      "cost": 100
    }
  ]
}

Delete Product

POST https://api.zortout.com/api.aspx

Delete product.

Query Parameters

Name	Type	Description
method	String	“DELETEPRODUCT”
format	String	json (Default), xml
version	String	3

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
sku*	String	Product SKU

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. URL

URL : https://api.zortout.com/api.aspx?method=DELETEPRODUCT&version=3

Ex. Request JSON

{
  "sku": "P0001"
}

Add Bundle

POST https://api.zortout.com/api.aspx

Add bundle.

Query Parameters

Name	Type	Description
method*	String	“ADDBUNDLE”
format	String	json (Default), xml
version*	String	3

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
name*	String	Bundle Name
sku*	String	Bundle Sku
sellprice*	String	Sell price
list*	ProductBundle (Array)	Product List
∟ id	Int	Product ID *Must have either id or sku
∟ sku	String	Product Sku Require if id = 0 or null *Must have either id or sku
∟ quantity*	Double	Product Quantity

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. URL

URL : https://api.zortout.com/api.aspx?method=ADDBUNDLE&version=3

Ex. Request JSON

{
    "sku": "SET0001",
    "name": "Bundle 001",
    "sellprice": 100,
    "list":    
    [
        {
            "sku": "P0001",
            "quantity": 2
        },
        {
            "id": 1234,
            "quantity": 3
        }
    ]
}