POST api/v1/products/retailer

Request Information

URI Parameters

None.

Body Parameters

Name	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": "8bab75f3-14b4-48ef-98e0-5b7c5fdb84a3",
  "ApplicationVersion": 2,
  "Udid": "sample string 3",
  "UserID": "1275adb6-30f5-443c-a123-39f9865ba856",
  "RetailerId": "095f9783-c96f-4e05-a5a0-77f6cbbde491",
  "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>8bab75f3-14b4-48ef-98e0-5b7c5fdb84a3</ApiKey>
  <ApplicationVersion>2</ApplicationVersion>
  <RetailerId>095f9783-c96f-4e05-a5a0-77f6cbbde491</RetailerId>
  <Skip>1</Skip>
  <Top>6</Top>
  <Udid>sample string 3</Udid>
  <UserID>1275adb6-30f5-443c-a123-39f9865ba856</UserID>
  <ZoneID>7</ZoneID>
</ProductsForRetailerRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProductsForRetailerRequest'.

Response Information

Resource Description

Collection of ProductDto

Name	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": "90478f7c-99c4-467f-a796-67f58c5a7452",
    "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": "90478f7c-99c4-467f-a796-67f58c5a7452",
    "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>90478f7c-99c4-467f-a796-67f58c5a7452</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>90478f7c-99c4-467f-a796-67f58c5a7452</RetailerID>
    <RetailerImageUrl>sample string 6</RetailerImageUrl>
    <RetailerName>sample string 7</RetailerName>
    <Title>sample string 1</Title>
    <WebshopUrl>sample string 4</WebshopUrl>
  </ProductDto>
</ArrayOfProductDto>