Anulowanie zamówienia z piaskownicy integracji przy użyciu interfejsów API Centrum partnerskiego

Artykuł
03/15/2024

Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA

W tym artykule opisano sposób używania interfejsów API Centrum partnerskiego do anulowania różnych typów zamówień subskrypcji z poziomu kont piaskownicy integracji. Takie zamówienia mogą obejmować wystąpienia zarezerwowane, oprogramowanie i komercyjne zamówienia subskrypcji oprogramowania jako usługi (SaaS).

W poniższej tabeli przedstawiono kolejność anulowania w piaskownicy i środowisku produkcyjnym.

Typ produktu	Kolejność aktualizacji piaskownicy	Subskrypcja aktualizacji piaskownicy	Kolejność aktualizacji produkcyjnych	Subskrypcja aktualizacji produkcyjnej
Wystąpienia zarezerwowane platformy Azure	Y	N	N	N
Oprogramowanie bezterminowe	Y	N	Y	N
Subskrypcje oprogramowania	Y	Y	Y	Y
Nowy handel	N	Y	N	Y
Komercyjna platforma handlowa	N	Y	N	Y
plan platformy Azure	N	Y	N	Y

Uwaga

Anulowanie wystąpienia zarezerwowanego lub komercyjnych zamówień subskrypcji SaaS na platformie handlowej jest możliwe tylko na kontach piaskownicy integracji. Nie można anulować żadnych zamówień piaskownicy starszych niż 60 dni w Centrum partnerskim.

Aby anulować zamówienia produkcyjne oprogramowania za pośrednictwem interfejsu API, użyj opcji cancel-software-purchases. Możesz również anulować zamówienia produkcyjne oprogramowania za pośrednictwem pulpitu nawigacyjnego przy użyciu anulowania zakupu.

Wymagania wstępne

Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
Konto partnera piaskownicy integracji z klientem z aktywnym wystąpieniem zarezerwowanym/ oprogramowaniem/ zamówieniami subskrypcji SaaS innych firm.

C#

Aby anulować zamówienie z piaskownicy integracji, przekaż poświadczenia konta do CreatePartnerOperations metody w celu uzyskania interfejsu IPartner w celu uzyskania operacji partnerskich.

Aby wybrać określone zamówienie, użyj operacji partnerów i wywołaj Customers.ById() metodę z identyfikatorem klienta, aby określić klienta, a następnie Orders.ById() z identyfikatorem zamówienia, aby określić zamówienie i na koniec Get lub GetAsync metodę, aby go pobrać.

Order.Status Ustaw właściwość na cancelled i użyj Patch() metody , aby zaktualizować kolejność.

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

Żądanie REST

Składnia żądania

Method	Identyfikator URI żądania
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

Parametr identyfikatora URI

Użyj następującego parametru zapytania, aby usunąć klienta.

Nazwisko	Type	Wymagania	opis
identyfikator dzierżawy klienta	guid	Y	Wartość to identyfikator GUID sformatowany jako customer-tenant-id , który umożliwia odsprzedawcy filtrowanie wyników dla danego klienta należącego do odsprzedawcy.
order-id	string	Y	Wartość jest ciągiem oznaczającym identyfikatory zamówień, które należy anulować.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

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

Przykład żądania

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

Odpowiedź REST

W przypadku powodzenia ta metoda zwraca anulowane zamówienie.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i więcej informacji o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykład odpowiedzi

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

Udostępnij za pośrednictwem