コンテンツにスキップ
Docs
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

購入リンク

商品ごとに1本ある、購入画面を開くための URL。

購入リンクは購入画面を開くための URL です。商品ごとに1本あり、商品を作ると同時に作られます。自分のサイトにはこの購入リンクを置きます。

しくみ

商品を作ってから、お客様の注文ができるまでは、次の順に進みます。

商品を作ると、購入リンクができる

商品を作ると、標準の購入リンクが1本作られます。URL は /checkout/ で始まり、商品ごとの識別子が続きます。

お客様が購入リンクを開く

購入リンクを開くと、購入画面が開きます。

お客様が支払う

お客様はメールアドレスを入力し、カードで支払います。

注文ができる

支払いが終わると、注文が1件できます。詳しくは 注文 を参照してください。

商品をアーカイブすると、その購入リンクでの新規購入が止まります。既存のお客様の閲覧は続きます。アーカイブした商品の購入リンクをお客様が開くと、「このページは開けません」と「この商品の販売は終了しています。」が表示されます。

販売の準備(審査の承認と売上の受け取り先の登録)が済むまでは、購入リンクを開いても「この商品は現在購入できません」と表示され、お客様は購入できません。管理画面の商品詳細にも「アカウントの審査が完了するまで、このリンクでは購入できません」と表示されます。

サイトに置く

管理画面の商品詳細には、購入リンクを確認するための3つのタブがあります。

  • 「リンク」:自分のサイトに置く購入リンクの URL です。
  • 「HTMLタグ」:そのまま貼れる HTML のリンクです。見た目はサイト側で調整します。
  • 「プロダクトID」:SDK の設定に使う商品IDです。購入者限定ページの保護に必要です。

購入リンクの例は次のとおりです。

<a href="(管理画面の「リンク」タブの URL)">購入する</a>

API で扱う

購入リンクは外部 API で取得と発行ができます。

  • 取得:GET /products/{product_id}/checkout-link(スコープは checkout_links:read)。購入リンクが発行されていなければ 404 になります。無効なリンクは disabled: true で返ります。
  • 発行:PUT /products/{product_id}/checkout-link(スコープは checkout_links:write)。リンクが新しく作られたときは 201、既存のリンクを返したときは 200 です。

発行では、商品がアーカイブ済みのとき(product_archived)と、既存の標準リンクが無効なとき(checkout_link_disabled)は 409 になります。Cozeni が別のリンクを作ったり、無効なリンクを有効に戻したりすることはありません。

API の詳細は次を参照してください。

次に読むページ

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