Partager via

Gérer les offres privées existantes via l’API

  • Article

Vous pouvez utiliser des API pour supprimer ou retirer des offres privées existantes.

Supprimer une offre privée existante

Utilisez cette méthode pour supprimer une offre privée existante alors qu’elle est toujours à l’état de brouillon. Vous devez utiliser l’ID d’offre privée pour spécifier l’offre privée à supprimer. Pour les offres privées multipartes, seul l’originateur MPO peut supprimer l’offre privée.

Requête

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-07-01

En-tête de requête

En-tête Type Description
Autorisation Chaîne Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>.

Paramètres de la demande

$version - obligatoire. Il s’agit de la version du schéma utilisé dans la requête.

Corps de la demande

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
        {
        "$schema": "https://schema.mp.microsoft.com/schema/private-offer/2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705",
        "privateOfferType": "multipartyPromotionOriginator",
        "state": "deleted"
        }
    ]
}

Response

La réponse contient l’id de travail que vous pouvez utiliser ultérieurement pour interroger l’état.

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "notStarted",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "0001-01-01",
    "errors": []
}

Codes d’erreur

Code d’état HTTP Description
401 Erreur d’authentification : vérifiez que vous utilisez un jeton d’accès Microsoft Entra valide.
400 Validation de schéma. Vérifiez que le corps de votre demande suit le schéma correct et inclut tous les champs obligatoires.

Retirer une offre privée existante

Utilisez cette méthode pour retirer une offre privée existante. Le retrait d’une offre signifie que votre client ne pourra plus y accéder.

Remarque

Pour les offres privées à plusieurs parties, l’éditeur de logiciels indépendants peut retirer une offre privée soumise si le partenaire de canal n’a pas encore publié et l’a rendu disponible pour le client final. Le partenaire de canal ne peut retirer une offre privée publiée que si le client ne l’a pas accepté. Si l’offre privée a déjà été mise à la disposition du client pour accepter et que les éditeurs de logiciels indépendants doivent y apporter des modifications, le partenaire de canal doit d’abord retirer l’offre privée afin que l’ISV puisse ensuite retirer et rétablir l’offre privée à un état brouillon pour apporter des modifications.

Vous devez utiliser l’ID d’offre privée pour spécifier l’offre privée que vous souhaitez retirer.

Requête

POST https://graph.microsoft.com/rp/product-ingestion/configure?$version=2022-07-01

En-tête de requête

En-tête Type Description
Autorisation Chaîne Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>.

Paramètres de la demande

$version - obligatoire. Il s’agit de la version du schéma utilisé dans la requête.

Corps de la demande (pour ISV)

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
         {
        "$schema": "https://schema.mp.microsoft.com/schema/private-offer/ 2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705", 
        "privateOfferType": "multipartyPromotionOriginator",
        "state": "withdrawn"
        }
    ]
}

Corps de la demande (pour le partenaire de canal)

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure/2022-07-01"
     "resources": [
         {
        $schema": "https://schema.mp.microsoft.com/schema/private-offer/ 2023-07-15",
        "id": "private-offer/456e-a345-c457-1234",
        "name": "privateOffercustomer1705", 
        "privateOfferType": "multiPartyPromotionChannelPartner",
        "state": "withdrawn"
        }
    ]
}

Response

La réponse contient l’id de travail que vous pouvez utiliser ultérieurement pour interroger l’état.

{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "notStarted",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "0001-01-01",
    "errors": []
}

Codes d’erreur

Code d’état HTTP Description
401 Erreur d’authentification : vérifiez que vous utilisez un jeton d’accès Microsoft Entra valide.
400 Validation de schéma. Vérifiez que le corps de votre demande suit le schéma correct et inclut tous les champs obligatoires.

Contenu connexe