Get promotions
Applies To
- Partner Center
Appropriate roles
- Global admin
- Admin agent
Note
The new commerce experiences for license-based services include many new capabilities and are available to all Cloud Solution Provider (CSPs). For more information, see new commerce experiences overview.
Partners can get a list of active new commerce promotions for a given market (country/region) and segment. This method returns available current promotions based on the promotions available start and end dates.
Prerequisites
Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
Segment represents the type of customer the promotions are enabled for. Currently supports only commercial.
Country represents the customer country/region promotions are available for. Country is represented by a two character country code.
REST request
[GET] /v1/productpromotions?country={country-code}&segment={segment}
Request syntax
Method | Request URI |
---|---|
GET | {baseURL}/v1/productpromotions?country={country-code}&segment={segment} HTTP/1.1 |
URI parameter
Use the following query parameters to return available promotions.
Name | Type | Required | Description |
---|---|---|---|
segment | string | Y | A string that determines which promotions are available for a given segment. |
country | string | Y | A two letter country code determining which customer country/region promotions are available for. |
Request headers
For more information, see Partner Center REST headers.
Request body
None
Request example
GET https://api.partnercenter.microsoft.com/v1/productpromotions?country=US&segment=commercial HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
X-Locale: en-US
REST response
If successful, this method returns a list of promotions.
Response success and error codes
Each response comes with an HTTP status code that indicates success or failure and more debugging information. Use a network trace tool to read this code, error type, and more parameters. For the full list, see Error Codes.
Response example
HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT
{
"totalCount": 2,
"items": [
{
"id": "39NFJQT1PJQB:0001:39NFJQT1Q5KN",
"name": "Visio Plan 1",
"description": "Visio Plan 1",
"startDate": "2021-09-23T00:00:00+00:00",
"endDate": "2021-10-14T23:59:59+00:00",
"properties": {
"isAutoApplicable": true
},
"requiredProducts": [
{
"productId": "CFQ7TTC0HD33",
"skuId": "0003",
"term": {
"duration": "P1Y",
"billingCycle": "Annual"
},
"pricingPolicies": [
{
"policyType": "PercentDiscount",
"value": "0.05"
}
]
}
]
},
{
"id": "39NFJQT1PJQC:0001:39NFJQT1Q5KM",
"name": "Vision Plan 1",
"description": "Vision Plan 1",
"startDate": "2021-09-23T00:00:00+00:00",
"endDate": "2021-10-14T23:59:59+00:00",
"properties": {
"isAutoApplicable": true
},
"requiredProducts": [
{
"productId": "CFQ7TTC0HD33",
"skuId": "0003",
"term": {
"duration": "P1Y",
"billingCycle": "Monthly"
},
"pricingPolicies": [
{
"policyType": "PercentDiscount",
"value": "0.167"
}
]
}
]
}
],
"attributes": {
"objectType": "Collection"
}
}