Manage orders - Get a list of offers for a market (by customer)
Retrieves all offers of a partner using customer id.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customerId}/offers
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 |
---|---|---|---|---|
customer
|
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 |
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
Contracts.V1.Models.Enums.OfferProduct
Name | Type | Description |
---|---|---|
id |
string |
|
name |
string |
|
type |
string |
|
unit |
string |
Contracts.V1.Models.Offer
Name | Type | Description |
---|---|---|
acquisitionType |
enum:
|
|
actions |
string[] |
|
additionalProperties |
object |
|
attestationProperties | ||
attributes | ||
billing |
enum:
|
|
category | ||
conversionTargetOffers |
string[] |
|
country |
string |
|
description |
string |
|
hasAddOns |
boolean |
|
id |
string |
|
isAddOn |
boolean |
|
isAutoRenewable |
boolean |
|
isAvailableForPurchase |
boolean |
|
isInternal |
boolean |
|
isMicrosoftProduct |
boolean |
|
isTrial |
boolean |
|
limit |
integer |
|
limitUnitOfMeasure |
string |
|
links | ||
locale |
string |
|
maximumQuantity |
integer |
|
minimumQuantity |
integer |
|
name |
string |
|
orderService |
string |
|
prerequisiteOffers |
string[] |
|
product | ||
providerId |
string |
|
providerLocationId |
string |
|
providerName |
string |
|
rank |
integer |
|
reselleeQualifications |
string[] |
|
resellerQualifications |
string[] |
|
salesGroupId |
string |
|
supportedBillingCycles | ||
supportedCatalogTypes | ||
term |
integer |
|
termUnitOfMeasure |
string |
|
unitType |
string |
|
upgradeTargetOffers |
string[] |
|
uri |
string |
Contracts.V1.Models.OfferAttestationProperties
Name | Type | Description |
---|---|---|
attestationType |
string |
|
enforceAttestation |
boolean |
Contracts.V1.Models.OfferCategory
Name | Type | Description |
---|---|---|
attributes | ||
country |
string |
|
id |
string |
|
links | ||
locale |
string |
|
name |
string |
|
rank |
integer |
Contracts.V1.Models.OfferLinks
Name | Type | Description |
---|---|---|
learnMore | ||
next | ||
previous | ||
self |
Link
Name | Type | Description |
---|---|---|
body |
string |
|
headers |
System. |
|
method |
string |
|
uri |
string |
ResourceAttributes
Name | Type | Description |
---|---|---|
etag |
string |
|
objectType |
string |
ResourceCollection[Contracts.V1.Models.Offer]
Name | Type | Description |
---|---|---|
attributes | ||
items | ||
links | ||
totalCount |
integer |
ResourceLinks
Name | Type | Description |
---|---|---|
next | ||
previous | ||
self |
SupportedBillingCycles
Name | Type | Description |
---|---|---|
annual |
string |
|
monthly |
string |
|
none |
string |
|
one_time |
string |
|
triennial |
string |
|
unknown |
string |
SupportedCatalogTypes
Name | Type | Description |
---|---|---|
live |
string |
|
sandbox |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name | Type | Description |
---|---|---|
key |
string |
|
value |
string |