Partilhar via

Gerencie 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 o ID da oferta privada para especificar qual oferta privada deve ser excluída. Para ofertas privadas com várias partes, apenas o originador do MPO pode excluir a oferta privada.

Pedir

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

Cabeçalho do pedido

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

Parâmetros de solicitação

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

Corpo do pedido

{
    "$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 de erro

Código de estado de HTTP Description
401 Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra.
400 Validação de esquema. Verifique se o corpo da solicitação está seguindo o esquema correto e inclui todos os campos obrigatórios.

Retirar uma oferta privada existente

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

Nota

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 ao cliente final. O parceiro de canal só pode retirar uma oferta privada publicada se o cliente não a tiver aceite. Se a oferta privada já tiver sido disponibilizada para o cliente aceitar e o ISV precisar fazer alterações nela, o parceiro de canal deve primeiro retirar a oferta privada para que o ISV possa então retirar e reverter a oferta privada de volta para um estado de rascunho para fazer edições.

Tem de utilizar o ID da oferta privada para especificar qual a oferta privada que pretende levantar.

Pedir

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

Cabeçalho do Pedido

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

Parâmetros de solicitação

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

Corpo do pedido (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"
        }
    ]
}

Response

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 de erro

Código de estado de HTTP Description
401 Erro de autenticação: verifique se você está usando um token de acesso válido do Microsoft Entra.
400 Validação de esquema. Verifique se o corpo da solicitação está seguindo o esquema correto e inclui todos os campos obrigatórios.

Conteúdos relacionados