Obter promoção por ID

Artigo
09/27/2024

Aplica-se a

Partner Center

Funções apropriadas

Agente administrativo

Nota

As novas experiências de comércio para serviços baseados em licença incluem muitos recursos novos e estão disponíveis para todos os CSPs (Provedor de Soluções na Nuvem). Para obter mais informações, consulte Visão geral de novas experiências comerciais.

Os parceiros podem obter uma única promoção para um determinado ID de promoção e país/região. Esse método retorna os dados da promoção, ignorando as datas de início e término da promoção. Esse método é usado principalmente para fins de reconciliação para recuperar detalhes da promoção, mesmo depois que a promoção expirou.

Pré-requisitos

Credenciais conforme descrito na autenticação do Partner Center. Este cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
ID de promoção é um conjunto delimitado de cadeias de caracteres que representam uma promoção específica.
O país representa o país/região do cliente para o qual as promoções estão disponíveis. O país é representado por um código de país de dois caracteres.

Pedido REST

Sintaxe da solicitação

Método	URI do pedido
GET	{baseURL}/v1/productpromotions/{promotion-id}?country={código de país HTTP/1.1

Parâmetro URI

Use os seguintes parâmetros de consulta para retornar as promoções disponíveis.

Nome	Type	Obrigatório	Description
ID da promoção	string	Y	Uma cadeia de caracteres que define a promoção a ser recuperada.
país	string	Y	Um código de país de duas letras que determina para quais promoções de país/região do cliente estão disponíveis.

Cabeçalhos do pedido

Para obter mais informações, consulte Cabeçalhos REST do Partner Center.

Corpo do pedido

Nenhuma

Restrições promocionais

As restrições promocionais agora são retornadas por esta API. Veja exemplos na resposta abaixo. Se uma promoção tiver restrições de elegibilidade, os detalhes serão retornados na resposta. Esses dados podem ser usados para entender se o seu cliente se qualifica para o desconto.

Categoria de restrição	Valor da restrição	Tipo de restrição	Description
SeatConstraints	MinSeats	SubscriçãoQuantidade	Assentos mínimos necessários para que o cliente seja elegível para a promoção.
SeatConstraints	MaxSeats	SubscriçãoQuantidade	Máximo de lugares a que a promoção pode ser aplicada.
AssetOwnershipLimits	MinAssets	LifetimeRedemptionCount	O número mínimo de vezes que a promoção pode ser aplicada a um cliente, normalmente 0.
AssetOwnershipLimits	MaxAtivos	LifetimeRedemptionCount	O número máximo de vezes que a promoção pode ser aplicada para o cliente.
ElegibilidadeRestrições	isAplicável	Primeira Compra	Sinalizador indicando se esta deve ser a primeira compra do produto SKU pelo cliente para receber a promoção.
ProductOwnershipConstraints	bigId	N/A	Ofertas especificadas que o cliente já deve possuir para ser elegível para a promoção (SKU do produto).

Exemplo de solicitação

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

Resposta do REST

Se for bem-sucedido, esse método retornará uma única promoção.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e mais informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, consulte Códigos de erro.

Exemplo de resposta

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

Partilhar via