AWS Marketplace API 參考已重組。如需支援的 API 操作的詳細資訊，請參閱 AWS Marketplace API 參考。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 AWS Marketplace APIs 處理頻道合作夥伴的私有優惠

您可以使用 AWS Marketplace Catalog API 自動化使用頻道合作夥伴私有優惠 (CPPOs的任務。

當您建立或更新 CPPO 時，提議草稿將包含來自轉售授權的條款和規則，買方將無法看見。在您的組織中涉及多個角色可以建立私有優惠，但並非必要。

例如，一個角色可以負責更新價格，而第二個角色可以負責更新付款排程。然後，第三個角色可以負責更新法律條款。您可以授予角色許可，以更新優惠的特定部分。不過，您可以僅授予重新銷售授權的讀取許可。

作為呼叫變更類型的先決條件，您必須已收到一或多個轉售授權，並熟悉如何使用 AWS Marketplace Catalog API。

如需詳細資訊，請參閱 AWS Marketplace 賣方指南中的頻道合作夥伴私有優惠。

下列主題說明如何使用目錄 API 來建立和更新 CPPOs：

CPPO 先決條件

ResaleAuthorization (SLR) 設定的服務連結角色是使用轉售授權建立 CPPO 的必要先決條件。若要使用轉售授權，獨立軟體廠商 (ISVs) 和 AWS Marketplace 頻道合作夥伴都必須建立服務連結角色，為 提供資源共用許可 AWS。如果兩個群組都無法執行此先決條件， AWS 就無法將授權資源從 ISV 分享給 AWS Marketplace 頻道合作夥伴。如需詳細資訊，請參閱《 AWS Marketplace 賣方指南》中的使用 的 角色進行轉售授權 AWS Marketplace。

建立 CPPO

您可以使用以您為目標的轉售授權來建立處於 Draft 狀態的頻道合作夥伴私有優惠 (CPPO) AWS Marketplace。

如果您的請求已成功處理， 會使用轉售授權條款為您 AWS Marketplace Catalog API 產生處於 Draft 狀態的優惠。您可以使用 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 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": []
    }
  ]
}

您可以使用 GETDescribeEntity請求來描述 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 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

建立頻道合作夥伴私有替代優惠

您可以使用目錄 API 在其中建立頻道合作夥伴私有替代優惠 AWS Marketplace。

您可以使用ResaleAuthorization針對您的 和 協議，作為提案者，透過StartChangeSet使用CreateReplacementOfferUsingResaleAuthorization變更類型呼叫 ，在目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的CreateReplacementOfferUsingResaleAuthorization動作 AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的CreateReplacementOfferUsingResaleAuthorization動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新標記

您可以使用目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括與 AWS Marketplace 賣方營運團隊驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateTargeting動作 AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateTargeting動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新法律資源

您可以使用目錄 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 準則。驗證程序可能需要幾分鐘到幾個小時。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。

同步驗證

下列結構描述驗證專屬於 中的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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateAvailability動作 AWS Marketplace Catalog API。當您呼叫 時，會執行這些驗證StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateAvailability動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

定義協議的過期日期

您可以使用目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateValidityTerms動作 AWS Marketplace Catalog API。當您呼叫 時，會執行這些驗證StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateValidityTerms動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新定價

您可以使用目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdatePricingTerms動作 AWS Marketplace Catalog API。當您呼叫 時，會執行這些驗證StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdatePricingTerms動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新付款排程詳細資訊

您可以使用目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdatePaymentScheduleTerms動作 AWS Marketplace Catalog API。當您呼叫 時，會執行這些驗證StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdatePaymentScheduleTerms動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

發佈 CPPO

您可以使用目錄 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合 AWS Marketplace 準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態 AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的ReleaseOffer動作 AWS Marketplace Catalog API。當您呼叫 時，會執行這些驗證StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的ReleaseOffer動作 AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

定義現有的 CPPO

您可以使用目錄 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回應的輸入欄位資訊：