Obter promoções
Aplica-se a
- Partner Center
Funções apropriadas
- 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 lista de promoções ativas de novos comércios para um determinado mercado (país/região) e segmento. Esse método retorna as promoções atuais disponíveis com base nas datas de início e término das promoções disponíveis.
Pré-requisitos
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Segmento representa o tipo de cliente para o qual as promoções estão habilitadas. Atualmente suporta apenas comercial.
País representa o país do cliente para o qual as promoções de país/região estão disponíveis. País é representado por um código de país de dois caracteres.
Solicitação REST
[GET] /v1/productpromotions?country={country-code}&segment={segment}
Sintaxe da solicitação
Método | URI da solicitação |
---|---|
GET | {baseURL}/v1/productpromotions?country={country-code}&segment={segment} 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 |
---|---|---|---|
segmento | cadeia de caracteres | Y | Uma string que determina quais promoções estão disponíveis para um determinado segmento. |
country | cadeia de caracteres | Y | Um código de país de duas letras que determina para qual país/região do cliente as promoções 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
Exemplo de solicitação
GET https://api.partnercenter.microsoft.com/v1/productpromotions?country=US&segment=commercial 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 REST
Se for bem-sucedido, esse método retornará uma lista de promoções.
Códigos de êxito e de erro de resposta
Cada resposta vem com um código de status HTTP que indica êxito 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 mais 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: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT
{
"totalCount": 2,
"items": [
{
"id": "39NFJQT1PJQB:0001:39NFJQT1Q5KN",
"name": "Visio Plan 1",
"description": "Visio Plan 1",
"startDate": "2021-09-23T00:00:00+00:00",
"endDate": "2021-10-14T23:59:59+00:00",
"properties": {
"isAutoApplicable": true
},
"requiredProducts": [
{
"productId": "CFQ7TTC0HD33",
"skuId": "0003",
"term": {
"duration": "P1Y",
"billingCycle": "Annual"
},
"pricingPolicies": [
{
"policyType": "PercentDiscount",
"value": "0.05"
}
]
}
]
},
{
"id": "39NFJQT1PJQC:0001:39NFJQT1Q5KM",
"name": "Vision Plan 1",
"description": "Vision Plan 1",
"startDate": "2021-09-23T00:00:00+00:00",
"endDate": "2021-10-14T23:59:59+00:00",
"properties": {
"isAutoApplicable": true
},
"requiredProducts": [
{
"productId": "CFQ7TTC0HD33",
"skuId": "0003",
"term": {
"duration": "P1Y",
"billingCycle": "Monthly"
},
"pricingPolicies": [
{
"policyType": "PercentDiscount",
"value": "0.167"
}
]
}
]
}
],
"attributes": {
"objectType": "Collection"
}
}