Manage orders - Get a list of products (by country)
Retrieves all products using country and locale information.
GET https://api.partnercenter.microsoft.com/v{version}/products
GET https://api.partnercenter.microsoft.com/v{version}/products?country={country}&targetView={targetView}&targetSegment={targetSegment}&reservationScope={reservationScope}
Name | In | Required | Type | Description |
---|---|---|---|---|
version
|
path | True |
string |
|
country
|
query |
string |
The country information. Two letter representation of country |
|
reservation
|
query |
string |
The optional reservation scope filter. |
|
target
|
query |
string |
The optional segment filter. |
|
target
|
query |
string |
The catalog view being requested. |
Name | Required | Type | Description |
---|---|---|---|
Authorization | True |
string |
Authorization Bearer token |
ms-correlationid |
string |
Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request |
|
MS-CV |
string |
Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request |
|
ms-requestid |
string |
Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request |
Name | Type | Description |
---|---|---|
200 OK |
The request was successful. The products are returned in the response body. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
Name | Type | Description |
---|---|---|
displayName |
string |
|
id |
string |
|
subType |
Name | Type | Description |
---|---|---|
description |
string |
|
id |
string |
|
isMicrosoftProduct |
boolean |
|
links | ||
localizedAttributes |
System. |
|
productType | ||
publisherName |
string |
|
title |
string |
Name | Type | Description |
---|---|---|
body |
string |
|
headers |
System. |
|
method |
string |
|
uri |
string |
Name | Type | Description |
---|---|---|
etag |
string |
|
objectType |
string |
Name | Type | Description |
---|---|---|
attributes | ||
items | ||
links | ||
totalCount |
integer |
Name | Type | Description |
---|---|---|
key |
string |
|
value |
string |