Obter promoção por ID

  • Artigo

Aplica-se a

  • Partner Center

Funções apropriadas

  • Administrador global
  • Agente de administração

Observação

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 (provedores de soluções em nuvem). Para obter mais informações, confira a visão geral das novas experiências de comércio.

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 em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.

  • A ID da promoção é um conjunto delimitado de cadeias de caracteres que representam uma promoção específica.

  • País representa o país do cliente / região para o qual as promoções estão disponíveis. O país é representado por um código de país de dois caracteres.

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
GET {baseURL}/v1/productpromotions/{promotion-id}?country={código do país HTTP/1.1

Parâmetro do URI

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

Nome Digitar Obrigatória Descrição
ID da Promoção cadeia de caracteres Y Uma cadeia de caracteres que define a promoção a ser recuperada.
country cadeia de caracteres 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 da solicitação

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

Corpo da solicitação

Nenhum

Restrições promocionais

As restrições promocionais agora são retornadas por essa API. Veja exemplos na resposta abaixo. Se uma promoção tiver restrições de qualificação, 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 Descrição
Restrições de assento MinAssentos SubscriptionQuantity Assentos mínimos necessários para que o cliente seja elegível para a promoção.
Restrições de assento MaxAssentos SubscriptionQuantity Máximo de assentos aos quais a promoção pode ser aplicada.
Limites de Propriedade de Ativos Ativos Mínimos LifetimeRedemptionCount O número mínimo de vezes que a promoção pode ser aplicada para um cliente, normalmente 0.
Limites de Propriedade de Ativos MaxAtivos LifetimeRedemptionCount O número máximo de vezes que a promoção pode ser aplicada ao cliente.
ElegibilidadeRestrições éAplicável Primeira Compra Sinalizador indicando se esta deve ser a primeira compra do SKU do produto pelo cliente para receber a promoção.
ProductOwnershipConstraints bigId N/D Ofertas especificadas que o cliente já deve possuir para ser elegível para a promoção (Product SKU).

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

Resposta REST

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

Códigos de êxito e de 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, confira Códigos de Erro.

Exemplo de resposta

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