Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,97 @@ BODY
{productIds: "bwv5n56m5bvh,c1k748m3xp5d"}
```

### Response format

Simple documentation:

```jsonc
{
"Products": [
{
"LocalizedProperties": [ // Holds a list of properties which may be localized to a language
{
"DeveloperName": "Contoso", // The author of the product
"PublisherName": "Contoso", // The publisher of the product

"ProductDescription": "", // Description of the product
"ProductTitle": "Contoso IT Support", // Title of the app
"Language": "en-us" // Language of this localization
}
],
"ProductId": "XXXXXXXXXXXX", // The id of the product. Useful for other requests
"Properties": {
"PackageFamilyName": "contoso.com.ContosoItSupport_xxxxxxxxxxxxx" // The full package name of the product
},
"ProductKind": "Application", // What kind of product this is. May be "Game", "Application", or other.
"DisplaySkuAvailabilities": [
{
"Sku": {
"SkuId": "0010" // The id of the Sku. Not sure how it works. Have only seen it ever be "0010" or "0011".
}
}
]
}
]
}
```

<details>
<summary>Larger documentation (incomplete)</summary>

```jsonc
{
"Products": [
{
"LocalizedProperties": [
{
"DeveloperName": "<DEVELOPER NAME>",
"PublisherName": "<PUBLISHER NAME>",
"Images": [
{
"Caption": "<CAPTION>",
"Height": /*<HEIGHT>*/,
"ImagePurpose": "<Logo OR Tile>",
"Uri": "<IMAGE URI>" // The URI is in the format: //<host>/<path>, lacking the schema. HTTPS is assumed.
}
],
"ProductDescription": "<DESCRIPTION>",
"ProductTitle": "<TITLE>",
"SearchTitles": [ // A list of search tags
{
"SearchTitleString": "<SEARCH RESULTS TAG>",
"SearchTitleType": "SearchHint"
},
],
"Language": "<LANGUAGE>",
"ShortDescription": "<SHORT DESCRIPTION>"
}
],
"MarketProperties": [
{
"RelatedProducts": [] // A list of related products
}
],
"ProductId": "<PRODUCT ID>",
"Properties": {
"PackageFamilyName": "<PACKAGE NAME>"
},
"ProductKind": "<Game OR App>",
"DisplaySkuAvailabilities": [
{
"Sku": {
"SkuId": "<SKU ID>"
}
},
],
"AverageRating": /*<RATING IN NUMBER OF STARS (1 decimal place)>*/,
"TotalRatingsCount": /*<NUMBER OF RATINGS>*/
}
]
}
```
</details>

## URL Parameters

- `market`
Expand Down