GET rest/v1/catalog/products/platform/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Catalog| Name | Description | Type | Additional information |
|---|---|---|---|
| products | Collection of Product |
None. |
|
| success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"products": [
{
"id": "sample string 1",
"sku": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"ISBN__c": "sample string 5",
"PlatformId__c": "sample string 6",
"productRatePlans": [
{
"id": "sample string 1",
"status": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"effectiveStartDate": "sample string 5",
"effectiveEndDate": "sample string 6",
"Discount__c": "sample string 7",
"MaterialNumber__c": "sample string 8",
"FreeDays__c": "sample string 9",
"productRatePlanCharges": [
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
}
],
"ProductId": "sample string 10",
"PlatformId": 11,
"PlatformName": "sample string 12",
"ProductGroup": "sample string 13",
"CouponCode__c": "sample string 14",
"DiscountRatePlan__c": "sample string 15",
"RatePlanType__c": "sample string 16",
"DiscountType__c": "sample string 17"
},
{
"id": "sample string 1",
"status": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"effectiveStartDate": "sample string 5",
"effectiveEndDate": "sample string 6",
"Discount__c": "sample string 7",
"MaterialNumber__c": "sample string 8",
"FreeDays__c": "sample string 9",
"productRatePlanCharges": [
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
}
],
"ProductId": "sample string 10",
"PlatformId": 11,
"PlatformName": "sample string 12",
"ProductGroup": "sample string 13",
"CouponCode__c": "sample string 14",
"DiscountRatePlan__c": "sample string 15",
"RatePlanType__c": "sample string 16",
"DiscountType__c": "sample string 17"
}
]
},
{
"id": "sample string 1",
"sku": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"ISBN__c": "sample string 5",
"PlatformId__c": "sample string 6",
"productRatePlans": [
{
"id": "sample string 1",
"status": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"effectiveStartDate": "sample string 5",
"effectiveEndDate": "sample string 6",
"Discount__c": "sample string 7",
"MaterialNumber__c": "sample string 8",
"FreeDays__c": "sample string 9",
"productRatePlanCharges": [
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
}
],
"ProductId": "sample string 10",
"PlatformId": 11,
"PlatformName": "sample string 12",
"ProductGroup": "sample string 13",
"CouponCode__c": "sample string 14",
"DiscountRatePlan__c": "sample string 15",
"RatePlanType__c": "sample string 16",
"DiscountType__c": "sample string 17"
},
{
"id": "sample string 1",
"status": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"effectiveStartDate": "sample string 5",
"effectiveEndDate": "sample string 6",
"Discount__c": "sample string 7",
"MaterialNumber__c": "sample string 8",
"FreeDays__c": "sample string 9",
"productRatePlanCharges": [
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
},
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"model": "sample string 4",
"pricingSummary": [
"sample string 1",
"sample string 2"
],
"billingDay": "sample string 5",
"billingPeriod": "sample string 6",
"taxable": true,
"taxCode": "sample string 8",
"taxMode": "sample string 9",
"ProductCode__c": "sample string 10",
"RatePlanISBN__c": "sample string 11",
"pricing": [
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
},
{
"currency": "sample string 1",
"price": {},
"tiers": {},
"includedUnits": {},
"overagePrice": {},
"discountPercentage": {},
"discountAmount": {}
}
]
}
],
"ProductId": "sample string 10",
"PlatformId": 11,
"PlatformName": "sample string 12",
"ProductGroup": "sample string 13",
"CouponCode__c": "sample string 14",
"DiscountRatePlan__c": "sample string 15",
"RatePlanType__c": "sample string 16",
"DiscountType__c": "sample string 17"
}
]
}
],
"success": true
}
application/xml, text/xml
Sample:
<Catalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Subscriptions.HMH.Common.APIEntities">
<products>
<Product>
<ISBN__c>sample string 5</ISBN__c>
<PlatformId__c>sample string 6</PlatformId__c>
<description>sample string 4</description>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlans>
<ProductRatePlan>
<CouponCode__c>sample string 14</CouponCode__c>
<DiscountRatePlan__c>sample string 15</DiscountRatePlan__c>
<DiscountType__c>sample string 17</DiscountType__c>
<Discount__c>sample string 7</Discount__c>
<FreeDays__c>sample string 9</FreeDays__c>
<MaterialNumber__c>sample string 8</MaterialNumber__c>
<PlatformId>11</PlatformId>
<PlatformName>sample string 12</PlatformName>
<ProductGroup>sample string 13</ProductGroup>
<ProductId>sample string 10</ProductId>
<RatePlanType__c>sample string 16</RatePlanType__c>
<description>sample string 4</description>
<effectiveEndDate>sample string 6</effectiveEndDate>
<effectiveStartDate>sample string 5</effectiveStartDate>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlanCharges>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
</productRatePlanCharges>
<status>sample string 2</status>
</ProductRatePlan>
<ProductRatePlan>
<CouponCode__c>sample string 14</CouponCode__c>
<DiscountRatePlan__c>sample string 15</DiscountRatePlan__c>
<DiscountType__c>sample string 17</DiscountType__c>
<Discount__c>sample string 7</Discount__c>
<FreeDays__c>sample string 9</FreeDays__c>
<MaterialNumber__c>sample string 8</MaterialNumber__c>
<PlatformId>11</PlatformId>
<PlatformName>sample string 12</PlatformName>
<ProductGroup>sample string 13</ProductGroup>
<ProductId>sample string 10</ProductId>
<RatePlanType__c>sample string 16</RatePlanType__c>
<description>sample string 4</description>
<effectiveEndDate>sample string 6</effectiveEndDate>
<effectiveStartDate>sample string 5</effectiveStartDate>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlanCharges>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
</productRatePlanCharges>
<status>sample string 2</status>
</ProductRatePlan>
</productRatePlans>
<sku>sample string 2</sku>
</Product>
<Product>
<ISBN__c>sample string 5</ISBN__c>
<PlatformId__c>sample string 6</PlatformId__c>
<description>sample string 4</description>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlans>
<ProductRatePlan>
<CouponCode__c>sample string 14</CouponCode__c>
<DiscountRatePlan__c>sample string 15</DiscountRatePlan__c>
<DiscountType__c>sample string 17</DiscountType__c>
<Discount__c>sample string 7</Discount__c>
<FreeDays__c>sample string 9</FreeDays__c>
<MaterialNumber__c>sample string 8</MaterialNumber__c>
<PlatformId>11</PlatformId>
<PlatformName>sample string 12</PlatformName>
<ProductGroup>sample string 13</ProductGroup>
<ProductId>sample string 10</ProductId>
<RatePlanType__c>sample string 16</RatePlanType__c>
<description>sample string 4</description>
<effectiveEndDate>sample string 6</effectiveEndDate>
<effectiveStartDate>sample string 5</effectiveStartDate>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlanCharges>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
</productRatePlanCharges>
<status>sample string 2</status>
</ProductRatePlan>
<ProductRatePlan>
<CouponCode__c>sample string 14</CouponCode__c>
<DiscountRatePlan__c>sample string 15</DiscountRatePlan__c>
<DiscountType__c>sample string 17</DiscountType__c>
<Discount__c>sample string 7</Discount__c>
<FreeDays__c>sample string 9</FreeDays__c>
<MaterialNumber__c>sample string 8</MaterialNumber__c>
<PlatformId>11</PlatformId>
<PlatformName>sample string 12</PlatformName>
<ProductGroup>sample string 13</ProductGroup>
<ProductId>sample string 10</ProductId>
<RatePlanType__c>sample string 16</RatePlanType__c>
<description>sample string 4</description>
<effectiveEndDate>sample string 6</effectiveEndDate>
<effectiveStartDate>sample string 5</effectiveStartDate>
<id>sample string 1</id>
<name>sample string 3</name>
<productRatePlanCharges>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
<ProductRatePlanCharge>
<ProductCode__c>sample string 10</ProductCode__c>
<RatePlanISBN__c>sample string 11</RatePlanISBN__c>
<billingDay>sample string 5</billingDay>
<billingPeriod>sample string 6</billingPeriod>
<id>sample string 1</id>
<model>sample string 4</model>
<name>sample string 2</name>
<pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
<Pricing>
<currency>sample string 1</currency>
<discountAmount />
<discountPercentage />
<includedUnits />
<overagePrice />
<price />
<tiers />
</Pricing>
</pricing>
<pricingSummary xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:string>sample string 1</d8p1:string>
<d8p1:string>sample string 2</d8p1:string>
</pricingSummary>
<taxCode>sample string 8</taxCode>
<taxMode>sample string 9</taxMode>
<taxable>true</taxable>
<type>sample string 3</type>
</ProductRatePlanCharge>
</productRatePlanCharges>
<status>sample string 2</status>
</ProductRatePlan>
</productRatePlans>
<sku>sample string 2</sku>
</Product>
</products>
<success>true</success>
</Catalog>