【シナリオエディタ】外部連携API
お知らせ
2023年5月30日(火)のリリースで、一部APIノードの名称を以下の通り変更いたしました。
※名称のみの変更となり、挙動に変更はございません。
・(変更前)ecforce 定期一覧API →(変更後)ecforce 定期選択API
・(変更前)ecforce 定期商品詳細API →(変更後)ecforce 定期商品選択API
・(変更前)ecforce 定期商品変更可能商品一覧API →(変更後)ecforce 定期商品変更可能商品選択API
・(変更前)ecforce 定期配送サイクル取得API →(変更後)ecforce 定期配送サイクル選択API
・(変更前)ecforce 定期受注停止理由取得API →(変更後)ecforce 定期停止理由選択API
・(変更前)ecforce 定期受注キャンセル理由取得API →(変更後)ecforce 定期キャンセル理由選択API
・(変更前)ecforce 受注一覧API →(変更後)ecforce 受注選択API
外部連携APIについて
「外部連携API」のパーツを設定することで、外部サービスとAPI連携をすることができます。
現在、ecforce chatがAPI連携をすることができる外部サービスは「ecforce」と「LINE LIFF」です。
「外部連携API」のパーツを配置する
「外部連携API」のパーツをドラッグします。エディタ内にドロップすると、【API追加】画面が表示されます。
項目 | 説明 |
---|---|
サービスタイプ | サービスタイプを設定できます。 |
サービス | API連携をする外部サービス名を設定できます。 |
API | APIの種類を設定できます。 設定できるAPIは以下です。 ▼ecforce
|
設定が完了したら、「追加する」をクリックします。「追加する」をクリックすると、APIの設定画面が表示されます。
設定が完了したら、「設定する」をクリックします。
※APIの設定方法については、各種APIの設定方法についてをご参照ください。「外部連携API」のパーツが配置されます。
各種APIの設定方法について
ecforce MultiPass API
ecforce MultiPass APIは、すでにecforceのマイページにログインしているユーザーをecforce chat上でもログインしている状態にするAPIです。
注意点
ecforce MultiPass APIは、ショップページ上でのみ利用可能です。
シナリオエディタ内の「動作確認」ボタンからは動作しません。
起動した際「リクエストパラメータのメールアドレスが設定されていません。」のエラーが表示される仕様です。
【ecforce MultiPass API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
シークレットキー | ecforceのMultiPass シークレットキーを設定してください。 ※ MultiPass シークレットキーは、ecforce管理画面の【設定を変更する > 外部連携アカウント > MultiPass(API)】画面にてご確認ください。 |
メールアドレス | デフォルトで変数が設定されているので、設定する必要はありません。 ※デフォルト値を編集・削除してしまった場合は、右側のプルダウンメニューから「ecforce 変数」の「会員メールアドレス(ログイン済み画面)」を選択して「設定」をクリックしてください。 |
メールアドレスハッシュ値 | デフォルトで変数が設定されているので、設定する必要はありません。 ※デフォルト値を編集・削除してしまった場合は、右側のプルダウンメニューから「ecforce 変数」の「会員メールアドレスハッシュ値(ログイン済み画面)」を選択して「設定」をクリックしてください。 |
ecforce MultiPass APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ecforceへのログインに成功した場合の選択肢です。 |
失敗 | ecforceへのログインに失敗した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce LINE MultiPass API ※プロフェッショナルプランのみ
ecforce LINE MultiPass APIは、LINE LIFF プロフィール情報取得APIで取得したユーザーのLINE IDもしくはメールアドレスを用いて、ecforce chat上でecforceのマイページにログインしている状態にするAPIです。
注意点
ecforce LINE MultiPass APIはプロフェッショナルプランでのみ使用することができます。
スタンダードプランをご契約中で本APIを使用したい場合は、カスタマーサポートへお問い合わせください。
また、本APIを使用する場合はユーザーのLINEのプロフィール情報(LINE IDもしくはメールアドレス)が必要になるため、予めLINE LIFF プロフィール情報取得APIが実行されている必要があります。
※本APIは以下の順序でユーザーの検索を行い、合致したユーザーをログイン状態にします。
LINE IDが一致する会員 → LINE IDが一致する仮会員 → LINE IDが一致するゲスト → LINE IDが一致するビジター → メールアドレスが一致する会員 → メールアドレスが一致する仮会員 → メールアドレスが一致するゲスト → メールアドレスが一致するビジター
【ecforce LINE MultiPass API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
シークレットキー | ecforceのMultiPass シークレットキーを設定してください。 ※ MultiPass シークレットキーは、ecforce管理画面の【設定を変更する > 外部連携アカウント > MultiPass(API)】画面にてご確認ください。 |
LINE ID | LINE IDで認証をする場合は、右側のプルダウンメニューから「プロフィール情報取得(LINE LIFF - チャット)」の「LINE ID[sub]」を選択して「設定」をクリックしてください。 ※未設定の場合は、「LINEメールアドレス」で認証をします。 |
LINEメールアドレス | LINEに登録しているメールアドレスで認証をする場合は、右側のプルダウンメニューから「プロフィール情報取得(LINE LIFF - チャット)」の「メールアドレス[email]」を選択して「設定」をクリックしてください。 ※未設定の場合は、「LINE ID」で認証をします。 |
ecforce LINE MultiPass APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ecforceへのログインに成功した場合の選択肢です。 |
失敗 | ecforceへのログインに失敗した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce ログインAPI
ecforce ログインAPIは、ユーザーがフォームに入力したecforceのログイン情報(メールアドレスとパスワード)を用いて、ユーザーをecforceのマイページにログインしている状態にするAPIです。
注意点
ecforce ログインAPIを使用する場合、ユーザーのecforceのログイン情報(メールアドレスとパスワード)が必要になるため、応答タイプが「フォーム」の対話ノードを予め設定しておく必要があります。
【ecforce ログインAPI】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
メールアドレス | 右側のプルダウンメニューからフォームの対話ノードの「メールアドレス」に設定した変数名(「ユーザー発言記憶用の名前」)を選択して「設定」をクリックしてください。 |
パスワード | 右側のプルダウンメニューからフォームの対話ノードの「パスワード」に設定した変数名(「ユーザー発言記憶用の名前」)を選択して「設定」をクリックしてください。 |
ecforce ログインAPIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ecforceへのログインに成功した場合の選択肢です。 |
失敗 | ecforceへのログインに失敗した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客詳細API
ecforce 顧客詳細APIは、ecforceに登録されているユーザー情報の詳細を取得するAPIです。
【ecforce 顧客詳細API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
ecforce 顧客詳細APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ユーザーの情報取得に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客メモ登録API
ecforce 顧客メモ登録APIは、ユーザーの顧客メモ(ecforce管理画面の【顧客管理 > 顧客管理 > 該当ユーザー】の「メモ管理」タブ)を登録するAPIです。
【ecforce 顧客メモ登録API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
メモ | ecforceの顧客メモに登録したい内容を設定してください。 ※下側のプルダウンメニューから変数を選択して設定することができます。 |
受付者メンバーID | ecforceのメンバーIDを設定してください。 |
ecforce 顧客メモ登録APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 顧客メモの登録に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 招待コード発行API
ecforce 招待コード発行APIは、ユーザーの招待コードを発行するAPIです。
注意点
ecforce 招待コード発行APIを使用する場合、予め以下いずれかのAPIが実行されている必要があります。
・ecforce MultiPass API
・ecforce LINE MultiPass API
・ecforce ログインAPI
【ecforce 招待コード発行API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
ecforce 招待コード発行APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 招待コードの発行に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客メール送信API
ecforce 顧客メール送信APIは、ユーザーにメールを送信するAPIです。
注意点
ecforce 顧客メール送信APIは、ecforceに登録されているユーザーのメールアドレス宛に、ecforceからメールを送信する機能です。
メールの配信状況は、ecforce管理画面の【顧客管理 > 顧客管理 > 対象顧客の詳細 > メール配信履歴】画面にてご確認ください。
また、ecforce管理画面でユーザーにメールを送信しない設定となっている(【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブで「このアドレスにメールを送信しない」にチェックが入っている)場合、ユーザーにメールは送信されません。※詳細は、顧客管理をご参照ください。
【ecforce 顧客メール送信】画面にて、以下のように設定をしてください。
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
メールタイトル | メールのタイトルを設定してください。 |
メール本文 | メールの本文を設定してください。 |
CC | CCで受け取るメールアドレスを設定してください。 |
BCC | BCCで受け取るメールアドレスを設定してください。 |
ecforce 顧客メール送信APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | メールの送信に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客LINE ID更新API
ecforce 顧客LINE ID更新APIは、LINE LIFF プロフィール情報取得APIで取得したユーザーのLINE IDをecforce上のユーザーのLINE IDとして登録(更新)するAPIです。
注意点
ecforce 顧客LINE ID更新APIを使用する場合、ユーザーのLINEのプロフィール情報(LINE ID)が必要になるため、予めLINE LIFF プロフィール情報取得APIが実行されている必要があります。
【ecforce 顧客LINE ID更新API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
LINE ID | 右側のプルダウンメニューから「プロフィール情報取得(LINE LIFF - チャット)」の「LINE ID[sub]」を選択して「設定」をクリックしてください。 |
ecforce 顧客LINE ID更新APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | LINE IDの更新に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客情報入力API
ecforce 顧客情報入力APIは、ユーザーの情報を入力するAPIです。
【ecforce 顧客情報入力API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
入力項目 - 基本 | 表示する項目にチェックを入れてください。 |
入力項目 - 請求先 | 表示する項目にチェックを入れてください。 |
メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 顧客情報入力APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 情報の入力に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客登録・更新API
ecforce 顧客登録・更新APIは、ecforce上にユーザーを登録する、もしくはecforce上に存在しているユーザーの情報を更新するAPIです。
注意点
ユーザーがecforceのマイページにログイン済みの場合は、ユーザーの情報を更新します。
ユーザーの請求先情報を登録・更新する場合は、以下の項目を設定する必要があります。
・姓
・郵便番号1
・都道府県ID
・住所1
・電話番号1
【ecforce 顧客登録・更新API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
顧客情報入力ノード変数を設定する | ecforce 顧客情報入力APIで設定した変数を一括で設定したい場合は、「顧客情報入力ノード変数を設定する」をクリックしてください。 |
会員ステータス | 会員ステータスを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「ステータス」が更新されます。 以下いずれかの値を設定してください。 ・visitor:ビジター ・guest:ゲスト ・temporary_member:仮会員 ・member:会員 |
メールアドレス | メールアドレスを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「メールアドレス」が更新されます。 |
パスワード | パスワードを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「パスワード」が更新されます。 |
生年月日 | 生年月日を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「生年月日」が更新されます。 |
性別ID | 性別IDを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「性別」が更新されます。 性別IDは、ecforce管理画面の【設定 > 顧客/会員 > 性別管理】画面にてご確認ください。 |
メールマガジン受け取り | ecforceから配信されるすべてのメールを停止するか否かの設定ができます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「メールマガジン受け取り」が更新されます。 以下いずれかの値を設定してください。 ・0:受け取らない ・1:受け取る |
このアドレスにメールを送信しない | ecforceから配信されるすべてのメールを停止するか否かの設定ができます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「このアドレスにメールを送信しない」が更新されます。 以下いずれかの値を設定してください。 ・0:停止しない ・1:停止する |
姓 | 名前(姓)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「お名前(1カラム目)」が更新されます。 1カラムにまとめる場合は、本項目に「姓」と「名」を設定してください。 |
名 | 名前(名)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「お名前(2カラム目)」が更新されます。 |
セイ | 名前のフリガナ(セイ)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「フリガナ(1カラム目)」が更新されます。 1カラムにまとめる場合は、本項目に「セイ」と「メイ」を設定してください。 |
メイ | 名前のフリガナ(メイ)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「フリガナ(2カラム目)」が更新されます。 |
郵便番号1 | 郵便番号(前半部)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「郵便番号(1カラム目)」が更新されます。 1カラムにまとめる場合は、本項目に「郵便番号1」と「郵便番号2」を設定してください。 |
郵便番号2 | 郵便番号(後半部)を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「郵便番号(2カラム目)」が更新されます。 |
都道府県ID | 都道府県IDを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「都道府県」が更新されます。 以下いずれかの値を設定してください。 1:北海道,2:青森県, 3:岩手県, 4:宮城県, 5:秋田県, 6:山形県, 7:福島県, 8:茨城県, 9:栃木県, 10:群馬県, 11:埼玉県, 12:千葉県, 13:東京都, 14:神奈川県, 15:新潟県, 16:富山県, 17:石川県, 18:福井県, 19:山梨県, 20:長野県, 21:岐阜県, 22:静岡県, 23:愛知県, 24:三重県, 25:滋賀県, 26:京都府, 27:大阪府, 28:兵庫県, 29:奈良県, 30:和歌山県, 31:鳥取県, 32:島根県, 33:岡山県, 34:広島県, 35:山口県, 36:徳島県, 37:香川県, 38:愛媛県, 39:高知県, 40:福岡県, 41:佐賀県, 42:長崎県, 43:熊本県, 44:大分県, 45:宮崎県, 46:鹿児島県, 47:沖縄県 |
住所1 | 住所を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「住所(1カラム目)」が更新されます。 |
住所2 | 住所を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「住所(2カラム目)」が更新されます。 |
住所3 | 住所を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「住所(3カラム目)」が更新されます。 |
電話番号1 |
電話番号を設定できます。 |
電話番号2 | 電話番号を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「電話番号(2カラム目)」が更新されます。 |
電話番号3 | 電話番号を設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「電話番号(3カラム目)」が更新されます。 |
LINE ID | LINE IDを設定できます。 ※ecforce管理画面の【顧客管理 > 顧客管理 > 該当顧客】画面の「基本情報」タブの「LINE ID」が更新されます。 |
ecforce 顧客登録・更新APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 情報の入力に成功した場合の選択肢です。 |
メールアドレスエラー ※ユーザーを登録する場合のみ |
メールアドレスがすでにecforce上に登録されている場合などの選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 顧客ポイント付与API
ecforce 顧客ポイント付与APIは、ユーザーにポイントを付与するAPIです。
注意点
ecforce 招待コード発行APIを使用する場合、予め以下いずれかのAPIが実行されている必要があります。
・ecforce MultiPass API
・ecforce LINE MultiPass API
・ecforce ログインAPI
・ecforce 顧客登録・更新API
【ecforce 顧客ポイント付与API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
ポイント名目ID | 顧客に付与するポイントのポイント名目IDを設定してください。 ※ポイント名目IDは、ecforce管理画面の【設定 > ポイント > ポイント名目管理】画面にてご確認ください。 |
ポイント数 | 顧客に付与するポイント数を設定してください。 なお、正の値を設定するとポイントが付与され、負の値を設定するとポイントが減算されます。 注意点ポイント数には、「ポイント名目ID」に設定したポイント名目IDの「名目種別」(付与 / 減算)に合った値を設定してください。 |
ecforce 顧客ポイント付与APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ポイントの付与に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期選択API
ecforce 定期選択APIは、ユーザーが持っている定期の情報を取得するAPIです。
取得した定期の中からユーザーに定期を選択させることができます。
注意点
ecforce 定期選択APIを使用する場合、予め以下いずれかのAPIが実行されている必要があります。
・ecforce MultiPass API
・ecforce LINE MultiPass API
・ecforce ログインAPI
【ecforce 定期選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
商品ID | 特定の商品の定期を取得したい場合のみ、商品の商品IDを設定してください。 ※商品IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[基本設定]タブで確認できます。 なお、商品IDは複数設定することができます。(上限なし) 複数の商品IDを設定する場合は、改行区切りで設定してください。 商品IDを複数設定した場合、いずれかの商品IDの商品をもつ定期を取得します。 また、「商品ID」と「SKU ID」それぞれを設定した場合は、商品IDとSKU IDを組み合わせて検索し、商品IDとSKU IDの両方が合致した商品をもつ定期を取得します。 |
SKU ID | 特定の商品の定期を取得したい場合のみ、商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 なお、SKU IDは複数設定することができます。(上限なし) 複数のSKU IDを設定する場合は、改行区切りで設定してください。 SKU IDを複数設定した場合、いずれかのSKU IDの商品をもつ定期を取得します。 また、「商品ID」と「SKU ID」それぞれを設定した場合は、商品IDとSKU IDを組み合わせて検索し、商品IDとSKU IDの両方が合致した商品をもつ定期を取得します。 |
定期選択メッセージ | ユーザーが複数の定期を持っている場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | ユーザーが複数の定期を持っている場合、「選択方式」で設定した方式で定期の一覧が表示されます。 フォームの項目名を設定してください。 |
選択項目テキスト | ユーザーが複数の定期を持っている場合、ユーザーが定期を選択できます。 選択項目に表示するテキストを設定してください。 |
選択方式 | ユーザーが複数の定期を持っている場合、ユーザーが定期を選択できます。 定期の選択方式を設定してください。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像について定期に設定されている商品の画像(ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像)が表示されます。 ・ラジオ(商品画像) 表示される画像について定期に設定されている商品の画像(ecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像)が表示されます。 |
対象ステータス | 取得対象とする定期のステータスにチェックを入れてください。 ・有効(active) ・停止(suspend) ・キャンセル(canceled) |
送信ボタンテキスト | ユーザーが複数の定期を契約している場合、ユーザーが定期を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
定期選択 | ステータスが「有効」の定期情報の取得に成功した場合の選択肢です。 |
エラー (定期0件) | ユーザーが、ステータスが「有効」の定期を1件も契約していない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品選択API
ecforce 定期商品選択APIは、ecforce 定期選択APIで選択した定期に設定されている商品を取得するAPIです。
取得した商品の中からユーザーに商品を選択させることができます。
注意点
ecforce 定期商品選択APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 定期選択API
【ecforce 定期商品選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
SKU ID | 特定の商品を選択させたい場合のみ、商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 なお、SKU IDは複数設定することができます。(上限なし) 複数のSKU IDを設定する場合は、改行区切りで設定してください。 |
定期商品選択メッセージ | 定期に複数の商品が設定されている場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | 定期に複数の商品が設定されている場合、「選択方式」で設定した方式で商品の一覧が表示されます。 フォームの項目名を設定してください。 |
選択方式 | 定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。 商品の選択方式を設定してください。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像が表示されます。 ・ラジオ(商品画像) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。 |
送信ボタンテキスト | 定期に複数の商品が設定されている場合、ユーザーが商品を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期商品選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
商品選択 | 定期に設定されている商品の選択に成功した場合の選択肢です。 |
エラー (商品0件) | 定期に商品が1つも設定されていない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品追加API
ecforce 定期商品追加APIは、ecforce 定期選択APIで選択した定期に商品を追加するAPIです。
※マイページからの定期商品の追加は許可せず、ecforce chatからの定期商品の追加は許可する場合にご使用ください。
ecforce 定期商品追加APIとecforce 定期商品追加API(マイページ挙動)の違い
ecforce 定期商品追加APIとecforce 定期商品追加API(マイページ挙動)はどちらも定期に商品を追加するAPIですが、以下の違いがあります。
・ecforce 定期商品追加API:ecforce管理画面上で定期に商品を追加する操作と同じ挙動
→マイページからの定期商品の追加を許可していない場合でも定期に商品を追加できます。
・ecforce 定期商品追加API(マイページ挙動):マイページ上で定期に商品を追加する操作と同じ挙動
→マイページからの定期商品の追加を許可していない場合は定期に商品を追加できません。
注意点
ecforce 定期商品追加APIを使用する場合、予めecforce 定期選択APIが実行されている必要があります。
【ecforce 定期商品追加API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
追加SKU ID | 追加する商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 ecforce SKU選択APIでユーザーが選択したSKU IDを設定したい場合は、右側のプルダウンメニューから「SKU選択(ecforce - EC)」の「商品バリエーションID [variant.id]」を選択して「設定」をクリックしてください。 |
個数 | 個数を設定してください。 |
次回のみお届け設定 | 商品を次回の受注にのみ追加するか否かの設定ができます。 ▼「毎回お届け」の場合 追加した商品が設定された状態で次回の受注が作成された後、追加した商品は定期から削除されず、設定されたままの状態となります。 ▼「次回のみお届け」の場合 追加した商品が設定された状態で次回の受注が作成された後、追加した商品は定期から削除されます。 |
ecforce 定期商品追加API(マイページ挙動)の選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の追加に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品追加API(マイページ挙動)
ecforce 定期商品追加API(マイページ挙動)は、ecforce 定期選択APIで選択した定期に商品を追加するAPIです。
ecforce 定期商品追加APIとecforce 定期商品追加API(マイページ挙動)の違い
ecforce 定期商品追加APIとecforce 定期商品追加API(マイページ挙動)はどちらも定期に商品を追加するAPIですが、以下の違いがあります。
・ecforce 定期商品追加API:ecforce管理画面上で定期に商品を追加する操作と同じ挙動
→マイページからの定期商品の追加を許可していない場合でも定期に商品を追加できます。
・ecforce 定期商品追加API(マイページ挙動):マイページ上で定期に商品を追加する操作と同じ挙動
→マイページからの定期商品の追加を許可していない場合は定期に商品を追加できません。
注意点
ecforce 定期商品追加API(マイページ挙動)を使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて以下の設定がされていること
・定期商品の追加 :許可する
・マイページでの商品追加:有効
※詳細は、通常受注に対してマイページ上で「商品の追加」を行えますか?をご参照ください。
【ecforce 定期商品追加API(マイページ挙動)】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
追加SKU ID | 追加する商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 ecforce SKU選択APIでユーザーが選択したSKU IDを設定したい場合は、右側のプルダウンメニューから「SKU選択(ecforce - EC)」の「商品バリエーションID [variant.id]」を選択して「設定」をクリックしてください。 |
個数 | 個数を設定してください。 |
次回のみお届け設定 | 商品を次回の受注にのみ追加するか否かの設定ができます。 ▼「毎回お届け」の場合 追加した商品が設定された状態で次回の受注が作成された後、追加した商品は定期から削除されず、設定されたままの状態となります。 ▼「次回のみお届け」の場合 追加した商品が設定された状態で次回の受注が作成された後、追加した商品は定期から削除されます。 |
ecforce 定期商品追加API(マイページ挙動)の選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の追加に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品削除API
ecforce 定期商品削除APIは、ecforce 定期商品選択APIでユーザーが選択した商品を削除するAPIです。
注意点
ecforce 定期商品削除APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce 定期選択API
・ecforce 定期商品選択API
【ecforce 定期商品削除API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
ecforce 定期商品削除APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の削除に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品変更可能商品選択API
ecforce 定期商品変更可能商品選択APIは、定期の商品に設定されている変更可能商品(変更可能SKUグループ内の商品)を取得するAPIです。
取得した変更可能商品の中からユーザーに変更後の商品を選択させることができます。
注意点
ecforce 定期商品変更可能商品選択APIを使用する場合、以下の条件を満たしている必要があります。
・予め以下のAPIが実行されていること
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 定期選択API
・ecforce 定期商品選択API
・ecforce管理画面にて以下の設定がされていること
・定期商品の変更:許可する
・SKUグループの設定
※詳細は、マイページで変更可能な商品は管理画面のどこで設定できますか?をご参照ください。
【ecforce 定期商品変更可能商品選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
商品選択メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
商品名テキスト | 変更可能商品の表示名を設定してください。 ・商品名 商品名のみが表示されます。 ・規格名 「規格名:分類名」の形式で表示されます。複数の規格が設定されている場合は、規格ごとに「/」で区切られて表示されます。 ・商品名/規格名 「商品名(規格名:分類名)」の形式で表示されます。複数の規格が設定されている場合は、規格ごとに「/」で区切られて表示されます。 |
選択方式 | 商品の選択方式を設定してください。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。 ・ラジオ(商品画像) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期商品変更可能商品選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
商品選択 | 変更可能商品の選択に成功した場合の選択肢です。 |
エラー (変更可能商品なし) | 変更可能商品がない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品変更API
ecforce 定期商品変更APIは、ecforce 定期選択APIで選択した定期の商品を変更するAPIです。
※マイページからの定期商品の変更は許可せず、ecforce chatからの定期商品の変更は許可する場合にご使用ください。
ecforce 定期商品変更APIとecforce 定期商品変更API(マイページ挙動)の違い
ecforce 定期商品変更APIとecforce 定期商品変更API(マイページ挙動)はどちらも定期の商品を変更するAPIですが、以下の違いがあります。
・ecforce 定期商品変更API:ecforce管理画面上で定期の商品を変更する操作と同じ挙動
→マイページからの定期商品の変更を許可していない場合でも定期の商品を変更できます。
・ecforce 定期商品変更API(マイページ挙動):マイページ上で定期の商品を変更する操作と同じ挙動
→マイページからの定期商品の変更を許可していない場合は定期の商品を変更できません。
注意点
ecforce 定期商品変更APIを使用する場合、以下の条件を満たしている必要があります。
・予め以下のAPIが実行されていること
・ecforce 定期選択API
・ecforce 定期商品選択API
・ecforce管理画面にてSKUグループの設定の設定がされていること
※詳細は、マイページ上での商品変更方法をご参照ください。
【ecforce 定期商品変更API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
変更後SKU ID | 変更後の商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 定期商品変更可能商品選択APIでユーザーが選択した商品に変更をしたい場合は、右側のプルダウンメニューから「定期商品変更可能商品選択(ecforce - EC)」の「SKU ID[id]」を選択して「設定」をクリックしてください。 |
個数 | 変更後の商品の個数を設定してください。 変更前の商品の個数と同じにしたい場合は、右側のプルダウンメニューから「定期商品選択(ecforce - EC)」の「個数[quantity]」を選択して「設定」をクリックしてください。 |
ecforce 定期商品変更APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の変更に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期商品変更API(マイページ挙動)
ecforce 定期商品変更API(マイページ挙動)は、ecforce 定期選択APIで選択した定期の商品を変更するAPIです。
ecforce 定期商品変更APIとecforce 定期商品変更API(マイページ挙動)の違い
ecforce 定期商品変更APIとecforce 定期商品変更API(マイページ挙動)はどちらも定期の商品を変更するAPIですが、以下の違いがあります。
・ecforce 定期商品変更API:ecforce管理画面上で定期の商品を変更する操作と同じ挙動
→マイページからの定期商品の変更を許可していない場合でも定期の商品を変更できます。
・ecforce 定期商品変更API(マイページ挙動):マイページ上で定期の商品を変更する操作と同じ挙動
→マイページからの定期商品の変更を許可していない場合は定期の商品を変更できません。
注意点
ecforce 定期商品変更API(マイページ挙動)を使用する場合、以下の条件を満たしている必要があります。
・予め以下のAPIが実行されていること
・ecforce 定期選択API
・ecforce 定期商品選択API
・ecforce管理画面にて以下の設定がされていること
・定期商品の変更:許可する
・SKUグループの設定
※詳細は、マイページ上での商品変更方法をご参照ください。
【ecforce 定期商品変更API(マイページ挙動)】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
変更後SKU ID | 変更後の商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 定期商品変更可能商品選択APIでユーザーが選択した商品に変更をしたい場合は、右側のプルダウンメニューから「定期商品変更可能商品選択(ecforce - EC)」の「SKU ID[id]」を選択して「設定」をクリックしてください。 |
個数 | 変更後の商品の個数を設定してください。 変更前の商品の個数と同じにしたい場合は、右側のプルダウンメニューから「定期商品選択(ecforce - EC)」の「個数[quantity]」を選択して「設定」をクリックしてください。 |
ecforce 定期商品変更API(マイページ挙動)の選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の変更に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期セット商品選択API
ecforce 定期セット商品選択APIは、ユーザーにセット商品を選択させることができるAPIです。
注意点
ecforce 定期セット商品選択APIを使用する場合、ecforce管理画面にてセット販売の設定がされている必要があります。
※詳細は、[オプション]セット販売管理 設定をご参照ください。
【ecforce 定期セット商品選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
最小商品点数 | ユーザーが選択できる商品の最小個数を設定してください。 |
最大商品点数 | ユーザーが選択できる商品の最大個数を設定してください。 |
SKU設定 | 商品情報を設定してください。 ※ecforce管理画面でセットに紐づけた商品(セット商品)の情報を設定してください。 SKU ID:商品のSKU IDを設定してください。 商品名:商品名を設定してください。 最小個数:商品の選択可能数(最小)を設定してください。 最大個数:商品の選択可能数(最大)を設定してください。 |
メッセージ | 表示するメッセージを設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期セット商品選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の選択に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期セット商品変更API
ecforce 定期セット商品変更APIは、ecforce 定期選択APIで選択した定期の商品を、定期セット商品選択APIで選択した商品に変更するAPIです。
注意点
ecforce 定期セット商品変更APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce 定期選択API
・ecforce 定期セット商品選択API
また、本APIは「ecforce 定期セット商品選択API」で選択された商品情報で定期の情報を上書きするため、定期にセット商品以外の商品が設定されていた場合、セット商品以外の商品は削除されます。そのため、本APIを実行する前に「定期にセット商品以外の商品が含まれるか否か」を判定する条件分岐ノードを配置する必要があります。
※詳細は、定期のセット商品を変更するシナリオ作成方法をご参照ください。
【ecforce 定期セット商品変更API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
ecforce 定期セット商品変更APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の変更に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期ポイント利用予約入力API
ecforce 定期ポイント利用予約入力APIは、定期に対して利用予約をするポイント数をユーザーに選択させるAPIです。
注意点
ecforce 定期ポイント利用予約入力APIを使用する場合、予めecforce 顧客詳細APIが実行されている必要があります。
【ecforce 定期ポイント利用予約入力API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
入力可能ポイント数 | ユーザーが入力できるポイント数の下限値と上限値を設定してください。 |
次回のみポイント利用予約 | ポイントを次回の受注にのみに利用するか否かの設定ができます。 ▼「次回のみ」の場合 ポイントは次回の受注のみに利用されます。 ▼「次回以降すべて」の場合 ポイントは次回以降のすべての受注に利用されます。 |
次回のみポイント利用予約の選択 | 「次回のみポイント利用予約」の選択をユーザーにさせるか否かの設定ができます。 ▼「ノード設定を利用する」の場合 項目 「次回のみポイント利用予約」の設定内容を参照します。 ▼「顧客に選択させる」の場合 「次回のみポイント利用する」というプルダウンメニューが表示されます。 ※項目 「次回のみポイント利用予約」の設定内容は参照しません。 |
定期ポイント利用予約入力メッセージ | 表示するメッセージを設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期ポイント利用予約入力APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の変更に成功した場合の選択肢です。 |
保有ポイントなしエラー | 顧客がポイントを保有していなかった場合の選択肢です。 |
保有ポイント不足エラー | 顧客が保有しているポイントが、項目「入力可能ポイント数」の下限値に満たなかった場合の選択肢です。 |
ecforce 定期ポイント利用予約設定API
ecforce 定期ポイント利用予約設定APIは、定期にポイント利用予約の設定をするAPIです。
注意点
ecforce 定期ポイント利用予約設定APIを使用する場合、以下の条件を満たしている必要があります。
・予め以下のAPIが実行されていること
・ecforce 顧客詳細API
・ecforce 定期選択API
・ecforce管理画面にて以下の設定がされていること
・ポイント機能:有効
・ポイント予約機能:有効
※詳細は、ポイントの設定をご参照ください。
また、購入商品の金額を全額ポイントでまかなえる場合、支払い方法は「0円決済」となります。
0円決済を利用する場合、ecforce管理画面にて0円決済の設定を「有効」にする必要があります。
※詳細は、支払い総額0円の決済を行う方法を教えて下さい。をご参照ください。
【ecforce 定期ポイント利用予約設定API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
ポイント利用数 | 定期に設定するポイント数を設定してください。 ecforce 定期ポイント利用予約入力APIでユーザーが選択したポイント数を設定したい場合は、右側のプルダウンメニューから「定期ポイント利用予約入力(ecforce - EC)」の「ポイント利用数[point_redeem]」を選択して「設定」をクリックしてください。 |
次回のみポイント予約 | 右側のプルダウンメニューから「定期ポイント利用予約入力(ecforce - EC)」の「ポイント利用数[onetime_point_redeem]」を選択して「設定」をクリックしてください。 |
ecforce 定期ポイント利用予約設定APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の変更に成功した場合の選択肢です。 |
保有ポイントなしエラー | 顧客がポイントを保有していなかった場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期次回発送・配送日選択API
ecforce 定期次回発送・配送日選択APIは、定期の次回発送予定日もしくは次回配送予定日をユーザーに選択させるAPIです。
【ecforce 定期次回発送・配送日選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
対象範囲日 | 選択可能期間の範囲を設定することができます。 上部の入力欄に起点日を設定し、下部の入力欄に日数を設定してください。 ※日数は必ず設定してください。起点日を設定しなかった場合、ユーザーが本APIのノードを表示した日が起点となります。 例:定期の「前回配送予定日」から90日後までを選択可能としたい場合 |
選択肢開始日 | 選択可能期間の開始日を設定することができます。 上部の入力欄に起点日を設定し、下部の入力欄に日数を設定してください。 ※日数は必ず設定してください。起点日を設定しなかった場合、対象範囲日が起点となります。 例:ユーザーが本APIのノードを表示した日から10日後の日付を選択可能期間の開始日としたい場合 |
休日設定 | 休日設定をすることで、休日として設定した日付を表示しないようにすることができます。 土・日・祝日を休日として設定する場合は、各項目にチェックを入れてください。 土・日・祝日以外にショップの休日(夏季休業など)を設定する場合は、「追加」をクリックし、「開始日」と「終了日」を設定してください。 注意点ユーザーに発送予定日を選択させる場合、ecforceの休日設定と同じ内容を設定することを推奨しております。 |
メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期次回発送・配送日選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 次回発送予定日もしくは次回配送予定日の選択に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期次回発送・配送日変更API
ecforce 定期次回発送・配送日変更APIは、定期の次回発送予定日もしくは次回配送予定日を変更するAPIです。
注意点
ecforce 定期次回発送・配送日変更APIを使用する場合、予めecforce 定期選択APIが実行されている必要があります。
【ecforce 定期次回発送・配送日変更API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
変更対象 | 以下のいずれかを設定してください。 ・次回発送予定日:定期の次回発送予定日を変更する場合 ・次回配送予定日:定期の次回配送予定日を変更する場合 |
変更日 | 変更後の日付を設定してください。 定期次回発送・配送日選択APIでユーザーが選択した日付を設定したい場合は、右側のプルダウンメニューから「定期次回発送・配送日選択(ecforce - EC)」の「選択日[select_date]」を選択して「設定」をクリックしてください。 |
ecforce 定期次回発送・配送日変更APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 次回発送予定日もしくは次回配送予定日の変更に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期配送スキップAPI
ecforce 定期配送スキップAPIは、定期の配送をスキップするAPIです。
注意点
ecforce 定期配送スキップAPIを使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて「次回配送のスキップ:許可する」と設定されていること
※詳細は、マイページ設定をご参照ください。
【ecforce 定期配送スキップAPI】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
ecforce 定期配送スキップAPIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 配送スキップに成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期配送サイクル選択API
ecforce 定期配送サイクル選択APIは、定期に設定されている商品の配送サイクルを取得するAPIです。
取得した定期配送サイクルの中からユーザーに定期配送サイクルを選択させることができます。
注意点
ecforce 定期配送サイクル選択APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 定期選択API
【ecforce 定期配送サイクル選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
次回配送予定日の再計算 | ユーザーが選択した配送サイクルをもとに次回配送予定日を再計算するか否かの設定ができます。 ▼「再計算する」の場合 ユーザーが選択した配送サイクルをもとに、次回配送予定日が再計算されます。 ▼「再計算しない」の場合 次回配送予定日は再計算されません。 |
次回配送予定日の再計算の選択 | 次回配送予定日を再計算の選択をユーザーにさせるか否かの設定ができます。 ▼「ノード設定を利用する」の場合 項目 「次回配送予定日の再計算」の設定内容を参照します。 ▼「顧客に選択させる」の場合 「次回配送予定日の再計算」というプルダウンメニューが表示されます。 ※項目 「次回配送予定日の再計算」の設定内容は参照しません。 |
配送サイクル選択メッセージ | 表示するメッセージを設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期配送サイクル選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 配送サイクルの選択に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期配送サイクル変更API
ecforce 定期配送サイクル変更APIは、定期の配送サイクルを変更するAPIです。
注意点
ecforce 定期配送サイクル変更APIを使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて「定期配送サイクルの変更:許可する」と設定されていること
詳細は、マイページ設定をご参照ください。
【ecforce 定期配送サイクル変更API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
配送サイクル | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「配送サイクル[payment_schedule]」を選択して「設定」をクリックしてください。 |
何ヶ月ごと | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「何ヶ月ごと[scheduled_to_be_delivered_every_x_month]」を選択して「設定」をクリックしてください。 |
何日に | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「何日[scheduled_to_be_delivered_on_xth_day]」を選択して「設定」をクリックしてください。 |
何回目の | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「何回目[scheduled_to_be_delivered_on_xth_day_of_week]」を選択して「設定」をクリックしてください。 |
何曜日に | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「何曜日[scheduled_to_be_delivered_every_x_day_of_week]」を選択して「設定」をクリックしてください。 |
何日ごと | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「何日ごと[scheduled_to_be_delivered_every_x_day]」を選択して「設定」をクリックしてください。 |
次回配送予定日の再計算 | 右側のプルダウンメニューから「定期配送サイクル選択(ecforce - EC)」の「再計算[recalc]」を選択して「設定」をクリックしてください。 |
ecforce 定期配送サイクル変更APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 配送サイクルの変更に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期停止理由選択API
ecforce 定期停止理由選択APIは、ecforceに登録されている停止理由を取得するAPIです。
取得した停止理由の中からユーザーに停止理由を選択させることができます。
【ecforce 定期停止理由選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
親理由ID | 親停止理由に紐付いている子停止理由のみを選択させたい場合、ecforceの「停止理由管理」で作成した親停止理由のIDを設定してください。 |
並び順 | ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、ユーザーがプルダウンメニューから停止理由を選択できます。 プルダウンメニューの停止理由の並び順を設定してください。 ・作成日:降順 ・作成日:昇順 ・ID:降順 ・ID:昇順 ・更新日:降順 ・更新日:昇順 |
理由選択メッセージ | ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、停止理由の一覧がプルダウンメニューで表示されます。 フォームの項目名を設定してください。 |
送信ボタンテキスト | ecforceに複数の停止理由が設定されている、もしくは親停止理由に複数の子停止理由が設定されている場合、ユーザーがプルダウンメニューから停止理由を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期停止理由選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 停止理由の選択に成功した場合の選択肢です。 |
エラー (理由0個) | ecforceに停止理由が設定されていない、もしくは親停止理由に子停止理由が設定されていない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期停止API
ecforce 定期停止APIは、定期を停止するAPIです。
※マイページからの定期解約は許可せず、ecforce chatからの定期解約は許可する場合にご使用ください。
ecforce 定期停止APIとecforce 定期停止API(マイページ挙動)の違い
ecforce 定期停止APIとecforce 定期停止API(マイページ挙動)はどちらも定期を停止するAPIですが、以下の違いがあります。
・ecforce 定期停止API:ecforce管理画面上で定期を停止する操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合でも定期を停止できます。
・ecforce 定期停止API(マイページ挙動):マイページ上で定期を停止する操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合は定期を停止できません。
注意点
ecforce 定期停止APIを使用する場合は、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて「定期解約ステータス:停止」と設定されていること
※詳細は、マイページ設定をご参照ください。
【ecforce定期停止API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
停止理由ID | 停止理由IDを指定することで、定期受注に停止理由を設定することができます。 ecforceに登録されている、停止理由のIDを設定してください。 なお、定期停止理由選択APIでユーザーが選択した停止理由のIDを設定する場合は、右側のプルダウンメニューから「定期停止理由選択(ecforce - EC)」の「理由ID[id]」を選択して「設定」をクリックしてください。 |
ecforce 定期停止APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 定期の停止に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期停止API(マイページ挙動)
ecforce 定期停止API(マイページ挙動)は、定期を停止するAPIです。
ecforce 定期停止APIとecforce 定期停止API(マイページ挙動)の違い
ecforce 定期停止APIとecforce 定期停止API(マイページ挙動)はどちらも定期を停止するAPIですが、以下の違いがあります。
・ecforce 定期停止API:ecforce管理画面上で定期を停止する操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合でも定期を停止できます。
・ecforce 定期停止API(マイページ挙動):マイページ上で定期を停止する操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合は定期を停止できません。
注意点
ecforce 定期停止API(マイページ挙動)を使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて以下の設定がされていること
・定期解約:許可する
・定期解約ステータス:停止
※詳細は、マイページ設定をご参照ください。
【ecforce定期停止API(マイページ挙動)】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
停止理由ID | 停止理由IDを指定することで、定期受注に停止理由を設定することができます。 ecforceに登録されている、親停止理由が「マイページからの停止」である停止理由のIDを設定してください。 なお、定期停止理由選択APIでユーザーが選択した停止理由のIDを設定する場合は、右側のプルダウンメニューから「定期停止理由選択(ecforce - EC)」の「理由ID[id]」を選択して「設定」をクリックしてください。 ※親停止理由が「マイページからの停止」でない停止理由のIDが設定されていた場合、API実行時にエラーとなります。 |
ecforce 定期停止API(マイページ挙動)の選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 定期の停止に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期キャンセル理由選択API
ecforce 定期キャンセル理由選択APIは、ecforceに登録されているキャンセル理由を取得するAPIです。
取得したキャンセル理由の中からユーザーにキャンセル理由を選択させることができます。
【ecforce 定期キャンセル理由選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
親理由ID | 親キャンセル理由に紐付いている子キャンセル理由のみを選択させたい場合、ecforceの「キャンセル理由管理」で作成した親キャンセル理由のIDを設定してください。 |
並び順 | ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、キャンセル理由の一覧がプルダウンメニューで表示されます。 プルダウンメニューのキャンセル理由の並び順を設定してください。 ・作成日:降順 ・作成日:昇順 ・ID:降順 ・ID:昇順 ・更新日:降順 ・更新日:昇順 |
理由選択メッセージ | ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、キャンセル理由の一覧がプルダウンメニューで表示されます。 フォームの項目名を設定してください。 |
送信ボタンテキスト | ecforceに複数のキャンセル理由が設定されている、もしくは親キャンセル理由に複数の子キャンセル理由が設定されている場合、ユーザーがプルダウンメニューからキャンセル理由を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 定期キャンセル理由選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | キャンセル理由の選択に成功した場合の選択肢です。 |
エラー (理由0個) | ecforceにキャンセル理由が設定されていない、もしくは親キャンセル理由に子キャンセル理由が設定されていない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期キャンセルAPI
ecforce 定期キャンセルAPIは、定期をキャンセルするAPIです。
※マイページからの定期キャンセルは許可せず、ecforce chatからの定期キャンセルは許可する場合にご使用ください。
ecforce 定期キャンセルAPIとecforce 定期キャンセルAPI(マイページ挙動)の違い
ecforce 定期キャンセルAPIとecforce 定期キャンセルAPI(マイページ挙動)はどちらも定期をキャンセルするAPIですが、以下の違いがあります。
・ecforce 定期キャンセルAPI:ecforce管理画面上で定期をキャンセルする操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合でも定期をキャンセルできます。
・ecforce 定期キャンセルAPI(マイページ挙動):マイページ上で定期をキャンセルする操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合は定期をキャンセルできません。
注意点
ecforce 定期キャンセルAPIを使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて「定期解約ステータス:キャンセル」と設定されていること
※詳細は、マイページ設定をご参照ください。
【ecforce 定期キャンセルAPI】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
キャンセル理由ID | キャンセル理由IDを指定することで、定期受注にキャンセル理由を設定することができます。 ecforceに登録されている、キャンセル理由のIDを設定してください。 なお、定期キャンセル理由選択APIでユーザーが選択したキャンセル理由のIDを設定する場合は、右側のプルダウンメニューから「定期キャンセル理由選択(ecforce - EC)」の「理由ID[id]」を選択して「設定」をクリックしてください。 |
ecforce 定期キャンセルAPIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 定期のキャンセルに成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 定期キャンセルAPI(マイページ挙動)
ecforce 定期キャンセルAPI(マイページ挙動)は、定期をキャンセルするAPIです。
ecforce 定期キャンセルAPIとecforce 定期キャンセルAPI(マイページ挙動)の違い
ecforce 定期キャンセルAPIとecforce 定期キャンセルAPI(マイページ挙動)はどちらも定期をキャンセルするAPIですが、以下の違いがあります。
・ecforce 定期キャンセルAPI:ecforce管理画面上で定期をキャンセルする操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合でも定期をキャンセルできます。
・ecforce 定期キャンセルAPI(マイページ挙動):マイページ上で定期をキャンセルする操作と同じ挙動
→マイページからの定期解約を許可していない場合や、定期が「定期お約束回数」未満の場合は定期をキャンセルできません。
注意点
ecforce 定期キャンセルAPI(マイページ挙動)を使用する場合、以下の条件を満たしている必要があります。
・予めecforce 定期選択APIが実行されていること
・ecforce管理画面にて以下の設定がされていること
・定期解約:許可する
・定期解約ステータス:キャンセル
※詳細は、マイページ設定をご参照ください。
【ecforce 定期キャンセルAPI(マイページ挙動)】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
キャンセル理由ID | キャンセル理由IDを指定することで、定期受注にキャンセル理由を設定することができます。 ecforceに登録されている、親キャンセル理由が「マイページからのキャンセル」であるキャンセル理由のIDを設定してください。 なお、定期キャンセル理由選択APIでユーザーが選択したキャンセル理由のIDを設定する場合は、右側のプルダウンメニューから「定期キャンセル理由選択(ecforce - EC)」の「理由ID[id]」を選択して「設定」をクリックしてください。 ※親キャンセル理由が「マイページからのキャンセル」でないキャンセル理由のIDが設定されていた場合、API実行時にエラーとなります。 |
ecforce 定期キャンセルAPI(マイページ挙動)の選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 定期のキャンセルに成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 受注選択API
ecforce 受注選択APIは、指定した定期に紐づく受注を取得するAPIです。
取得した受注の中からユーザーに受注を選択させることができます。
注意点
ecforce 受注選択APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 定期選択API
【ecforce 受注選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
対応状況 | 受注の対応状況を指定することで、表示する受注を制限することができます。 表示する受注の対応状況の名前を設定してください。 ※対応状況の名前は、ecforce管理画面の【設定 > 受注/定期受注 > 対応状況管理】画面にてご確認ください。 |
定期受注ID | 右側のプルダウンメニューから「定期選択(ecforce - EC)」の「定期ID[id]」を選択して「設定」をクリックしてください。 |
受注日範囲 | 受注日の範囲を指定することで、表示する受注を制限することができます。 表示する受注の受注日の範囲を設定してください。 ※範囲はノードが実行された日付を基点に計算されます。 |
最新の受注を選択 | ユーザーに受注を選択させずに、強制的に最新の受注を選択することができます。 最新の受注を選択する場合は、「有効」にチェックを入れてください。 |
受注選択メッセージ | 表示する受注が複数ある場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | 表示する受注が複数ある場合、「選択方式」で設定した方式で受注の一覧が表示されます。 フォームの項目名を設定してください。 |
選択方式 | 表示する受注が複数ある場合、ユーザーが受注を選択できます。 受注の選択方式を設定してください。 ※「受注番号:[受注番号]([受注に設定されている商品名])」の形式で表示されます。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。 ・ラジオ(商品画像) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「タブ:画像管理」で設定した画像が表示されます。 |
送信ボタンテキスト | 表示する受注が複数ある場合、ユーザーが受注を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 受注選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 受注の選択に成功した場合の選択肢です。 |
失敗 | 受注の選択に失敗した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 受注商品選択API
ecforce 受注商品選択APIは、ecforce 受注選択APIで選択した受注の商品を取得するAPIです。
取得した商品の中からユーザーに商品を選択させることができます。
注意点
ecforce 受注商品選択APIを使用する場合、予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 受注選択API
【ecforce 受注商品選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
SKU ID | 特定の商品を選択させたい場合のみ、商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 なお、SKU IDは複数設定することができます。(上限なし) 複数のSKU IDを設定する場合は、改行区切りで設定してください。 |
受注商品選択メッセージ | 表示する商品が複数ある場合、メッセージを表示することができます。 表示するメッセージを設定してください。 |
項目名 | 表示する商品が複数ある場合、「選択方式」で設定した方式で商品の一覧が表示されます。 フォームの項目名を設定してください。 |
選択方式 | 表示する商品が複数ある場合、ユーザーが商品を選択できます。 商品の選択方式を設定してください。 ※「商品名:[商品名]」の形式で表示されます。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像が表示されます。 ・ラジオ(商品画像) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像が表示されます。 |
送信ボタンテキスト | 表示する商品が複数ある場合、ユーザーが商品を選択できます。 情報を送信するボタンのテキストを設定してください。 |
ecforce 受注商品選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の選択に成功した場合の選択肢です。 |
失敗 | 商品の選択に失敗した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 配送状況確認API
ecforce 配送状況確認APIは、受注の配送状況を確認できるAPIです。
注意点
ecforce 配送状況確認APIを使用する場合、予めecforce 受注選択APIが実行されている必要があります。
【ecforce 配送状況確認API】画面にて、以下のように設定をしてください。
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
受注ID | 右側のプルダウンメニューから「受注選択(ecforce - EC)」の「受注ID [id]」を選択して「設定」をクリックしてください。 |
表示項目 | チャットで表示したい項目にチェックを入れてください。 表示できる項目は以下です。 ・購入番号 ※受注番号 ・商品名 ・購入日時 ・対応状況 ・発送予定日 ・配送予定日 ・お届け時間 ・配送業者 ・配送伝票番号 ・配送状況確認ボタン <注意点> 「配送状況確認ボタン」は、以下の条件を満たしている場合のみ表示されます。 ・受注に「配送伝票番号」が登録されていること ・受注に設定されている配送業者に「トラッキングURL」が設定されていること ※詳細は、配送業者管理をご参照ください。 |
ecforce 配送状況確認APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 受注の情報の取得に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce SKU選択API
ecforce SKU選択APIは、ユーザーに商品を選択させるAPIです。
設定したSKU IDの商品がチャット上に表示され、ユーザーが任意の商品を選択することができます。
【ecforce SKU選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
SKU | ユーザーに選択させる商品のSKU IDを設定してください。 ※SKU IDは、ecforce管理画面の【商品管理 > 商品管理 > 対象商品の詳細】画面の[SKU 管理]タブで確認できます。 SKU IDは、複数設定(上限なし)および右側のプルダウンメニューから任意の変数を選択して設定することができます。 複数のSKU IDを設定する場合は、改行区切りで設定してください。 また、商品名以外に表示したい内容がある場合は「追加テキスト」を設定してください。 ▼「追加テキスト」が未設定の場合 ▼「追加テキスト」を設定した場合 |
SKU選択メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
商品名テキスト | 商品の表示名を設定してください。 ・商品名 商品名のみが表示されます。 ・規格名 「規格名:分類名」の形式で表示されます。複数の規格が設定されている場合は、規格ごとに「/」で区切られて表示されます。 ・商品名/規格名 「商品名(規格名:分類名)」の形式で表示されます。複数の規格が設定されている場合は、規格ごとに「/」で区切られて表示されます。 |
選択方式 | 商品の選択方式を設定してください。 ・セレクトボックス ・ラジオ(カルーセル) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像が表示されます。 ・ラジオ(商品画像) 表示される画像についてecforce管理画面の【商品管理 > 商品管理 > 該当商品の編集】画面の「画像管理」タブで設定した画像が表示されます。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce SKU選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 商品の選択に成功した場合の選択肢です。 |
エラー (SKU0個) | SKU IDが指定されていない、もしくは選択されたSKU IDがecforce上に存在しない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 支払い方法選択API ※プロフェッショナルプランのみ
ecforce 支払い方法選択APIは、ユーザーに支払い方法を選択させるAPIです。
設定した支払い方法がチャット上に表示され、ユーザーが任意の支払い方法を選択することができます。
注意点
ecforce 支払い方法選択APIはプロフェッショナルプランでのみ使用することができます。
スタンダードプランをご契約中で本APIを使用したい場合は、カスタマーサポートへお問い合わせください。
【ecforce 支払い方法選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
支払い方法選択メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
選択可能支払い方法 | ユーザーに選択させる支払い���法を設定できます。クレジットカードを設定する場合ユーザーのクレジットカードがecforce上に登録されていない場合、「選択可能支払い方法」にクレジットカードを設定してもチャット上には表示されません。 |
ecforce 支払い方法選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 支払い方法の選択に成功した場合の選択肢です。 |
エラー(お支払い方法0個) | 「選択可能支払い方法」にクレジットカードのみを設定、かつログインしているユーザーのクレジットカードがecforceに登録されていない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce お届け先選択API
ecforce お届け先選択APIは、ユーザーにお届け先住所を選択させるAPIです。
ユーザーのお届け先住所(ecforce管理画面の【顧客管理 > 顧客管理 > 該当ユーザー】の「お届け先住所」タブに登録されている住所)がチャット上に表示され、ユーザーが任意のお届け先を選択することができます。
【ecforce お届け先選択API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
お届け先選択メッセージ | 表示するメッセージを設定してください。 |
項目名 | フォームの項目名を設定してください。 |
送信ボタンテキスト | 情報を送信するボタンのテキストを設定してください。 |
ecforce お届け先選択APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | お届け先の選択に成功した場合の選択肢です。 |
エラー(お届け先0個) | ユーザーのお届け先がecforceに登録されていない場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 受注作成内容確認API ※プロフェッショナルプランのみ
ecforce 受注作成内容確認APIは、作成する受注の内容を表示するAPIです。
ecforce 受注作成APIで受注を作成する前に実行し、ユーザーに注文の内容を確認させることができます。
注意点
ecforce 受注作成内容確認APIはプロフェッショナルプランでのみ使用することができます。
スタンダードプランをご契約中で本APIを使用したい場合は、カスタマーサポートへお問い合わせください。
また、本APIを使用する場合は予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 顧客詳細API
・ecforce 支払い方法選択API
【ecforce 受注作成内容確認API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
姓 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「性 [name01]」を選択して「設定」をクリックしてください。 |
名 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「名 [name02]」を選択して「設定」をクリックしてください。 |
セイ | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「セイ [kana01]」を選択して「設定」をクリックしてください。 |
メイ | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「メイ [kana02]」を選択して「設定」をクリックしてください。 |
郵便番号1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「郵便番号 [zip01]」を選択して「設定」をクリックしてください。 |
郵便番号2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「郵便番号 [zip02]」を選択して「設定」をクリックしてください。 |
都道府県ID | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「都道府県ID [prefecture_id]」を選択して「設定」をクリックしてください。 |
住所1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所1 [addr01]」を選択して「設定」をクリックしてください。 |
住所2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所2 [addr02]」を選択して「設定」をクリックしてください。 |
住所3 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所3 [addr03]」を選択して「設定」をクリックしてください。 |
電話番号1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号1 [tel01]」を選択して「設定」をクリックしてください。 |
電話番号2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号2 [tel02]」を選択して「設定」をクリックしてください。 |
電話番号3 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号3 [tel03]」を選択して「設定」をクリックしてください。 |
クーポンコード | クーポンコードを設定してください。 |
商品バリエーションID | 商品のSKU IDを設定してください。 ecforce SKU選択APIでユーザーが選択した商品を表示したい場合は、右側のプルダウンメニューから「SKU選択(ecforce - EC)」の「商品バリエーションID [variant.id]」を選択して「設定」をクリックしてください。 |
個数 | 個数を設定してください。 |
ecforce 受注作成内容確認APIの選択肢は以下です。
項目 | 説明 |
---|---|
購入する | 受注内容の表示に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce 受注作成API ※プロフェッショナルプランのみ
ecforce 受注作成APIは、指定した内容(お届け先住所や商品情報など)でecforce上に受注を作成するAPIです。
本APIの使用方法については、受注作成のシナリオ作成方法をご参照ください。
注意点
ecforce 受注作成APIはプロフェッショナルプランでのみ使用することができます。
スタンダードプランをご契約中で本APIを使用したい場合は、カスタマーサポートへお問い合わせください。
また、本APIを使用する場合は予め以下のAPIが実行されている必要があります。
・ecforce MultiPass API、ecforce LINE MultiPass API、ecforce ログインAPIのいずれか
・ecforce 顧客詳細API
・ecforce 支払い方法選択API
【ecforce 受注作成API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
受注作成内容確認ノード変数を設定する | ecforce 受注作成内容確認APIで設定した変数を一括で設定したい場合は、「受注作成内容確認ノード変数を設定する」をクリックしてください。 |
姓 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「性 [name01]」を選択して「設定」をクリックしてください。 |
名 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「名 [name02]」を選択して「設定」をクリックしてください。 |
セイ | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「セイ [kana01]」を選択して「設定」をクリックしてください。 |
メイ | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「メイ [kana02]」を選択して「設定」をクリックしてください。 |
郵便番号1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「郵便番号 [zip01]」を選択して「設定」をクリックしてください。 |
郵便番号2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「郵便番号 [zip02]」を選択して「設定」をクリックしてください。 |
都道府県ID | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「都道府県ID [prefecture_id]」を選択して「設定」をクリックしてください。 |
住所1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所1 [addr01]」を選択して「設定」をクリックしてください。 |
住所2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所2 [addr02]」を選択して「設定」をクリックしてください。 |
住所3 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「住所3 [addr03]」を選択して「設定」をクリックしてください。 |
電話番号1 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号1 [tel01]」を選択して「設定」をクリックしてください。 |
電話番号2 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号2 [tel02]」を選択して「設定」をクリックしてください。 |
電話番号3 | 右側のプルダウンメニューから任意の変数を選択して「設定」をクリックしてください。 ecforce お届け先選択APIでユーザーが選択したお届け先の情報を表示したい場合は、右側のプルダウンメニューから「お届け先選択(ecforce - EC)」の「電話番号3 [tel03]」を選択して「設定」をクリックしてください。 |
クーポンコード | クーポンコードを設定してください。 |
商品バリエーションID | 商品のSKU IDを設定してください。 右側のプルダウンメニューから「SKU選択(ecforce - EC)」の「商品バリエーションID [variant.id]」を選択して「設定」をクリックしてください。 |
個数 | 個数を設定してください。 |
ecforce 受注作成APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | 受注の作成に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
ecforce ラベル付与・削除API
ecforce ラベル付与・削除APIは、受注や顧客などのデータに対して任意のラベルを付与 / 削除するAPIです。
【ecforce ラベル付与・削除API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
API URLスキーム | 「https」と設定してください。 |
APIドメイン | ecforceのAPI接続用URLのドメインを設定してください。 |
認証トークン | ecforceで作成したAPI接続用のユーザーの認証トークンを設定してください。 ※ 認証トークンは、ecforce管理画面の【設定を変更する > メンバー/権限 > メンバー管理 > API接続用ユーザの詳細】画面にてご確認ください。 |
対象データ | 操作対象のデータ種別を設定してください。 設定できる種別は以下です。 ・受注 ・定期受注 ・顧客 |
操作 | 操作を設定してください。 ▼「付与」の場合 「対象データID」に設定したデータに対して、「ラベルID」に設定したラベルを付与します。 ▼「削除」の場合 「対象データID」に設定したデータに対して、「ラベルID」に設定したラベルを削除します。 |
対象データID | 操作対象のデータのIDを設定してください。 例:対象データを「受注」と設定した場合 受注IDを設定してください。 |
ラベルID | 操作対象のラベルIDを設定してください。 なお、ラベルIDは複数設定することができます。(上限なし) 複数のラベルIDを設定する場合は、改行区切りで設定してください。 |
ecforce ラベル付与・削除APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | ラベルの付与 / 削除に成功した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
LINE LIFF プロフィール情報取得API ※プロフェッショナルプランのみ
LINE LIFF プロフィール情報取得APIは、ユーザーのLINEのプロフィール(ユーザーID、表示名、プロフィール画像、メールアドレス)を取得するAPIです。
注意点
LINE LIFF プロフィール情報取得APIはプロフェッショナルプランでのみ使用することができます。
スタンダードプランをご契約中で本APIを使用したい場合は、カスタマーサポートへお問い合わせください。
【LINE LIFF プロフィール情報取得API】画面にて、以下のように設定をしてください。
項目 | 説明 |
---|---|
チャネルID | LINE Developersコンソールで作成したチャネルのチャネルIDを設定してください。 ※チャネルIDは、LINE Developersコンソールの[チャネル基本設定]タブで確認することができます。 |
IDトークン | 右側のプルダウンメニューから「LINE LIFF定数」の「ID Token」を選択して「設定」をクリックしてください。 |
LINE LIFF プロフィール情報取得APIの選択肢は以下です。
項目 | 説明 |
---|---|
成功 | プロフィール情報の取得に成功した場合の選択肢です。 |
失敗 | プロフィール情報の取得に失敗した場合の選択肢です。 |
IDトークンなし | LINE以外からecforce chatを起動した場合の選択肢です。 |
エラー (API) | エラーが発生した場合の選択肢です。 |
この記事の目次
このセクションの記事