こんにちは、Ryohei(@ityryohei)です!

本記事では、Stripeですべての商品情報を取得する方法をご紹介しています。アーカイブ済みの商品を除外する方法もあわせてご紹介しています。

Stripeに登録しているすべての商品情報を取得して商品一覧ページを作成したいな。良い方法ないかな?

上記の疑問にお答えします。

では、解説していきます。

すべての商品情報を取得する

Stripeに登録しているすべての商品情報を取得します。Stripeに登録済みの商品を使って、商品一覧ページを作成する場合などに有効な方法です。

$stripe = new \Stripe\StripeClient([
  "api_key" => "sk_xxxxxxxxxx",
  "stripe_version" => "2022-08-01"
]);

$products = $stripe->products->all();

参考:https://stripe.com/docs/api/products/list

すべての商品からアーカイブした商品を除外して取得する

すべての商品のうちアーカイブした商品が必要なければ、オプションのactivetrueを指定します。activetrueを指定することで、Stripeの管理画面でアーカイブにした商品を除外して取得することができます。

$stripe = new \Stripe\StripeClient([
  "api_key" => "sk_xxxxxxxxxx",
  "stripe_version" => "2022-08-01"
]);

$products = $stripe->products->all([
    "active" => true
]);

参考:https://stripe.com/docs/api/products/list#list_products-active

複数の商品IDを指定して商品情報を取得する

複数の商品IDを指定し、該当する商品情報を取得します。オプションのidsに配列形式で商品IDを指定します。

$stripe = new \Stripe\StripeClient([
    "api_key" => "sk_xxxxxxxxxx",
    "stripe_version" => "2022-08-01"
]);

$products = $stripe->products->all([
    "active" => true,
    "ids" => ["prod_xxxxx1", "prod_xxxxx2"],
]);

参考:https://stripe.com/docs/api/products/list#list_products-ids

最後に

Stripeでは、商品、支払い、顧客とECサイトに必要な情報をすべて管理することができます。そのたStripeを使えば簡易的なECサイトを構築する可能です。

Stripeには非常に使いやすいテスト環境が用意されているため、Stripe APIの勉強がてら、開発環境等でECサイトを作成してみるのも良いかもしれません。

以上、Stripeですべての商品情報を取得する方法のご紹介でした!

この記事を書いた人

Ryohei

Webエンジニア / ブロガー

福岡のWeb制作会社に務めるWebエンジニアです。エンジニア歴は10年程で、好きな言語はPHPとJavaScriptです。本サイトは私がインプットしたWebに関する知識を整理し、共有することを目的に2015年から運営しています。Webに関するご相談があれば気軽にお問い合わせください。