Manage orders - Get an availability for a SKU (by customer)

Service:

Partner Center Rest

API Version:

v1

Retrieves an availability for the requested customer context.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customerId}/products/{productId}/skus/{skuId}/availabilities/{availabilityId}

URI Parameters

Name	In	Required	Type	Description
availabilityId	path	True	string	The availability id.
customerId	path	True	string	The customer id.
productId	path	True	string	The product Id.
skuId	path	True	string	The sku Id.
version	path	True	string

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.Availability	The request was successful. The availability is returned in the response body. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Contracts.V1.Models.Availability
Contracts.V1.Models.AvailabilityIncludedQuantity
Contracts.V1.Models.AvailabilityLinks
Contracts.V1.Models.AvailabilityTerm
Contracts.V1.Models.CancellationPolicy
Contracts.V1.Models.CancellationRefundOption
Contracts.V1.Models.CurrencyInfo
Contracts.V1.Models.ItemType
Contracts.V1.Models.Product
Contracts.V1.Models.ProductLinks
Contracts.V1.Models.RenewalInstruction
Contracts.V1.Models.RenewalInstructionOption
Contracts.V1.Models.RenewalOption
Contracts.V1.Models.Sku
Contracts.V1.Models.SkuAttestationProperties
Link
ResourceLinks
SupportedBillingCycles
System.Collections.Generic.KeyValuePair[System.String,System.String]

Contracts.V1.Models.Availability

Name	Type	Description
catalogItemId	string
country	string
defaultCurrency	Contracts.V1.Models.CurrencyInfo
id	string
includedQuantityOptions	Contracts.V1.Models.AvailabilityIncludedQuantity[]
isPurchasable	boolean
isRenewable	boolean
links	Contracts.V1.Models.AvailabilityLinks
product	Contracts.V1.Models.Product
productId	string
renewalInstructions	Contracts.V1.Models.RenewalInstruction[]
segment	string
sku	Contracts.V1.Models.Sku
skuId	string
terms	Contracts.V1.Models.AvailabilityTerm[]

Contracts.V1.Models.AvailabilityIncludedQuantity

Name	Type	Description
description	string
units	string

Contracts.V1.Models.AvailabilityLinks

Name	Type	Description
next	Link
previous	Link
pricing	Link
self	Link

Contracts.V1.Models.AvailabilityTerm

Name	Type	Description
billingCycle	string
cancellationPolicies	Contracts.V1.Models.CancellationPolicy[]
description	string
duration	string
id	string
renewalOptions	Contracts.V1.Models.RenewalOption[]

Contracts.V1.Models.CancellationPolicy

Name	Type	Description
refundOptions	Contracts.V1.Models.CancellationRefundOption[]

Contracts.V1.Models.CancellationRefundOption

Name	Type	Description
expiresAfter	string
sequenceId	integer
type	string

Contracts.V1.Models.CurrencyInfo

Name	Type	Description
code	string
symbol	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

Contracts.V1.Models.RenewalInstruction

Name	Type	Description
applicableTermIds	string[]
renewalOptions	Contracts.V1.Models.RenewalInstructionOption[]

Contracts.V1.Models.RenewalInstructionOption

Name	Type	Description
isAutoRenewable	boolean
renewToId	string

Contracts.V1.Models.RenewalOption

Name	Type	Description
description	string
termDuration	string

Contracts.V1.Models.Sku

Name	Type	Description
actions	string[]
attestationProperties	Contracts.V1.Models.SkuAttestationProperties
consumptionType	string
description	string
dynamicAttributes	object
id	string
inventoryVariables	string[]
isTrial	boolean
links	ResourceLinks
maximumQuantity	integer
minimumQuantity	integer
productId	string
provisioningVariables	string[]
purchasePrerequisites	string[]
supportedBillingCycles	SupportedBillingCycles[]
termsOfUseUri	string
title	string

Contracts.V1.Models.SkuAttestationProperties

Name	Type	Description
attestationType	string
enforceAttestation	boolean

Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	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

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

Name	Type	Description
key	string
value	string