Manage orders - Get a list of offers for a market (by customer)

Service:

Partner Center Rest

API Version:

v1

Retrieves all offers of a partner using customer id.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customerId}/offers

With optional parameters:

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customerId}/offers?offer_category_id={offer_category_id}&offset={offset}&size={size}

URI Parameters

Name	In	Required	Type	Description
customerId	path	True	string	The customer id
version	path	True	string
offer_category_id	query		string	The offer category identifier. Optional paramter. Filters offers by category when provided
offset	query		integer (int32)	The page offset. Optional parameter
size	query		integer (int32)	The page size. Optional parameter

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.Offer]	The request was successful. The requested partner's offers information is returned in the response body. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Contracts.V1.Models.Enums.OfferProduct
Contracts.V1.Models.Offer
Contracts.V1.Models.OfferAttestationProperties
Contracts.V1.Models.OfferCategory
Contracts.V1.Models.OfferLinks
Link
ResourceAttributes
ResourceCollection[Contracts.V1.Models.Offer]
ResourceLinks
SupportedBillingCycles
SupportedCatalogTypes
System.Collections.Generic.KeyValuePair[System.String,System.String]

Contracts.V1.Models.Enums.OfferProduct

Object

Name	Type	Description
id	string
name	string
type	string
unit	string

Contracts.V1.Models.Offer

Object

Name	Type	Description
acquisitionType	enum: purchase (int32) referral (int32)
actions	string[]
additionalProperties	object
attestationProperties	Contracts.V1.Models.OfferAttestationProperties
attributes	ResourceAttributes
billing	enum: license (int32) none (int32) usage (int32)
category	Contracts.V1.Models.OfferCategory
conversionTargetOffers	string[]
country	string
description	string
hasAddOns	boolean
id	string
isAddOn	boolean
isAutoRenewable	boolean
isAvailableForPurchase	boolean
isInternal	boolean
isMicrosoftProduct	boolean
isTrial	boolean
limit	integer (int32)
limitUnitOfMeasure	string
links	Contracts.V1.Models.OfferLinks
locale	string
maximumQuantity	integer (int32)
minimumQuantity	integer (int32)
name	string
orderService	string
prerequisiteOffers	string[]
product	Contracts.V1.Models.Enums.OfferProduct
providerId	string
providerLocationId	string
providerName	string
rank	integer (int32)
reselleeQualifications	string[]
resellerQualifications	string[]
salesGroupId	string
supportedBillingCycles	SupportedBillingCycles[] (int32)
supportedCatalogTypes	SupportedCatalogTypes[] (int32)
term	integer (int32)
termUnitOfMeasure	string
unitType	string
upgradeTargetOffers	string[]
uri	string

Contracts.V1.Models.OfferAttestationProperties

Object

Name	Type	Description
attestationType	string
enforceAttestation	boolean

Contracts.V1.Models.OfferCategory

Object

Name	Type	Description
attributes	ResourceAttributes
country	string
id	string
links	ResourceLinks
locale	string
name	string
rank	integer (int32)

Contracts.V1.Models.OfferLinks

Object

Name	Type	Description
learnMore	Link
next	Link
previous	Link
self	Link

Link

Object

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

ResourceAttributes

Object

Name	Type	Description
etag	string
objectType	string

ResourceCollection[Contracts.V1.Models.Offer]

Object

Name	Type	Description
attributes	ResourceAttributes
items	Contracts.V1.Models.Offer[]
links	ResourceLinks
totalCount	integer (int32)

ResourceLinks

Object

Name	Type	Description
next	Link
previous	Link
self	Link

SupportedBillingCycles

Enumeration

Value	Description
annual
monthly
none
one_time
triennial
unknown

SupportedCatalogTypes

Enumeration

Value	Description
live
sandbox

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

Object

Name	Type	Description
key	string
value	string