View a markdown version of this page

Trabalhe com ofertas privadas de parceiros de canal usando o AWS Marketplace APIs - AWS Marketplace
Pré-requisitos do CPPOCrie um CPPOCrie uma oferta de substituição privada para parceiros de canalAtualizar marcaçãoAtualizar configuração de segmentaçãoAtualizar recursos legaisAtualize a capacidade de descoberta do CPPODefina a data de expiração dos contratosAtualizar preçosAtualizar detalhes do cronograma de pagamentoPublique o CPPODefinir um CPPO existente

A referência da 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 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 determinadas 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 tipos de mudança, você deve ter recebido uma ou mais autorizações de revenda e estar familiarizado com elas. AWS Marketplace Catalog API

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

Os tópicos a seguir descrevem como usar a API de catálogo para criar e atualizar CPPOs:

Pré-requisitos do CPPO

Service-linked a configuração de role for 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 para. 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 Uso de 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 em. AWS Marketplace

Se sua solicitação for processada com sucesso, AWS Marketplace Catalog API gerará uma oferta válida para Draft você com os termos da Autorização de Revenda. Você pode usar DescribeEntity para ver os termos aplicados ao rascunho da oferta na Autorização de Revenda. Essa é uma oferta incompleta e não está visível para os compradores em 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 sobre os campos para adicionar o tipo de CreateOfferUsingResaleAuthorization alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • ResaleAuthorizationId(string) (obrigatório) — O identificador exclusivo que inclui o produto, os termos e as regras que estão sendo oferecidos. Os parceiros de canal podem adicionar termos e regras adicionais usando os tipos de alteração de atualização. ResaleAuthorization deve estar disponível e direcionado para você como parceiro.

    • Nome (string) (opcional) — O nome associado à oferta para melhor legibilidade. Ele é exibido como parte das informações do contrato.

    • OfferSetId(string) (opcional) — O ID do conjunto de ofertas ao qual associar essa oferta. Especifique esse campo somente ao criar uma oferta que fará parte de um conjunto de ofertas. Se não OfferSetId for fornecida, será criada uma oferta individual que pode ser comprada de forma independente. Observe que especificar um OfferSetId durante a criação da oferta indica apenas sua intenção de associar a oferta a esse conjunto de ofertas. Para concluir a associação, você deve usar o tipo de AssociateOffers alteração após a criação da oferta.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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, ou diretamente por meio da API de catálogo, 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 ResaleAuthorization na AWS Marketplace Catalog API Referência. Para obter mais informações, consulte DescribeChangeSet.

Termos e regras de ResaleAuthorization

  • LegalTerms— As disposições que descrevem termos legais, como o EULA no ResaleAuthorization serão adicionadas ao rascunho da oferta. Você pode adicionar termos legais usando o tipo de UpdateLegalTerms alteração. Para obter mais informações, consulte UpdateLegalTerms.

  • PricingTerms— Todos os termos de preços (ConfigurableUpfrontPricingTermFixedUpfrontPricingTerm,UsageBasedPricingTerm,,PaymentScheduleTerms) descritos pelo fabricante no ResaleAuthorization serão adicionados ao rascunho da oferta. Você pode optar por aumentar o preço (para cada dimensão) para seus compradores-alvo usando o tipo de UpdateMarkup alteração. Para obter mais informações, consulte UpdateMarkup neste guia.

  • PaymentTerms— Se o fabricante tiver definido o cronograma de pagamento futuro no ResaleAuthorization, você poderá ver as condições de pagamento no rascunho da oferta. Você pode optar por aumentar o valor do cronograma de pagamento para seus compradores-alvo usando o tipo de UpdateMarkup alteração. Se você quiser definir o cronograma de pagamento para seus compradores, você pode usarUpdatePaymentScheduleTerms. Para obter mais informações, consulte UpdatePaymentScheduleTerms.

  • TargetingRule— Se ResaleAuthorization for direcionado a compradores específicos, os parceiros de canal podem oferecer ofertas privadas a um subconjunto de compradores que usam PositiveTargeting. Por padrão, a regra incluirá todos os compradores de ResaleAuthorization. Você pode selecionar compradores específicos e atualizar o rascunho da oferta usando o tipo de UpdateTargeting alteração. Para obter mais informações, consulte UpdateTargeting.

{
  "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 seguintes validações de esquema são específicas para CreateOfferUsingResaleAuthorization ações no. AWS Marketplace Catalog API Essas validações são realizadas quando você ligaStartChangeSet. Se a solicitação não atender aos requisitos a seguir, ela falhará com uma resposta HTTP.

Campo de entrada Regra de validação Código HTTP
Nome

Obrigatório

O comprimento deve estar entre 1 e 150 caracteres

 422
Description

Obrigatório

O comprimento deve estar entre 1 e 255 caracteres

 422
ResaleAuthorizationId

Obrigatório

O comprimento deve estar entre 1 e 50 caracteres

 422
ResaleAuthorizationId ResaleAuthorization deve ser direcionado ao parceiro de canal. 422
ResaleAuthorizationId ResaleAuthorization deve estar ativo 422
Parceiro de canal O parceiro de canal deve receber o pagamento do vendedor em AWS Marketplace 422

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.

Código de erro Mensagem de erro
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Use um ResaleAuthorization em estado ativo.
PRODUTO_INCOMPATÍVEL OfferSetId não é suportado nas ofertas do produto.

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

Você pode usar a API de catálogo 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 da 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 para um 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 sobre os campos para adicionar o tipo de CreateReplacementOfferUsingResaleAuthorization alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • ResaleAuthorizationId(string) (obrigatório) — ResaleAuthorizationId é o identificador exclusivo que inclui o produto, os termos e as regras que estão sendo oferecidos. Os parceiros de canal podem adicionar termos e regras adicionais usando os tipos de alteração de atualização.

      ResaleAuthorizationdeve estar disponível e direcionado para você como parceiro.

    • Nome (string) (opcional) — Name associado à oferta para melhor legibilidade para você e seus clientes. Também será exibido como parte das informações do Contrato.

    • AgreementId(string) (obrigatório) — AgreementId é o identificador exclusivo do contrato criado quando o comprador-alvo aceitou a oferta anterior que você está tentando substituir

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação
Nome O comprimento deve estar entre 1 e 150 caracteres
AgreementId

O contrato fornecido deve estar ativo Desde que o acordo exista

O contrato fornecido deve ser de propriedade do parceiro de canal
ResaleAuthorizationId

Obrigatório

O comprimento deve estar entre 1 e 50 caracteres
ResaleAuthorizationId ResaleAuthorization deve ser direcionado ao parceiro de canal.
ResaleAuthorizationId ResaleAuthorization deve estar ativo
Parceiro de canal O parceiro de canal deve receber o pagamento do vendedor em AWS Marketplace

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.

Código de erro Mensagem de erro
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Use um ResaleAuthorization em estado ativo.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL ResaleAuthorization Deve ser do mesmo produto associado ao contrato.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Use um ResaleAuthorization direcionado para o aceitante do contrato.

Atualizar marcação

Você pode usar a API de catálogo para atualizar os termos de preços em 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 futuros cronogramas de pagamento) definidos 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 sobre os campos para adicionar o tipo de UpdateMarkup alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • Porcentagem (string) (obrigatório) — O valor percentual será adicionado aos preços ou condições de pagamento do fabricante.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação
Porcentagem

Obrigatório

O tipo de dados é “String”

Deve ser não negativo

Permita até 9 decimais

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.

Código de erro Mensagem de erro
MARCAÇÃO_INCOMPATÍVEL A alteração solicitada não pode ser realizada após o lançamento da oferta.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL MarkupPercentagenão podem ser atualizados quando PaymentScheduleTerm ou FixedUpfrontPricingTerm estão presentes na oferta e não estão presentes naResaleAuthorization.
TERMOS_INCOMPATÍVEIS Use UpdatePaymentScheduleTerms com um valor de pagamento específico ou UpdateMarkup com uma única porcentagem de marcação para as datas programadas.
PERCENTAGEM_DE_MARCAÇÃO INVÁLIDA UpdateMarkup só pode ser invocado para ofertas criadas usando ResaleAuthorization.

Atualizar configuração de segmentação

Você pode usar a API de catálogo para substituir completamente a configuração de segmentação existente. 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 sobre os campos para adicionar o tipo de UpdateTargeting alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • PositiveTargeting(objeto) (opcional) — A segmentação positiva define os critérios que o perfil de qualquer comprador deve atender para poder acessar a oferta. Esse campo é opcional, mas pelo menos uma opção de segmentação deve ser fornecida quando esse campo estiver presente.

      • CountryCodes(matriz de cadeias de caracteres) (opcional) — Lista como opção para permitir a segmentação com base no país. Se a intenção não for direcionar a oferta para um país, esse campo deve ser omitido. Se estiver presente, a lista deve conter pelo menos um código de país. Cada elemento dessa lista deve ser um código de país válido de 2 letras, usando este formato: ISO 3166-1 alfa-2.

      • BuyerAccounts(matriz de sequências de caracteres) (opcional) — Listar como uma opção para permitir a segmentação com base em Contas da AWS (também conhecida como Oferta Privada). Se a intenção é não direcionar a oferta para um Conta da AWS, esse campo deve ser omitido.

    • NegativeTargeting(objeto) (opcional) — A segmentação negativa define os critérios que o perfil de qualquer cliente deve cumprir para ter acesso restrito à oferta. Embora esse campo seja opcional, pelo menos uma opção de segmentação deve ser fornecida quando esse campo estiver presente.

      • CountryCodes(matriz de sequências de caracteres) (obrigatório) — Lista como opção para permitir a segmentação com base no país. Se a intenção não for direcionar a oferta para um país específico, esse campo deverá ser omitido. Se estiver presente, a lista deve conter pelo menos um código de país. Cada elemento dessa lista deve ser um código de país válido de 2 letras usando este formato: ISO 3166-1 alfa-2.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação Código HTTP
Detalhes

Obrigatório

 422
PositiveTargeting

Opcional

 422
NegativeTargeting

Opcional

 422
PositiveTargeting.CountryCodes

Opcional

Os códigos de país devem ser válidos (ISO 3166-1 alpha-2)

 422
PositiveTargeting.BuyerAccounts

Opcional

Conta da AWS Os IDs devem estar em formato válido (número de 12 dígitos)

Não deve conter mais de 25 contas

 422
NegativeTargeting.CountryCodes

Opcional

Os códigos de país devem ser válidos (ISO 3166-1 alpha-2)

 422
NegativeTargeting.BuyerAccounts Não deve ser fornecido (a segmentação negativa BuyerAccounts não é suportada) 422

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.

Código de erro Mensagem de erro
CONTAS_DE COMPRADORES INVÁLIDAS Forneça contas de comprador válidas. Contas inválidas: [x].
CÓDIGOS DE PAÍS INVÁLIDOS Forneça códigos de país compatíveis.
SEGMENTAÇÃO_INVÁLIDA Use segmentação negativa ou positiva no mesmo atributo.
PRODUTO_INCOMPATÍVEL Country-based a segmentação não é compatível com o produto.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Forneça BuyerAccounts que sejam compatíveis com ResaleAuthorization o.
SEGMENTAÇÃO_INCOMPATÍVEL A alteração solicitada não pode ser realizada após o lançamento da oferta.
SEGMENTAÇÃO_INCOMPATÍVEL A alteração solicitada não pode ser realizada depois que a oferta expirar.
SEGMENTAÇÃO_INCOMPATÍVEL A segmentação não pode ser atualizada em uma oferta substituta. Se o comprador não estiver associado ao fornecido AgreementId, crie uma nova oferta privada fornecendo um AgreementId associado ao comprador.
MUITAS CONTAS DE COMPRADORES Forneça BuyerAccounts dentro dos limites permitidos.

Você pode usar a API do Catálogo 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 sobre os campos para adicionar o tipo de UpdateLegalTerms alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • Termos (matriz de estruturas) (obrigatório) — Lista de termos legais que você deseja atualizar. Os termos legais aceitos são:

    • LegalTerm(objeto) (obrigatório) — Define a lista de contratos de texto a serem propostos aos aceitantes. Um exemplo desse contrato é o contrato de licença de usuário final (EULA).

      • Tipo (string) (obrigatório) — Categoria do termo que está sendo atualizada.

      • Documentos (matriz de estruturas) (obrigatório) — Lista de referências aos recursos legais a serem propostos aos compradores. Um exemplo desse recurso é o contrato de licença de usuário final (EULA). Cada referência é composta por um tipo e uma URL:

        • Tipo (sequência de caracteres) (obrigatório) — Tipo de documento. Os tipos de documentos disponíveis são:

          • CustomEula— Um EULA personalizado fornecido por você como vendedor. É necessário um URL para um EULA armazenado em um bucket acessível do S3 para esse tipo de documento.

          • StandardEula— Contrato padrão para AWS Marketplace (SCMP). Para obter mais informações sobre o SCMP, consulte o Guia do AWS Marketplace vendedor. Você não fornece um URL para esse tipo porque ele é gerenciado por AWS Marketplace.

        • Url (string) (obrigatório condicionalmente) — Um URL para o documento legal para os compradores lerem. Obrigatório quando uma das opções a seguir Type é [CustomEula].

        • Versão (string) (exigida condicionalmente) — Uma versão dos contratos padrão fornecida pela AWS Marketplace. Isso é necessário quando Type éStandardEula. As versões disponíveis sã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 do Portal de gerenciamento do AWS Marketplace, ou na API do Catálogo com a DescribeChangeSet ação.

Validações síncronas

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

Campo de entrada Regra de validação Código HTTP
Termos

Obrigatório

Só LegalTerm é permitido na lista

O tamanho da lista deve ser 1

 422
Termos []. LegalTerm.Documents

Obrigatório

 422
Termos []. LegalTerm.Documents[] .Tipo

Obrigatório

Valores permitidos:

  • CustomEula

  • StandardEula

 422
Termos []. LegalTerm.Documents[] .URL

Obrigatório e deve ser um URL válido quando “Tipo” é um dos

  • CustomEula

 422

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.

Código de erro Mensagem de erro
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada após o lançamento da oferta.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada depois que a oferta expirar.
DOCUMENTOS_LEGAIS_INVÁLIDOS Forneça URLs para documentos legais armazenados em buckets acessíveis do S3.
DOCUMENTOS_LEGAIS_INVÁLIDOS Somente a versão mais recente do StandardEula é compatível com novas ofertas.
DOCUMENTOS_LEGAIS_INVÁLIDOS Forneça documentos legais nos formatos de arquivo compatíveis.
DOCUMENTOS_LEGAIS_INVÁLIDOS Forneça documentos legais usando os tipos de documentos compatíveis.
LIMITE EXCEDIDO DO TAMANHO DO DOCUMENTO LEGAL Forneça documentos legais dentro dos limites de tamanho permitidos.

Atualize a capacidade de descoberta do CPPO

Você pode usar a API do Catálogo para gerenciar a descoberta 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 descoberta de sua oferta ou, no passado, para expirar sua oferta.

Para gerenciar a capacidade de descoberta 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 sobre os campos para adicionar o tipo de UpdateAvailability alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • AvailabilityEndDate(string) — Data até a qual a oferta pode ser descoberta e comprada em. AWS Marketplace Você pode escolher definir uma data específica no futuro para restringir a disponibilidade ou no passado para expirar a oferta. As datas são representadas em YYYY-MM-DD formato. A oferta expira às 23:59:59.999 UTC na data fornecida.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação Código HTTP
AvailabilityEndDate

Obrigatório

Formato: "YYYY-MM-DD”

 422

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.

Código de erro Mensagem de erro
DATA-FINAL DE DISPONIBILIDADE_INVÁLIDA AvailabilityEndDate não é compatível com ofertas públicas.
DATA-FINAL DE DISPONIBILIDADE_INVÁLIDA Ofereça um futuro AvailabilityEndDate.
DATA-FINAL DE DISPONIBILIDADE_INVÁLIDA Forneça AvailabilityEndDate o que é antes AgreementEndDate.
DATA DE TÉRMINO DA DISPONIBILIDADE_FALTANTE Forneça um AvailabilityEndDate que seja anterior à data de término do contrato.

Defina a data de expiração dos contratos

Você pode usar a API do Catálogo 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 sobre os campos para adicionar o tipo de UpdateValidityTerms alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • Termos (matriz de estruturas) — Lista dos termos de validade que você deseja atualizar. Os termos de validade suportados são:

      • ValidityTerm(objeto) — Define as condições que manterão um contrato, criado a partir desta oferta, válido.

        • Tipo (string) — Categoria do termo que está sendo atualizado.

        • AgreementDuration(string) — Define por quanto tempo o contrato permanece ativo. Se AgreementStartDate não for fornecida, a duração do contrato é relativa à hora da assinatura do contrato. A duração é representada no formato ISO_8601.

        • AgreementStartDate(string) — Define a data em que o contrato começa. AgreementStartDateé representado em YYYY-MM-DD formato. O contrato começa às 00:00:00.000 UTC na data fornecida. Se AgreementStartDate não for fornecida, a data de início do contrato é determinada com base na hora da assinatura do contrato.

        • AgreementEndDate(string) — Define a data em que o contrato termina. O AgreementEndDate é representado em YYYY-MM-DD formato. O contrato termina às 23:59:59.999 UTC na data fornecida. Se AgreementEndDate não for fornecida, a data de término do contrato é determinada pela validade dos termos individuais.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação Código HTTP
Termos

Obrigatório

Somente "ValidityTerm" é permitido na lista

Deve estar vazio ou conter apenas 1 termo

 422
Termos []. ValidityTerm

Casos de uso compatíveis:

1. ValidityTerm com apenas AgreementDuration

2. ValidityTerm com apenas AgreementStartDate

3. ValidityTerm com apenas AgreementEndDate

4. ValidityTerm com ambos AgreementStartDate e AgreementEndDate

 422
Termos []. ValidityTerm.AgreementDuration

Opcional

Representado no formato ISO_8601.

 422
Termos []. ValidityTerm.AgreementStartDate

Opcional

Formato: "YYYY-MM-DD”

 422
Termos []. ValidityTerm.AgreementEndDate

Opcional

Formato: "YYYY-MM-DD”

 422

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.

Código de erro Mensagem de erro
ACORDO_INCOMPATÍVEL AgreementStartDate não pode estar no futuro quando o contrato atual a ser substituído não tiver data futura.
DATA-FINAL DO CONTRATO INCOMPATÍVEL AgreementEndDate não podem ser atualizadas após o lançamento da oferta.
DATA DE INÍCIO DO CONTRATO INCOMPATÍVEL AgreementStartDate não podem ser atualizadas após o lançamento da oferta.
PRODUTO_INCOMPATÍVEL AgreementStartDate in the future não é suportado.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que a duração entre AgreementStartDate e AgreementEndDate seja compatível com ResaleAuthorization o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de AgreementStartDate que é compatível com ResaleAuthorization o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de AgreementEndDate que é compatível com ResaleAuthorization o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que a duração entre AgreementStartDate e AgreementEndDate seja compatível com ResaleAuthorization o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que a duração das AgreementDuration correspondências seja especificada no ResaleAuthorization.
TERMOS_INCOMPATÍVEIS ValidityTerm não é compatível com ofertas públicas.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada depois que a oferta expirar.
DURAÇÃO_DE_CONTRATO INVÁLIDA Forneça AgreementDuration que seja maior ou igual a [x] dias.
DATA-FINAL DO CONTRATO INVÁLIDA Ofereça um futuro AgreementEndDate.
DATA-FINAL DO CONTRATO INVÁLIDA Forneça AgreementEndDate que seja posterior ou igual a [x].
DATA DE INÍCIO DO CONTRATO INVÁLIDA Forneça um AgreementStartDate que vem depois AvailabilityEndDate.
DATA DE INÍCIO DO CONTRATO INVÁLIDA Forneça um AgreementStartDate que esteja antes do AgreementEndDate.
DATA DE INÍCIO DO CONTRATO INVÁLIDA Forneça um AgreementStartDate que esteja dentro de [x] anos a partir de hoje.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO ValidityTerm com ambos AgreementDuration e AgreementEndDate não é compatível.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO ValidityTerm com ambos AgreementStartDate e AgreementDuration não é suportado em uma oferta para o produto.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO ValidityTerm with AgreementStartDate não é suportado em uma oferta para o produto.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO ValidityTerm with only AgreementStartDate não é suportado.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO AgreementEndDate não é suportado, a menos que seja usado em combinação com um future AgreementStartDate ou para ofertas de substituição.
INTERVALO_TEMPO_DO_CONTRATO INVÁLIDO Forneça AgreementStartDate e AgreementEndDate onde a diferença seja menor ou igual a [x] anos.
DATA DE INÍCIO DO CONTRATO AUSENTE Certifique-se de que AgreementStartDate está presente ValidityTerm quando usado junto com ConfigurableUpfrontPricingTerm.

Atualizar preços

Você pode usar a API de catálogo 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 serem aprovadosFixedUpFrontPricingTerm.

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 sobre os campos para adicionar o tipo de UpdatePricingTerms alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • Detalhes (string) (obrigatório) — Detalhes específicos da solicitação. Esse campo é um campo de string JSON. Ele deve ser formatado corretamente para um campo de string de linha única, incluindo caracteres de escape (como aspas) que não podem estar em uma string.

    • PricingModel(string) (obrigatório) — Modelo de preço para sua oferta. Os valores possíveis para o modelo de preços são:

      • Contrato — modelo de Contract-based preços em que os compradores são cobrados antecipadamente pelo uso de seu produto ou oferecem um cronograma de pagamento flexível. Os compradores também podem pagar por um uso adicional acima do contrato.

      • Termos (matriz de estruturas) (obrigatório) — Lista dos termos de preços que você deseja atualizar. Os termos de preços suportados são:

        • FixedUpfrontPricingTerm(objeto) — Define um modelo de preço pré-pago em que os clientes pagam um valor inicial fixo.

          • Tipo (string) (obrigatório) — Tipo do termo que está sendo atualizado.

          • CurrencyCode(string) (obrigatório) — Define a moeda dos preços mencionados neste termo. Para ofertas públicas, somente USD são aceitos. Para ofertas privadas, USD, AUD, EUR, GBP e JPY são suportados.

          • Preço (sequência de caracteres) (obrigatório) — Valor fixo a ser cobrado do cliente quando esse termo for aceito.

          • Subsídios (conjunto de estruturas) (obrigatório) — Direitos que serão concedidos ao aceitante do pagamento adiantado fixo como parte da execução do contrato.

            • DimensionKey(string) (obrigatório) — Chave de dimensão exclusiva definida no documento do produto. As dimensões representam categorias de capacidade em um produto e são especificadas quando o produto é listado em AWS Marketplace.

            • MaxQuantity(inteiro) (opcional) — Quantidade máxima de capacidade que o comprador pode ter direito à determinada dimensão do produto. Se não MaxQuantity for fornecido, o comprador poderá usar uma quantidade ilimitada da dimensão fornecida.

          • Duração (string) (opcional) — Define a duração em que o termo permanece ativo. Esse campo é compatível com o formato ISO 8601.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação
PricingModel

Obrigatório

Modelos de preços permitidos:

Contrato
Termos

Obrigatório

Termos permitidos:

FixedUpfrontPricingTerm
Termos []. FixedUpfrontPricingTerm.CurrencyCode

Obrigatório

Valores permitidos: ["USD”, “AUD”, “EUR”, “GBP”, “JPN"]

Modelos de preços permitidos:

Contrato
Termos []. FixedUpfrontPricingTerm.Price

Obrigatório

O tipo de dados é “String”. Deve ser não negativo

Support até 6 decimais

Nenhum caractere especial suportado
Termos []. FixedUpfrontPricingTerm.Duration

Obrigatório

Formato esperado: duração da ISO 8601
Termos []. FixedUpfrontPricingTerm.Grants[]. DimensionKey

Obrigatório

O comprimento deve estar entre 1 e 60
Termos []. FixedUpfrontPricingTerm.Grants[]. MaxQuantity

Obrigatório

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.

Código de erro Mensagem de erro
CHAVES DE DIMENSÃO DUPLICADAS Forneça aos Grants uma lista exclusiva de chaves de dimensão em [x].
CHAVES DE DIMENSÃO DUPLICADAS RateCard Forneça uma lista exclusiva de chaves de dimensão em [x].
SELETORES_DUPLICADOS Forneça uma lista exclusiva de seletores em ConfigurableUpfrontPricingTerm.
TIPOS_TERMO_DUPLICADOS Forneça uma lista exclusiva de tipos de termos.
ACORDO_INCOMPATÍVEL Os termos a seguir não podem ser removidos da oferta de substituição: [x, y, z].
ACORDO_INCOMPATÍVEL Os seguintes termos não podem ser adicionados à oferta de substituição: [x, y, z].
CÓDIGO_DE_MOEDA INCOMPATÍVEL CurrencyCode não pode ser alterado após o lançamento da oferta.
CONFIGURAÇÕES_DE PAGAMENTO INCOMPATÍVEIS Atualize suas configurações de pagamento para serem compatíveis com CurrencyCode o.
PRODUTO_INCOMPATÍVEL O modelo de preços de uso não é compatível com o produto.
PRODUTO_INCOMPATÍVEL O modelo de preços contratuais não é compatível com o produto.
PRODUTO_INCOMPATÍVEL O modelo de preços Byol não é compatível com o produto.
PRODUTO_INCOMPATÍVEL O modelo de preço gratuito não é compatível com o produto.
PRODUTO_INCOMPATÍVEL [x] não é compatível com uma oferta do produto.
PRODUTO_INCOMPATÍVEL As condições de pagamento e preço fornecidas são incompatíveis.
PRODUTO_INCOMPATÍVEL Use as dimensões existentes e disponíveis no produto em [x].
PRODUTO_INCOMPATÍVEL FreeTrialPricingTerm pois o único termo de preço da oferta não é compatível com o produto.
PRODUTO_INCOMPATÍVEL Os seguintes termos não são compatíveis com o produto: [x, y, z].
PRODUTO_INCOMPATÍVEL As ofertas de substituição são suportadas somente para o modelo de preços contratuais.
PRODUTO_INCOMPATÍVEL Forneça termos de preços compatíveis com as dimensões do produto. Termos de preços incompatíveis: [x, y, z].
RESTRIÇÕES DE TARIFA_CARTÃO INCOMPATÍVEIS QuantityConfiguration Defina MultipleDimensionSelection e como Permitido no modelo ConfigurableUpfrontPricingTerm de preços de uso.
RESTRIÇÕES DE TARIFA_CARTÃO INCOMPATÍVEIS QuantityConfiguration Defina MultipleDimensionSelection e como Não permitido no modelo ConfigurableUpfrontPricingTerm de preços de uso.
RESTRIÇÕES DE TARIFA_CARTÃO INCOMPATÍVEIS QuantityConfiguration a ConfigurableUpfrontPricingTerm entrada não pode ser alterada após o lançamento da oferta.
RESTRIÇÕES DE TARIFA_CARTÃO INCOMPATÍVEIS MultipleDimensionSelection a ConfigurableUpfrontPricingTerm entrada não pode ser alterada após o lançamento da oferta.
TAXAS_INCOMPATÍVEIS Defina todos os valores e preços de cobrança como zero (0) ao usar o modelo de preços gratuitos.
TAXAS_INCOMPATÍVEIS Somente zero (0) preços são permitidos UsageBasedPricingTerm para uma oferta de teste gratuito do produto.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Forneça o mesmo CurrencyCode que está especificado no ResaleAuthorization.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Garanta a duração nas FixedUpfrontPricingTerm partidas com a duração especificada no ResaleAuthorization.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Forneça termos que sejam compatíveis com ResaleAuthorization o. Termos incompatíveis: [x, y, z].
DURAÇÃO_SELETOR_INCOMPATÍVEL As durações não podem ser removidas das tabelas de tarifas ConfigurableUpfrontPricingTerm após o lançamento da oferta.
VERIFICAÇÃO_DE_VENDEDOR INCOMPATÍVEL Conclua todos os processos necessários de verificação do vendedor.
TERMOS_INCOMPATÍVEIS [x] não é compatível com os seguintes termos: [y, z].
TERMOS_INCOMPATÍVEIS Os seguintes termos não podem ser adicionados após o lançamento da oferta: [x, y, z].
TERMOS_INCOMPATÍVEIS Os termos a seguir não podem ser removidos após o lançamento da oferta: [x, y, z].
TERMOS_INCOMPATÍVEIS [x] não é compatível com ofertas privadas.
TERMOS_INCOMPATÍVEIS Os termos a seguir não são compatíveis com o FreeTrialPricingTerm que concede uso ilimitado: [x, y, z].
TERMOS_INCOMPATÍVEIS Os seguintes termos não são compatíveis com FreeTrialPricingTerm o produto: [x, y, z].
TERMOS_INCOMPATÍVEIS Forneça um preço zero (0) para FixedUpfrontPricingTerm quando a oferta contiver um PaymentScheduleTerm.
TERMOS_INCOMPATÍVEIS Os termos a seguir não são compatíveis com PricingModel: [x, y, z].
TERMOS_INCOMPATÍVEIS FixedUpfrontPricingTerm não é suportado quando MarkupPercentage é maior que zero (0).
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada após o lançamento da oferta.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada depois que a oferta expirar.
DURAÇÃO_DE_CONTRATO INVÁLIDA Forneça uma duração entre [x] e [y] meses.
DURAÇÃO_DE_CONTRATO INVÁLIDA Certifique-se de que a granularidade da duração esteja no nível do dia para dimensões medidas.
CÓDIGO_DE_MOEDA INVÁLIDO Forneça um suporte CurrencyCode.
CÓDIGO_DE_MOEDA INVÁLIDO Forneça o mesmo CurrencyCode em todos os preços e condições de pagamento.
DURAÇÃO_INVÁLIDA Certifique-se de que a duração em FreeTrialPricingTerm esteja dentro da faixa permitida.
DURAÇÃO_INVÁLIDA Forneça uma duração FixedUpfrontPricingTerm que corresponda à duração entre AgreementStartDate AgreementEndDate e.
DURAÇÃO_INVÁLIDA Forneça uma duração entre [x] e [y] meses.
DURAÇÃO_INVÁLIDA Certifique-se de que a granularidade da duração esteja no nível do dia para dimensões medidas.
SUBVENÇÕES_INVÁLIDAS Forneça o mesmo MaxQuantity para todos os subsídios em FreeTrialPricingTerm.
SUBVENÇÕES_INVÁLIDAS Forneça subsídios para todas as dimensões medidas disponíveis em FreeTrialPricingTerm.
ALTERAÇÃO_DE_PREÇO_INVÁLIDA [x] não pode ser atualizado até [y] porque você solicitou um aumento de preço nos últimos 120 dias. Para cancelar sua solicitação anterior de aumento de preço ou para obter mais informações, entre em contato com a equipe de operações do catálogo AWS Marketplace gerenciado.
ALTERAÇÃO_DE_PREÇO_INVÁLIDA O aumento de preço e a adição de dimensões em [x] não são aceitos na mesma solicitação. Adicione as dimensões primeiro.
ALTERAÇÃO_DE_PREÇO_INVÁLIDA O aumento e a diminuição de preços UsageBasedPricingTerm não são suportados na mesma solicitação. Diminua os preços primeiro.
ALTERAÇÃO_DE_PREÇO_INVÁLIDA O aumento RecurringPaymentTerm e a diminuição do preço em UsageBasedPricingTerm não são suportados na mesma solicitação. Diminua os preços primeiro.
ALTERAÇÃO_DE_PREÇO_INVÁLIDA A redução de preço RecurringPaymentTerm e o aumento de preço em UsageBasedPricingTerm não são suportados na mesma solicitação. Diminua os preços primeiro.
CARTÃO_TAXA_INVÁLIDA ConfigurableUpfrontPricingTerm está faltando uma ou mais chaves de dimensão durante a duração [x]. Forneça preços para o mesmo conjunto de chaves de dimensão para todas as durações.
CARTÃO_TAXA_INVÁLIDA Forneça uma tabela de tarifas apenas para dimensões medidas. UsageBasedPricingTerm
CARTÃO_TAXA_INVÁLIDA As tarifas não podem ser removidas de [x]. Forneça preços para todas as dimensões na tabela de preços existente.
CARTÃO_TAXA_INVÁLIDA Forneça dimensões que tenham a mesma unidade em [x].
CARTÃO_TAXA_INVÁLIDA Forneça todas as dimensões medidas ou todas as dimensões autorizadas em [x].
CARTÃO_TAXA_INVÁLIDA Forneça somente as dimensões autorizadas em [x].
CARTÃO_TAXA_INVÁLIDA Forneça taxas baseadas no uso para todas as dimensões medidas disponíveis em UsageBasedPricingTerm.
CARTÃO_TAXA_INVÁLIDA Forneça taxas baseadas no uso para todas as dimensões do teste gratuito.
CARTÃO_TAXA_INVÁLIDA Forneça preços com até 8 casas decimais. UsageBasedPricingTerm
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Forneça uma duração entre [x] e [y] meses.
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Certifique-se de que a granularidade da duração esteja no nível do dia para dimensões medidas.
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Certifique-se de que a duração em ConfigurableUpfrontPricingTerm esteja dentro da faixa permitida.
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Forneça uma ou mais durações de contrato suportadas.
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Forneça uma ou mais durações de contrato suportadas ou uma única duração personalizada.
VALOR_DURAÇÃO_SELETOR_INVÁLIDO Forneça uma duração ConfigurableUpfrontPricingTerm que corresponda à duração entre AgreementStartDate AgreementEndDate e.
DURAÇÃO_AUSENTE Forneça a duração em FixedUpfrontPricingTerm.
TERMOS_OBRIGATÓRIOS AUSENTES FixedUpfrontPricingTerm só é suportado quando emparelhado com ByolPricingTerm ou PaymentScheduleTerm.
TERMOS_OBRIGATÓRIOS AUSENTES Forneça pelo menos um de [x, y, z].
TERMOS_OBRIGATÓRIOS AUSENTES Forneça um ByolPricingTerm ao usar o modelo de preços Byol.
MUITOS_SUBSÍDIOS Forneça até [x] subsídios em [y].
MUITOS_CARTÕES_TARIFÁRIOS Somente uma tabela de preços ConfigurableUpfrontPricingTerm é permitida para o produto.
MUITOS_CARTÕES_TARIFÁRIOS Até [x] cartões de avaliação são permitidos ConfigurableUpfrontPricingTerm para o produto.
MUITAS_TARIFAS Forneça RateCards dentro dos limites permitidos em ConfigurableUpfrontPricingTerm.
MUITAS_TARIFAS Forneça RateCards dentro dos limites permitidos em UsageBasedPricingTerm.

Atualizar detalhes do cronograma de pagamento

Você pode usar a API do Catálogo 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 parceiro de canal pode:

  • Use o tipo de UpdateMarkup alteração para aplicar uma marcação percentual uniforme a todos os planos de pagamento.

  • Use o tipo de UpdatePaymentScheduleTerms alteração para definir valores de pagamento personalizados com um valor maior ou igual ao fornecido na Autorização de Revenda. As datas de pagamento não podem ser alteradas. As duas opções não podem ser aplicadas simultaneamente. Se uma marcação for aplicada primeiro e você precisar alterá-la para aplicar um cronograma de pagamento, defina a marcação 0 por meio do tipo de UpdateMarkup alteração. Se um plano de pagamento for aplicado primeiro, você não poderá reverter a alteração para aplicar a marcação.

Para atualizar os detalhes associados ao pagamento de 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 sobre os campos para adicionar o tipo de UpdatePaymentScheduleTerms alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação.

    • Condições (matriz de estruturas) — Lista das condições de pagamento que você deseja atualizar. As condições de pagamento aceitas são:

      • PaymentScheduleTerm(objeto) — Define um modelo de preços baseado em parcelas em que os clientes pagam um preço fixo em datas diferentes durante o período de validade do contrato.

        • Tipo (string) — Tipo do termo que está sendo atualizado. Este é o valor do objeto:"PaymentScheduleTerm".

        • Cronograma (matriz de estruturas) — Lista do cronograma de pagamento em que cada elemento define uma parcela do pagamento. Ele contém as informações necessárias para calcular o preço a ser pago e a data em que o cliente seria cobrado.

          • ChargeDate(string) — A data em que o cliente pagaria o preço definido nesse prazo do cronograma de pagamento. ChargeDateé representado em YYYY-MM-DD formato. As faturas são geradas na data fornecida.

          • ChargeAmount(string) — O preço que o cliente pagaria na data programada (ChargeDate).

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação HTTP
Termos

Obrigatório

Somente "PaymentScheduleTerm" é permitido

O tamanho da lista deve ser menor que 2

 422
Termos []. PaymentScheduleTerm.CurrencyCode

Obrigatório

Moedas suportadas: ["USD”, “AUD”, “EUR”, “GBP”, “JPN"]

 422
Termos []. PaymentScheduleTerm.Schedule[]

Obrigatório

O tamanho da lista deve estar entre 1 e 60, inclusive

 422
Termos []. PaymentScheduleTerm.Schedule[]. ChargeDate

Obrigatório

Formato: "YYYY-MM-DD”

 422
Termos []. PaymentScheduleTerm.Schedule[]. ChargeAmount Obrigatório

O tipo de dados é “String”

Non-negativenúmeros decimais com até 2 casas decimais suportadas

Nenhuma propriedade adicional é permitida

 422

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.

Código de erro Mensagem de erro
DATAS_DE_COBRANÇA DUPLICADAS Forneça datas de cobrança exclusivas em PaymentScheduleTerm.
PERCENTAGEM DE MARCAÇÃO INCOMPATÍVEL PaymentScheduleTerm não é suportado quando MarkupPercentage é maior que zero (0).
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Forneça termos que sejam compatíveis com ResaleAuthorization o. Termos incompatíveis: [PaymentScheduleTerm].
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que a ChargeAmounts entrada total PaymentScheduleTerm seja compatível com ResaleAuthorization o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que as datas de cobrança PaymentScheduleTerm sejam iguais às datas de cobrança no ResaleAuthorization.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que o valor da cobrança PaymentScheduleTerm seja maior ou igual ao valor da ResaleAuthorization cobrança nessa data.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada após o lançamento da oferta.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada depois que a oferta expirar.
TERMOS_INCOMPATÍVEIS Use UpdatePaymentScheduleTerms com um valor de pagamento específico ou UpdateMarkup com uma única porcentagem de marcação para as datas programadas.
DATAS_DE_COBRANÇA INVÁLIDAS Forneça datas de cobrança antes AgreementEndDate.
MUITAS_COBRANÇAS RETROATIVAS Forneça até 1 pagamento agendado antes AvailabilityEndDate.
Código de erro Mensagem de erro
DATAS_DE_COBRANÇA DUPLICADAS Forneça datas de cobrança exclusivas em PaymentScheduleTerm.
CÓDIGO_DE_MOEDA INCOMPATÍVEL CurrencyCode não pode ser alterado após o lançamento da oferta.
PERCENTAGEM DE MARCAÇÃO INCOMPATÍVEL PaymentScheduleTerm não é suportado quando MarkupPercentage é maior que zero (0).
CONFIGURAÇÕES_DE PAGAMENTO INCOMPATÍVEIS Atualize suas configurações de pagamento para serem compatíveis com CurrencyCode o.
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Forneça termos que sejam compatíveis com ResaleAuthorization o. Termos incompatíveis: [PaymentScheduleTerm].
AUTORIZAÇÃO_DE REVENDA INCOMPATÍVEL Certifique-se de que a ChargeAmounts entrada total PaymentScheduleTerm seja compatível com ResaleAuthorization o.
VERIFICAÇÃO_DE_VENDEDOR INCOMPATÍVEL Conclua todos os processos necessários de verificação do vendedor.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada após o lançamento da oferta.
TERMOS_INCOMPATÍVEIS A alteração solicitada não pode ser realizada depois que a oferta expirar.
DATAS_DE_COBRANÇA INVÁLIDAS Forneça datas de cobrança antes AgreementEndDate.
CÓDIGO_DE_MOEDA INVÁLIDO Forneça um suporte CurrencyCode.
CÓDIGO_DE_MOEDA INVÁLIDO Forneça o mesmo CurrencyCode em todos os preços e condições de pagamento.
MUITAS_COBRANÇAS RETROATIVAS Forneça até 1 pagamento agendado antes AvailabilityEndDate.

Publique o CPPO

Você pode usar a API do Catálogo para mesclar as informações coletadas de todos os tipos de alteração de atualização e depois publicar a oferta em AWS Marketplace.

As ofertas permanecem em um Draft estado, até ReleaseOffer que sejam chamadas. 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 sobre os campos para adicionar o tipo de ReleaseOffer alteração:

  • Entidade (objeto) (obrigatório) — Seu CPPO.

    • Tipo (string) (obrigatório) — O Type é sempreOffer@1.0.

    • Identificador (string) (obrigatório) — Seu ID da oferta. Para obter mais informações, consulte Identificador.

  • DetailsDocument(object) (obrigatório) — O valor JSON das especificações da solicitação. Deve estar vazio paraReleaseOffer.

Sintaxe de resposta

Um conjunto de alterações é criado para sua solicitação. A resposta a essa solicitação fornece a 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 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, ou diretamente por meio da API de catálogo, usando a operação da DescribeChangeSet API.

Validações síncronas

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

Campo de entrada Regra de validação
Detalhes Deve estar vazio ({})

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.

Código de erro Mensagem de erro
CONFIGURAÇÕES_DE PAGAMENTO INCOMPATÍVEIS Atualize suas configurações de pagamento para serem compatíveis com CurrencyCode o.
PRODUTO_INCOMPATÍVEL Primeiro, crie uma oferta pública para o produto.
VERIFICAÇÃO_DE_VENDEDOR INCOMPATÍVEL Conclua todos os processos necessários de verificação do vendedor.
SOLICITAÇÃO_DE ATUALIZAÇÃO INVÁLIDA A alteração solicitada não pode ser realizada após o lançamento da oferta.
DATA DE TÉRMINO DO CONTRATO AUSENTE Forneça uma AgreementEndDate para ofertas de substituição.
DATA DE TÉRMINO DA DISPONIBILIDADE_FALTANTE Forneça uma AvailabilityEndDate oferta privada.
TERMOS_OBRIGATÓRIOS AUSENTES Forneça um FixedUpfrontPricingTerm quando a oferta contiver um PaymentScheduleTerm.
CONTAS DE COMPRADORES AUSENTES PositiveTargeting BuyersAccounts Forneça ofertas criadas usando ResaleAuthorization.
CONTAS DE COMPRADORES AUSENTES Todas as ofertas do produto devem ser privadas. Forneça PositiveTargeting com BuyersAccounts.
DESCRIÇÃO_AUSENTE Defina a descrição antes de lançar a oferta.
TERMOS_OBRIGATÓRIOS AUSENTES Adicione [x] à oferta.
TERMOS_OBRIGATÓRIOS AUSENTES Forneça um FixedUpfrontPricingTerm quando a oferta contiver um PaymentScheduleTerm.
NOME_AUSENTE Defina o nome antes de liberar a oferta.
MUITAS_OFERTAS Somente uma oferta pública pode ser criada por produto.
MUITAS_OFERTAS Somente uma oferta pública de teste gratuito pode ser criada por produto.

Definir um CPPO existente

Você pode usar a API do Catálogo para definir detalhes do CPPO em AWS Marketplace.

Para definir um CPPO existente, chame a operação de 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 sobre os campos para adicionar o tipo de DescribeEntity alteração:

  • catalog (string) — O catálogo relacionado à solicitação. Valor fixo:AWSMarketplace.

  • entityID (string) — O ID exclusivo da oferta a ser descrita.

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:

  • EntityType(string) — O tipo nomeado da entidade, que éOffer@1.0.

  • EntityIdentifier(string) — O identificador da entidade, no formato deEntityId@RevisionId.

  • EntityArn(string) — O ARN associado ao identificador exclusivo do conjunto de alterações referenciado nessa solicitação.

  • LastModifiedDate(string) — A data da última modificação da entidade, no formato ISO 8601 ()2018-02-27T13:45:22Z.

  • DetailsDocument(objeto) — O objeto JSON inclui os detalhes da entidade.

    • Id (string) — Identificador exclusivo de uma entidade de oferta em AWS Marketplace e é gerado durante a criação de uma oferta.

    • State (string) — O status da oferta.

    • Nome (string) — Nome associado à oferta para melhor legibilidade para você e seus clientes. Também será exibido como parte das informações do Contrato.

    • Descrição (string) — A descrição é um texto de formato livre que deve ser usado somente por você e nunca será exposto aos compradores.

    • PreExistingAgreement(string) — Determina se essa oferta é uma renovação de um contrato existente com um cliente existente para o mesmo produto subjacente. O acordo existente pode ser interno ou externo AWS Marketplace. AWS pode auditar e verificar se sua oferta é uma renovação. Se AWS não conseguir verificar sua oferta, AWS poderá revogar a oferta e os direitos do seu cliente.

      • AcquisitionChannel(string) — Indica se o contrato existente foi assinado externamente AWS Marketplace ou internamente AWS Marketplace. Valores possíveis:External,AwsMarketplace.

      • PricingModel(string) — Indica qual modelo de preços o contrato existente usa. Valores possíveis:Contract,Usage,Byol,Free.

    • ProductId(string) — A descrição é um texto de formato livre que deve ser usado somente por você e nunca será exposto aos compradores.

    • ResaleAuthorizationId(string) — ResaleAuthorization é usado para criar a oferta privada.

    • MarkupPercentage(string) — Valor percentual que o parceiro de canal transmitiu no tipo de UpdateMarkup alteração. Essa marcação já está aplicada aos termos.

    • Termos (matriz de estruturas) — Lista de termos.

    • Regras (matriz de estruturas) — Lista de regras.