Products List

All product information can be searched by various specified values ​​in detail to get the fastest information

API Endpoint

URL	{base url}/api/Product/ProductsList
Method	POST
Authorization	Bearer Token
Content-Type	application/json

Request Headers

Parameter	Type	Required	Description
APIKEY	string	true	System key code

Request Parameters

Parameter	Type	Required	Description
Limit	integer	true	Number of records to retrieve
LoadIndex	integer	true	The starting index for the data to retrieve
Active	boolean	false	Status of the records (True = active, False = inactive)
Sortby	string	false	Field to sort by (e.g., createdate)
SortType	string	false	Sorting direction (asc = ascending, desc = descending)
ProductSaleId	string	false	filter by product sale id
ProductCode	string	false	filter by product code
ProductName	string	false	filter by product name
Sku	string	false	filter by product sku
Barcode	string	false	filter by product barcode

Request JSON Example

{
  "Limit": 10,
  "LoadIndex": 1,
  "Active": true,
  "Sortby": "",
  "SortType": "desc",
  "ProductSaleId": "1C90C0E7-78BF-431B-8335-96FBB117C4C9",
  "ProductCode": "TEST_02",
  "ProductName": "TEST_02",
  "Sku": "",
  "Barcode": ""
}
    

Response Parameters

Parameter	Type	Description
Id	integer	Error status (0 = no error)
Success	boolean	Status of the request
Message	string	Response message
RequestId	string	Reference ID for the request
Size	integer	Number of records returned
Data	object	Products data

Data

Parameter	Type	Description
No	integer	Order
PdsaleId	string	Product sale ID
SellerId	string	Seller ID
PdsCode	string	Product code
PdsName	string	Product name
CfCode	string	Sale code
PdGroupId	string	Product group ID
IsPdSet	boolean	Indicates whether the product is a set
Brand	string	Brand
Manufacturer	string	Manufacturer
Remark	string	Remark
Tag	string	Tag
CreateDate	string	Creation date
UpdateDate	string	Update date
ProductSkus	object	Product unit details

ProductSkus

Parameter	Type	Description
Seq	integer	Sequence
Kind	string	Packaging type
Sku	string	SKU code
CategoryA	string	Category A name
SubcategoryA	string	Category A details
CategoryB	string	Category B name
SubcategoryB	string	Category B details
Barcode	string	Barcode
SellingPrice	decimal	Selling price
SkuWidth	string	Width
SkuLong	string	Length
SkuHigh	string	Height
SkuWeight	string	Weight
AmtStock	integer	Stock quantity
AmtOos	string	Out-of-stock indicator
AmtBuffer	string	Buffer stock quantity
Tag	string	Tag
PackSize	integer	Pack size
UnitId	string	Unit ID

Response JSON Example

{
    "Id": 0,
    "Success": true,
    "Message": "SUCCESS",
    "RequestId": "FE8005D0-701F-41E9-932F-4A36BBB34FCB",
    "Size": 1,
    "Data": [
        {
            "No": 1,
            "PdsaleId": "1C90C0E7-78BF-431B-8335-96FBB117C4C9",
            "SellerId": "0BB930BC-B87F-40DD-8405-1645B9A87E2C",
            "PdsCode": "TEST_02",
            "PdsName": "TEST_02",
            "CfCode": null,
            "PdGroupId": null,
            "IsPdSet": false,
            "Brand": null,
            "Manufacturer": null,
            "Remark": null,
            "Tag": null,
            "CreateDate": "2024-10-30T08:55:06.2519057",
            "UpdateDate": null,
            "ProductSkus": [
                {
                    "Seq": 1,
                    "Kind": null,
                    "Sku": "TEST_021",
                    "CategoryA": null,
                    "SubcategoryA": "TEST_021",
                    "CategoryB": null,
                    "SubcategoryB": null,
                    "Barcode": "TEST_021",
                    "SellingPrice": 0.0,
                    "SkuWidth": null,
                    "SkuLong": null,
                    "SkuHigh": null,
                    "SkuWeight": null,
                    "AmtStock": 0,
                    "AmtOos": null,
                    "AmtBuffer": null,
                    "Tag": null,
                    "PackSize": 0,
                    "UnitId": null
                },
                {
                    "Seq": 2,
                    "Kind": null,
                    "Sku": "TEST_022",
                    "CategoryA": null,
                    "SubcategoryA": "TEST_022",
                    "CategoryB": null,
                    "SubcategoryB": null,
                    "Barcode": "TEST_022",
                    "SellingPrice": 0.0,
                    "SkuWidth": null,
                    "SkuLong": null,
                    "SkuHigh": null,
                    "SkuWeight": null,
                    "AmtStock": 0,
                    "AmtOos": null,
                    "AmtBuffer": null,
                    "Tag": null,
                    "PackSize": 0,
                    "UnitId": null
                }
            ]
        }
    ]
}