Manage orders - Get a list of offers for a market

Ruft alle Angebote eines Partners unter Verwendung von Länder- und Gebietsschemainformationen ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
version
path True

string

country
query

string

Die Länderinformationen. Zwei-Buchstaben-Darstellung des Landes

offer_category_id
query

string

Der Angebotskategoriebezeichner. Optionaler Parameter. Filtert Angebote nach Kategorie, wenn sie bereitgestellt werden

offset
query

integer

int32

Der Seitenoffset. Optionale Parameter

size
query

integer

int32

Die Seitengröße. Optionale Parameter

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Autorisierungs-Bearertoken

ms-correlationid

string

Wird für die interne Nachverfolgung von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue.

MS-CV

string

Wird für die interne Nachverfolgung von Anforderungen verwendet. Wenn kein MS-CV bereitgestellt wird, generiert der Server für jede Anforderung einen neuen.

ms-requestid

string

Wird für Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue.

Antworten

Name Typ Beschreibung
200 OK

ResourceCollection[Contracts.V1.Models.Offer]

Die Anforderung wurde erfolgreich gesendet. Die Angebotsinformationen des angeforderten Partners werden im Antworttext zurückgegeben.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitionen

Name Beschreibung
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

Name Typ Beschreibung
id

string

name

string

type

string

unit

string

Contracts.V1.Models.Offer

Name Typ Beschreibung
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 Typ Beschreibung
attestationType

string

enforceAttestation

boolean

Contracts.V1.Models.OfferCategory

Name Typ Beschreibung
attributes

ResourceAttributes

country

string

id

string

links

ResourceLinks

locale

string

name

string

rank

integer

Name Typ Beschreibung
learnMore

Link

next

Link

previous

Link

self

Link

Name Typ Beschreibung
body

string

headers

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

method

string

uri

string

ResourceAttributes

Name Typ Beschreibung
etag

string

objectType

string

ResourceCollection[Contracts.V1.Models.Offer]

Name Typ Beschreibung
attributes

ResourceAttributes

items

Contracts.V1.Models.Offer[]

links

ResourceLinks

totalCount

integer

Name Typ Beschreibung
next

Link

previous

Link

self

Link

SupportedBillingCycles

Name Typ Beschreibung
annual

string

monthly

string

none

string

one_time

string

triennial

string

unknown

string

SupportedCatalogTypes

Name Typ Beschreibung
live

string

sandbox

string

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

Name Typ Beschreibung
key

string

value

string