Annuler une commande à partir du bac à sable d’intégration à l’aide des API de l’Espace partenaires

Article
03/15/2024

S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government

Cet article explique comment utiliser les API de l’Espace partenaires pour annuler différents types de commandes d’abonnement à partir de comptes de bac à sable d’intégration. Ces commandes peuvent inclure des instances réservées, des logiciels et des commandes d’abonnement SaaS (Software as a Service).

Le tableau suivant indique l’ordre d’annulation dans le bac à sable et la production.

Type de produit	Ordre de mise à jour du bac à sable	Abonnement à la mise à jour du bac à sable	Ordre de mise à jour de production	Abonnement de mise à jour de production
Instances réservées Azure	O	N	N	N
Logiciels perpétuels	O	N	Y	N
Abonnements à des logiciels	O	O	O	O
Nouveau commerce	N	Y	N	O
Place de marché commerciale	N	Y	N	O
plan Azure	N	Y	N	O

Remarque

Les annulations d’une instance réservée ou de commandes d’abonnement SaaS de la Place de marché commerciale ne sont possibles qu’à partir de comptes de bac à sable d’intégration. Toutes les commandes de bac à sable antérieures à 60 jours ne peuvent pas être annulées à partir de l’Espace partenaires.

Pour annuler les commandes de production de logiciels par le biais de l’API, utilisez cancel-software-purchases. Vous pouvez également annuler les commandes de production de logiciels via le tableau de bord à l’aide d’annuler un achat.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.
Un compte partenaire de bac à sable d’intégration avec un client disposant d’une instance réservée active/ de logiciels / commandes d’abonnement SaaS tierces.

C#

Pour annuler une commande à partir du bac à sable d’intégration, transmettez vos informations d’identification de compte à la CreatePartnerOperations méthode pour obtenir une IPartner interface pour obtenir des opérations de partenaire.

Pour sélectionner une commande particulière, utilisez les opérations de partenaire et la méthode d’appel Customers.ById() avec l’identificateur du client pour spécifier le client, suivie de Orders.ById() l’identificateur de commande pour spécifier la commande et enfin Get ou GetAsync la méthode pour la récupérer.

Définissez la propriété et cancelled utilisez la Patch()Order.Status méthode pour mettre à jour l’ordre.

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

Demande REST

Syntaxe de la requête

Méthode	URI de demande
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

Paramètre d’URI

Utilisez le paramètre de requête suivant pour supprimer un client.

Nom	Type	Requise	Description
id-locataire-client	guid	Y	La valeur est un ID client au format GUID qui permet au revendeur de filtrer les résultats d’un client donné qui appartient au revendeur.
order-id	string	O	La valeur est une chaîne indiquant les ID de commande qui doivent être annulés.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

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

Exemple de requête

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

Réponse REST

Si elle réussit, cette méthode retourne l’ordre annulé.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et plus d’informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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

Partager via