Promotie ophalen op id

  • Artikel

Van toepassing op

  • Partnercentrum

Juiste rollen

  • Algemene beheerder
  • Beheer agent

Notitie

De nieuwe commerce-ervaringen voor services op basis van licenties omvatten veel nieuwe mogelijkheden en zijn beschikbaar voor alle CSP's (Cloud Solution Provider). Zie het overzicht van nieuwe commerce-ervaringen voor meer informatie.

Partners kunnen één promotie krijgen voor een bepaalde promotie-id en land/regio. Deze methode retourneert de promotiegegevens, waarbij de begin- en einddatum van de promotie worden genegeerd. Deze methode wordt voornamelijk gebruikt voor afstemmingsdoeleinden om promotiedetails op te halen, zelfs nadat de promotie is verlopen.

Vereisten

  • Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.

  • Promotie-id is een gescheiden set tekenreeksen die een specifieke promotie vertegenwoordigen.

  • Het land vertegenwoordigt de promoties van het klantland of de regio zijn beschikbaar voor. Land wordt vertegenwoordigd door een landcode van twee tekens.

REST-aanvraag

Aanvraagsyntaxis

Wijze Aanvraag-URI
GET {baseURL}/v1/productpromotions/{promotion-id}?country={country-code HTTP/1.1

URI-parameter

Gebruik de volgende queryparameters om beschikbare promoties te retourneren.

Name Type Vereist Beschrijving
promotie-id Tekenreeks J Een tekenreeks die de promotie definieert die moet worden opgehaald.
Land Tekenreeks J Een landcode van twee letters die bepaalt voor welke klantland-/regiopromoties beschikbaar zijn.

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

Geen

Promotiebeperkingen

Promotiebeperkingen worden nu geretourneerd door deze API. Zie voorbeelden in het onderstaande antwoord. Als een promotie geschiktheidsbeperkingen heeft, worden details geretourneerd in het antwoord. Deze gegevens kunnen worden gebruikt om te begrijpen of uw klant in aanmerking komt voor de korting.

Categorie beperking Beperkingswaarde Type beperking Beschrijving
SeatConstraints MinSeats SubscriptionQuantity Minimale seats die nodig zijn voor de klant om in aanmerking te komen voor de promotie.
SeatConstraints MaxSeats SubscriptionQuantity Maximum aantal plaatsen waar de promotie op kan worden toegepast.
AssetOwnershipLimits MinAssets LifetimeRedemptionCount Het minimale aantal keren dat de promotie kan worden toegepast voor een klant, meestal 0.
AssetOwnershipLimits MaxAssets LifetimeRedemptionCount Het maximum aantal keren dat de promotie kan worden aangevraagd voor de klant.
EligibilityConstraints isApplicable FirstPurchase Vlag die aangeeft of dit de eerste aankoop van de product-SKU van de klant moet zijn om de promotie te ontvangen.
ProductOwnershipConstraints bigId N.v.t. Opgegeven aanbiedingen die de klant al moet bezitten om in aanmerking te komen voor de promotie (Product-SKU).

Aanvraagvoorbeeld

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: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
X-Locale: en-US

REST-antwoord

Als dit lukt, retourneert deze methode één promotie.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het succes of de fout optreedt en meer informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie Foutcodes voor de volledige lijst.

Responsvoorbeeld

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, 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"
                }
            ]
        ]
    }
}