Promosyon uygunluğunu doğrulama

Makale
03/20/2024

Şunun için geçerlidir:

İş Ortağı Merkezi

Uygun roller

Genel yöneticisi
Yönetici aracısı

Not

Lisans tabanlı hizmetler için yeni ticaret deneyimleri birçok yeni özellik içerir ve tüm Bulut Çözümü Sağlayıcısı (CSP' ler) tarafından kullanılabilir. Daha fazla bilgi için bkz . Yeni ticaret deneyimlerine genel bakış.

Bölümleyiciler, bir müşteri işleminin belirli bir promosyon için uygun olup olmadığını doğrulayabilir. Müşteri işlemi belirli bir promosyon için uygunsa bu yöntem True döndürür. İş ortakları, yükseltmenin uygulandığından emin olmak için işlem göndermeden önce uygunluğu doğrulayabilir.

Önkoşullar

İş Ortağı Merkezi kimlik doğrulamasında açıklandığı gibi kimlik bilgileri. Bu senaryo hem tek başına Uygulama hem de Uygulama+Kullanıcı kimlik bilgileriyle kimlik doğrulamayı destekler.
Uygunluk satın alınan ürün sku kullanılabilirliğini, değerlendirilen promosyon kimliğini, işlemin miktarını, dönem süresini ve faturalama döngüsünü içerir.
Bu API için iş ortağı kiracısı başına dakika başına en fazla 625 istek (RPM) azaltma oranı. Sınırı aşan çağrılar 429 http yanıtına neden olur. Azaltma hakkında bilgi için bkz . azaltma kılavuzu .

REST isteği

İstek söz dizimi

Metot	İstek URI'si
POST	{baseURL}/v1/customers/{customerId}/promotionEligibilities HTTP/1.1

URI parametresi

Kullanılabilir yükseltmeleri döndürmek için aşağıdaki sorgu parametrelerini kullanın.

Adı	Tür	Zorunlu	Açıklama
Customerıd	string	Y	Değer, müşteri belirtmenize olanak tanıyan bir tanımlayıcı olan GUID biçimli customer-tenant-id değeridir.

İstek üst bilgileri

Daha fazla bilgi için bkz . İş Ortağı Merkezi REST üst bilgileri.

Request body

Gövde, PromotionEligibilitiesRequestItems koleksiyonunu içerir. Bu tabloda PromotionEligibilitiesRequestItem özellikleri açıklanmaktadır.

Özellik	Type	Zorunlu	Açıklama
catalogItemId	string	Yes	Katalog öğesi tanımlayıcısı.
quantity	int	Yes	Lisans veya örnek sayısı.
termDuration	Tarih Saat	Yes	Terimin süresinin ISO 8601 gösterimi. Desteklenen geçerli değerler P1M (bir ay), P1Y (bir yıl) ve P3Y (üç yıl) değerleridir.
billingCycle	string	Yes	Faturalama döngüsünün türünü gösteren değer.
promotionId	Dize	Hayır	Promosyon öğesi tanımlayıcısı.

İstek örneği

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

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

REST yanıtı

Bir promotionId sağlanırsa ve istek başarılı olursa, bu yöntem bir uygunluk sonuçları koleksiyonu döndürür. promotionId sağlanmazsa ve istek başarılı olursa, bu yöntem belirtilen teklif için kullanılabilen tüm promosyonları ve her promosyon için ilgili müşteri uygunluğunu döndürür.

Yanıt başarısı ve hata kodları

Her yanıt, başarılı veya başarısız olduğunu belirten bir HTTP durum kodu ve daha fazla hata ayıklama bilgisi ile birlikte gelir. Bu kodu, hata türünü ve diğer parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz . Hata Kodları.

Uygunluk hata türleri ve açıklamaları

Uygunluk denetimleri, promosyon kimliğine göre değerlendirilen ürün SKU'sunun uyumlu olmadığını belirlerse, uygunluk false döndürür. Çeşitli koşullar ve kısıtlamalar değerlendirilir ve uygunluk için karşılanmayan koşulları açıklamak üzere hata türleri döndürür.

Uygunluk hata türü	Uygunluk hatası açıklaması
InvalidCatalogItemId	Sağlanan CatalogItemId geçersiz.
InvalidPromotion	Sağlanan yükseltme geçersiz.
PrerequisiteProductOwnership	Müşteri, bu promosyona uygun olmak için önkoşul ürün sahipliği gereksinimlerini karşılamıyor.
RedemptionLimit	Bu promosyon için kullanım sınırına ulaştık.
SeatCount	Sağlanan miktar, promosyon için minimum veya maksimum koltuk gereksinimlerini karşılamaz.
OfferPurchasedPreviously	Bu teklif daha önce bu müşteri için satın alınmıştır.
Süre	Sağlanan terim promosyon için geçerli değildir.
NoPromotionsAvailable	Şu anda promosyon yok.

Yanıt örneği

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

// 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: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e133
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"
    }
}

Aracılığıyla paylaş