Delen via

Bestaande privéaanbiedingen beheren via API

  • Artikel

U kunt API's gebruiken om bestaande privéaanbiedingen te verwijderen of in te trekken.

Een bestaande privéaanbieding verwijderen

Gebruik deze methode om een bestaande privéaanbieding te verwijderen terwijl deze nog steeds de conceptstatus heeft. U moet de id van de privéaanbieding gebruiken om op te geven welke privéaanbieding u wilt verwijderen. Voor privéaanbiedingen met meerdere onderdelen kan alleen de MPO-originator de privéaanbieding verwijderen.

Aanvraag

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

Aanvraagheader

Koptekst Type Description
Autorisatie String Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>.

Aanvraagparameters

$version - vereist. Dit is de versie van het schema dat in de aanvraag wordt gebruikt.

Aanvraagtekst

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

De respons

Het antwoord bevat de jobId die u later kunt gebruiken om de status te peilen.

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

Foutcodes

HTTP-statuscode Beschrijving
401 Verificatiefout: zorg ervoor dat u een geldig Microsoft Entra-toegangstoken gebruikt.
400 Schemavalidatie. Zorg ervoor dat de hoofdtekst van de aanvraag het juiste schema volgt en alle vereiste velden bevat.

Een bestaande privéaanbieding intrekken

Gebruik deze methode om een bestaande privéaanbieding in te trekken. Het intrekken van een aanbieding betekent dat uw klant er geen toegang meer toe heeft.

Notitie

Voor privéaanbiedingen met meerdere partijen kan de ISV een ingediende privéaanbieding intrekken als de kanaalpartner deze nog niet heeft gepubliceerd en beschikbaar heeft gesteld aan de eindklant. De kanaalpartner kan alleen een gepubliceerde privéaanbieding intrekken als de klant deze niet heeft geaccepteerd. Als de privéaanbieding al beschikbaar is gesteld zodat de klant deze kan accepteren en ISV wijzigingen moet aanbrengen, moet de kanaalpartner eerst de privéaanbieding intrekken, zodat de ISV de privéaanbieding vervolgens kan intrekken en terugzetten naar een conceptstatus om wijzigingen aan te brengen.

U moet de id van de privéaanbieding gebruiken om op te geven welke privéaanbieding u wilt intrekken.

Aanvraag

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

Aanvraagkoptekst

Koptekst Type Description
Autorisatie String Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>.

Aanvraagparameters

$version - vereist. Dit is de versie van het schema dat in de aanvraag wordt gebruikt.

Aanvraagbody (voor 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"
        }
    ]
}

Aanvraagbody (voor kanaalpartner)

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

Respons

Het antwoord bevat de jobId die u later kunt gebruiken om de status te peilen.

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

Foutcodes

HTTP-statuscode Beschrijving
401 Verificatiefout: zorg ervoor dat u een geldig Microsoft Entra-toegangstoken gebruikt.
400 Schemavalidatie. Zorg ervoor dat de hoofdtekst van de aanvraag het juiste schema volgt en alle vereiste velden bevat.

Gerelateerde inhoud