使用合作夥伴中心 API 從整合沙箱取消訂單

發行項
03/15/2024

適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府Microsoft雲端合作夥伴中心

本文說明如何使用合作夥伴中心 API，從整合沙盒帳戶取消不同類型的訂用帳戶訂單。這類訂單可以包含保留實例、軟體和商業市集軟體即服務（SaaS）訂用帳戶訂單。

下表顯示沙箱和生產環境的取消順序。

產品類型	沙箱更新順序	沙箱更新訂用帳戶	生產更新訂單	生產更新訂閱
Azure 保留執行個體	是	N	N	N
永久軟體	是	N	Y	否
軟體訂用帳戶	Y	Y	Y	Y
新商務	否	Y	N	是
商務 Marketplace	否	Y	N	是
Azure 方案	否	Y	N	是

注意

只有整合沙盒帳戶才能取消保留實例或商業市集 SaaS 訂用帳戶訂單。任何超過 60 天的沙箱訂單都無法從合作夥伴中心取消。

若要透過 API 取消軟體的生產訂單，請使用 cancel-software-purchases。您也可以使用取消購買，透過儀錶板取消軟體的生產訂單。

必要條件

認證，如合作夥伴中心驗證所述。此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
整合沙盒合作夥伴帳戶，與客戶擁有作用中的保留實例/軟體/第三方 SaaS 訂用帳戶訂單。

C#

若要從整合沙箱取消訂單，請將您的帳戶認證傳遞至 CreatePartnerOperations 方法，以取得介面以取得 IPartner 合作夥伴作業。

若要選取特定訂單，請使用合作夥伴作業和呼叫 Customers.ById() 方法搭配客戶標識碼來指定客戶，後面接著 Orders.ById() 訂單標識碼來指定訂單，最後 Get 或 GetAsync 方法可擷取訂單。

將 Order.Status 屬性設定為 cancelled ，並使用 Patch() 方法來更新順序。

// IPartnerCredentials tipAccountCredentials;
// Customer tenant Id to be deleted.
// string customerTenantId;

IPartner tipAccountPartnerOperations = PartnerService.Instance.CreatePartnerOperations(tipAccountCredentials);

// Cancel order
var order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Get();
order.Status = "cancelled";
order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Patch(order);

REST 要求

要求語法

方法	要求 URI
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

URI 參數

使用下列查詢參數來刪除客戶。

名稱	類型	必要	描述
customer-tenant-id	guid	Y	此值是 GUID 格式的客戶租使用者識別碼，可讓轉銷商篩選屬於轉銷商之指定客戶的結果。
order-id	string	Y	值是字串，表示需要取消的順序標識碼。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "status": "cancelled",
}

要求範例

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/orders/<order-id> HTTP/1.1
Accept: application/json
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "status": "cancelled",
}

REST 回應

如果成功，這個方法會傳回取消的訂單。

回應成功和錯誤碼

每個回應都有一個 HTTP 狀態代碼，指出成功或失敗，以及更多偵錯資訊。使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。如需完整清單，請參閱合作夥伴中心的 REST 錯誤碼。

回應範例

HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "alternateId": "11fc4bdfd47a",
    "referenceCustomerId": "bd59b416-37f9-4d8f-8df3-5750111fc615",
    "billingCycle": "one_time",
    "currencyCode": "USD",
    "currencySymbol": "$",
    "lineItems": [
        {
            "lineItemNumber": 0,
            "offerId": "DG7GMGF0DWT0:0001:DG7GMGF0DSQR",
            "termDuration": "",
            "transactionType": "New",
            "friendlyName": "Microsoft Identity Manager 2016 - 1 User CAL",
            "quantity": 1,
            "links": {
                "product": {
                    "uri": "/products/DG7GMGF0DWT0?country=US",
                    "method": "GET",
                    "headers": []
                },
                "sku": {
                    "uri": "/products/DG7GMGF0DWT0/skus/0001?country=US",
                    "method": "GET",
                    "headers": []
                },
                "availability": {
                    "uri": "/products/DG7GMGF0DWT0/skus/0001/availabilities/DG7GMGF0DSQR?country=US",
                    "method": "GET",
                    "headers": []
                }
            }
        }
    ],
    "creationDate": "2019-02-21T17:56:21.1335741Z",
    "status": "cancelled",
    "transactionType": "UserPurchase",
    "attributes": {
        "objectType": "Order"
    }
}

共用方式為