获取促销

项目
09/28/2024

适用于

合作伙伴中心

相应的角色

管理员代理

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商业体验概述。

合作伙伴可以获取给定市场（国家/地区）和细分市场的活动新商务促销列表。此方法根据可用的促销开始日期和结束日期返回可用的当前促销。

先决条件

合作伙伴中心身份验证中所述的凭据。此方案支持使用独立应用和 App+User 凭据进行身份验证。
细分表示启用了促销的客户类型。目前仅支持商业版。
国家/地区表示客户国家/地区促销可供使用。国家/地区由两个字符的国家/地区代码表示。

REST 请求

[GET] /v1/productpromotions？country={country-code}&segment={segment}

请求语法

方法	请求 URI
GET	{baseURL}/v1/productpromotions？country={country-code}&segment={segment} HTTP/1.1

URI 参数

使用以下查询参数返回可用的促销。

名称	类型	必需	说明
段	string	Y	一个字符串，用于确定哪些促销可用于给定段。
country	string	Y	一个两个字母国家/地区代码，用于确定哪些客户国家/地区促销可用。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。

请求正文

无

请求示例

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

REST 响应

如果成功，此方法将返回促销列表。

响应的成功和错误代码

每个响应都有一个 HTTP 状态代码，指示成功或失败以及更多的调试信息。使用网络跟踪工具读取此代码、错误类型和其他参数。有关完整列表，请参阅错误代码。

响应示例

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

通过