Manage orders - Get a list of products (by country)

Service:

Partner Center Rest

API Version:

v1

Retrieves all products using country and locale information.

GET https://api.partnercenter.microsoft.com/v{version}/products

With optional parameters:

GET https://api.partnercenter.microsoft.com/v{version}/products?country={country}&targetView={targetView}&targetSegment={targetSegment}&reservationScope={reservationScope}

URI Parameters

Name	In	Required	Type	Description
version	path	True	string
country	query		string	The country information. Two letter representation of country
reservationScope	query		string	The optional reservation scope filter.
targetSegment	query		string	The optional segment filter.
targetView	query		string	The catalog view being requested.

Request Header

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

Responses

Name	Type	Description
200 OK	ResourceCollection[Contracts.V1.Models.Product]	The request was successful. The products are returned in the response body. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Contracts.V1.Models.ItemType
Contracts.V1.Models.Product
Contracts.V1.Models.ProductLinks
Link
ResourceAttributes
ResourceCollection[Contracts.V1.Models.Product]
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]

Contracts.V1.Models.ItemType

Name	Type	Description
displayName	string
id	string
subType	Contracts.V1.Models.ItemType

Contracts.V1.Models.Product

Name	Type	Description
description	string
id	string
isMicrosoftProduct	boolean
links	Contracts.V1.Models.ProductLinks
localizedAttributes	System.Collections.Generic.KeyValuePair[System.String,System.String][]
productType	Contracts.V1.Models.ItemType
publisherName	string
title	string

Contracts.V1.Models.ProductLinks

Name	Type	Description
next	Link
previous	Link
self	Link
skus	Link

Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

ResourceAttributes

Name	Type	Description
etag	string
objectType	string

ResourceCollection[Contracts.V1.Models.Product]

Name	Type	Description
attributes	ResourceAttributes
items	Contracts.V1.Models.Product[]
links	ResourceLinks
totalCount	integer

ResourceLinks

Name	Type	Description
next	Link
previous	Link
self	Link

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string