A referência de API do AWS Marketplace foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência de API do AWS Marketplace.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Trabalhe com ofertas privadas de parceiros de canal usando o AWS Marketplace APIs

Você pode usar o AWS Marketplace Catalog API para automatizar tarefas para trabalhar com ofertas privadas de parceiros de canal (CPPOs).

Quando você cria ou atualiza um CPPO, o rascunho da oferta conterá os termos e as regras de uma Autorização de Revenda e ficará invisível para o comprador. É possível, mas não obrigatório, envolver várias pessoas em sua organização para criar uma oferta privada.

Por exemplo, uma pessoa pode ser responsável por atualizar os preços, enquanto uma segunda pessoa pode ser responsável por atualizar o cronograma de pagamento. Então, uma terceira pessoa pode ser responsável pela atualização dos termos legais. Você pode dar permissão a uma pessoa para atualizar certas partes de uma oferta. No entanto, você só pode conceder permissões de leitura às autorizações de revenda.

Como pré-requisito para ligar para os tipos de alteração, você deve ter recebido uma ou mais autorizações de revenda e estar familiarizado com o trabalho. AWS Marketplace Catalog API

Para obter mais informações, consulte as ofertas privadas de parceiros de canal no Guia do AWS Marketplace vendedor.

Os tópicos a seguir descrevem como usar a API Catalog para criar e atualizar o CPPoS:

Pré-requisitos do CPPO

Service-linked A função de configuração ResaleAuthorization (SLR) é um pré-requisito obrigatório para usar a autorização de revenda para criar um CPPO. Para usar a Autorização de Revenda, tanto os fornecedores independentes de software (ISVs) quanto os parceiros de AWS Marketplace canal devem criar uma função vinculada ao serviço que forneça permissões de compartilhamento de recursos a. AWS Se os dois grupos não cumprirem esse pré-requisito, não AWS poderão compartilhar o recurso de autorização do ISV com o parceiro de canal. AWS Marketplace Para obter mais informações, consulte Como usar funções para autorização de revenda AWS Marketplace no Guia do AWS Marketplace vendedor.

Crie um CPPO

Você usa uma autorização de revenda direcionada a você para criar uma oferta privada de parceiro de canal (CPPO) no Draft estado de. AWS Marketplace

Se sua solicitação for processada com sucesso, AWS Marketplace Catalog API gerará uma oferta Draft estadual para você com os termos de autorização de revenda. Você pode usar DescribeEntity para ver os termos aplicados ao rascunho da oferta da Autorização de Revenda. Essa é uma oferta incompleta e não está visível para os compradores AWS Marketplace. Em seguida, você usa os tipos de alteração associados ao CPPO para concluir a oferta.

Depois que a oferta for concluída, você usa o tipo de ReleaseOffer alteração para concluir o processo de criação da oferta e liberar a oferta. Isso validará toda a oferta e tornará sua oferta visível para os compradores em AWS Marketplace.

Para criar uma oferta privada de parceiro de canal, chame a operação da StartChangeSet API com o tipo de CreateOfferUsingResaleAuthorization alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "resaleauthz-123456789",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de CreateOfferUsingResaleAuthorization alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

A resposta a essa solicitação fornece o status da solicitação. Se o status forSUCCEEDED, um novo OfferId será gerado.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2021-05-27T22:21:26Z",
  "EndTime": "2021-05-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet": [
    {
      "ChangeType": "CreateOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "resaleauthz-123456789",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Você pode usar a GET DescribeEntity solicitação para descrever o rascunho das regras e dos termos da oferta criados a partir ResaleAuthorization da AWS Marketplace Catalog API Referência. Para obter mais informações, consulte DescribeChangeSet.

Termos e regras de ResaleAuthorization

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-a5EXAMPLEwzpu@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:444555666777:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rb23tu92rn",
    "Name": "Test Offer",
    "Description": "Worldwide private offer for Test Product",
    "ProductId": "prod-0bc848d78b51",
    "ResaleAuthorizationId": "resaleauthz-123456789",
    "Terms": [
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P12M"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "BuyerAccounts": [
            "111222333444"
          ]
        }
      }
    ]
  }
}

Validações síncronas

As validações de esquema a seguir são específicas CreateOfferUsingResaleAuthorization das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos CreateOfferUsingResaleAuthorization das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Crie uma oferta de substituição privada para parceiros de canal

Você pode usar a API Catalog para criar uma oferta de substituição privada para parceiros de canal em AWS Marketplace.

Você usa o que é ResaleAuthorization direcionado a você e um Contrato do qual você é o proponente para criar uma oferta de substituição privada de parceiro de canal no Draft estado na API do catálogo ligando StartChangeSet com o tipo de CreateReplacementOfferUsingResaleAuthorization alteração, conforme mostrado no exemplo a seguir. As ofertas de substituição podem ser usadas para substituir um contrato de uma oferta anterior antes que ela termine.

CreateReplacementOfferUsingResaleAuthorizationcriará um rascunho de oferta com o aceitante do contrato na segmentação. Essa segmentação não pode ser alterada posteriormente. O rascunho da oferta também conterá o ID da oferta de origem do contrato.

Para criar uma oferta de substituição privada de parceiro de canal, chame a operação da StartChangeSet API com o tipo de CreateReplacementOfferUsingResaleAuthorization alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "2bd2c761-3b7f-3771-a9a7-e8ad36517698",
        "Name": "CAPI-saas-abo-contract-fps",
        "AgreementId": "agmt-f2ooEXAMLEamtm7mjj0j59gu"
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de CreateReplacementOfferUsingResaleAuthorization alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas CreateReplacementOfferUsingResaleAuthorization das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos CreateReplacementOfferUsingResaleAuthorization das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar marcação

Você pode usar a API Catalog para atualizar os termos de preços por um valor percentual em sua oferta em AWS Marketplace.

Isso aplicará a margem percentual fornecida em todas as condições de preços e condições de pagamento (para cronogramas de pagamento futuros) definidas pelo fabricante no. ResaleAuthorization Qualquer marcação existente será sobrescrita. Você pode ver preços e condições de pagamento atualizados usandoDescribeEntity.

Para atualizar a marcação, chame a operação da StartChangeSet API com o tipo de UpdateMarkup alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateMarkup",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Percentage": "5.0"
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateMarkup alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações com a equipe de operações do AWS Marketplace vendedor para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdateMarkup das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateMarkup das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar configuração de segmentação

Você pode usar a API Catalog para substituir completamente a configuração de segmentação existente em AWS Marketplace.

Todas as opções de segmentação existentes que não estejam incluídas na solicitação mais recente serão removidas da oferta. Os fabricantes podem mencionar compradores-alvo específicos emResaleAuthorization. Os parceiros de canal podem oferecer ofertas privadas a um subconjunto de compradores usando PositiveTargeting o tipo de UpdateTargeting alteração.

Para atualizar as configurações de segmentação da sua oferta, chame a operação da StartChangeSet API com o tipo de UpdateTargeting alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateTargeting",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111222333444"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateTargeting alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdateTargeting das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateTargeting das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar recursos legais

Você pode usar a API Catalog para mesclar os termos legais da Autorização de Revenda e substituir completamente os termos legais existentes. AWS Marketplace

Essa alteração não afeta os contratos existentes. Os termos legais que não estão incluídos na solicitação mais recente serão removidos da oferta. Você pode ver os termos legais mesclados ligando paraDescribeEntity.

Para atualizar os termos legais da sua oferta, chame a operação da StartChangeSet API com o tipo de UpdateLegalTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateLegalTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateLegalTerms alteração:

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a ID do conjunto de alterações.

Sintaxe de resposta

{
"ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-
1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação das informações com a equipe de operações do AWS Marketplace vendedor para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas. Você pode verificar o status da solicitação por meio da API do Portal de gerenciamento do AWS Marketplace catálogo ou na API do catálogo com a DescribeChangeSet ação.

Validações síncronas

As validações de esquema a seguir são específicas UpdateLegalTerms das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateLegalTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualize a capacidade de descoberta do CPPO

Você pode usar a API Catalog para gerenciar a visibilidade de sua oferta em AWS Marketplace. Esse tipo de alteração não afeta os contratos existentes.

Você pode escolher definir uma data específica no futuro para restringir a visibilidade de sua oferta ou no passado para expirar sua oferta.

Para gerenciar a visibilidade de sua oferta, chame a operação da StartChangeSet API com o tipo de UpdateAvailability alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateAvailability",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateAvailability alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdateAvailability das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateAvailability das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Defina a data de expiração dos contratos

Você pode usar a API Catalog para definir a data de expiração dos contratos criados usando essa oferta em AWS Marketplace.

Essa alteração não afeta os contratos existentes. O fabricante pode mencionar a data máxima de início do contrato em uma Autorização de Revenda. No entanto, os parceiros de canal não podem fornecer uma data de início do contrato posterior a essa data.

Para definir a data de expiração dos contratos, chame a operação da StartChangeSet API com o tipo de UpdateValidityTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateValidityTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdateValidityTerms das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateValidityTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar preços

Você pode usar a API Catalog para substituir completamente os termos de preços existentes.

Os termos de preço que não estão incluídos na solicitação mais recente serão removidos da oferta. Os parceiros de canal só podem usar esse tipo de alteração para passarFixedUpFrontPricingTerm.

Para atualizar os termos de preços de suas ofertas, chame a operação da StartChangeSet API com o tipo de UpdatePricingTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdatePricingTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "Details": {
        "PricingModel": "Contract",
        "Terms": [
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Duration": "P465D",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdatePricingTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdatePricingTerms das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdatePricingTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar detalhes do cronograma de pagamento

Você pode usar a API Catalog para alterar os detalhes do cronograma de pagamento, como o cronograma de pagamento flexível, em AWS Marketplace.

Se o fabricante tiver fornecido um cronograma de pagamento na Autorização de Revenda, o Channel Partner poderá:

Para atualizar os detalhes associados ao pagamento da sua oferta, chame a operação da StartChangeSet API com o tipo de UpdatePaymentScheduleTerms alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdatePaymentScheduleTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "Schedule": [
              {
                "ChargeDate": "2021-12-01",
                "ChargeAmount": "200.00"
              },
              {
                "ChargeDate": "2022-03-01",
                "ChargeAmount": "250.00"
              }
            ]
          }
        ]
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdatePaymentScheduleTerms alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas UpdatePaymentScheduleTerms das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdatePaymentScheduleTerms das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Atualizar as condições de pagamento líquido

Se a Autorização de Revenda que você usa para criar uma oferta privada de parceiro de canal (CPPO) contém um prazo de pagamento líquido, esse prazo é o período máximo que você pode oferecer ao seu comprador. O prazo da Autorização de Revenda é aplicado automaticamente ao seu CPPO quando você o cria.

Para oferecer ao comprador um período de pagamento menor do que o autorizado pelo vendedor, ligue para a operação da StartChangeSet API com o tipo de UpdateNetPaymentTerms alteração em sua oferta, conforme mostrado no exemplo a seguir. Se você quiser usar o mesmo período que o vendedor autorizou, não precisa ligarUpdateNetPaymentTerms.

Se a Autorização de Revenda não contiver um prazo de pagamento líquido, você não poderá adicionar um ao CPPO, e os termos de pagamento do seu comprador se aplicarão. AWS Você também não pode remover o prazo de pagamento líquido de um CPPO quando a Autorização de Revenda contém um.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateNetPaymentTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "NetPaymentTerm",
            "PaymentDuePeriod": "P30D"
          }
        ]
      }
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de UpdateNetPaymentTerms alteração:

Validações síncronas

As validações de esquema a seguir são específicas UpdateNetPaymentTerms das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos UpdateNetPaymentTerms das ações em um CPPO no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Publique o CPPO

Você pode usar a API Catalog para mesclar as informações coletadas de todos os tipos de alteração de atualização e, em seguida, publicar a oferta em AWS Marketplace.

As ofertas permanecem em um Draft estado até serem ReleaseOffer convocadas. Depois que a oferta for lançada, ela poderá ser descoberta em AWS Marketplace.

Para publicar sua oferta, chame a operação da StartChangeSet API com o tipo de ReleaseOffer alteração, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Forneça informações para os campos para adicionar o tipo de ReleaseOffer alteração:

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece o ChangeSetId e ChangeSetArn para o conjunto de alterações e tem a seguinte aparência.

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}

A solicitação de alteração é adicionada a uma fila e processada. Isso inclui a validação de informações para garantir que elas atendam às AWS Marketplace diretrizes. O processo de validação pode levar de alguns minutos a algumas horas.

Você pode verificar o status da solicitação por meio da Portal de gerenciamento do AWS Marketplace API Catalog ou diretamente pela API Catalog usando a operação da DescribeChangeSet API.

Validações síncronas

As validações de esquema a seguir são específicas ReleaseOffer das ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos seguintes requisitos, ela falhará com uma resposta HTTP.

Erros assíncronos

Os erros a seguir são específicos ReleaseOffer das ações no AWS Marketplace Catalog API. Esses erros são retornados quando você liga DescribeChangeSet após o processamento de um conjunto de alterações. Para obter mais informações sobre como usar DescribeChangeSet para obter o status de uma solicitação de alteração, consulteTrabalhando com conjuntos de alterações.

Definir um CPPO existente

Você pode usar a API Catalog para definir os detalhes do CPPO em AWS Marketplace.

Para definir um CPPO existente, chame a operação da DescribeEntity API com o tipo de Offer@1.0 entidade, conforme mostrado no exemplo a seguir.

Sintaxe da solicitação

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

Forneça informações para os campos para adicionar o tipo de DescribeEntity alteração:

Sintaxe de resposta

A resposta a essa solicitação fornece os detalhes da oferta e tem a seguinte aparência.

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-a5oEXAMPLEzpu@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:446235747164:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "Details": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide private offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-0bEXAMPLEb51",
    "ResaleAuthorizationId": "resaleauthz-123456789",
    "MarkupPercentage": "5.0",
    "Terms": [
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P12M"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00Z",
            "ChargeAmount": "1250.00"
          }
        ]
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "118033953248"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2050-08-30T01:56:03Z"
      }
    ]
  }
}

Forneça informações para os campos de entrada da DescribeEntity resposta: