Condividi tramite

Gestire le offerte private esistenti tramite l'API

  • Articolo

È possibile usare le API per eliminare o ritirare offerte private esistenti.

Eliminare un'offerta privata esistente

Usare questo metodo per eliminare un'offerta privata esistente mentre è ancora in fase di bozza. È necessario usare l'ID offerta privata per specificare l'offerta privata da eliminare. Per le offerte private multipart, solo l'originatore MPO può eliminare l'offerta privata.

Richiesta

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

Intestazione della richiesta

Intestazione Digitare Descrizione
Autorizzazione Stringa Obbligatorio. Il token di accesso Microsoft Entra nel formato Bearer <token>.

Parametri della richiesta

$version : obbligatorio. Si tratta della versione dello schema in uso nella richiesta.

Corpo della richiesta

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

Risposta

La risposta contiene l'ID del lavoro che puoi utilizzare successivamente per controllare lo stato.

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

Codici di errore

Codice di stato HTTP Descrizione
401 Errore di autenticazione: assicurarsi di usare un token di accesso Microsoft Entra valido.
400 Convalida dello schema. Verificare che il corpo della richiesta stia seguendo lo schema corretto e includa tutti i campi obbligatori.

Ritirare un'offerta privata esistente

Utilizzare questo metodo per ritirare un'offerta privata esistente. Ritirare un'offerta significa che il cliente non sarà più in grado di accedervi.

Nota

Per le offerte private multiparty, l'ISV può ritirare un'offerta privata inviata se il partner del canale non ha ancora pubblicato e reso disponibile al cliente finale. Il partner del canale può ritirare un'offerta privata pubblicata solo se il cliente non lo ha accettato. Se l'offerta privata è già stata resa disponibile per consentire al cliente di accettare e l'ISV deve apportare modifiche, il partner del canale deve prima ritirare l'offerta privata in modo che l'ISV possa quindi ritirare e ripristinare l'offerta privata in uno stato bozza per apportare modifiche.

È necessario utilizzare l'ID offerta privata per specificare l'offerta privata da ritirare.

Richiesta

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

Intestazione richiesta

Intestazione Digitare Descrizione
Autorizzazione Stringa Obbligatorio. Il token di accesso di Microsoft Entra nel formato Bearer <token>.

Parametri della richiesta

$version : obbligatorio. Si tratta della versione dello schema in uso nella richiesta.

Corpo della richiesta (per 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"
        }
    ]
}

Corpo della richiesta (per partner del canale)

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

Risposta

La risposta contiene il jobId che è possibile usare successivamente per verificare lo stato.

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

Codici di errore

Codice di stato HTTP Descrizione
401 Errore di autenticazione: assicurarsi di usare un token di accesso Microsoft Entra valido.
400 Convalida dello schema. Verificare che il corpo della richiesta stia seguendo lo schema corretto e includa tutti i campi obbligatori.

Contenuto correlato