POST Catalog/ProductByID
Get a Product
Request Information
URI Parameters
None.
Body Parameters
GetProductRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ProductID | integer |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json, text/json
{
"ProductID": 1,
"Lang": "sample string 2",
"StoreID": 3
}
application/xml, text/xml
<GetProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Catalog"> <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 2</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">3</StoreID> <ProductID>1</ProductID> </GetProductRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Product| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| StoreID | integer |
None. |
|
| Created | date |
None. |
|
| Discontinued | date |
None. |
|
| Reference | string |
Required |
|
| Name | string |
Required |
|
| ShortDescription | string |
None. |
|
| Description | string |
None. |
|
| Quantity |
Aggregates product variation Stocks. Total is corrected with OutOfStockQuantity |
decimal number |
None. |
| ShippingTime | decimal number |
None. |
|
| DeliveryDate | date |
None. |
|
| Slug | string |
None. |
|
| ProviderID | integer |
None. |
|
| ProviderName | string |
None. |
|
| TitleTag |
Seo Title Tag |
string |
None. |
| MetaDescription |
Seo MetaDescription |
string |
None. |
| NotSell |
This product is not for sell |
boolean |
None. |
| PackProductIDs | Collection of integer |
None. |
|
| BoundProductIDs | Collection of integer |
None. |
|
| AttributeIDs |
List of attributes applicable to this product variations |
Collection of AttributeID |
None. |
| VariationAttributes |
Combination of attributes applying to each product variation ID |
Dictionary of integer [key] and Collection of integer [value] |
None. |
| ClassificationIDs | Collection of integer |
None. |
|
| Images | Collection of ItemImage |
None. |
|
| Promotion | PromotionItem |
None. |
|
| Promotions | Collection of PromotionItem |
None. |
|
| StoreManufacture |
if true , this product belongs to the store manufacturer |
boolean |
None. |
| SalesStockPolicyID | integer |
None. |
|
| BrandName | string |
None. |
|
| BrandSlug | string |
None. |
|
| BrandImages | Collection of ItemImage |
None. |
|
| CollectionName | string |
None. |
|
| ConditionName | string |
None. |
|
| VariationPrices | Collection of VariationPrice |
None. |
|
| Weight | decimal number |
None. |
|
| Dimensions | Dimensions |
None. |
|
| MinimumOrderQuantity |
Minimum quantity that must be placed in each order |
decimal number |
None. |
| MaximumOrderQuantity |
Maximum quantity that can be placed in each order; 0 = no limit |
decimal number |
None. |
| OrderQuantityStep |
Sets the number of items that have to be grouped together to place an Order |
decimal number |
None. |
| IsComposite | boolean |
None. |
|
| Features |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.