Hämta befordran efter ID
Gäller för
- Partnercenter
Lämpliga roller
- Administratörsagent
Anteckning
De nya handelsupplevelserna för licensbaserade tjänster innehåller många nya funktioner och är tillgängliga för alla Molnlösningsleverantör (CSP:er). För mer information, se översikten över nya handelsupplevelser.
Partner kan få en enda kampanj för ett visst kampanj-ID och land/region. Den här metoden returnerar kampanjdata och ignorerar start- och slutdatum för befordran. Den här metoden används främst i avstämningssyfte för att hämta kampanjinformation även efter att kampanjen har upphört att gälla.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Kampanj-ID är avgränsad uppsättning strängar som representerar en specifik kampanj.
Landet visar vilka kampanjer som är tillgängliga för kundens land/region. Landet representeras av en landskod med två tecken.
REST-begäran
Syntax för förfrågan
Metod | URI för förfrågan |
---|---|
GET | {baseURL}/v1/productpromotions/{promotion-id}?country={country-code} HTTP/1.1 |
URI-parametern
Använd följande frågeparametrar för att returnera tillgängliga kampanjer.
Namn | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
promotion-id | sträng | Y | En sträng som definierar befordran som ska hämtas. |
land | sträng | Y | En landskod med två bokstäver som avgör vilka kampanjer för kundens land/region som är tillgängliga för. |
Begärandehuvuden
För mer information, se Partner Center REST-huvuden.
Begärandetext
Ingen
Kampanjbegränsningar
Kampanjbegränsningar returneras nu av det här API:et. Se exempel i svaret nedan. Om en kampanj har berättigandebegränsningar returneras information i svaret. Dessa data kan användas för att förstå om kunden kvalificerar sig för rabatten.
Begränsningskategori | Villkorsvärde | Villkorstyp | Beskrivning |
---|---|---|---|
Sittplatsbegränsningar | MinSeats | Prenumerationskvantitet | Minsta antal platser som krävs för att kunden ska vara berättigad till kampanjen. |
Sittplatsbegränsningar | MaxSeats | Prenumerationskvantitet | Maximalt antal platser som kampanjen kan tillämpas på. |
AssetOwnershipLimits | MinAssets | Livstidinlösenantal | Det minsta antalet gånger som kampanjen kan användas för en kund, vanligtvis 0. |
AssetOwnershipLimits | MaxAssets | Livstidsinlösningsantal | Det maximala antalet gånger som kampanjen kan användas för kunden. |
Behörighetsbegränsningar | ärTillämpligt | FirstPurchase | Flagga som anger om detta måste vara kundens första köp av produktens SKU för att ta emot kampanjen. |
Produktägandebegränsningar | bigId | Ej tillämpligt | Angivna erbjudanden som kunden redan måste äga för att vara berättigad till kampanjen (Produkt-SKU). |
Exempel på begäran
GET https://api.partnercenter.microsoft.com/v1/productpromotions/CFQ7TTC0HD33:0003:CFQ7TTC0K59M?country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
REST-svar
Om det lyckas returnerar den här metoden en enda befordran.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och mer felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Felkoder.
Svarsexempel
HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 24 Apr 2023 20:42:26 GMT
{
"id": "39NFJQT1SNC7:0001:39NFJQT1Q5KM",
"name": "TEST Promotion May 2023 - Microsoft 365 F3",
"description": "TEST Promotion May 2023 - Microsoft 365 F3",
"startDate": "2023-05-03T00:00:00+00:00",
"endDate": "9999-01-01T00:00:00+00:00",
"properties": {
"isAutoApplicable": true
},
"requiredProducts": [
{
"productId": "CFQ7TTC0LH05",
"skuId": "0001",
"term": {
"duration": "P1Y",
"billingCycle": "Annual"
},
"pricingPolicies": [
{
"policyType": "PercentDiscount",
"value": "0.5"
}
]
}
],
"promotionConstraints": {
"seatConstraints": [
{
"minSeats": 10,
"maxSeats": 100,
"type": "SubscriptionQuantity"
}
],
"assetOwnershipLimits": [
{
"minAssets": 0,
"maxAssets": 3,
"type": "LifetimeRedemptionCount"
}
],
"eligibilityConstraints": [
{
"isApplicable": true,
"type": "FirstPurchase"
}
],
"productOwnershipConstraints": [
[
{
"bigId": "CFQ7TTC0MBMD/0002"
}
]
]
}
}