AWS Marketplace API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、AWS Marketplace API リファレンスを参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Marketplace APIs

を使用して AWS Marketplace Catalog API 、チャネルパートナーのプライベートオファー (CPPOs) を操作するタスクを自動化できます。

CPPO を作成または更新すると、オファー案には再販承認の条項とルールが含まれ、購入者には表示されません。組織内の複数のペルソナを関与させてプライベートオファーを作成することは可能ですが、必須ではありません。

たとえば、1 つのペルソナが料金の更新を担当し、もう 1 つのペルソナが支払いスケジュールの更新を担当できます。その後、3 番目のペルソナが法的条件の更新に責任を負うことができます。ペルソナにオファーの特定の部分を更新するアクセス許可を付与できます。ただし、再販認可には読み取りアクセス許可のみを付与できます。

変更タイプを呼び出すための前提条件として、1 つ以上の再販認可を受けており、 の操作に精通している必要があります AWS Marketplace Catalog API。

詳細については、「 AWS Marketplace 販売者ガイド」の「チャネルパートナーのプライベートオファー」を参照してください。

以下のトピックでは、 Catalog API を使用して CPPOs を作成および更新する方法について説明します。

CPPO の前提条件

ResaleAuthorization (SLR) 設定のサービスにリンクされたロールは、再販認可を使用して CPPO を作成するための必須の前提条件です。再販認可を使用するには、独立系ソフトウェアベンダー (ISVs) と AWS Marketplace チャネルパートナーの両方が、 にリソース共有アクセス許可を提供するサービスにリンクされたロールを作成する必要があります AWS。両方のグループがこの前提条件を実行しない場合、ISV から AWS Marketplace チャネルパートナーに認可リソースを共有 AWS することはできません。詳細については、AWS Marketplace 「 Seller Guide」の「Using roles for Resale Authorization for for AWS Marketplace 」を参照してください。

CPPO を作成する

再販承認を使用して、 Draft状態のチャネルパートナープライベートオファー (CPPO) を作成します AWS Marketplace。

リクエストが正常に処理されると、 は再販承認条件を使用して Draft 状態のオファー AWS Marketplace Catalog API を生成します。を使用してDescribeEntity、再販承認からオファー案に適用される条件を確認できます。これは不完全なオファーであり、 の購入者には表示されません AWS Marketplace。次に、CPPO に関連付けられた変更タイプを使用してオファーを完了します。

オファーが完了したら、ReleaseOffer変更タイプを使用してオファー作成プロセスを完了し、オファーをリリースします。これにより、オファー全体が検証され、オファーが購入者に表示されます AWS Marketplace。

チャネルパートナーのプライベートオファーを作成するには、次の例に示すように、 CreateOfferUsingResaleAuthorization変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

CreateOfferUsingResaleAuthorization 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

このリクエストに対するレスポンスは、リクエストのステータスを示します。ステータスが の場合SUCCEEDED、新しい OfferId が生成されます。

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

GET DescribeEntity リクエストを使用して、 AWS Marketplace Catalog API リファレンスの から作成されたオファーのドラフトルールと条件ResaleAuthorizationを記述できます。詳細については、「DescribeChangeSet」を参照してください。

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

同期検証

以下のスキーマ検証は、 のCreateOfferUsingResaleAuthorizationアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のCreateOfferUsingResaleAuthorizationアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

チャネルパートナーのプライベート代替オファーを作成する

Catalog API を使用して、チャネルパートナーのプライベート代替オファーを作成できます AWS Marketplace。

次の例に示すように、 ResaleAuthorizationを CreateReplacementOfferUsingResaleAuthorization変更タイプStartChangeSetで呼び出すことで、ターゲットを絞った と、提案者である 契約を使用して、Catalog API でチャネルパートナーのプライベート代替オファーを Draft状態で作成します。代替オファーを使用して、以前のオファーの契約を終了前に置き換えることができます。

CreateReplacementOfferUsingResaleAuthorization は、ターゲティングにおける契約アクセプターとのオファー案を作成します。このターゲットは後で変更できません。オファー案には、契約のソースオファー ID も含まれます。

チャネルパートナーのプライベート代替オファーを作成するには、次の例に示すように、 CreateReplacementOfferUsingResaleAuthorization変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

CreateReplacementOfferUsingResaleAuthorization 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のCreateReplacementOfferUsingResaleAuthorizationアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のCreateReplacementOfferUsingResaleAuthorizationアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

マークアップの更新

Catalog API を使用して、 オファーの料金条件をパーセンテージ値で更新できます AWS Marketplace。

これにより、ResaleAuthorization で製造元が定義したすべての料金条件と支払い条件 (将来の支払いスケジュールの場合) に、指定されたパーセンテージのマークアップが適用されます。既存のマークアップは上書きされます。を使用して、更新された料金と支払い条件を表示できますDescribeEntity。

マークアップを更新するには、次の例に示すように、UpdateMarkup変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdateMarkup 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace Seller Operations チームで情報を検証し、ガイドラインを満たし AWS Marketplace ていることを確認することが含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateMarkupアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateMarkupアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

ターゲット設定を更新する

Catalog API を使用して、既存のターゲティング設定を完全に置き換えることができます AWS Marketplace。

最新のリクエストに含まれていない既存のターゲティングオプションは、オファーから削除されます。製造元は、 で特定のターゲット購入者について言及できますResaleAuthorization。チャネルパートナーは、UpdateTargeting変更タイプPositiveTargetingで を使用して、購入者のサブセットにプライベートオファーを提供できます。

オファーのターゲット設定を更新するには、次の例に示すように、UpdateTargeting変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdateTargeting 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateTargetingアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateTargetingアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

法的リソースを更新する

Catalog API を使用して、再販認可の法的条件をマージし、既存の法的条件を完全に置き換えることができます AWS Marketplace。

この変更は既存の契約には影響しません。最新のリクエストに含まれていない法的条件は、オファーから削除されます。を呼び出すことで、マージされた法的用語を表示できますDescribeEntity。

オファーの法的条件を更新するには、次の例に示すように、UpdateLegalTerms変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdateLegalTerms 変更タイプを追加するフィールドの情報を入力します。

リクエストの変更セットが作成されます。このリクエストへのレスポンスは、変更セットの ID を提供します。

レスポンスの構文

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

変更リクエストがキューに追加され、処理されます。これには、ガイドラインを満たし AWS Marketplace ていることを確認するための AWS Marketplace Seller Operations チームへの情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または DescribeChangeSetアクションを使用して Catalog API で確認できます。

同期検証

以下のスキーマ検証は、 のUpdateLegalTermsアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateLegalTermsアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

CPPO の検出可能性を更新する

Catalog API を使用して、オファーの検出可能性を管理できます AWS Marketplace。この変更タイプは既存の契約には影響しません。

将来の特定の日付を設定してオファーの検出可能性を制限するか、過去に設定してオファーを期限切れにするかを選択できます。

オファーの検出可能性を管理するには、次の例に示すように、UpdateAvailability変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdateAvailability 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateAvailabilityアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateAvailabilityアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

契約の有効期限を定義する

Catalog API を使用して、このオファーを使用して作成された契約の有効期限を定義できます AWS Marketplace。

この変更は、既存の契約には影響しません。製造元は、再販認可で最大契約開始日を記載できます。ただし、チャネルパートナーは、その日付より後の契約開始日を指定することはできません。

契約の有効期限を定義するには、次の例に示すように、UpdateValidityTerms変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdateValidityTerms 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdateValidityTermsアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdateValidityTermsアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

料金を更新する

Catalog API を使用して、既存の料金条件を完全に置き換えることができます。

最新のリクエストに含まれていない料金条件は、オファーから削除されます。チャネルパートナーは、この変更タイプを を渡すためにのみ使用できますFixedUpFrontPricingTerm。

オファーの料金条件を更新するには、次の例に示すように、UpdatePricingTerms変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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
              }
            ]
          }
        ]
      }
    }
  ]
}

UpdatePricingTerms 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdatePricingTermsアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdatePricingTermsアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

支払いスケジュールの詳細を更新する

Catalog API を使用して、柔軟な支払いスケジュールなどの支払いスケジュールの詳細を変更できます AWS Marketplace。

製造元が再販認可で支払いスケジュールを提供している場合、チャネルパートナーは次のいずれかを行うことができます。

オファーの支払い関連の詳細を更新するには、次の例に示すように、UpdatePaymentScheduleTerms変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

UpdatePaymentScheduleTerms 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のUpdatePaymentScheduleTermsアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のUpdatePaymentScheduleTermsアクションに固有です AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

CPPO を発行する

Catalog API を使用して、すべての更新変更タイプから収集された情報をマージし、オファーを公開できます AWS Marketplace。

オファーは、 ReleaseOffer が呼び出されるまで Draft状態のままです。オファーがリリースされると、 で検出できます AWS Marketplace。

オファーを公開するには、次の例に示すように、ReleaseOffer変更タイプを使用して StartChangeSet API オペレーションを呼び出します。

リクエストの構文

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

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

ReleaseOffer 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

リクエストの変更セットが作成されます。このリクエストに対するレスポンスは、変更セットChangeSetArnの ChangeSetIdと を提供し、次のようになります。

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

変更リクエストがキューに追加され、処理されます。これには、 AWS Marketplace ガイドラインを満たしていることを確認するための情報の検証が含まれます。検証プロセスには数分から数時間かかる場合があります。

リクエストのステータスは、 を通じて AWS Marketplace 管理ポータル、または API オペレーションを使用して Catalog DescribeChangeSet API から直接確認できます。

同期検証

以下のスキーマ検証は、 のReleaseOfferアクションに固有です AWS Marketplace Catalog API。これらの検証は、 を呼び出すときに実行されますStartChangeSet。リクエストが次の要件を満たしていない場合、HTTP レスポンスで失敗します。

非同期エラー

以下のエラーは、 のReleaseOfferアクションに固有のものです AWS Marketplace Catalog API。これらのエラーは、変更セットの処理DescribeChangeSet後に を呼び出すと返されます。DescribeChangeSet を使用して変更リクエストのステータスを取得する方法の詳細については、「」を参照してください変更セットの使用。

既存の CPPO を定義する

Catalog API を使用して、CPPO の詳細を定義できます AWS Marketplace。

既存の CPPO を定義するには、次の例に示すように、 Offer@1.0エンティティタイプで DescribeEntity API オペレーションを呼び出します。

リクエストの構文

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

DescribeEntity 変更タイプを追加するフィールドの情報を入力します。

レスポンスの構文

このリクエストに対するレスポンスは、オファーの詳細を提供し、次のようになります。

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

DescribeEntity レスポンスの入力フィールドの情報を入力します。