POST api/v1/products/retailer
Request Information
URI Parameters
None.
Body Parameters
ProductsForRetailerRequestName | Description | Type | Additional information |
---|---|---|---|
ApiKey | globally unique identifier |
Required |
|
ApplicationVersion | integer |
Required |
|
Udid | string |
Required |
|
UserID | globally unique identifier |
Required |
|
RetailerId | globally unique identifier |
Required |
|
Top | integer |
Required |
|
ZoneID | integer |
Required |
|
Skip | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "ApiKey": "2ad6b5b4-bbd0-4a4a-bebc-8225e154dc31", "ApplicationVersion": 2, "Udid": "sample string 3", "UserID": "1b658781-9ba5-4580-ab8c-aaa5ec6ef812", "RetailerId": "6850eef2-d6da-4974-affc-dae59ce6305f", "Top": 6, "ZoneID": 7, "Skip": 1 }
application/xml, text/xml
Sample:
<ProductsForRetailerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Products.v1"> <ApiKey>2ad6b5b4-bbd0-4a4a-bebc-8225e154dc31</ApiKey> <ApplicationVersion>2</ApplicationVersion> <RetailerId>6850eef2-d6da-4974-affc-dae59ce6305f</RetailerId> <Skip>1</Skip> <Top>6</Top> <Udid>sample string 3</Udid> <UserID>1b658781-9ba5-4580-ab8c-aaa5ec6ef812</UserID> <ZoneID>7</ZoneID> </ProductsForRetailerRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of ProductDtoName | Description | Type | Additional information |
---|---|---|---|
ProductType | ProductType |
None. |
|
Title | string |
None. |
|
Description | string |
None. |
|
ImageUrl | string |
None. |
|
Price | decimal number |
None. |
|
DiscountedPrice | decimal number |
None. |
|
WebshopUrl | string |
None. |
|
RetailerID | globally unique identifier |
None. |
|
RetailerImageUrl | string |
None. |
|
RetailerName | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ProductType": 1, "Title": "sample string 1", "Description": "sample string 2", "ImageUrl": "sample string 3", "Price": 1.1, "DiscountedPrice": 1.1, "WebshopUrl": "sample string 4", "RetailerID": "38837685-bbc1-4a1c-ad5e-f4a44673821c", "RetailerImageUrl": "sample string 6", "RetailerName": "sample string 7" }, { "ProductType": 1, "Title": "sample string 1", "Description": "sample string 2", "ImageUrl": "sample string 3", "Price": 1.1, "DiscountedPrice": 1.1, "WebshopUrl": "sample string 4", "RetailerID": "38837685-bbc1-4a1c-ad5e-f4a44673821c", "RetailerImageUrl": "sample string 6", "RetailerName": "sample string 7" } ]
application/xml, text/xml
Sample:
<ArrayOfProductDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Products"> <ProductDto> <Description>sample string 2</Description> <DiscountedPrice>1.1</DiscountedPrice> <ImageUrl>sample string 3</ImageUrl> <Price>1.1</Price> <ProductType>Interactive</ProductType> <RetailerID>38837685-bbc1-4a1c-ad5e-f4a44673821c</RetailerID> <RetailerImageUrl>sample string 6</RetailerImageUrl> <RetailerName>sample string 7</RetailerName> <Title>sample string 1</Title> <WebshopUrl>sample string 4</WebshopUrl> </ProductDto> <ProductDto> <Description>sample string 2</Description> <DiscountedPrice>1.1</DiscountedPrice> <ImageUrl>sample string 3</ImageUrl> <Price>1.1</Price> <ProductType>Interactive</ProductType> <RetailerID>38837685-bbc1-4a1c-ad5e-f4a44673821c</RetailerID> <RetailerImageUrl>sample string 6</RetailerImageUrl> <RetailerName>sample string 7</RetailerName> <Title>sample string 1</Title> <WebshopUrl>sample string 4</WebshopUrl> </ProductDto> </ArrayOfProductDto>