API連携

1.機能概要

注意:APIアクセスは並列アクセスを1秒間に1回以内に制限させて頂きます。連続してアクセスする場合は非同期通信は行わず、レスポンスを待って次の処理を行うようして頂くか、1秒間のスリープを入れて頂きますようお願い致します。

(1)API連携メソッド一覧

本システムは、以下のAPI連携メソッドをサポートしています。
OUT連携の連携タイミングは全てリアルタイム(画面上操作と同じタイミング)です。

全てのAPI連携は以下の仕様に従います。

プロトコル:httpまたはhttps
メソッド:POST
アクセス元IPアドレス制限:IN連携に対して、特定のIPアドレスからのアクセスのみ許可します。
(アクセス元IPアドレスは初期設定の「APIのアクセス元IPアドレス」に指定します 複数のIPアドレスやサブネットアドレスの指定が可能です)
文字コードエンコーディング:UTF-8
(エンコーディングは初期設定の「外部API連携処理エンコード」で変更できます)

※「APIのアクセス元IPアドレス」「外部API連携処理エンコード」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

API連携の項目定義で共通となる仕様を以下に記載します。

・必須カラムについて
 ○ ・・・ データIN連携時に設定が必須な項目です。データOUT連携時も必ず設定されます。
 △ ・・・ データIN連携時の新規登録時に必ず設定する項目です。データIN連携時で更新処理の場合は項目を省略することは可能ですが、項目を指定する場合は合わせて値の設定が必須となります。また、データOUT連携時は必ず設定されます。

・属性説明
 全角 ・・・ 全角、半角、半角数値のいずれも設定可能
 半角 ・・・ 半角、半角数値の設定が可能
 半角数値 ・・・ 半角数値の設定が可能

・データIN連携時の項目の設定方法について
 項目の設定があってなおかつ値の設定もある場合は、項目に空白値が設定され、項目そのものが無い場合は、その項目が無視されます。
 例)
  パターン1 → MEMBER_ID=1234&L_NAME=田中&F_NAME=太郎&ADDR1=...
  パターン2 → MEMBER_ID=1234&L_NAME=田中&F_NAME=太郎...
 データIN連携でデータを更新する場合、上記の例でパターン1の場合は ADDR1 の項目に空白(null)が設定され、パターン2の場合は項目の設定がないので無視され、データベースの ADDR1 にはデータの更新が行われません。
  また、データIN連携でデータを新規登録する場合は、上記パターン1、2のいずれもデータベースには空白(null)が設定されます。
・データIN連携時、更新者のIDは「99999998」が固定で設定されます。

(2)API連携メソッド仕様
1.顧客データ連携IN(外部システム→本システム)

外部システムからAPI接続することにより、本システム内顧客マスタデータの新規登録・変更・削除(論理削除)を行うことができます。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。
 以下の項目はシステム設定の初期値となっており、初期設定の「会員登録受取API連携処理項目定義」で変更が可能です。
 ※「会員登録受取API連携処理項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

名称 必須 桁数 説明
会員ID 数値 8 すでに同一会員IDのデータが存在するときは上書きされ、設定されていないかまたは存在しない値の場合は新規に顧客データが作成されます。
ただし、存在しないIDを指定された場合は、そのIDは無視され、新規にIDが発行されます。
端末区分 数値 1 1:PCで新規会員登録、3携帯で新規会員登録(設定の無い場合は、自動的に「1:PCで新規会員登録」に設定されます)
端末機種情報 半角英数 2000
会員アクセスブラウザ区分 半角英数 100
登録言語 半角英数 100
姓(漢字) 全角 30
名(漢字) 全角 30
姓(カナ) 全角 30 全角カナである必要はありません。
名(カナ) 全角 30 全角カナである必要はありません。
ニックネーム 全角 100 (商品レビューオプションが有効な場合のみ利用可能)
郵便番号 半角英数 15
住所1(都道府県) 全角 100 東京都
住所2(市区町村、番地) 全角 200 ○○市○○町1-2-3
住所3(ビル、マンション名等) 全角 200 ○○ビル1F 
性別 半角英数 1 M:男性、F:女性
生年月日 日付 -
電話番号 半角英数 30
PCメールアドレス 半角英数 200 PCメールアドレスと携帯メールアドレスを通じて、ユニークである必要があります。
PCメール形式 数値 1 空白(null):テキストメール、1:HTMLメール
携帯メールアドレス 半角英数 200 PCメールアドレスと携帯メールアドレスを通じて、ユニークである必要があります。
携帯メール形式 数値 1 空白(null):テキストメール、1:HTMLメール
ログインID 半角英数 2000 すべての顧客を通じてユニークである必要があります。
ログインPW 半角英数 2000
ポイント残高 数値 8
備考 全角 1000
メルマガ受付区分 数値 1 空白(null):受け付けない
1:PC/携帯の両方で受け付ける
2:PCで受け付ける
3:携帯で受け付ける
自動お知らせアイコン 半角英数 2000
削除日 日付 - 削除時設定する
退会日 日付 - 退会時設定する
会員ランク 数値 8 (オプションが有効な場合のみ利用可能)
アクセスURL 半角英数 2000
パスワード誤りカウント 数値 2
パスワード誤り上限 数値 2
ログイン回数 数値 8
最終ログイン日時 日付 -
アカウントロック日時 日付 -
請求先ID 数値 8
外部サイトログインプロバイダ 数値 8
会員の自由項目 自由項目の設定による(最大2000バイト) 自由項目の設定による(最大2000バイト)
外部サイトログインID 半角英数 2000
外部サイトアイコン画像パス 半角英数 2000
外部サイトアイコン画像使用プロバイダ 数値 8
標準利用支払い方法 数値 3
標準利用クレジットカード 半角英数 100
標準利用クレジットカード支払い回数 数値 2
2段階ログイン利用区分 数値 2 空白(null):利用しない、1:PCメール、2:携帯メール
登録区分 数値 1
本登録メール送信日時 日付 -
ポイント利用設定 数値 1
管理ツール登録者 数値 8
法人ID 数値 8
利用制限決済 半角英数 200
管理ツール更新者 数値 8

※API連携での更新は顧客管理の顧客新規登録でできる必須項目編集の必須項目に影響されません。

 ※NAMEは全て半角大文字で指定する必要があります。
 ※項目の設定があってなおかつ値の設定もある場合は、項目に空白値が設定されているとして処理され、項目そのものが無い場合は、その項目が無視されます。
 ※値の設定がある項目は値のチェックが行われ、値の正しくない項目が1つでもある場合はエラーを返却し、処理をキャンセルします。
 ※自由項目は「利用する」項目のみが設定されます。
 ※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
 ※初期設定の以下の設定は、入力チェックには利用されず無視されます。
  ・ユーザーウェブパスワード最低桁数
  ・ユーザーウェブログインID最低桁数
  ・ユーザーウェブログインIDパスワード一致許可
  ・ユーザーウェブパスワード数字混合強制
  ・会員マスタ必須項目

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&MEMBER_ID=顧客ID

(値のチェックエラー)
status=1&MEMBER_ID=顧客ID&message=エラーメッセージ

(システム障害エラー)
status=9&MEMBER_ID=顧客ID&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&MEMBER_ID=顧客ID&message=エラーメッセージ1~エラーメッセージ2
※ 新規登録時、エラーが発生して顧客IDが発行されていない場合は、顧客IDが設定されないことがあります。

2.顧客データ連携OUT(本システム→外部システム)

外部システムへ、本システム内の顧客データの変更通知を行います。

①アクセスURL
 初期設定の「会員登録外部API連携接続先URL」にリクエストします。

アクセスURL:初期設定の「会員登録外部API連携接続先URL」
※「会員登録外部API連携接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

②連携タイミング
 以下の処理実行時にAPI連携が起動されます。

(ユーザーウェブ)
新規会員登録時
会員情報変更時
カート精算と同時に会員登録を変更する時
メルマガ登録時、解除時
(ショップ管理ツール)
新規顧客登録時
顧客情報変更時
顧客情報一括アップロード時
メルマガ解除時(メルマガ配信エラーアドレス管理)
オペレータ受注画面からの受注登録時

③連携項目定義
 項目定義は以下の通りです。項目の定義順は順不同です。
 以下の項目はシステム設定の初期値となっており、初期設定の「会員登録外部API連携処理項目定義」で変更が可能です。
 ※「会員登録外部API連携処理項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

名称 必須(必須項目は連携先ごとに異なる) 桁数 説明
アクセスURL 半角英数 2000
住所1(都道府県) 全角 100 東京都
住所2(市区町村、番地) 全角 200 ○○市○○町1-2-3
住所3(ビル、マンション名等) 全角 200 ○○ビル1F
備考 全角 1000
生年月日 日付 -
削除日 日付 - 削除時設定する
名(カナ) 全角 30
名(漢字) 全角 30
会員の自由項目 自由項目の設定による(最大2000バイト) 自由項目の設定による(最大2000バイト)
姓(カナ) 全角 30
姓(漢字) 全角 30
最終ログイン日時 日付 -
ログイン回数 数値 8
パスワード誤りカウント 数値 2
パスワード誤り上限 数値 2
ログインID 半角英数 2000 すべての顧客を通じてユニーク
メルマガ受付区分 数値 1 空白(null):受け付けない
1:PC/携帯の両方で受け付ける
2:PCで受け付ける
3:携帯で受け付ける
会員アクセスブラウザ区分 半角英数 100
会員ID 半角英数 8
ポイント利用設定 数値 1
会員ランク 数値 8 (オプションが有効な場合のみ利用可能)
利用制限決済 半角英数 200
端末機種情報 半角英数 2000
携帯メールアドレス 半角英数 200
携帯メール形式 数値 1 空白(null):テキストメール、1:HTMLメール
ニックネーム 全角 100 (商品レビューオプションが有効な場合のみ利用可能)
ログインPW 半角英数 2000
PCメールアドレス 半角英数 200 PCメールアドレスと携帯メールアドレスのどちらかが必須設定されます。
PCメール形式 数値 1 空白(null):テキストメール、1:HTMLメール
端末区分 数値 1 1:PCで新規会員登録、3携帯で新規会員登録
ポイント残高 数値 8
登録区分 数値 1
登録言語 半角英数 100
本登録メール送信日時 日付 -
請求先ID 数値 8
性別 半角英数 1 M:男性、F:女性
退会日 日付 - 退会時設定する
電話番号 半角英数 30
2段階ログイン利用区分 数値 2 空白(null):利用しない
1:PCメール
2:携帯メール
郵便番号 半角英数 15

 ※NAMEは全て半角大文字です。
 ※上記にあるすべての項目が設定されます。(初期設定の「会員登録外部API連携処理項目定義」を変更していない場合に限る)
 ※自由項目は「利用する」項目のみが設定されます。
 ※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。

④返却値

初期設定「API結果判定緩和設定」:利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」:利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断

返却値はログに出力されます。

※statusがどの値の場合に正常とするかはカスタマイズ可能です。
※「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。

3.商品データ連携IN(外部システム→本システム)

外部システムからAPI接続することにより、本システム内商品マスタデータの新規登録・変更・を行うことができます。(削除はできません)

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。
 以下の項目はシステム設定の初期値となっており、初期設定の「商品登録受取API連携処理項目定義」で変更が可能です。
 ※「商品登録受取API連携処理項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

名称 必須 桁数 説明
商品ID 数値 8
商品コード 半角英数 50 すでに同一商品コードのデータが存在するときは上書きされ、存在しない値の場合は新規に商品データが作成されます。
自動的に大文字に変換して処理され、また「-」ハイフンを含む値の指定はできません。
端末区分 数値 1 1:PCのみ、2:PC+携帯、3携帯のみ
(設定の無い場合は、自動的に「2:PC+携帯」に設定されます)
ダウンロード販売商品 数値 1 空白(null):通常商品、1:ダウンロード販売商品
ダウンロードファイル名 半角英数 500 ダウンロード販売商品のアップロードフォルダ download_file 内の相対パス
定期販売商品 数値 1 空白(null):通常商品、1:定期販売商品
定期販売配送日数 数値 3 注文から出荷までの日数
定期販売対象月 半角英数 200
月次定期販売締め日 半角英数 200
商品名 〇※ 全角 200 ※新規登録時のみ必須
商品名(カナ) 〇※ 全角 200 全角カナである必要はありません。
※新規登録時のみ必須
販売価格 〇※ 数値 12 ※新規登録時のみ必須
希望小売価格 数値 12
表示期間FROM 日付 - 「YYYY/MM/DD HH:MM」のフォーマットで時間指定もできます。
表示期間TO 日付 - 「YYYY/MM/DD HH:MM」のフォーマットで時間指定もできます。
商品画像1 半角英数 500 ファイル名または画像格納フォルダ内の相対パスを指定
以下画像パスは全て同様
携帯用商品画像1 半角数値 500
商品画像2 半角数値 500
携帯用商品画像2 半角数値 500
商品画像3 半角数値 500
携帯用商品画像3 半角数値 500
商品画像4 半角数値 500
携帯用商品画像4 半角数値 500
アピール画像 半角数値 500
携帯用アピール商品画像 半角数値 500
アピールポイント 全角 2000
携帯用アピールポイント 全角 2000
商品コメント1 全角 20000
携帯用商品コメント1 全角 20000
商品コメント2 全角 40000
携帯用商品コメント2 全角 40000
商品コメント3 全角 40000
携帯用商品コメント3 全角 40000
カート用商品コメント 全角 4000
携帯カート用商品コメント 全角 4000
最低在庫数 数値 8
在庫単位フラグ 数値 1 空白(null):商品ごとに在庫管理する、1:商品バリエーションごとに在庫管理する
新規登録時、指定しないと「空白(null):商品ごとに在庫管理する」となります。
在庫管理 数値 1 空白(null):在庫管理しない、1:在庫管理する
(注文時の在庫数チェックの有無、品切れ・在庫少メッセージ表示の有無)
在庫数表示 数値 1 空白(null):表示しない、1:表示する
会員割引FLG 数値 1 空白(null):割引対象外、1:割引可能
ポイントフラグ 数値 1 空白(null):ポイント使用不可、1:ポイント使用可能、2:ポイントサイト用
加算ポイント 数値 12 購入時加算されるポイント
ADD_POINT・ADD_POINT_RATEのどちらか一方のみ指定可能
(両方空白(null)の場合は管理マスタのポイント還元率より計算される)
ポイント還元率 数値 6 購入時ポイント還元率(%)、小数点以下2桁まで入力可能。
ADD_POINT・ADD_POINT_RATEのどちらか一方のみ指定可能
(両方空白(null)の場合は管理マスタのポイント還元率より計算される)
発売日 日付 - 「YYYY/MM/DD HH:MM」のフォーマットで時間指定もできます。
配送方法 数値 4 配送方法マスタに存在する必要があります。
配送方法重み 数値 6
登録区分 数値 1 空白(null):本登録、1:仮登録
検索結果表示フラグ 数値 1 空白(null):表示する
1:表示しない
2:顧客ログイン中のみ表示
タイトルタグ表示名 全角 300 HTMLのTITLEタグに表示する名称
メタタグキーワード 全角 2000 HTMLのMETAタグに出力されるキーワード
メタタグディスクリプション 全角 2000
会員割引額 数値 12 会員割引フラグを「使用する」場合に販売価格から割引く金額を指定します。
未入力の場合は金額設定の会員割引率から計算されます。
最低注文数 数値 8 1度に注文することのできる最小の商品数量
最高注文数 数値 8 1度に注文することのできる最高の商品数量
同一注文者購入個数制限 数値 8 同一顧客による購買個数上限
商品入数 数値 8
販売単位制限数 数値 8
予約商品フラグ 数値 1
予約商品自動有効化フラグ 数値 1
加算ネットマイルポイント 数値 12 会員登録時と商品購入時に加算されるネットマイルを指定します。
何も入力しない場合は、ネットマイル還元率により計算されます。
ネットマイルオプションがONの場合のみ有効です。
仕入先ID 数値 8
仕入金額 数値 12
「買い物かごに入れる」リンク表示 数値 1 空白(null):表示する、1:表示しない。
利用制限決済 半角英数 200 商品利用決済ID情報のカンマ区切りリスト
ID)1:銀行振込
2:郵便振替
5:クレジットカード
6:コンビニ(セブンイレブン)例)1,2,5,6
新着順用更新日 日付 - 新着順で並び替えるための日付
カテゴリ 半角 - カテゴリコードをカンマ区切りで設定します。
登録上限は10個で、10個以上設定しても10個までしか登録されません。
カテゴリが存在しない場合エラーとなります。
レコメンド 半角 - 商品コードをカンマ区切りで設定します。
登録上限は10個で、10個以上設定しても10個までしか登録されません。
商品コードが存在しない場合エラーとなります。
「商品コード」に設定する値と同じ値を設定するとエラーとなります。
代表カテゴリ 数値 8
レコメンドカテゴリ 数値 8
送料無料フラグ 数値 1 空白(null):送料無料にしない
1:この商品と一緒に購入するすべての商品の送料が無料にする
決済手数料無料フラグ 数値 1
別注商品フラグ 数値 1 空白(null):通常商品、1:別注商品(商品バリエーション単位)、2:別注商品(商品単位) 
別注商品(商品バリエーション単位)に設定すると、他の商品および、属性の異なる同一商品と同時に注文することができなくなります。
別注商品(商品単位)に設定すると、他の商品と同時に注文できなくなりますが、属性の異なる同一商品と同時に注文することは可能となります。
別注商品グループ 半角英数 100 別注商品管理を行う場合に、別注対象外とするグループを半角文字列で指定します。
公開会員ランク 数値 8 空白(null):ランクを設定しない、ランクを設定すると会員以外ではその商品が購入できなくなります。
また会員のランクと連動し、ログイン中の会員よりも上位のランクの商品は表示されなくなります。
ランクは数値が小さいほど上位ランクを意味します。
配送希望日指定可能最小日数 数値 8 配送希望日に指定できる受注からの最小日数
配送希望日指定可能最大日数 数値 8 配送希望日に指定できる受注からの最大日数
発送スパン 数値 8 日次定期受注商品の場合の次回定期受注が作られるまでの日数
例)1,2,5,6
発送スパン単位 数値 8 空白(null):「日」、1:「年」
最大配送間隔 数値 8
最低購入回数 数値 8 定期の停止ができるようになるまでの最低受注回数
例)1,2,5,6
定期変更期限日数 数値 8
定期にまとめて注文可能フラグ 数値 1
Google Shopping連携フラグ 数値 1
カートオプション設定 半角英数 1000 空白(null):精算時にオプション商品一覧が表示されません。
1:精算時にオプション商品一覧が表示されます。
オプション商品区分 数値 8
別精算ページリンク 半角英数 1000 link1,link2,link3 のように指定
受注取消シリアル引当フラグ 数値 1
商品シリアルお知らせメール最低在庫数 数値 8
注文確認メール商品コメント 全角 2000 注文確認メールに設定される商品コメント
在庫数 数値 12
閲覧履歴非表示フラグ 数値 1
セット子商品在庫切れフラグ 数値 1
入荷お知らせ受付 数値 1
登録者 数値 8
管理ツール登録者 数値 8
登録日時 日付 -
更新者 数値 8
管理ツール更新者 数値 8
更新日時 日付 -
PC向け商品テンプレート 全角 100
SmartPhone向け商品テンプレート 全角 100
商品の自由項目 自由項目の設定による(最大2000バイト) 自由項目の設定による(最大2000バイト)
携帯向け商品テンプレート 全角 100
商品詳細表示フラグ 数値 1
頒布会商品フラグ 数値 1
頒布会コード 数値 8
ノベルティ商品フラグ 数値 1
ノベルティ商品付与期間FROM 日付 -
ノベルティ商品付与期間TO 日付 -
ノベルティ商品付与対象金額 数値 8
ノベルティ付与条件特定化フラグ 数値 1
ノベルティ商品付与回数上限 数値 8
Criteo連携フラグ 数値 1
Criteoバナー表示フラグ 数値 1
公開会員ランク指定フラグ 数値 1

 ※NAMEは全て半角大文字で指定する必要があります。
 ※項目の設定があってなおかつ値の設定もある場合は、項目に空白値が設定されているとして処理され、項目そのものが無い場合は、その項目が無視されます。
 ※値の設定がある項目は値のチェックが行われ、値の正しくない項目が1つでもある場合はエラーを返却し、処理をキャンセルします。
 ※自由項目は「利用する」項目のみが設定されます。
 ※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
 ※自身がセットの子商品の場合、商品バリエーションの変更ができないため、以下の項目は無視されますのでご注意ください。
  商品バリエーションリスト、在庫数、在庫単位フラグ、商品セットリスト

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&ITEM_CD=商品コード

(値のチェックエラー)
status=1&ITEM_CD=商品コード&message=エラーメッセージ

(システム障害エラー)
status=9&ITEM_CD=商品コード&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&ITEM_CD=商品コード&message=エラーメッセージ1~エラーメッセージ2

4.商品データ連携OUT(本システム→外部システム)

外部システムへ、本システム内の商品データの変更通知を行います。

①アクセスURL
 初期設定の「商品登録外部API連携接続先URL」にリクエストします。

アクセスURL:初期設定の「商品登録外部API連携接続先URL」
※「商品登録外部API連携接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

②連携タイミング
 以下の処理実行時にAPI連携が起動されます。

(ショップ管理ツール)
商品情報登録時
商品情報変更時
商品一覧画面からの登録区分更新時
商品情報一括アップロード時

③連携項目定義
 項目定義は以下の通りです。項目の定義順は順不同です。
 以下の項目はシステム設定の初期値となっており、初期設定の「商品登録外部API連携処理項目定義」で変更が可能です。
 ※「商品登録外部API連携処理項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

名称 必須(必須項目は連携先ごとに異なる) 桁数 説明
商品ID 数値 8
商品コード 半角英数 50
端末区分 数値 1 1:PCのみ、2:PC+携帯、3携帯のみ
ダウンロード販売商品 数値 1 空白(null):通常商品、1:ダウンロード販売商品
ダウンロードファイル名 半角英数 500 ダウンロード販売商品のアップロードフォルダ
download_file 内の相対パス
定期販売商品 数値 1 空白(null):通常商品、1:定期販売商品
定期販売配送日数 数値 3 注文から出荷までの日数
定期販売対象月 半角英数 200
月次定期販売締め日 半角英数 200
商品名 全角 200
商品名(カナ) 全角 200
販売価格 数値 12
希望小売価格 数値 12
表示期間FROM 日付 -
表示期間TO 日付 -
商品画像1 半角数値 500 ファイル名または画像格納フォルダ内の相対パスを指定
以下画像パスは全て同様
携帯用商品画像1 半角数値 500
商品画像2 半角数値 500
携帯用商品画像2 半角数値 500
商品画像3 半角数値 500
携帯用商品画像3 半角数値 500
商品画像4 半角数値 500
携帯用商品画像4 半角数値 500
アピール画像 半角数値 500
携帯用アピール商品画像 半角数値 500
アピールポイント 全角 2000
携帯用アピールポイント 全角 2000
商品コメント1 全角 20000
携帯用商品コメント1 全角 20000
商品コメント2 全角 40000
携帯用商品コメント2 全角 40000
商品コメント3 全角 40000
携帯用商品コメント3 全角 40000
カート用商品コメント 全角 4000
携帯カート用商品コメント 全角 4000
最低在庫数 数値 8
在庫単位フラグ 数値 1 空白(null):商品ごとに在庫管理する、1:商品バリエーションごとに在庫管理する
在庫管理 数値 1 空白(null):在庫管理しない、1:在庫管理する
(注文時の在庫数チェックの有無、品切れ・在庫少メッセージ表示の有無)
在庫数表示 数値 1 空白(null):表示しない、1:表示する
会員割引FLG 数値 1 空白(null):割引対象外、1:割引可能
ポイントフラグ 数値 1 空白(null):ポイント使用不可、1:ポイント使用可能、2:ポイントサイト用
加算ポイント 数値 12 購入時加算されるポイント
ADD_POINT・ADD_POINT_RATEのどちらか一方のみ指定可能
(両方空白(null)の場合は管理マスタのポイント還元率より計算される)
ポイント還元率 数値 6 購入時ポイント還元率(%)、小数点以下2桁まで入力可能。
ADD_POINT・ADD_POINT_RATEのどちらか一方のみ指定可能
(両方空白(null)の場合は管理マスタのポイント還元率より計算される)
発売日 日付 -
配送方法 数値 4 配送方法マスタのID
配送方法重み 数値 6
登録区分 数値 1 空白(null):本登録、1:仮登録
検索結果表示フラグ 数値 1 空白(null):表示する
1:表示しない
2:顧客ログイン中のみ表示
タイトルタグ表示名 全角 300 HTMLのTITLEタグに表示する名称
メタタグキーワード 全角 2000 HTMLのMETAタグに出力されるキーワード
メタタグディスクリプション 全角 2000
会員割引額 数値 12 会員割引フラグを「使用する」場合に販売価格から割引く金額を指定します。
未入力の場合は金額設定の会員割引率から計算されます。
最低注文数 数値 8 1度に注文することのできる最小の商品数量
最高注文数 数値 8 1度に注文することのできる最高の商品数量
同一注文者購入個数制限 数値 8 同一顧客による購買個数上
商品入数 数値 8
販売単位制限数 数値 8
予約商品フラグ 数値 1
予約商品自動有効化フラグ 数値 1
加算ネットマイルポイント 数値 12 会員登録時と商品購入時に加算されるネットマイルを指定します。
何も入力しない場合は、ネットマイル還元率により計算されます。
ネットマイルオプションがONの場合のみ有効です。
仕入金額 数値 12
「買い物かごに入れる」リンク表示 数値 1 空白(null):表示する、1:表示しない。
利用制限決済 半角英数 200 商品利用決済ID情報のカンマ区切りリスト
ID)1:銀行振込,2:郵便振替,5:クレジットカード,6:コンビニ(セブンイレブン)
例)1,2,5,6
新着順用更新日 日付 - 新着順で並び替えるための日付
送料無料フラグ 数値 1 空白(null):送料無料にしない、1:この商品と一緒に購入するすべての商品の送料が無料にする
決済手数料無料フラグ 数値 1
別注商品フラグ 数値 1 空白(null):通常商品、1:別注商品(商品バリエーション単位)、2:別注商品(商品単位) 
別注商品(商品バリエーション単位)に設定すると、他の商品および、属性の異なる同一商品と同時に注文することができなくなります。
別注商品(商品単位)に設定すると、他の商品と同時に注文できなくなりますが、属性の異なる同一商品と同時に注文することは可能となります。
別注商品グループ 半角英数 100 別注商品管理を行う場合に、別注対象外とするグループを半角文字列で指定します。
公開会員ランク 数値 8 空白(null):ランクを設定しない、ランクを設定すると会員以外ではその商品が購入できなくなります。
また会員のランクと連動し、ログイン中の会員よりも上位のランクの商品は表示されなくなります。
ランクは数値が小さいほど上位ランクを意味します。
配送希望日指定可能最小日数 数値 8 配送希望日に指定できる受注からの最小日数
配送希望日指定可能最大日数 数値 8 配送希望日に指定できる受注からの最大日数
発送スパン 数値 8 日次定期受注商品の場合の次回定期受注が作られるまでの日数
例)1,2,5,6
発送スパン単位 数値 8 空白(null):「日」、1:「年」
最大配送間隔 数値 8
最低購入回数 数値 8 定期の停止ができるようになるまでの最低受注回数
例)1,2,5,6
定期変更期限日数 数値 8
定期にまとめて注文可能フラグ 数値 1
Google Shopping連携フラグ 数値 1
カートオプション設定 半角英数 1000 空白(null):精算時にオプション商品一覧が表示されません。
1:精算時にオプション商品一覧が表示されます。
オプション商品区分 数値 8
別精算ページリンク 半角英数 1000 link1,link2,link3 のように指定
受注取消シリアル引当フラグ 数値 1
商品シリアルお知らせメール最低在庫数 数値 8
注文確認メール商品コメント 全角 2000 注文確認メールに設定される商品コメント
閲覧履歴非表示フラグ 数値 1
入荷お知らせ受付 数値 1
登録者 数値 8
登録日時 日付 -
更新者 数値 8
更新日時 日付 -
PC向け商品テンプレート 全角 100
SmartPhone向け商品テンプレート 全角 100
商品の自由項目 自由項目の設定による(最大2000バイト) 自由項目の設定による(最大2000バイト)
携帯向け商品テンプレート 全角 100
商品詳細表示フラグ 数値 1
頒布会商品フラグ 数値 1
頒布会コード 数値 8
ノベルティ商品フラグ 数値 1
ノベルティ商品付与期間FROM 日付 -
ノベルティ商品付与期間TO 日付 -
ノベルティ商品付与対象金額 数値 8
ノベルティ付与条件特定化フラグ 数値 1
ノベルティ商品付与回数上限 数値 8
Criteo連携フラグ 数値 1
Criteoバナー表示フラグ 数値 1
公開会員ランク指定フラグ 数値 1
代表カテゴリ 半角英数 20

 ※NAMEは全て半角大文字です。
 ※上記にあるすべての項目が設定されます。(初期設定の「商品登録外部API連携処理項目定義」を変更していない場合に限る)
 ※自由項目は「利用する」項目のみが設定されます。
 ※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。

④返却値

初期設定「API結果判定緩和設定」:利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」:利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断

返却値はログに出力されます。

※statusがどの値の場合に正常とするかはカスタマイズ可能です。
※「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。

5.受注データ連携OUT(本システム→外部システム)

外部システムへ、本システム内の受注データの登録・変更通知を行います。

①アクセスURL
 初期設定の「受注登録外部API連携接続先URL」にリクエストします。

アクセスURL:初期設定の「受注登録外部API連携接続先URL」
※「受注登録外部API連携接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

②連携タイミング
 以下の処理実行時にAPI連携が起動されます。

(ユーザーウェブ)
お買い物時
(ショップ管理ツール)
受注新規登録時
受注情報変更時(明細の登録・更新のタイミングも含む)
受注照会画面での受注ステータス変更時(入金区分、配送区分など)
受注データ一括アップロード時
出荷実績取込時
※出荷実績取込時については、ラジオボタンを下記の通り選択してアップロードした場合
・配送日自動設定「 設定する」
・代引決済入金区分チェック「入金済にする」
・後払い決済入金区分チェック「入金済にする」

③連携項目定義
 項目定義は以下の通りです。項目の定義順は順不同です。
 以下の項目は、初期設定の「受注登録外部API連携処理項目定義」で変更が可能です(オプション使用時のみ使用可能な項目は(オプション使用時のみ使用可)と記載しています)。
 ※「受注登録外部API連携処理項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。

名称 必須(必須項目は連携先ごとに異なる) 桁数 説明
アクセスURL 半角英数 2000
加算ポイント 数値 13
住所1 全角 100
住所2 全角 200
住所3 全角 200
オーソリ確定日 日付 -
オーソリ日 日付 -
クレジット処理結果 数値 1 0:正常終了、9:異常終了
備考 全角 2000
内訳(まとめ買い割引値引額) 数値 12
受注取消日 日付 -
取消メール配信日 日付 -
有効性エラーフラグ 数値 1
継続課金請求送信日 日付 -
継続課金請求ステータス 数値 1
利用クーポンID 数値 8
内訳(クーポン割引額) 数値 12
分割回数 数値 2 1:一括払い、n:n回
0:ボーナス一括払い
99:リボ払い
カード種別 半角英数 20 1:American Express
2:Diners ClubInternational
3:中国銀聯
4:Diners Club 米国・カナダ
5:Discover Card
6:JCB
7:Maestro
8:MasterCard
9:Solo
10:Switch
11:Visa
12:Visa Electron
有効期限 半角英数 7
カード名義 全角 60
カード番号 半角英数 20 クレジットカード番号の保存フォーマットは、初期設定の「クレジットカード番号保存フォーマット」に準拠します。
※「クレジットカード番号保存フォーマット」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
内訳(代引手数料) 数値 8
内訳(代引手数料消費税) 数値 12
削除日 日付 - DEL_DATE
ダウンロード日 日付 -
イースコットプラスオーソリID 数値 8
名(カナ) 全角 30
名(漢字) 全角 30
配送方法 数値 4 購入する商品の配送方法重みによる選択することができません。
払込票URL 半角英数 300
支払方法 数値 3 1:郵便振込
2:銀行振込
3:代金引換
18:e-standardクレジット決済
10:ベリトランスクレジット決済
13:ベリトランスコンビニ決済(セブンイレブン)
14:ベリトランスコンビニ決済(ローソン)
15:ベリトランスコンビニ決済(ファミリーマート)
決済連携ID 数値 8
姓(カナ) 全角 30
姓(漢字) 全角 30
広告媒体コード 半角英数 20
顧客ID 数値 8 会員登録済みの顧客の注文時のみ設定されます
内訳(会員割引額) 数値 12
携帯メールアドレス 半角英数 200
ネットマイル加算ポイント 数値 12 ネットマイル連携時のみ有効
次回配送予定日 日付 -
次回定期お休みフラグ 数値 1
受注API連携ステータス 数値 1
受注日 日付 -
受注表示番号 半角英数 30
アクセスブラウザ区分 半角英数 100
受注確認メール配信日 日付 -
受注番号 数値 8
この注文の商品に関する情報を受信するフラグ 数値 1
払込期限 日付 -
入金日 日付 -
入金確認メール配信日 日付 -
入金額 数値 12
PCメールアドレス 半角英数 200 PCメールアドレスと携帯メールアドレスのどちらかが必須設定されます。
端末区分 数値 1 1:PCで購入、3:携帯で購入
利用ポイント 数値 8
内訳(ポイント使用額) 数値 8
受付番号 半角英数 32
登録言語 半角英数 100
キャンペーン付与ポイント 数値 8
内訳(キャンペーン割引額) 数値 12
請求金額合計 数値 12
精算ページID 半角英数 1000
送付先住所1 全角 100
送付先住所2 全角 200
送付先住所3 全角 200
配送日 日付 -
送付先名(カナ) 全角 30
送付先名(漢字) 全角 30
配送希望日 日付 -
配送希望時間 全角 100 希望なし、午前中、12時から14時、14時から16時、16時から18時、18時から20時、20時から21時
送付先姓(カナ) 全角 30
送付先姓(漢字) 全角 30 配送先の指定がない場合は、注文者の情報が自動設定されます。
(以下配送先名~配送先電話番号)
送付先E-MAIL 半角英数 200
配送確認メール配信日 日付 -
送付先電話番号 半角英数 30
出荷予定日 日付 -
送付先郵便番号 半角英数 15
連携済み宅配伝票番号 半角英数 4000
セッションID 半角英数 50
宅配伝票番号 半角英数 2000
内訳(仕入金額合計) 数値 12
内訳(送料) 数値 8
内訳(送料消費税) 数値 12
照会番号 半角英数 20
内訳(消費税) 数値 12
税率 数値 5
購入時の値段(受注明細) 数値 12
内訳(商品定価) 数値 12
内訳(商品定価消費税) 数値 12
定期販売区分 数値 1 空白(null)通常受注
1:定期販売受注
9:定期販売中止
定期販売受注処理日 日付 - 定期販売受注の処理日
定期販売毎月配送希望日 数値 2
定期連続お休み回数 数値 8
定期販売停止日 日付 -
定期にまとめ先注文親番号 数値 8
定期にまとめ先注文受注番号 数値 8
定期販売対象年月 数値 6 YYYYMM
電話番号 半角英数 30
端末機種情報 半角英数 512
取引ID 半角英数 100
予約日 日付 -
予約確定メール配信日 日付 -
予約ステータス 数値 4
郵便番号 半角英数 15
加算ポイント(受注明細) 数値 12
誕生日 日付 -
クーポンID 数値 8
割引種別 数値 1
決済種別 数値 2
商品コード 半角英数 50
ダウンロード回数(受注明細) 数値 8 ダウンロード販売商品の場合のダウンロード済み回数
ダウンロード有効期限(受注明細) 文字列(YYYY/MM/DD hh24:mi) 18 ダウンロード販売商品の場合のダウンロード可能有効期限
ダウンロードURL(受注明細) 半角英数 2000 ダウンロード販売商品の場合のダウンロードURL
商品属性コード(受注明細) 半角英数 100 商品コード+商品バリエーションコードのハイフン「-」区切りが格納されます。
商品バリエーションが設定されていない商品の場合は0が設定されます。
格納される順番は、商品バリエーションカテゴリID順、商品バリエーション表示順となります。
(例)商品コードが ITEM01 で選択した商品バリエーションコードが RED(赤)、S(スモール)の場合 ITEM01-RED-S
商品名(受注明細) 全角 200
シリアル番号リスト(受注明細) 半角英数 65535 商品シリアル番号カンマ区切りリスト(商品の数量の分だけ設定)
ケース数(受注明細) 数値 8
最大注文数 数値 8
会員割引(受注明細) 数値 12
最小注文数 数値 8
受注明細番号 数値 4
受注日フォーマット 半角英数 19
受注配送先番号(受注明細) 数値 4
出力フラグ(受注明細) 数値 1 商品情報をメールや購入履歴に出力するかどうか
空白(null):出力しない、1:出力する
数量(受注明細) 数値 8
仕入金額(受注明細) 数値 12
セット商品フラグ(受注明細) 数値 1
オプション商品対象受注明細番号 数値 4
受注ヘッダの自由項目 - - "n"は任意の数字(1~100)になります。
受注明細の自由項目 - - "n"は任意の数字(1~100)になります。

 ※NAMEは全て半角大文字です。
 ※上記にあるすべての項目が設定されます。(初期設定の「受注登録外部API連携処理項目定義」を変更していない場合に限る)
 ※受注明細項目のNAMEは、アンダーバーに続けて1から連番号で設定されます。(例:ITEM_CD_1)
 ※自由項目は「利用する」項目のみが設定されます。
 ※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。

請求合計金額の算出方法は下記になります。
請求金額合計=
 内訳(商品定価)
 +内訳(消費税)
 +内訳(送料)
 +内訳(代引手数料)
※「内訳(商品定価)」には会員割引後の金額が設定されているため、
 「内訳(会員割引額)」は上記算出式の要素になりません。

④返却値

初期設定「API結果判定緩和設定」:利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」:利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断

返却値はログに出力されます。

※statusがどの値の場合に正常とするかはカスタマイズ可能です。
※「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。

6.受注ステータスデータ連携IN(外部システム→本システム)

外部システムから受注のステータス(出荷状況)を受け取ります。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
アクセスURL 半角英数 2000
加算ポイント 数値 13
住所1 全角 100
住所2 全角 200
住所3 全角 200
管理ツール登録者 数値 8
管理ツール更新者 数値 8
後払い注文ID 半角英数 10
後払いステータス 全角 200
オーソリ確定日 日付 -
オーソリ日 日付 -
クレジット処理結果 数値 1
自動お知らせアイコン 半角英数 2000
自動キャンセルメール送信日 日付 -
自動キャンセル処理ステータス 数値 1
備考 全角 2000
内訳(まとめ買い割引値引額) 数値 12
受注取消日 日付 -
取消メール配信日 日付 -
カート一時引当セッションID 半角英数 50
メール送信先端末 数値 1
有効性エラーフラグ 数値 1
継続課金請求送信日 日付 -
継続課金請求ステータス 数値 1
法人ID 数値 8
利用クーポンID 数値 8
内訳(クーポン割引額) 数値 12
分割回数 数値 2
カード種別 半角英数 20
有効期限 半角英数 7
カード名義 全角 60
カード番号 半角英数 20
内訳(代引手数料) 数値 8
内訳(代引手数料消費税) 数値 12
定期販売月スパン配送希望日 数値 2
定期販売月スパン配送希望曜日(週) 数値 1
定期販売月スパン配送希望曜日(曜日) 数値 1
削除日 日付 -
ダウンロード日 日付 -
加算ポイント編集フラグ 数値 1
イースコットプラスオーソリID 数値 8
イースコットプラス処理ID 半角英数 32
イースコットプラス処理パスワード 半角英数 32
イースコットプラス登録カード使用フラグ 数値 1
名(カナ) 全角 30
名(漢字) 全角 30
運送会社ID(GMOPS後払い用) 数値 8
配送方法 数値 4
頒布回数 数値 2
頒布会ID 数値 8
頒布会受注区分 数値 1
頒布会親受注番号 数値 8
払込票URL 半角英数 300
頒布会受注親フラグ 数値 1
定期受注ヘッダフラグ 数値 1
支払い方法 数値 3
決済連携ID 数値 8
決済結果文言メールモバイル 全角 60000
決済結果文言メールPC 全角 60000
姓(カナ) 全角 30
姓(漢字) 全角 30
広告媒体コード 半角英数 20
会員ID 数値 8
内訳(会員割引額) 数値 12
携帯メールアドレス 半角英数 2000
ネットマイル加算ポイント 数値 12
次回配送予定日 日付 -
次回定期お休みフラグ 数値 1
受注API連携ステータス 数値 1
受注日時 日付 -
受注表示番号 半角 30
受注アクセスブラウザ区分 半角英数 100
受注商品属性ID 数値 8
受注確認メール配信日 日付 -
この注文の商品に関する情報を受信するフラグ 数値 1
払込期限 日付 -
入金日 日付 -
入金確認メール配信日 日付 -
入金額 数値 12
受注決済ステータス 全角 200
PCメールアドレス 半角英数 2000
端末区分 数値 1
利用ポイント 数値 8
内訳(ポイント使用額) 数値 8
受付番号 半角英数 32
登録言語 半角英数 100
キャンペーン付与ポイント 数値 8
内訳(キャンペーン割引額) 全角 2147483647
内訳(キャンペーン割引額) 数値 12
カード番号登録受注フラグ 数値 1
マスクされたカード番号 半角英数 20
使用カード取引ID 半角英数 100
請求金額合計 数値 12
精算ページID 半角英数 1000
送付先住所1 全角 100
送付先住所2 全角 200
送付先住所3 全角 200
配送日 日付 - 指定をすると配送済みとなります。
送付先名(カナ) 全角 30
送付先名(漢字) 全角 30
配送希望日 日付 -
配送希望時間 全角 100
送付先姓(カナ) 全角 30
送付先姓(漢字) 全角 30
送付先E-MAIL 半角英数 200
配送確認メール配信日 日付 -
送付先電話番号 半角英数 30
出荷予定日 日付 -
送付先郵便番号 半角英数 15
連携済み宅配伝票番号 半角英数 4000
セッションID 半角英数 50
宅配伝票番号 半角英数 2000 複数ある場合はカンマ区切りで指定してください。
内訳(仕入金額合計) 数値 12
内訳(送料) 数値 8
内訳(送料消費税) 数値 12
照会番号 半角英数 20
内訳(消費税) 数値 12
税率 数値 5
内訳(商品定価) 数値 12
内訳(商品定価消費税) 数値 12
定期ヘッダ受注番号 数値 8
定期販売区分 数値 1
定期販売配送事前通知処理日 日付 -
定期販売受注処理日 日付 -
定期販売毎月配送希望日 数値 2
定期連続お休み回数 数値 8
定期販売停止日 日付 -
定期にまとめ先注文親番号 数値 8
定期にまとめ先注文受注番号 数値 8
定期販売対象年月 数値 6
電話番号 半角英数 30
端末機種情報 半角英数 512
取引ID 半角英数 100
予約日 日付 -
予約確定メール配信日 日付 -
予約ステータス 数値 4
郵便番号 半角英数 15

 ※NAMEは全て半角大文字で指定する必要があります。
 ※項目の設定があってなおかつ値の設定もある場合は、項目に空白値が設定されているとして処理され、項目そのものが無い場合は、その項目が無視されます。
 ※値の設定がある項目は値のチェックが行われ、値の正しくない項目が1つでもある場合はエラーを返却し、処理をキャンセルします。

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0

(値のチェックエラー)
status=1&message=エラーメッセージ

(システム障害エラー)
status=9&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&MEMBER_ID=顧客ID&message=エラーメッセージ1~エラーメッセージ2

7.オーソリ確定処理IN(外部システム→本システム)

外部システムからオーソリ確定処理の指示を受け取ります。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
オーソリ確定日 日付 -
クレジット処理結果 数値 1
受注表示番号 半角 30 受注表示番号を指定してください。
受注決済ステータス 全角 200

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0

(値のチェックエラー)
status=1&message=エラーメッセージ

(システム障害エラー)
status=9&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&MEMBER_ID=顧客ID&message=エラーメッセージ1~エラーメッセージ2

8.顧客取得(外部システム→本システム)

外部システムからAPI接続することにより、本システム内顧客マスタデータを取得することができます。
※本APIはオプションとなります。ご利用の際はサポートまでお問い合わせください。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
アクセスURL 半角英数 2000
住所1(都道府県) 全角 100
住所2(市区町村、番地) 全角 200
住所3(マンション名等) 全角 100
管理ツール登録者 数値 8
管理ツール更新者 数値 8
備考 全角 1000
生年月日 日付 -
法人ID 数値 8
連携カラムのカラム名 - - 取得したい顧客情報のカラム名をカンマ区切りで指定します。
削除日 日付 -
名(カナ) 全角 30
名(漢字) 全角 30
外部サイトアイコン画像パス 半角英数 2,000
外部サイトアイコン画像使用プロバイダ 数値 8
外部サイトログインID 半角英数 2000
外部サイトログインプロバイダ 数値 8
顧客の自由項目 自由項目の設定による 自由項目の設定による
姓(カナ) 全角 30
姓(漢字) 全角 30
最終ログイン日時 日付 -
ログイン回数 数値 8
ログイン誤り回数 数値 2
ログイン誤り上限回数 数値 2
アカウントロック日時 日付 -
ログインID 〇※ 半角英数 2000
ログインIDで顧客取得するときはパスワードも必須となります。
メルマガ受付区分 数値 1
端末機種情報 半角英数 100
標準利用支払い方法 数値 3
標準利用クレジットカード支払い回数 数値 2
標準利用クレジットカード 半角英数 100
顧客ID 〇※ 数値 8
※以下のいずれかの値、組み合わせが必須です。
・顧客ID
・ログインIDとパスワード
・PC,携帯メールアドレスとパスワード
ポイント利用設定 数値 1
顧客ランク 数値 8
利用制限決済 半角英数 200
アクセスブラウザ区分 半角英数 2000
携帯メールアドレス 〇※ 半角英数 200
携帯メールアドレスで顧客取得するときはパスワードも必須となります。
ニックネーム 全角 100
パスワード 〇※ 半角英数 2000 ログインID、PCメールアドレス、携帯メールアドレスで顧客情報を取得する時に使用する項目です。
PCメールアドレス 〇※ 半角英数 200
PCメールアドレスで顧客取得するときはパスワードも必須となります。
端末区分 数値 1
ポイント残高 数値 8
登録日時 日付 -
登録区分 数値 1
登録言語 半角英数 100
本登録メール送信日時 日付 -
登録者 数値 8
請求先 数値 8
性別 半角英数 1
退会日 日付 -
自宅電話番号 半角英数 30
2段階ログイン利用区分 数値 2
更新日時 日付 -
更新者 数値 8
郵便番号 半角英数 15

※顧客ID、ログインID、PCメールアドレス、携帯メールアドレスそれぞれの値または組は、いずれかが必須となります。

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&指定カラム=指定したカラムの値&指定カラム=...

(値のチェックエラー)
status=1&message=エラーメッセージ

(システム障害エラー)
status=9&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&message=エラーメッセージ1~エラーメッセージ2

9.顧客ポイント取得(外部システム→本システム)

外部システムからAPI接続することにより、本システム内顧客マスタデータのポイントを取得することができます。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
顧客ID 数値 8
ポイント残高 数値 8

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&MEMBER_ID=顧客ID&POINT=顧客が保持しているポイント

※ポイントは未設定の場合も0が返却されます。

(値のチェックエラー)
status=1&MEMBER_ID=顧客ID&message=エラーメッセージ

(システム障害エラー)
status=9&MEMBER_ID=顧客ID&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&MEMBER_ID=顧客ID&message=エラーメッセージ1~エラーメッセージ2

10.受注情報取得(外部システム→本システム)

外部システムから本システムへAPI接続することにより、本システムの受注情報を取得することができます。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
アクセスキー - - 共通のキー + 本日日付_YYYYMMDDをsha1で暗号化したキー
アクセスURL 半角英数 2000
加算ポイント 数値 13
住所1 全角 100
住所2 全角 200
住所3 全角 200
管理ツール登録者 数値 8
管理ツール更新者 数値 8
後払い注文ID 半角英数 10
後払いステータス 全角 200
オーソリ確定日 日付 -
オーソリ日 日付 -
クレジット処理結果 数値 1
自動お知らせアイコン 半角英数 2000
自動キャンセルメール送信日 日付 -
自動キャンセル処理ステータス 数値 1
備考 全角 2000
内訳(まとめ買い割引値引額) 数値 12
受注取消日 日付 -
取消メール配信日 日付 -
カート引当セッションID 半角英数 50
連携カラムのカラム名 - - 取得したい受注情報のカラム名をカンマ区切りで指定します。
(例)COLUMN=ORDER_H.ORDER_NO ORDER_D.ITEM_NAME ..
※ヘッダ項目、明細項目を明示する必要がある返却名を指定したい場合は以下のようにパラメータを指定
(例) COLUMN=ORDER_H.ORDER_NO:ORDER_NO  ORDER_D.ITEM_NAME:ITEM_NAME ..
メール送信先端末 数値 1
有効性エラーフラグ 数値 1
継続課金請求送信日 日付 -
継続課金請求ステータス 数値 1
法人ID 数値 8
利用クーポンID 数値 8
内訳(クーポン割引額) 数値 12
分割回数 数値 2
カード種別 半角英数 20
有効期限 半角英数 7
カード名義 全角 60
カード番号 半角英数 20
内訳(代引手数料) 数値 8
内訳(代引手数料消費税) 数値 12
定期販売月スパン配送希望日 数値 2
定期販売月スパン配送希望曜日(週) 数値 1
定期販売月スパン配送希望曜日(曜日) 数値 1
削除日 日付 -
ダウンロード日 日付 -
加算ポイント編集フラグ 数値 1
イースコットプラスオーソリID 数値 8
イースコットプラス処理ID 半角英数 32
イースコットプラス処理パスワード 半角英数 32
イースコットプラス登録カード使用フラグ 数値 1
名(カナ) 全角 30
受注ヘッダの自由項目 自由項目の設定による 自由項目の設定による
名(漢字) 全角 30
運送会社ID(GMOPS後払い用) 数値 8
配送方法 数値 4
頒布回数 数値 2
頒布会ID 数値 8
頒布会受注区分 数値 1
頒布会親受注番号 数値 8
払込票URL 半角英数 300
頒布会受注親フラグ 数値 1
定期受注ヘッダフラグ 数値 1
支払方法 数値 3
決済連携ID 数値 8
決済結果文言メールモバイル 全角 60000
決済結果文言メールPC 全角 60000
姓(カナ) 全角 30
姓(漢字) 全角 30
広告媒体コード 半角英数 20
顧客ID 数値 8
内訳(会員割引額) 数値 12
携帯メールアドレス 半角英数 200
ネットマイル加算ポイント 数値 12
次回配送予定日 日付 -
次回定期お休みフラグ 数値 1
受注API連携ステータス 数値 1
受注日 日付 -
受注表示番号 半角英数 30
アクセスブラウザ区分 半角英数 100
受注商品属性ID 数値 8
受注確認メール配信日 日付 -
受注番号 数値 8
この注文の商品に関する情報を受信するフラグ 数値 1
払込期限 日付 -
入金日 日付 -
入金確認メール配信日 日付 -
入金額 数値 12
受注決済ステータス 全角 200
PCメールアドレス 半角英数 200
端末区分 数値 1
利用ポイント 数値 8
内訳(ポイント使用額) 数値 8
受付番号 半角英数 32
登録日時 日付 -
登録言語 半角英数 100
登録者 数値 8
キャンペーン付与ポイント 数値 8
キャンペーンIDリスト 全角 2147483647
内訳(キャンペーン割引額) 数値 12
カード番号登録受注フラグ 数値 1
マスクされたカード番号 半角英数 20
使用カード取引ID 半角英数 100
請求金額合計 数値 12
精算ページID 半角英数 1000
送付先住所1 全角 100
送付先住所2 全角 200
送付先住所3 全角 200
配送日 日付 -
送付先名(カナ) 全角 30
送付先名(漢字) 全角 30
配送希望日 日付 -
配送希望時間 全角 100
送付先姓(カナ) 全角 30
送付先姓(漢字) 全角 30
送付先E-MAIL 半角英数 200
配送確認メール配信日 日付 -
送付先電話番号 半角英数 30
出荷予定日 日付 -
送付先郵便番号 半角英数 15
連携済み宅配伝票番号 半角英数 4000
セッションID 半角英数 50
宅配伝票番号 半角英数 2000
内訳(仕入金額合計) 数値 12
内訳(送料) 数値 8
内訳(送料消費税) 数値 12
照会番号 半角英数 20
内訳(消費税) 数値 12
税率 数値 5
内訳(商品定価) 数値 12
内訳(商品定価消費税) 数値 12
定期ヘッダ受注番号 数値 8
定期販売区分 数値 1
定期販売配送事前通知処理日 日付 -
定期販売受注処理日 日付 -
定期販売毎月配送希望日 数値 2
定期連続お休み回数 数値 8
定期販売停止日 日付 -
定期にまとめ先注文親番号 数値 8
定期にまとめ先注文受注番号 数値 8
定期販売対象年月 数値 6
電話番号 半角英数 30
更新日時 日付 -
更新者 数値 8
端末機種情報 半角英数 512
取引ID 半角英数 100
予約日 日付 -
予約確定メール配信日 日付 -
予約ステータス 数値 4
郵便番号 半角英数 15

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&指定カラム=指定したカラムの値&指定カラム=...

(値のチェックエラー)
status=1&message=エラーメッセージ

(システム障害エラー)
status=9&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&message=エラーメッセージ1~エラーメッセージ2

11.商品情報取得(外部システム→本システム)

外部システムから本システムへAPI接続することにより、本システムの商品情報を取得することができます。

①アクセスURL
 アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。

②連携項目定義
 項目定義は以下の通りです。項目の定義順は問いません。

名称 必須 桁数 説明
加算ポイント 数値 12
ポイント還元率 数値 6
管理ツール登録者 数値 8
管理ツール更新者 数値 8
受注取消シリアル引当フラグ 数値 1
カート用商品コメント 全角 4000
カートオプション設定 半角英数 1000
「買い物かごに入れる」リンク表示 数値 1
Criteoバナー表示フラグ 数値 1
Criteo連携フラグ 数値 1
連携カラムのカラム名 - - 取得したい商品情報のカラム名をカンマ区切りで指定します。
(例) COLUMN=ITEM_ID ITEM_NAME ..
※商品ID、商品コードのいずれかが必須となります。
会員割引FLG 数値 1
商品詳細表示フラグ 数値 1
商品の自由項目 自由項目の設定による 自由項目の設定による
商品テンプレート(FP) 全角 100
Google Shopping連携フラグ 数値 1
配送方法ID 数値 4
配送方法重み 数値 6
頒布会商品フラグ 数値 1
頒布会ID 数値 8
閲覧履歴非表示フラグ 数値 1
アピールポイント 全角 2000
アピール画像 半角英数 500
商品コード 〇※ 半角英数 50
※商品ID, 商品コードどちらかが必須です。
ダウンロード販売商品 数値 1
ダウンロードファイル名 半角英数 500
商品ID 〇※ 数値 8
※商品ID, 商品コードどちらかが必須です。
画像パス1 半角英数 500
画像パス2 半角英数 500
画像パス3 半角英数 500
画像パス4 半角英数 500
商品説明1 全角 20000
商品説明2 全角 40000
商品説明3 全角 40000
商品名カナ 全角 200
商品名 全角 200
公開顧客ランク 数値 8
セット子商品在庫切れフラグ 数値 1
利用制限決済 半角英数 200
決済手数料フラグ 数値 1
表示期間FROM 日付 -
表示期間TO 日付 -
携帯カート用商品コメント 全角 4000
携帯アピールポイント 全角 2000
携帯アピール画像 半角英数 500
携帯画像パス1 半角英数 500
携帯画像パス2 半角英数 500
携帯画像パス3 半角英数 500
携帯画像パス4 半角英数 500
携帯商品説明1 全角 20000
携帯商品説明2 全角 40000
携帯商品説明3 全角 40000
代表カテゴリ 数値 8
希望小売価格 数値 12
レコメンドカテゴリ 数値 8
最高注文数 数値 8
会員割引額 数値 12
メタタグディスクリプション 全角 2000
メタタグキーワード 全角 2000
最低注文数 数値 8
商品シリアルお知らせメール最低在庫数 数値 8
最低在庫数 数値 8
ネットマイルポイント 数値 12
並び替え用新着日付 日付 -
ノベルティ付与条件特定化フラグ 数値 1
ノベルティ商品フラグ 数値 1
ノベルティ付与期間FROM 日付 -
ノベルティ付与応募期間TO 日付 -
ノベルティ付与回数上限 数値 8
ノベルティ付与対象金額 数値 8
入荷お知らせ受付 数値 1
オプション商品区分 数値 8
注文確認メール商品コメント 全角 2,000
同一顧客購入個数制限 数値 8
別精算ページリンク 半角英数 1000
商品テンプレート(PC) 全角 100
端末区分 数値 1
ポイントFLG 数値 1
公開会員ランク指定フラグ 数値 1
入数 数値 8
販売単位制限数 数値 8
登録日時 日付 -
登録区分 数値 1
登録者 数値 8
発売日 日付 -
検索結果表示フラグ 数値 1
配送希望日指定可能最小日数 数値 8
配送希望日指定可能最大日数 数値 8
別注商品フラグ 数値 1
別注商品グループ 半角英数 100
仕入金額 数値 12
送料無料フラグ 数値 1
商品テンプレート(スマートフォン) 全角 100
販売価格 数値 12
定期販売商品 数値 1
最大配送間隔 数値 8
最低購入回数 数値 8
定期変更期限日数 数値 8
月次定期販売処理日 半角英数 200
定期販売配送日数 数値 3
発送スパン 数値 8
発送スパン単位区分 数値 8
定期販売対象月 半角英数 200
定期にまとめて注文可能フラグ 数値 1
タイトルタグ表示名 全角 300
取引先ID 数値 8
更新日時 日付 -
更新者 数値 8
予約商品フラグ 数値 1
予約フラグ自動有効化フラグ 数値 1
在庫数表示フラグ 数値 1
在庫管理FLG 数値 1
在庫単位フラグ 数値 1
在庫総数 数値 12

③返却値
 HTTPアクセスにより以下の値が返却されます。

(処理OKのとき)
status=0&指定カラム=指定したカラムの値&指定カラム=...

(値のチェックエラー)
status=1&message=エラーメッセージ

(システム障害エラー)
status=9&message=エラーメッセージ

※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
 例)status=1&message=エラーメッセージ1~エラーメッセージ2

この説明は参考になりましたか?

はい いいえ

0人の方が「参考になった」と言っています。
3人の方が「参考にならなかった」と言っています。