POST Catalog/Variation
Get a Variation
Request Information
URI Parameters
None.
Body Parameters
GetVariationRequestName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
Lang | string |
None. |
|
StoreID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "ID": 1, "Lang": "sample string 2", "StoreID": 3 }
application/xml, text/xml
Sample:
<GetVariationRequest 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> <ID>1</ID> </GetVariationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VariationName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
ProductID | integer |
None. |
|
Slug | string |
None. |
|
Name |
product Name |
string |
None. |
ShortDescription |
use product ShortDescription if variation ShortDescription is null |
string |
None. |
Description |
use product Description if variation Description is null |
string |
None. |
SKU | string |
None. |
|
Quantity |
Aggregates variation Stocks. Total is corrected with OutOfStockQuantity |
decimal number |
None. |
ShippingTime | decimal number |
None. |
|
SortOrder | integer |
None. |
|
AttributeIDs |
AttributeIDs applying to this variation |
Collection of integer |
None. |
Images | Collection of ItemImage |
None. |
|
UnitAmount | decimal number |
None. |
|
Discount | decimal number |
None. |
|
DiscountPercent | decimal number |
None. |
|
UnitBase | decimal number |
None. |
|
TaxPercent | decimal number |
None. |
|
EquivalenceSurchargePercent | decimal number |
None. |
|
Base | decimal number |
None. |
|
Tax | decimal number |
None. |
|
EquivalenceSurcharge | decimal number |
None. |
|
Amount | decimal number |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.