| GET | /eCommerce/Products |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientId | query | int? | No | |
| BranchId | query | int? | No | |
| HPcatId | query | string | No | |
| SearchText | query | string | No | |
| Lang | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| BCode | form | string | No | |
| bbcode | form | string | No | |
| Incode | form | string | No | |
| category_id | form | string | No | |
| category_code | form | string | No | |
| category_nu | form | string | No | |
| producer_id | form | string | No | |
| producer_nu | form | string | No | |
| prcountry_nu | form | string | No | |
| Name | form | string | No | |
| products_ne | form | string | No | |
| vattype | form | int | No | |
| packcount | form | short | No | |
| packbcount | form | decimal? | No | |
| Unit | form | string | No | |
| mdtrade | form | decimal | No | |
| mdretail | form | decimal | No | |
| imported | form | bool? | No | |
| Netto | form | decimal | No | |
| vat | form | decimal | No | |
| Price | form | decimal | No | |
| InStock | form | bool? | No | |
| Points | form | decimal | No | |
| HCategoryId | form | int? | No | |
| BrandId | form | int? | No | |
| Promo | form | bool | No | |
| Discount | form | decimal? | No | |
| ImgLink | form | string | No | |
| rcount | form | decimal? | No | |
| DiscountedPrice | form | decimal? | No | |
| IsNew | form | bool? | No | |
| ByWeight | form | byte? | No | |
| AnnotationHtml | form | string | No | |
| NeedPrepare | form | int? | No | |
| QuantityStep | form | decimal? | No | |
| sale_price | form | decimal | No | |
| PPCatId | form | string | No | |
| QualityId | form | string | No | |
| Quality | form | string | No | |
| HCategoryName | form | string | No | |
| HCategoryHcode | form | string | No | |
| BrandName | form | string | No | |
| BrandAbbreviation | form | string | No | |
| BrandImageLink | form | string | No | |
| AnnotationHtmlEn | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| BCode | form | string | No | |
| Name | form | string | No | |
| Price | form | decimal | No | |
| Points | form | decimal? | No | |
| InStock | form | bool | No | |
| Promo | form | bool | No | |
| Discount | form | decimal? | No | |
| ImgLink | form | string | No | |
| DiscountedPrice | form | decimal? | No | |
| IsNew | form | bool? | No | |
| Netto | form | decimal | No | |
| Unit | form | string | No | |
| AnnotationHtml | form | string | No | |
| NeedPrepare | form | int? | No | |
| QuantityStep | form | decimal? | No | |
| ByWeight | form | byte? | No | |
| Slug | form | string | No | |
| PPCatId | form | string | No | |
| mdtrade | form | decimal | No | |
| mdretail | form | decimal | No | |
| rcount | form | decimal | No | |
| QualityId | form | int? | No | |
| Quality | form | string | No | |
| HCategoryId | form | int? | No | |
| Incode | form | string | No | |
| HCategoryName | form | string | No | |
| HCategoryHcode | form | string | No | |
| BrandId | form | int? | No | |
| BrandName | form | string | No | |
| BrandAbbreviation | form | string | No | |
| BrandImageLink | form | string | No | |
| AnnotationHtmlEn | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /eCommerce/Products HTTP/1.1 Host: 10.10.0.107 Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: String,
BCode: String,
Name: String,
Price: 0,
Points: 0,
InStock: False,
Promo: False,
Discount: 0,
ImgLink: String,
DiscountedPrice: 0,
IsNew: False,
Netto: 0,
Unit: String,
AnnotationHtml: String,
NeedPrepare: 0,
QuantityStep: 0,
ByWeight: 0,
Slug: String,
PPCatId: String,
mdtrade: 0,
mdretail: 0,
rcount: 0,
QualityId: 0,
Quality: String,
HCategoryId: 0,
Incode: String,
HCategoryName: String,
HCategoryHcode: String,
BrandId: 0,
BrandName: String,
BrandAbbreviation: String,
BrandImageLink: String,
AnnotationHtmlEn: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}