GET PrizesCatalog/{id}?loyaltyProgramId={loyaltyProgramId}&stockBySite={stockBySite}
Gets a sku catalog by it's ID, represented as SkuCatalogDto.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the sku. |
globally unique identifier |
Required |
| loyaltyProgramId |
The ID of the loyalty program associated with the sku. |
globally unique identifier |
Required |
| stockBySite |
Get stock for the sku by site (optional, false by default). |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
The sku data.
PrizeDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Code | string |
None. |
|
| POSCode | string |
None. |
|
| DescriptionFull | string |
None. |
|
| DescriptionShort | string |
None. |
|
| DescriptionUltraShort | string |
None. |
|
| StockKeepingUnitImages | Collection of ImageDto |
None. |
|
| LoyaltyPoints | decimal number |
None. |
|
| StockBySites | Collection of StockBySiteDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "a867428c-5eea-4831-8251-83cfc01c056f",
"Code": "sample string 2",
"POSCode": "sample string 3",
"DescriptionFull": "sample string 4",
"DescriptionShort": "sample string 5",
"DescriptionUltraShort": "sample string 6",
"StockKeepingUnitImages": [
{
"Name": "sample string 1",
"Url": "sample string 2"
},
{
"Name": "sample string 1",
"Url": "sample string 2"
}
],
"LoyaltyPoints": 7.0,
"StockBySites": [
{
"SkuId": "fd46c3c9-e607-40a6-9ef4-77cca08e59e4",
"SiteId": "78d576d8-da37-4f3c-8de7-5850549bd3c7",
"SiteName": "sample string 3",
"SiteAddress": "sample string 4",
"SiteCity": "sample string 5",
"SiteCountry": "sample string 6",
"SiteLongitude": 1.1,
"SiteLatitude": 1.1,
"AvailableStock": 7.0,
"AvailableStockForReservation": 8.0,
"ReservedStock": 9.0
},
{
"SkuId": "fd46c3c9-e607-40a6-9ef4-77cca08e59e4",
"SiteId": "78d576d8-da37-4f3c-8de7-5850549bd3c7",
"SiteName": "sample string 3",
"SiteAddress": "sample string 4",
"SiteCity": "sample string 5",
"SiteCountry": "sample string 6",
"SiteLongitude": 1.1,
"SiteLatitude": 1.1,
"AvailableStock": 7.0,
"AvailableStockForReservation": 8.0,
"ReservedStock": 9.0
}
]
}
application/xml, text/xml
Sample:
<PrizeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model.Sku">
<Code>sample string 2</Code>
<DescriptionFull>sample string 4</DescriptionFull>
<DescriptionShort>sample string 5</DescriptionShort>
<DescriptionUltraShort>sample string 6</DescriptionUltraShort>
<Id>a867428c-5eea-4831-8251-83cfc01c056f</Id>
<LoyaltyPoints>7</LoyaltyPoints>
<POSCode>sample string 3</POSCode>
<StockBySites>
<StockBySiteDto>
<AvailableStock>7</AvailableStock>
<AvailableStockForReservation>8</AvailableStockForReservation>
<ReservedStock>9</ReservedStock>
<SiteAddress>sample string 4</SiteAddress>
<SiteCity>sample string 5</SiteCity>
<SiteCountry>sample string 6</SiteCountry>
<SiteId>78d576d8-da37-4f3c-8de7-5850549bd3c7</SiteId>
<SiteLatitude>1.1</SiteLatitude>
<SiteLongitude>1.1</SiteLongitude>
<SiteName>sample string 3</SiteName>
<SkuId>fd46c3c9-e607-40a6-9ef4-77cca08e59e4</SkuId>
</StockBySiteDto>
<StockBySiteDto>
<AvailableStock>7</AvailableStock>
<AvailableStockForReservation>8</AvailableStockForReservation>
<ReservedStock>9</ReservedStock>
<SiteAddress>sample string 4</SiteAddress>
<SiteCity>sample string 5</SiteCity>
<SiteCountry>sample string 6</SiteCountry>
<SiteId>78d576d8-da37-4f3c-8de7-5850549bd3c7</SiteId>
<SiteLatitude>1.1</SiteLatitude>
<SiteLongitude>1.1</SiteLongitude>
<SiteName>sample string 3</SiteName>
<SkuId>fd46c3c9-e607-40a6-9ef4-77cca08e59e4</SkuId>
</StockBySiteDto>
</StockBySites>
<StockKeepingUnitImages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ationet.Model">
<d2p1:ImageDto>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Url>sample string 2</d2p1:Url>
</d2p1:ImageDto>
<d2p1:ImageDto>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Url>sample string 2</d2p1:Url>
</d2p1:ImageDto>
</StockKeepingUnitImages>
</PrizeDto>