Manage orders - Get promotion eligibilities

Service:

Partner Center Rest

API Version:

v1

Gets the promotion eligibilities based on the passed promotion eligibility request items.

POST https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/promotionEligibilities

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string
version	path	True	string

Request Header

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

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

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequestItem[]

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection`1[Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility]	The request was successful. The response body contains the promotion eligibility information. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection`1[Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Services.RuleEngine.Models.Enums.BillingCycleType
Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequest
Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequestItem
Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility
Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilityError
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

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

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection`1[Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.RuleEngine.Models.Enums.BillingCycleType

Name	Type	Description
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer
5	Integer

Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequest

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequestItem[]

Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilitiesRequestItem

Name	Type	Description
billingCycle	Microsoft.Partner.Services.RuleEngine.Models.Enums.BillingCycleType
catalogItemId	string
id	integer
promotionId	string
quantity	integer
termDuration	string

Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibility

Name	Type	Description
errors	Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilityError[]
isEligible	boolean
promotionId	string

Microsoft.Partner.Services.RuleEngine.Models.PromotionEligibilityError

Name	Type	Description
description	string
type	string

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

Name	Type	Description
key	string
value	string