Ověření nároku na propagační akci

Článek
09/27/2024

Platí pro

Partnerské centrum

Odpovídající role

Agent pro správu

Poznámka:

Nové komerční prostředí pro služby založené na licencích zahrnují mnoho nových funkcí a jsou k dispozici pro všechny poskytovatele cloudových řešení (CSP). Další informace najdete v přehledu nových obchodních prostředí.

Partery můžou ověřit, jestli má transakce zákazníka nárok na danou propagační akci. Tato metoda vrátí hodnotu True , pokud má transakce zákazníka nárok na danou povýšení. Partneři můžou ověřit způsobilost před odesláním transakce, aby se zajistilo, že se povýšení použije.

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.
Způsobilost zahrnuje zakoupenou dostupnost skladové položky produktu, ID povýšení, které se vyhodnocuje, množství, doba trvání a fakturační cyklus transakce.
Míra omezování tohoto rozhraní API maximálně 625 požadavků za minutu (RPM) na partnerského tenanta. Volání, která překročí limit, způsobí odpověď HTTP 429. Informace o omezování najdete v doprovodných materiálech k omezování.

Požadavek REST

Syntaxe požadavku

metoda	Identifikátor URI žádosti
POST	{baseURL}/v1/customers/{customerId}/promotionEligibilities HTTP/1.1

Parametr identifikátoru URI

K vrácení dostupných propagačních akcí použijte následující parametry dotazu.

Name	Type	Požadováno	Popis
customerId	string	Y	Hodnota je IDENTIFIKÁTOR GUID formátovaný id tenanta zákazníka, což je identifikátor, který umožňuje zadat zákazníka.

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Tělo obsahuje kolekci PromotionEligibilitiesRequestItems. Tato tabulka popisuje vlastnosti PromotionEligibilitiesRequestItem.

Vlastnost	Typ	Požadováno	Popis
catalogItemId	string	Ano	Identifikátor položky katalogu.
množství.	int	Ano	Počet licencí nebo instancí.
termDuration	DateTime	Ano	Reprezentace doby trvání období iso 8601. Aktuální podporované hodnoty jsou P1M (jeden měsíc), P1Y (jeden rok) a P3Y (tři roky).
billingCycle	string	Ano	Hodnota, která označuje typ fakturačního cyklu.
promotionId	string	No	Identifikátor položky povýšení.

Příklad požadavku

POST https://api.partnercenter.microsoft.com/v1/customers/46632f71-f052-4384-8f84-4cdb6c12c2a1/promotionEligibilities 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

 // Request example with promotion ID input
{
    "items": [
        {
            "catalogItemId": "CFQ7TTC0LH2Z:0002:CFQ7TTC0HRVK",
            "quantity": 2400,
            "termDuration": "P1Y",
            "billingCycle": "Monthly",
            "promotionId": "39NFJQT1PM6C:0005:39NFJQT1Q5L7"
        }
    ]
}

POST https://api.partnercenter.microsoft.com/v1/customers/46632f71-f052-4384-8f84-4cdb6c12c2a1/promotionEligibilities HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70b
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
X-Locale: en-US

 // Request example with no promotion ID input
{
    "items": [
        {
            "id": "0",
            "catalogItemId": "CFQ7TTC0HBSJ:0001:CFQ7TTC0JQH3",
            "quantity": 300,
            "termDuration": "P1M",
            "billingCycle": "monthly"
        }
    ]
}

Odpověď REST

Pokud je zadaný identifikátor promotionId a požadavek je úspěšný, vrátí tato metoda kolekci výsledků způsobilosti. Pokud propagační ID není zadané a požadavek je úspěšný, vrátí tato metoda všechny propagační akce dostupné pro zadanou nabídku a odpovídající nárok zákazníka na každou propagační akci.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který indikuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb.

Typy a popisy chyb způsobilosti

Pokud kontroly způsobilosti určují, že skladová položka produktu, která se vyhodnocuje s ID propagační akce, se nerovná. Různé podmínky a omezení se vyhodnocují a vracejí typy chyb, které popisují podmínky, které nejsou splněny pro způsobilost.

Typ chyby způsobilosti	Popis chyby způsobilosti
InvalidCatalogItemId	Poskytnutá vlastnost CatalogItemId je neplatná.
InvalidPromotion	Poskytnuté zvýšení úrovně je neplatné.
PrerequisiteProductOwnership	Zákazník nesplňuje požadavky na vlastnictví produktu, které by měly být způsobilé pro tuto propagační akci.
RedemptionLimit	Bylo dosaženo limitu uplatnění pro tuto propagační akci.
SeatCount	Zadané množství nevyhovuje minimálním nebo maximálním požadavkům na sedadlo pro povýšení.
OfferPurchasedPreviously	Tato nabídka byla pro tohoto zákazníka zakoupena dříve.
Období	Zadaný termín se nevztahuje na povýšení.
NoPromotionsAvailable	V tuto chvíli nejsou k dispozici žádné propagační akce.

Příklad odpovědi

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, 26 Feb 2021 20:42:26 GMT

// Response example with promotion ID provided in the request
{
    "totalCount": 1,
    "items": [
        {
            "id": 0,
            "catalogItemId": "CFQ7TTC0LH2Z:0002:CFQ7TTC0HRVK",
            "quantity": 2400,
            "billingCycle": "monthly",
            "termDuration": "P1Y",
            "eligibilities": [
                {
                    "promotionId": "39NFJQT1PM6C:0005:39NFJQT1Q5L7",
                    "isEligible": false,
                    "errors": [
                        {
                            "minimumRequiredSeats": 1,
                            "maximumRequiredSeats": 2400,
                            "availableSeats": 500,
                            "type": "SeatCount",
                            "description": "The provided quantity does not satisfy the minimum or maximum seat requirements for the promotion."
                        }
                    ]
                }
            ],
            "attributes": {
                "objectType": "PromotionEligibilities"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70b
Date: Fri, 26 Feb 2021 20:42:26 GMT

// Response example with no promotion ID provided in the request
{
    "totalCount": 1,
    "items": [
        {
            "id": 0,
            "catalogItemId": "CFQ7TTC0HBSJ:0001:CFQ7TTC0JQH3",
            "quantity": 300,
            "billingCycle": "monthly",
            "termDuration": "P1M",
            "eligibilities": [
                {
                    "promotionId": "39NFJQT1XK5L:000J:39NFJQT1Q5D8",
                    "isEligible": true
                },
                {
                    "promotionId": "39NFJQT1XG89:0002:39NFJQT1Q5L2",
                    "isEligible": true
                }
            ],
            "attributes": {
                "objectType": "PromotionEligibilities"
            }
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

Sdílet prostřednictvím