ドキュメント
開発者ハブAPIステータスサポート
入力を開始して検索...

在庫補充API v2022-11-07ユースケースガイド

出品パートナーの在庫補充プログラムの指標とオファー情報を返します。

APIバージョン：2022-11-07

在庫補充APIとは

在庫補充のSelling Partner API（在庫補充API）では、出品パートナーの在庫補充プログラム事業に関する情報を返すことができます。現在は定期お得便（SnS）在庫補充プログラムがサポートされています。在庫補充APIを使用すると、出品パートナーの在庫補充業務のパフォーマンスに関する指標と、その在庫補充プログラムのオファーに関する情報を返すアプリケーションを作成できます。

Some attributes or use cases might not be applicable to both sellers and vendors. Refer to the Replenishment API v2022-11-07 reference for details.

補充APIは、Amazonサブスクライブならどこでも利用できます & セーブはライブです。この API は、ベンダーやフルフィルメント by Amazon (FBA) の出品パートナーも利用できます。

主な機能

  • ビジネス指標データを取得する：在庫補充APIは、一定期間にわたって集計されたさまざまな指標を返すことができます。データは、カタログアイテム（ASIN）レベルで返すこともできます。

  • 出品者のオファーの詳細を取得する：在庫補充APIは、出品者が定期お得便に登録している在庫補充プログラムのオファーに関する詳細を返すことができます。

用語

  • 在庫補充プログラム：受取人が選択した頻度で、補充可能な商品を定期的に配送するプログラム。

  • 定期お得便（SnS）：Amazonの在庫補充プログラム。顧客が選択した頻度で、補充可能な商品を定期的に配送（自動または手動）します。

  • オファー：在庫補充オファー。出品オファーとは異なります。在庫補充オファーは、Amazon標準識別番号（ASIN）、出品パートナーID、マーケットプレイスID、SKUによって、バックエンドサービスで一意に特定されます。

  • 有効なオファー：新規購読の対象となる在庫補充プログラムのオファー。

  • 出品パートナー：出品パートナーは出品者またはベンダーです。

チュートリアル：特定の条件で絞り込んだ出品パートナーの在庫補充オファーをすべて取得する

このチュートリアルでは、在庫補充APIを使用して、フィルター条件に基づいて出品パートナーの在庫補充（現在は定期お得便）オファーを返す方法について説明します。

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

  • Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
  • ブランド分析ロールが開発者プロフィールに割り当てられていること。
  • ブランド分析ロールがアプリケーションのアプリ登録ページで選択されていること。
  • The marketplace identifier for the marketplace for which to return data. Refer to Marketplace IDs to find the identifier for a marketplace. Refer to the Replenishment API v2022-11-07 reference for details about supported marketplaces.

タスク1 - 出品パートナーの有効なオファーをすべて取得する

Enabled offers are those which are eligible for new subscriptions. To return enabled offers, call the listOffers operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOffersRequestPagination

 はい
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOffersRequestFilters

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOffersRequestSort

 いいえ

The filters parameter supports an optional eligibilities array where you can provide the eligibility statuses for the offers that you want to return. To return only the enabled or eligible offers, specify only the "ELIGIBLE" enum value in the eligibilities array, as shown in the following request example.

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters":{
    "eligibilities":["ELIGIBLE"],
    "marketplaceId": "A21TJRUUN4KGV",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  }
}

レスポンス

成功時のレスポンスには、有効なオファーのリストと、各オファーの追加情報が含まれます。

レスポンスの例

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    }
  ],
  "pagination": {
    "totalResults": 1
  }
}

タスク2 - 特定のASINに基づく出品パートナーのオファーをすべて取得する

To return all of the offers under the given ASINs, call the listOffers operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOffersRequestPagination

 はい
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOffersRequestFilters

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOffersRequestSort

 いいえ

filtersパラメーターはオプションのasins配列をサポートしており、次のリクエスト例に示すように、返したいオファーのASINのリストを指定できます。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "asins": ["ASIN_1", "ASIN_2"],
    "marketplaceId": "A21TJRUUN4KGV",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  }
}

レスポンス

成功時のレスポンスには、リクエストしたいずれかのASINに一致するオファーのリストと、各オファーの追加情報が含まれます。

レスポンスの例

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    }
  ],
  "pagination": {
    "totalResults": 1
  }
}

タスク3 - 指定した出品者出資割引の対象となっている、出品パートナーのオファーをすべて取得する

To return all of the offers which have the given seller funded discount, call the listOffers operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOffersRequestPagination

 はい
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOffersRequestFilters

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOffersRequestSort

 いいえ

filtersパラメーターはオプションのpromotionsプロパティをサポートしており、次のリクエスト例に示すように、指定した割引率のオファーのみが含まれるように結果を絞り込むことができます。

次のいずれかでオファーを返すためのリクエスト例 0 または 5 売り手資金調達

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "marketplaceId": "ATVPDKIKX0DER",
    "promotions": {
      "sellingPartnerFundedBaseDiscount": {
        "percentage": [
          0,
          5
        ]
      }
    },
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 25,
    "offset": 10
  },
  "sort": {
    "order": "ASC",
    "key": "ASIN"
  }
}

レスポンス

成功時のレスポンスには、リクエストしたいずれかの出品者出資割引に一致するオファーのリストと、各オファーの追加情報が含まれます。

レスポンスの例

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 0
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_1",
      "sku": "SKU_OPTED_IN"
    },
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_2",
      "sku": "SKU_OPTED_IN_2"
    }
  ],
  "pagination": {
    "totalResults": 2
  }
}

タスク4 - 指定した自動登録設定に一致する出品パートナーのオファーをすべて取得する（出品者にのみ適用）

To return all offers which have the requested auto enrollment preference, call the listOffers operation, passing following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOffersRequestPagination

 はい
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOffersRequestFilters

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOffersRequestSort

 いいえ

filtersパラメーターはオプションのpreferencesプロパティをサポートしており、次のリクエスト例に示すように、指定したautoEnrollment設定に一致するオファーのみが含まれるように結果を絞り込むことができます。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search
{
  "filters": {
    "marketplaceId": "A21TJRUUN4KGV",
    "preferences": {
      "autoEnrollment": [
        "OPTED_IN"
      ]
    },
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 20
  },
  "sort": {
    "order": "ASC",
    "key": "ASIN"
  }
}

レスポンス

成功時のレスポンスには、指定したいずれかの自動登録設定に一致するオファーのリストと、各オファーの追加情報が含まれます。

レスポンスの例

{
  "offers": [
    {
      "marketplaceId": "ATVPDKIKX0DER",
      "offerProgramConfiguration": {
        "preferences": {
          "autoEnrollment": "OPTED_IN"
        },
        "promotions": {
          "sellingPartnerFundedBaseDiscount": {
            "percentage": 5
          },
          "sellingPartnerFundedTieredDiscount": {
            "percentage": 0
          },
          "amazonFundedBaseDiscount": {
            "percentage": 5
          },
          "amazonFundedTieredDiscount": {
            "percentage": 10
          }
        },
        "enrollmentMethod": "AUTOMATIC"
      },
      "programType": "SUBSCRIBE_AND_SAVE",
      "eligibility": "ELIGIBLE",
      "asin": "ASIN_2",
      "sku": "SKU_OPTED_IN_2"
    }
  ],
  "pagination": {
    "totalResults": 2
  }
}

チュートリアル：出品パートナーの在庫補充業務指標を取得する

このチュートリアルでは、在庫補充APIを使用して、出品パートナーの在庫補充プログラム（現在は定期お得便）を返す方法について説明します。以下の指標がサポートされています。

  • SHIPPED_SUBSCRIPTION_UNITS
  • TOTAL_SUBSCRIPTIONS_REVENUE
  • ACTIVE_SUBSCRIPTIONS
  • NOT_DELIVERED_DUE_TO_OOS
  • SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE
  • LOST_REVENUE_DUE_TO_OOS
  • SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS
  • COUPONS_REVENUE_PENETRATION
  • REVENUE_BY_DELIVERIES
  • SUBSCRIBER_RETENTION
  • REVENUE_PENETRATION_BY_SELLER_FUNDING
  • SHARE_OF_COUPON_SUBSCRIPTIONS

Refer to Metric for the metric names and descriptions.

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

  • Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
  • ブランド分析ロールが開発者プロフィールに割り当てられていること。
  • ブランド分析ロールがアプリケーションのアプリ登録ページで選択されていること。
  • The marketplace identifier for the marketplace for which to return data.. Refer to Marketplace IDs to find the identifier for a marketplace. Refer to the Replenishment API v2022-11-07 reference for details about supported marketplaces.

タスク1 - 指定した頻度で集計されたすべてのパフォーマンス指標を取得する

To return a selling partner's past performance metrics, call the getSellingPartnerMetrics operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
aggregationFrequency レスポンス内のデータをグループ化するために使用される期間。これが有効なのは、パフォーマンス期間タイプに限られることに注意してください。

Type: AggregationFrequency

 いいえ
timeInterval 指標の計算に使用される期間。

Type: TimeInterval

 はい
metrics リクエストした指標のリスト。指標値が指定されていない場合は、すべての指標のデータが返されます。

Type: < Metric > array

 いいえ
timePeriodType リクエストした指標が過去に関するもの（パフォーマンス）か、将来に関するもの（予測）かを決定する期間タイプ。

Type: TimePeriodType

 はい
marketplaceId The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to MarketPlace IDs to find the identifier for the marketplace.

タイプ：文字列

 はい
programTypes 指標を返す在庫補充プログラムタイプのリスト。

Type: ProgramTypes

 はい

metricsパラメーターのデフォルトは、使用可能なすべての指標を返すことです。そのため、すべての使用可能な指標を返すには、次のリクエスト例に示すようにmetricsパラメーターを省略します。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
  "aggregationFrequency": "WEEK",
  "timeInterval": {
    "endDate": "2023-03-11T00:00:00Z",
    "startDate": "2023-03-05T00:00:00Z"
  },
  "timePeriodType": "PERFORMANCE",
  "marketplaceId": "ATVPDKIKX0DER",
  "programTypes": [
    "SUBSCRIBE_AND_SAVE"
  ]
}

レスポンス

A successful response includes the data for each available metric. For each metric, the timeInterval used is returned in the response and is determined based on the aggregation frequency. Refer to TimeInterval for more information.

レスポンスの例

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 5290,
      "notDeliveredDueToOOS": 5.54,
      "totalSubscriptionsRevenue": 131340.24,
      "lostRevenueDueToOOS": 93.29,
      "couponsRevenuePenetration": 46.22,
      "activeSubscriptions": 0,
      "currencyCode": "USD",
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      }
    },
    {
      "subscriberAverageRevenue": 125.93,
      "nonSubscriberAverageRevenue": 73.62,
      "currencyCode": "USD",
      "subscriberAverageReorders": 4.61,
      "nonSubscriberAverageReorders": 2.38,
      "timeInterval": {
        "endDate": "2023-05-24T21:13:55Z",
        "startDate": "2022-05-24T21:13:55Z"
      }
    }
  ]
}

タスク2 - 指定した頻度で集計された特定のパフォーマンス指標を取得する

オプションのmetricsパラメーターを指定すると、使用可能なすべての指標を返す代わりに特定の指標をリクエストできます。

To return a selling partner's past performance metrics, call the getSellingPartnerMetrics operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
aggregationFrequency レスポンス内のデータをグループ化するために使用される期間。これが有効なのは、パフォーマンス期間タイプに限られることに注意してください。

Type: AggregationFrequency

 いいえ
timeInterval 指標の計算に使用される期間。

Type: TimeInterval

 はい
metrics リクエストした指標のリスト。指標値が指定されていない場合は、すべての指標のデータが返されます。

Type: < Metric > array

 いいえ
timePeriodType リクエストした指標が過去に関するもの（パフォーマンス）か、将来に関するもの（予測）かを決定する期間タイプ。

Type: TimePeriodType

 はい
marketplaceId The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to MarketPlace IDs to find the identifier for the marketplace.

タイプ：文字列

 はい
programTypes 指標を返す在庫補充プログラムタイプのリスト。

Type: ProgramTypes

 はい

To request specific metrics for a selling partner, provide one or more Metric values in the metrics parameter, as shown in the following request example:

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
  "aggregationFrequency": "WEEK",
  "timeInterval": {
    "endDate": "2023-03-11T00:00:00Z",
    "startDate": "2023-03-05T00:00:00Z"
  },
  "metrics": [
    "SHIPPED_SUBSCRIPTION_UNITS",
  ],
  "timePeriodType": "PERFORMANCE",
  "marketplaceId": "ATVPDKIKX0DER",
  "programTypes": [
    "SUBSCRIBE_AND_SAVE"
  ]
}

レスポンス

A successful response includes the requested metrics. For each metric, the timeInterval used is returned in the response and is determined based on the aggregation frequency. Refer to TimeInterval for more information.

レスポンスの例

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 50,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      }
    }
  ]
}

タスク3 - 今後30日、60日、または90日の予測指標データを取得する（出品者にのみ適用）

To return forecast metrics for the next 30, 60, or 90 days, call the getSellingPartnerMetrics operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
timeInterval 指標の計算に使用される期間。

Type: TimeInterval

 はい
metrics リクエストした指標のリスト。指標値が指定されていない場合は、すべての指標のデータが返されます。

Type: < Metric > array

 いいえ
timePeriodType リクエストした指標が過去に関するもの（パフォーマンス）か、将来に関するもの（予測）かを決定する期間タイプ。

Type: TimePeriodType

 はい
marketplaceId The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to MarketPlace IDs to find the identifier for the marketplace.

タイプ：文字列

 はい
programTypes 指標を返す在庫補充プログラムタイプのリスト。

Type: ProgramTypes

 はい

getSellingPartnerMetricsオペレーションを呼び出すときに、過去のパフォーマンス指標ではなく将来の予測指標を返すように選択できます。予測指標をリクエストするには、timePeriodTypeパラメーターの値としてFORECASTを指定します。

今後30日、60日、90日のデータを利用できます。予測データを返すには、timeIntervalパラメーターで指定する日付/時間範囲の値を30日、60日、または90日にする必要があります。指定したtimeIntervalが正確に30日、60日、または90日に一致しない場合は、次に多い予測日数になるように切り上げられます。

たとえば、期間が91日の場合、レスポンスには今後30日、60日、90日の予測指標が含まれます。期間が89日の場合、レスポンスには今後30日、60日、90日の予測指標が含まれます。期間が59日の場合、レスポンスには今後30日と60日の予測指標が含まれます。

サポートされている予測指標は、TOTAL_SUBSCRIPTIONS_REVENUEとSHIPPED_SUBSCRIPTION_UNITS指標のみです。

予測指標は出品者のみが利用できます。

今日が2023-05-25T00:00:00Zで、予測指標を返したいとします。次のリクエスト例は、SHIPPED_SUBSCRIPTION_UNITS指標について今後90日間の予測データをリクエストする方法を示しています。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/sellingPartners/metrics/search
{
    "timeInterval": {
      "endDate": "2023-08-23T00:00:00Z",
      "startDate": "2023-05-25T00:00:00Z"
    },
    "metrics":["SHIPPED_SUBSCRIPTION_UNITS"],
    "timePeriodType": "FORECAST",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": ["SUBSCRIBE_AND_SAVE"]
}

レスポンス

成功時のレスポンスには、リクエストした指標が含まれます。各指標について、リクエストで指定したtimeInterval値に応じて30日、60日、または90日のいずれかのtimeIntervalがレスポンスで返されます。

レスポンスの例

{
  "metrics": [
    {
      "shippedSubscriptionUnits": 10,
      "timeInterval": {
        "endDate": "2023-06-24T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    },
    {
      "shippedSubscriptionUnits": 20,
      "timeInterval": {
        "endDate": "2023-07-24T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    },
    {
      "shippedSubscriptionUnits": 30,
      "timeInterval": {
        "endDate": "2023-08-23T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    }
  ]
}

チュートリアル：出品パートナーの各オファーの在庫補充ビジネス指標を取得する

このチュートリアルでは、在庫補充APIを使用して、ASINレベルで出品パートナーの在庫補充指標を返す方法を説明します。以下の指標がサポートされています。

  1. SHIPPED_SUBSCRIPTION_UNITS
  2. TOTAL_SUBSCRIPTIONS_REVENUE
  3. ACTIVE_SUBSCRIPTIONS
  4. NOT_DELIVERED_DUE_TO_OOS
  5. SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE
  6. LOST_REVENUE_DUE_TO_OOS
  7. COUPONS_REVENUE_PENETRATION
  8. REVENUE_BY_DELIVERIES
  9. SUBSCRIBER_RETENTION
  10. REVENUE_PENETRATION_BY_SELLER_FUNDING
  11. SHARE_OF_COUPON_SUBSCRIPTIONS

Refer to Metric for the metric names and descriptions.

前提条件

このチュートリアルを正常に完了するには、次のものが必要です。

  • Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
  • ブランド分析ロールが開発者プロフィールに割り当てられていること。
  • ブランド分析ロールがアプリケーションのアプリ登録ページで選択されていること。
  • The marketplace identifier for the marketplace for which to return data.. Refer to Marketplace IDs to find the identifier for a marketplace. Refer to the Replenishment API v2022-11-07 reference for details about supported marketplaces.

タスク1 - 指定した頻度で集計されたパフォーマンス指標データを取得する

To return a selling partner's performance metrics for every ASIN, call the listOfferMetrics operation, passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOfferMetricsRequestPagination

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOfferMetricsRequestSort

 いいえ
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOfferMetricsRequestFilters

 はい

filtersパラメーターは、過去のパフォーマンス指標または将来の予測指標を選択できるようにするtimePeriodTypeプロパティをサポートしています。パフォーマンス指標を返すには、timePeriodType値としてPERFORMANCEを指定する必要があります。

listOfferMetricsオペレーションは、集約頻度の1単位分の時間間隔のみをサポートします。たとえば、集約頻度のMONTHの期間はstartDateからendDateまでとなり、1か月を超えることはできません。

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search
{
  "filters": {
    "aggregationFrequency": "WEEK",
    "timeInterval": {
      "endDate": "2023-03-11T00:00:00Z",
      "startDate": "2023-03-05T00:00:00Z"
    },
    "timePeriodType": "PERFORMANCE",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 10
  },
  "sort": {
    "order": "ASC",
    "key": "SHIPPED_SUBSCRIPTION_UNITS"
  }
}

レスポンス

成功時のレスポンスには、各ASINについてリクエストした指標が含まれます。

レスポンスの例

{
  "offers": [
    {
      "notDeliveredDueToOOS": 30.78,
      "shippedSubscriptionUnits": 20,
      "totalSubscriptionsRevenue": 12.89,
      "asin": "B000TMUDOW",
      "revenuePenetration": 10.34,
      "lostRevenueDueToOOS": 12.32,
      "couponsRevenuePenetration": 10,
      "shareOfCouponSubscriptions": 24.04,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      },
      "currencyCode": "USD"
    },
    {
      "notDeliveredDueToOOS": 40.78,
      "shippedSubscriptionUnits": 40,
      "totalSubscriptionsRevenue": 34.03,
      "asin": "B004CLH5CY",
      "revenuePenetration": 9.87,
      "lostRevenueDueToOOS": 17.82,
      "couponsRevenuePenetration": 17,
      "shareOfCouponSubscriptions": 20.04,
      "timeInterval": {
        "endDate": "2023-03-11T00:00:00Z",
        "startDate": "2023-03-05T00:00:00Z"
      },
      "currencyCode": "USD"
    }
  ],
  "pagination": {
    "totalResults": 17
  }
}

タスク2 - 今後30日、60日、または90日の予測指標データを取得する（出品者にのみ適用）

To return forecast metrics data for every ASIN, call the listOfferMetrics operation,
passing the following parameters:

ボディのパラメーター

パラメーター 説明 必須
pagination これらのパラメーターは、レスポンスのページ割りに使用します。

Type: ListOfferMetricsRequestPagination

 はい
sort これらのパラメーターは、レスポンスの並べ替えに使用します。

Type: ListOfferMetricsRequestSort

 いいえ
filters これらのパラメーターは、結果の絞り込みに使用します。結果は、指定したすべてのパラメーターと一致する必要があります。パラメーターが配列である場合は、結果は指定した配列の少なくとも1つの要素と一致する必要があります。

Type: ListOfferMetricsRequestFilters

 はい

listOfferMetricsオペレーションを呼び出すときに、過去のパフォーマンス指標ではなく将来の予測指標を返すように選択できます。予測指標をリクエストするには、filtersパラメーターのtimePeriodTypeプロパティの値としてFORECASTを指定します。

listOfferMetricsオペレーションは、集約頻度の1単位分の時間間隔のみをサポートします。たとえば、集約頻度のMONTHの期間はstartDateからendDateまでとなり、1か月を超えることはできません。

サポートされている予測指標は、TOTAL_SUBSCRIPTIONS_REVENUEとSHIPPED_SUBSCRIPTION_UNITS指標のみです。

予測指標は出品者のみが利用できます。

次のリクエストは、現在の日付を例として、今後90日間の予測データをリクエストする方法を示しています 2023-05-25T00:00:00Z:

リクエストの例

POST https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search
{
  "filters": {
    "timeInterval": {
      "endDate": "2023-08-23T00:00:00Z",
      "startDate": "2023-05-25T00:00:00Z"
    },
    "timePeriodType": "FORECAST",
    "marketplaceId": "ATVPDKIKX0DER",
    "programTypes": [
      "SUBSCRIBE_AND_SAVE"
    ]
  },
  "pagination": {
    "limit": 10,
    "offset": 10
  }
}

レスポンス

成功時のレスポンスには、各ASINで使用可能な予測指標が含まれます。

レスポンスの例

{
  "offers": [
    {
      "next30DayTotalSubscriptionsRevenue": 0,
      "next60DayTotalSubscriptionsRevenue": 61.8,
      "next90DayTotalSubscriptionsRevenue": 30.9,
      "asin": "B0872JRNS2",
      "next90DayShippedSubscriptionUnits": 20,
      "next60DayShippedSubscriptionUnits": 10,
      "next30DayShippedSubscriptionUnits": 2,
      "currencyCode": "USD",
      "timeInterval": {
        "endDate": "2023-08-23T00:00:00Z",
        "startDate": "2023-05-25T00:00:00Z"
      }
    }
  ],
  "pagination": {
    "totalResults": 17
  }
}

Updated about 2 months ago

このページは役に立ちましたか？