Membatalkan pesanan dari kotak pasir integrasi menggunakan API Pusat Mitra

Artikel
03/15/2024

Berlaku untuk: Pusat Mitra | Pusat Mitra yang dioperasikan oleh 21Vianet | Pusat Mitra untuk Microsoft Cloud untuk Pemerintah AS

Artikel ini menjelaskan cara menggunakan API Pusat Mitra untuk membatalkan berbagai jenis pesanan langganan dari akun kotak pasir integrasi. Pesanan tersebut dapat mencakup instans cadangan, perangkat lunak, dan pesanan langganan Software as a Service (SaaS) marketplace komersial.

Tabel berikut ini memperlihatkan urutan pembatalan dalam kotak pasir dan produksi.

Jenis produk	Urutan pembaruan kotak pasir	Langganan pembaruan kotak pasir	Urutan pembaruan produksi	Langganan pembaruan produksi
Instans Cadangan Azure	Y	N	N	N
Perangkat lunak abadi	Y	N	Y	N
Mengelola langganan perangkat lunak	Y	Y	Y	Y
Perdagangan baru	N	Y	N	Y
Pasar komersial	N	Y	N	Y
Paket Azure	N	Y	N	Y

Catatan

Pembatalan instans yang dipesan, atau pesanan langganan SaaS marketplace komersial hanya dimungkinkan dari akun sandbox integrasi. Setiap pesanan kotak pasir yang lebih lama dari 60 hari tidak dapat dibatalkan dari Pusat Mitra.

Untuk membatalkan pesanan produksi perangkat lunak melalui API, gunakan cancel-software-purchases. Anda juga dapat membatalkan pesanan produksi perangkat lunak melalui dasbor menggunakan pembatalan pembelian.

Prasyarat

Kredensial seperti yang dijelaskan dalam autentikasi Pusat Mitra. Skenario ini mendukung autentikasi dengan kredensial Aplikasi mandiri dan Aplikasi+Pengguna.
Akun mitra kotak pasir integrasi dengan pelanggan yang memiliki instans / perangkat lunak / pesanan langganan SaaS pihak ketiga yang aktif.

C#

Untuk membatalkan pesanan dari kotak pasir integrasi, teruskan kredensial akun Anda ke CreatePartnerOperations metode untuk mendapatkan IPartner antarmuka untuk mendapatkan operasi mitra.

Untuk memilih Pesanan tertentu, gunakan operasi mitra dan metode panggilan Customers.ById() dengan pengidentifikasi pelanggan untuk menentukan pelanggan, diikuti Orders.ById() dengan pengidentifikasi pesanan untuk menentukan pesanan dan akhirnya Get atau GetAsync metode untuk mengambilnya.

Atur Order.Status properti ke cancelled dan gunakan Patch() metode untuk memperbarui pesanan.

// 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);

Permintaan REST

Minta sintaks

Metode	URI Permintaan
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

Parameter URI

Gunakan parameter kueri berikut untuk menghapus pelanggan.

Nama	Tipe	Wajib	Deskripsi
customer-tenant-id	Guid	Y	Nilainya adalah id-penyewa pelanggan berformat GUID yang memungkinkan reseller memfilter hasil untuk pelanggan tertentu milik penjual.
id pesanan	tali	Y	Nilainya adalah string yang menunjukkan ID pesanan yang perlu dibatalkan.

Header permintaan

Untuk informasi selengkapnya, lihat Header REST Pusat Mitra.

Isi permintaan

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

Contoh permintaan

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: 1438ea3d-b515-45c7-9ec1-27ee0cc8e6bd

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

Respons REST

Jika berhasil, metode ini mengembalikan pesanan yang dibatalkan.

Kode kesalahan dan keberhasilan respons

Setiap respons dilengkapi dengan kode status HTTP yang menunjukkan keberhasilan atau kegagalan dan informasi penelusuran kesalahan lainnya. Gunakan alat pelacakan jaringan untuk membaca kode ini, jenis kesalahan, dan parameter lainnya. Untuk daftar lengkapnya, lihat Kode kesalahan REST Pusat Mitra.

Contoh tanggapan

HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: 1438ea3d-b515-45c7-9ec1-27ee0cc8e6bd
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"
    }
}

Bagikan melalui