GET 3dCartWebAPI/v1/Products/{catalogid}/skuinfo
Get all products (SKUInfo section only)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| catalogid |
Catalog ID |
integer |
Default value is 0 |
| limit |
Maximum number of items that can be returned |
integer |
Default value is 10 |
| offset |
Starting point for the return data |
integer |
Default value is 1 |
| countonly |
Count the number of rows only |
integer |
Default value is 0 |
| sku |
SKU Code of the product |
string |
Default value is |
| name |
Name of the product |
string |
Default value is |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of ProductSKU| Name | Description | Type | Additional information |
|---|---|---|---|
| CatalogID |
Primary key. Auto-incremented. database reference = products.catalogid |
integer |
None. |
| SKU |
database reference = products.id |
string |
String length: inclusive between 0 and 255 |
| Name |
database reference = products.name |
string |
String length: inclusive between 0 and 255 |
| Cost |
database reference = products.cost |
decimal number |
None. |
| Price |
database reference = products.price |
decimal number |
None. |
| Currency |
Dynamically generated field. No database reference. |
string |
None. |
| RetailPrice |
database reference = products.price2 |
decimal number |
None. |
| SalePrice |
database reference = products.saleprice |
decimal number |
None. |
| OnSale |
database reference = products.onsale |
boolean |
None. |
| Stock |
database reference = products.stock |
decimal number |
None. |
Response Formats
application/json, text/json
[
{
"CatalogID": 1,
"SKU": "sample string 1",
"Name": "sample string 2",
"Cost": 1.1,
"Price": 1.1,
"Currency": "sample string 3",
"RetailPrice": 1.1,
"SalePrice": 1.1,
"OnSale": true,
"Stock": 1.1
},
{
"CatalogID": 1,
"SKU": "sample string 1",
"Name": "sample string 2",
"Cost": 1.1,
"Price": 1.1,
"Currency": "sample string 3",
"RetailPrice": 1.1,
"SalePrice": 1.1,
"OnSale": true,
"Stock": 1.1
}
]
application/xml, text/xml
<ArrayOfProductSKU xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ProductSKU>
<CatalogID>1</CatalogID>
<SKU>sample string 1</SKU>
<Name>sample string 2</Name>
<Cost>1.1</Cost>
<Price>1.1</Price>
<Currency>sample string 3</Currency>
<RetailPrice>1.1</RetailPrice>
<SalePrice>1.1</SalePrice>
<OnSale>true</OnSale>
<Stock>1.1</Stock>
</ProductSKU>
<ProductSKU>
<CatalogID>1</CatalogID>
<SKU>sample string 1</SKU>
<Name>sample string 2</Name>
<Cost>1.1</Cost>
<Price>1.1</Price>
<Currency>sample string 3</Currency>
<RetailPrice>1.1</RetailPrice>
<SalePrice>1.1</SalePrice>
<OnSale>true</OnSale>
<Stock>1.1</Stock>
</ProductSKU>
</ArrayOfProductSKU>