Gerenciar ofertas privadas existentes via API

  • Artigo

Você pode usar APIs para excluir ou retirar ofertas privadas existentes.

Excluir uma oferta privada existente

Use esse método para excluir uma oferta privada existente enquanto ela ainda estiver em estado de rascunho. Você deve usar a ID da oferta privada para especificar qual oferta privada excluir. Para ofertas privadas de várias partes, somente o originador do MPO pode excluir a oferta privada.

Solicitar

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização String Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>.

Parâmetros da solicitação

$version - obrigatório. Esta é a versão do esquema que está sendo usada na solicitação.

Corpo da solicitação

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

Resposta

A resposta contém o jobId que você pode usar posteriormente para sondar o status.

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

Códigos do Erro

Código de status HTTP Descrição
401 Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra.
400 Validação de esquema. Certifique-se de que o corpo da solicitação esteja seguindo o esquema correto e inclua todos os campos obrigatórios.

Retirar uma oferta privada existente

Use este método para retirar uma oferta privada existente. Retirar uma oferta significa que seu cliente não poderá mais acessá-la.

Observação

Para ofertas privadas com vários participantes, o ISV pode retirar uma oferta privada enviada se o parceiro de canal ainda não a tiver publicado e disponibilizado para o cliente final. O parceiro de canal só pode retirar uma oferta privada publicada se o cliente não a tiver aceitado. Se a oferta privada já tiver sido disponibilizada para o cliente aceitar e o ISV precisar fazer alterações nela, o parceiro de canal deverá primeiro retirar a oferta privada para que o ISV possa retirar e reverter a oferta privada de volta para um estado de rascunho para fazer edições.

Você deve usar o ID da oferta privada para especificar qual oferta privada quer retirar.

Solicitar

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização String Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>.

Parâmetros da solicitação

$version - obrigatório. Esta é a versão do esquema que está sendo usada na solicitação.

Corpo da solicitação (para 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 da solicitação (para parceiro 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"
        }
    ]
}

Resposta

A resposta contém o jobId que você pode usar posteriormente para sondar o status.

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

Códigos do Erro

Código de status HTTP Descrição
401 Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra.
400 Validação de esquema. Certifique-se de que o corpo da solicitação esteja seguindo o esquema correto e inclua todos os campos obrigatórios.

Conteúdo relacionado