Manage orders - Get Offer by ID

Service:

Partner Center Rest

API Version:

v1

Retrieves an offer by its identifier of a partner using country and locale information.

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

With optional parameters:

GET https://api.partnercenter.microsoft.com/v{version}/offers/{offer_id}?country={country}

URI Parameters

Name	In	Required	Type	Description
offer_id	path	True	string	The offer identifier.
version	path	True	string
country	query		string	The country information. Two letter representation of country

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	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
ResourceLinks
SupportedBillingCycles
SupportedCatalogTypes
System.Collections.Generic.KeyValuePair[System.String,System.String]

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: purchase referral
actions	string[]
additionalProperties	object
attestationProperties	Contracts.V1.Models.OfferAttestationProperties
attributes	ResourceAttributes
billing	enum: license none usage
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
limitUnitOfMeasure	string
links	Contracts.V1.Models.OfferLinks
locale	string
maximumQuantity	integer
minimumQuantity	integer
name	string
orderService	string
prerequisiteOffers	string[]
product	Contracts.V1.Models.Enums.OfferProduct
providerId	string
providerLocationId	string
providerName	string
rank	integer
reselleeQualifications	string[]
resellerQualifications	string[]
salesGroupId	string
supportedBillingCycles	SupportedBillingCycles[]
supportedCatalogTypes	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	ResourceAttributes
country	string
id	string
links	ResourceLinks
locale	string
name	string
rank	integer

Contracts.V1.Models.OfferLinks

Name	Type	Description
learnMore	Link
next	Link
previous	Link
self	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

ResourceLinks

Name	Type	Description
next	Link
previous	Link
self	Link

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