Freigeben über

Verwalten vorhandener privater Angebote über API

  • Artikel

Sie können APIs verwenden, um vorhandene private Angebote zu löschen oder zurückzuziehen.

Löschen eines vorhandenen privaten Angebots

Verwenden Sie diese Methode, um ein vorhandenes privates Angebot zu löschen, während es sich noch im Entwurfszustand befindet. Sie müssen die ID des privaten Angebots verwenden, um anzugeben, welches private Angebot gelöscht werden soll. Bei mehrteiligen privaten Angeboten kann nur der MPO-Absender das private Angebot löschen.

Anfordern

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

Anforderungsheader

Header Typ Beschreibung
Autorisierung String Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>.

Anforderungsparameter

$version – erforderlich. Dies ist die Version des Schemas, das in der Anforderung verwendet wird.

Anforderungstext

{
    "$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"
        }
    ]
}

Antwort

Die Antwort enthält die jobId, die Sie später verwenden können, um den Status abzufragen.

{
    "$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": []
}

Fehlercodes

HTTP-Statuscode Beschreibung
401 Authentifizierungsfehler: Stellen Sie sicher, dass Sie ein gültiges Microsoft Entra-Zugriffstoken verwenden.
400 Schemaüberprüfung. Stellen Sie sicher, dass der Anforderungstext dem richtigen Schema folgt und alle erforderlichen Felder enthält.

Zurückziehen eines vorhandenen privaten Angebots

Verwenden Sie diese Methode, um ein vorhandenes privates Angebot zurückzuziehen. Das Widerrufen eines Angebots bedeutet, dass Ihr Kunde nicht mehr darauf zugreifen kann.

Hinweis

Für private Angebote mit mehreren Teilnehmern kann der ISV ein übermitteltes privates Angebot widerrufen, wenn der Kanalpartner es noch nicht veröffentlicht und dem Endkunden zur Verfügung gestellt hat. Der Kanalpartner kann ein veröffentlichtes privates Angebot nur widerrufen, wenn der Kunde es nicht akzeptiert hat. Wenn das private Angebot bereits für den Kunden zur Verfügung gestellt wurde und ISV Änderungen daran vornehmen muss, muss der Kanalpartner zuerst das private Angebot zurückziehen, damit der ISV das private Angebot zurücknehmen und das private Angebot wieder in einen Entwurfszustand zurückverwenden kann, um Bearbeitungen vorzunehmen.

Sie müssen die ID des privaten Angebots verwenden, um anzugeben, welches private Angebot zurückgezogen werden soll.

Anfordern

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

Anforderungsheader

Header Typ Beschreibung
Autorisierung String Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>.

Anforderungsparameter

$version – erforderlich. Dies ist die Version des Schemas, das in der Anforderung verwendet wird.

Anforderungstext (für 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"
        }
    ]
}

Anforderungstext (für Kanalpartner)

{
    "$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"
        }
    ]
}

Antwort

Die Antwort enthält die jobId, die Sie später verwenden können, um den Status abzufragen.

{
    "$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": []
}

Fehlercodes

HTTP-Statuscode Beschreibung
401 Authentifizierungsfehler: Stellen Sie sicher, dass Sie ein gültiges Microsoft Entra-Zugriffstoken verwenden.
400 Schemaüberprüfung. Stellen Sie sicher, dass der Anforderungstext dem richtigen Schema folgt und alle erforderlichen Felder enthält.

Zugehöriger Inhalt