© 2024 InterFactory,inc.
本システムと外部システムとのAPI連携を行います。
APIアクセスは並列アクセスを1秒間に1回以内に制限させて頂きます。連続してアクセスする場合は非同期通信は行わず、レスポンスを待って次の処理を行うようして頂くか、1秒間のスリープを入れて頂きますようお願い致します。
API連携(API-IN)について、ご契約内容によって課金対象になります。
メールサーバのブラックリスト入りを防ぐため、
本システムでは一定期間内に同一メールアドレスに対して大量に配信される場合、
該当のメールアドレス宛にメールを送信しません。
このため、API連携エラー時に店舗管理者宛に大量のエラーメールが自動配信される場合は、
メールを配信しません。
本システムは、以下のAPI連携メソッドをサポートしています。
OUT連携の連携タイミングは全てリアルタイム（画面上操作と同じタイミング）です。
１．会員データ連携IN（外部システム→本システム）
２．会員データ連携OUT（本システム→外部システム）
３．商品データ連携IN（外部システム→本システム）
４．商品データ連携OUT（本システム→外部システム）
５．受注データ連携OUT（本システム→外部システム）
６．受注ステータスデータ連携IN（外部システム→本システム）
７．オーソリ確定処理IN（外部システム→本システム）
８．会員取得（外部システム→本システム）
９．会員ポイント取得（外部システム→本システム）
１０．受注情報取得（外部システム→本システム）
１１．商品情報取得（外部システム→本システム）
１２．会員ポイントデータ連携IN（外部システム→本システム）
全てのAPI連携は以下の仕様に従います。
プロトコル：httpまたはhttps
メソッド：POST
アクセス元IPアドレス制限：外部システム→本システムの処理は、特定のIPアドレスからのアクセスのみ許可します。
（アクセス元IPアドレスは初期設定の「APIのアクセス元IPアドレス」に指定します 複数のIPアドレスやサブネットアドレスの指定が可能です）
文字コードエンコーディング：UTF-8
（エンコーディングは初期設定の「外部API連携処理エンコード」で変更できます）
※「APIのアクセス元IPアドレス」「外部API連携処理エンコード」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
API連携の項目定義で共通となる仕様を以下に記載します。
・必須カラムについて
○ ・・・ データIN連携時に設定が必須な項目です。データOUT連携時も必ず設定されます。
△ ・・・ データIN連携時の新規登録時に必ず設定する項目です。データIN連携時で更新処理の場合は項目を省略することは可能ですが、項目を指定する場合は合わせて値の設定が必須となります。また、データOUT連携時は必ず設定されます。
・属性説明
全角 ・・・ 全角、半角、半角数値のいずれも設定可能
半角 ・・・ 半角、半角数値の設定が可能
数値 ・・・ 半角数値の設定が可能
・データIN連携時の項目の設定方法について
連携された項目に値がない場合、値は空白（null）として処理されます。
項目そのものが無い場合、その項目は更新、登録されません。
例）
パターン１ → MEMBER_ID=1234&L_NAME=田中&F_NAME=太郎&ADDR1=...
パターン２ → MEMBER_ID=1234&L_NAME=田中&F_NAME=太郎...
データIN連携でデータを更新する場合、上記の例でパターン１の場合は ADDR1 の項目に空白（null）が設定され、パターン２の場合は項目の設定がないので無視され、データベースの ADDR1 にはデータの更新が行われません。
また、データIN連携でデータを新規登録する場合は、上記パターン１、２のいずれもデータベースには空白（null）が設定されます。
・データIN連携時、更新者のIDは「99999998」が固定で設定されます。
外部システムからAPI接続することにより、本システム内会員マスタデータの新規登録・変更・削除（論理削除）を行うことができます。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
②連携項目定義
項目定義は以下の通りです。項目の定義順は問いません。
以下の項目はシステム設定の初期値となっており、初期設定の「会員データ連携IN 連携項目定義」で変更が可能です。
※「会員データ連携IN 連携項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
「会員データ連携IN 連携項目定義」の設定値の上限は5000バイトです。
| 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| 会員ID | 数値 | 8 | すでに同一会員IDのデータが存在するときは上書きされ、設定されていないかまたは存在しない値の場合は新規に会員データが作成されます。 ただし、存在しないIDを指定した場合は、指定されたIDで登録します。 | |
| 端末区分 | 数値 | 1 | 1:PCで新規会員登録、3携帯で新規会員登録（設定の無い場合は、自動的に「1:PCで新規会員登録」に設定されます） | |
| 端末機種情報 | 半角英数 | 2000 | ||
| 会員アクセスブラウザ区分 | 半角英数 | 100 | ||
| 登録言語 | 半角英数 | 100 | ||
| 姓（漢字） | 〇 | 全角 | 30 | |
| 名（漢字） | 〇 | 全角 | 30 | |
| 姓（カナ） | 全角 | 30 | 全角カナである必要はありません。 | |
| 名（カナ） | 全角 | 30 | 全角カナである必要はありません。 | |
| ニックネーム | 全角 | 100 | （商品レビューオプションが有効な場合のみ利用可能） | |
| 郵便番号 | 半角英数 | 15 | ||
| 住所１(都道府県) | 全角 | 100 | 東京都 | |
| 住所２(市区町村、番地) | 全角 | 200 | ○○市○○町1-2-3 | |
| 住所３(ビル、マンション名等) | 全角 | 200 | ○○ビル1F | |
| 性別 | 半角英数 | 1 | M：男性、F：女性、X：その他（初期設定『性別「その他」利用フラグ』が「利用する」の場合）、空白(null)：設定なし | |
| 生年月日 | 日付 | - | ||
| 電話番号 | 半角英数 | 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 | ||
| 会員の自由項目 | 自由項目の設定による（最大2000バイト） | 自由項目の設定による（最大2000バイト） | ||
| 標準利用支払い方法 | 数値 | 3 | ||
| 標準利用クレジットカード | 半角英数 | 100 | ||
| 標準利用クレジットカード支払い回数 | 数値 | 2 | ||
| 2段階ログイン利用区分 | 数値 | 2 | 空白(null):利用しない、1:PCメール、2:携帯メール | |
| 登録区分 | 数値 | 1 | ||
| 本登録メール送信日時 | 日付 | - | ||
| ポイント利用設定 | 数値 | 1 | ||
| 管理ツール登録者 | 数値 | 8 | ||
| 法人ID | 数値 | 8 | ||
| 利用制限決済 | 半角英数 | 200 | ||
| 営業会員フラグ | 数値 | 1 | ||
| 同報メール種別 | 半角 | 20 | ||
| 秘密の質問 | 全角 | 1000 | ||
| 秘密の質問の答え | 全角 | 1000 | ||
| パスワード変更時認証項目誤りカウント | 数値 | 2 | ||
| パスワード変更時認証項目誤り上限 | 数値 | 2 | ||
| 管理ツール更新者 | 数値 | 8 |
※API連携での更新は会員管理の会員新規登録でできる必須項目編集の必須項目に影響されません。
※NAMEは全て半角大文字で指定する必要があります。
※連携された項目に値がない場合、値は空白（null）として処理されます。
項目そのものが無い場合、その項目は更新、登録されません。
※値の設定がある項目は値のチェックが行われ、値の正しくない項目が１つでもある場合はエラーを返却し、処理をキャンセルします。
※自由項目は「利用する」項目のみが設定されます。
※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
※初期設定の以下の設定は、入力チェックには利用されず無視されます。
・ユーザーウェブパスワード最低桁数
・ユーザーウェブパスワード最高桁数
・ユーザーウェブログインID最低桁数
・ユーザーウェブログイン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=エラーメッセージ１~エラーメッセージ２
※ 新規登録時、エラーが発生して会員IDが発行されていない場合は、会員IDが設定されないことがあります。
※ 異常系レスポンスとして、上記以外のHTMLが返却される場合があります。
（サイト混雑時ユーザー整理機能発動時やサーバー高負荷時）
外部システムへ、本システム内の会員データの変更通知を行います。
①アクセスURL
初期設定の「会員データ連携OUT 接続先URL」にリクエストします。
アクセスURL：初期設定の「会員データ連携OUT 接続先URL」
※「会員データ連携OUT 接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
②連携タイミング
以下の処理実行時にAPI連携が起動されます。
（ユーザーウェブ）
新規会員登録時
会員情報変更時
注文完了時
メルマガ登録時、解除時
（ショップ管理ツール）
新規会員登録時
会員情報変更時
会員情報一括アップロード時
メルマガ解除時（メルマガ配信エラーアドレス管理）
オペレータ受注画面での会員情報の登録・変更時
受注取消によりポイントの加算・減算が行われ、スマレジ連携を行った時
会員ポイント管理でのポイントの加算・減算が行われた時
（その他）
会員データ連携IN（外部システム→本システム）の起動時
会員ポイントデータ連携IN（外部システム→本システム）の起動時
③連携項目定義
項目定義は以下の通りです。項目の定義順は順不同です。
以下の項目はシステム設定の初期値となっており、初期設定の「会員データ連携OUT 連携項目定義」で変更が可能です。
※「会員データ連携OUT 連携項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
「会員データ連携OUT 連携項目定義」の設定値の上限は5000バイトです。
| 名称 | 本システムに、データが必ず存在する | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| アクセスURL | 半角英数 | 2000 | ||
| 住所１(都道府県) | 全角 | 100 | 東京都 | |
| 住所２(市区町村、番地) | 全角 | 200 | ○○市○○町1-2-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：女性、X：その他（初期設定『性別「その他」利用フラグ』が「利用する」の場合）、空白(null)：設定なし | |
| 退会日 | 日付 | - | 退会時設定する | |
| 電話番号 | 半角英数 | 30 | ||
| 2段階ログイン利用区分 | 数値 | 2 | 空白(null):利用しない 1:PCメール 2:携帯メール | |
| 郵便番号 | 半角英数 | 15 | ||
| 営業会員フラグ | 数値 | 1 | ||
| 同報メール種別 | 半角 | 20 | ||
| 秘密の質問 | 全角 | 1000 | ||
| 秘密の質問の答え | 全角 | 1000 | ||
| パスワード変更時認証項目誤りカウント | 数値 | 2 | ||
| パスワード変更時認証項目誤り上限 | 数値 | 2 |
※NAMEは全て半角大文字です。
※上記にあるすべての項目が設定されます。（初期設定の「会員データ連携OUT 連携項目定義」を変更していない場合に限る）
※自由項目は「利用する」項目のみが設定されます。
※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
④返却値
外部システムへ通信し、
通信先より、以下のようなレスポンスを受け取ることを想定しています。
■返却値例
（処理OKのとき）
status=0
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※処理が正常か異常かを示す「status」については、初期設定「API結果判定緩和設定」で変更可能です。
初期設定「API結果判定緩和設定」：利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」：利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断
statusがどの値の場合に正常とするかはカスタマイズ可能です。
「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。
パラメータには、複数の返却値をひもづけるために「&」を、項目と値をひもづけるために「=」を必ず使用してください。
この用途以外に「&」「=」を使用した場合は、想定外の挙動になるため、ご注意ください。
外部システムからAPI接続することにより、本システム内商品マスタデータの新規登録・変更・を行うことができます。（削除はできません）
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
②連携項目定義
項目定義は以下の通りです。項目の定義順は問いません。
以下の項目はシステム設定の初期値となっており、初期設定の「商品データ連携IN 連携項目定義」で変更が可能です。
※「商品データ連携IN 連携項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
「商品データ連携IN 連携項目定義」の設定値の上限は5000バイトです。
| 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| 商品ID | 数値 | 8 | ||
| 商品コード | 〇 | 半角英数 | 50 | すでに同一商品コードのデータが存在するときは上書きされ、存在しない値の場合は新規に商品データが作成されます。 自動的に大文字に変換して処理され、また「-」ハイフンを含む値の指定はできません。 |
| 端末区分 | 数値 | 1 | 1:PCのみ、2:PC+携帯、3携帯のみ （設定の無い場合は、商品新規登録画面の「端末区分」のデフォルト値が設定されます） | |
| ダウンロード販売商品 | 数値 | 1 | 空白(null):通常商品、1:ダウンロード販売商品 | |
| ダウンロードファイル名 | 半角英数 | 500 | ダウンロード販売商品のアップロードフォルダ download_file 内の相対パス | |
| 商品名 | 〇※ | 全角 | 200 | ※新規登録時のみ必須 |
| 商品名(カナ) | 〇※ | 全角 | 200 | 全角カナである必要はありません。 ※新規登録時のみ必須 |
| 販売価格 | 〇※ | 数値 | 12 | ※新規登録時のみ必須 |
| 希望小売価格 | 数値 | 12 | ||
| 表示期間FROM | 日付 | - | 「YYYY/MM/DD HH:MM」のフォーマットで時間指定もできます。 | |
| 表示期間TO | 日付 | - | 「YYYY/MM/DD HH:MM」のフォーマットで時間指定もできます。 | |
| 商品画像１ | 半角英数 | 500 | ファイル名または画像格納フォルダ内の相対パスを指定 以下画像パスは全て同様 | |
| 商品画像２ | 半角数値 | 500 | ||
| 商品画像３ | 半角数値 | 500 | ||
| 商品画像４ | 半角数値 | 500 | ||
| アピール画像 | 半角数値 | 500 | ||
| アピールポイント | 全角 | 2000 | ||
| 商品コメント１ | 全角 | 20000 | ||
| 商品コメント２ | 全角 | 40000 | ||
| 商品コメント３ | 全角 | 40000 | ||
| カート用商品コメント | 全角 | 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 | ||
| 仕入先ID | 数値 | 8 | ||
| 仕入金額 | 数値 | 12 | ||
| 「買い物かごに入れる」リンク表示 | 数値 | 1 | 空白(null):表示する、1:表示しない。 | |
| 利用制限決済 | 半角英数 | 200 | 商品利用決済ID情報のカンマ区切りリスト ID）1:銀行振込 2:郵便振替 5:クレジットカード 例）1,2,5 | |
| 新着順用更新日 | 日付 | - | 新着順で並び替えるための日付 | |
| カテゴリ | 半角 | - | カテゴリコードをカンマ区切りで設定します。 登録上限は10個で、10個以上設定しても10個までしか登録されません。 カテゴリが存在しない場合エラーとなります。 | |
| レコメンド | 半角 | - | 商品コードをカンマ区切りで設定します。 登録上限は10個で、10個以上設定しても10個までしか登録されません。 商品コードが存在しない場合エラーとなります。 「商品コード」に設定する値と同じ値を設定するとエラーとなります。 | |
| 代表カテゴリ | 数値 | 8 | ||
| レコメンドカテゴリ | 数値 | 8 | ||
| 送料無料フラグ | 数値 | 1 | 空白(null):送料無料にしない 1:この商品と一緒に購入するすべての商品の送料が無料にする | |
| 決済手数料無料フラグ | 数値 | 1 | ||
| 別注商品フラグ | 数値 | 1 | 空白(null):通常商品、1:別注商品(商品バリエーション単位)、2:別注商品(商品単位) 別注商品（商品バリエーション単位）に設定すると、他の商品および、属性の異なる同一商品と同時に注文することができなくなります。 別注商品（商品単位）に設定すると、他の商品と同時に注文できなくなりますが、属性の異なる同一商品と同時に注文することは可能となります。 | |
| 別注商品グループ | 半角英数 | 100 | 別注商品管理を行う場合に、別注対象外とするグループを半角文字列で指定します。 | |
| 公開会員ランク | 数値 | 8 | 空白(null):ランクを設定しない、ランクを設定すると会員以外ではその商品が購入できなくなります。 また会員のランクと連動し、ログイン中の会員よりも上位のランクの商品は表示されなくなります。 ランクは数値が小さいほど上位ランクを意味します。 | |
| 配送希望日指定可能最小日数 | 数値 | 8 | 配送希望日に指定できる受注からの最小日数 | |
| 配送希望日指定可能最大日数 | 数値 | 8 | 配送希望日に指定できる受注からの最大日数 | |
| カートオプション設定 | 半角英数 | 1000 | 空白(null):精算時にオプション商品一覧が表示されません。 1:精算時にオプション商品一覧が表示されます。 | |
| オプション商品区分 | 数値 | 8 | ||
| 受注取消シリアル引当フラグ | 数値 | 1 | ||
| 商品シリアルお知らせメール最低在庫数 | 数値 | 8 | ||
| 注文確認メール商品コメント | 全角 | 2000 | 注文確認メールに設定される商品コメント | |
| 在庫数 | 数値 | 12 |
バリエーションごとの在庫数を指定する場合は、「在庫単位フラグ（ZAIKO_TANI_FLG）」を「1」で指定し、「商品バリエーションリスト（ITEM_ITEMPROPERTY_LIST）」で対象のバリエーションを指定してください。 また、マイナスの値で在庫を減らしたい場合は「在庫数プラスマイナスフラグ（ZAIKO_PLUS_MINUS_FLG）」を「1」で指定する必要があります。 |
|
| 閲覧履歴非表示フラグ | 数値 | 1 | ||
| セット子商品在庫切れフラグ | 数値 | 1 | ||
| 登録者 | 数値 | 8 | ||
| 管理ツール登録者 | 数値 | 8 | ||
| 登録日時 | 日付 | - | ||
| 更新者 | 数値 | 8 | ||
| 管理ツール更新者 | 数値 | 8 | ||
| 更新日時 | 日付 | - | ||
| PC向け商品テンプレート | 全角 | 100 | ||
| SmartPhone向け商品テンプレート | 全角 | 100 | ||
| 商品の自由項目 | 自由項目の設定による（最大2000バイト） | 自由項目の設定による（最大2000バイト） | ||
| 商品詳細表示フラグ | 数値 | 1 | ||
| 公開会員ランク指定フラグ | 数値 | 1 | ||
| 軽減税率フラグ | 数値 | 1 | 空白(null):通常商品,1:軽減税率対象商品 | |
| 受注残管理 | 数値 | 1 | 空白(null):しない,1:する | |
| 受注残用在庫引当 | 数値 | 1 | 空白(null):手動で確定する,1:自動で確定する | |
| 受注残受付上限 | 数値 | 8 |
※NAMEは全て半角大文字で指定する必要があります。
※連携された項目に値がない場合、値は空白（null）として処理されます。
項目そのものが無い場合、その項目は更新、登録されません。
※値の設定がある項目は値のチェックが行われ、値の正しくない項目が１つでもある場合はエラーを返却し、処理をキャンセルします。
※自由項目は「利用する」項目のみが設定されます。
※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
※自身がセットの子商品の場合、商品バリエーションの変更ができないため、以下の項目は無視されますのでご注意ください。
商品バリエーションリスト、在庫数、在庫単位フラグ、商品セットリスト
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0&ITEM_CD=商品コード
（値のチェックエラー）
status=1&ITEM_CD=商品コード&message=エラーメッセージ
（システム障害エラー）
status=9&ITEM_CD=商品コード&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&ITEM_CD=商品コード&message=エラーメッセージ１~エラーメッセージ２
※ 異常系レスポンスとして、上記以外のHTMLが返却される場合があります。
（サイト混雑時ユーザー整理機能発動時やサーバー高負荷時）
外部システムへ、本システム内の商品データの変更通知を行います。
①アクセスURL
初期設定の「商品データ連携OUT 接続先URL」にリクエストします。
アクセスURL：初期設定の「商品データ連携OUT 接続先URL」
※「商品データ連携OUT 接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
②連携タイミング
以下の処理実行時にAPI連携が起動されます。
（ショップ管理ツール）
商品情報登録時
商品情報変更時
商品一覧画面からの登録区分更新時
商品情報一括アップロード時
③連携項目定義
項目定義は以下の通りです。項目の定義順は順不同です。
以下の項目はシステム設定の初期値となっており、初期設定の「商品データ連携OUT 連携項目定義」で変更が可能です。
※「商品データ連携OUT 連携項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
「商品データ連携OUT 連携項目定義」の設定値の上限は5000バイトです。
| 名称 | 本システムに、データが必ず存在する | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| 商品ID | 〇 | 数値 | 8 | |
| 商品コード | 〇 | 半角英数 | 50 | |
| 端末区分 | 〇 | 数値 | 1 | 1:PCのみ、2:PC+携帯、3携帯のみ |
| ダウンロード販売商品 | 数値 | 1 | 空白(null):通常商品、1:ダウンロード販売商品 | |
| ダウンロードファイル名 | 半角英数 | 500 | ダウンロード販売商品のアップロードフォルダ download_file 内の相対パス | |
| 商品名 | 〇 | 全角 | 200 | |
| 商品名(カナ) | 〇 | 全角 | 200 | |
| 販売価格 | 〇 | 数値 | 12 | |
| 希望小売価格 | 数値 | 12 | ||
| 表示期間FROM | 日付 | - | ||
| 表示期間TO | 日付 | - | ||
| 商品画像１ | 半角数値 | 500 | ファイル名または画像格納フォルダ内の相対パスを指定 以下画像パスは全て同様 | |
| 商品画像２ | 半角数値 | 500 | ||
| 商品画像３ | 半角数値 | 500 | ||
| 商品画像４ | 半角数値 | 500 | ||
| アピール画像 | 半角数値 | 500 | ||
| アピールポイント | 全角 | 2000 | ||
| 商品コメント１ | 全角 | 20000 | ||
| 商品コメント２ | 全角 | 40000 | ||
| 商品コメント３ | 全角 | 40000 | ||
| カート用商品コメント | 全角 | 4000 | ||
| 在庫数 | 数値 | 8 | ||
| 最低在庫数 | 数値 | 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 | ||
| 仕入金額 | 数値 | 12 | ||
| 「買い物かごに入れる」リンク表示 | 数値 | 1 | 空白(null):表示する、1:表示しない。 | |
| 利用制限決済 | 半角英数 | 200 | 商品利用決済ID情報のカンマ区切りリスト ID）1:銀行振込,2:郵便振替,5:クレジットカード 例）1,2,5 | |
| 新着順用更新日 | 日付 | - | 新着順で並び替えるための日付 | |
| 送料無料フラグ | 数値 | 1 | 空白(null):送料無料にしない、1:この商品と一緒に購入するすべての商品の送料が無料にする | |
| 決済手数料無料フラグ | 数値 | 1 | ||
| 別注商品フラグ | 数値 | 1 | 空白(null):通常商品、1:別注商品(商品バリエーション単位)、2:別注商品(商品単位) 別注商品（商品バリエーション単位）に設定すると、他の商品および、属性の異なる同一商品と同時に注文することができなくなります。 別注商品（商品単位）に設定すると、他の商品と同時に注文できなくなりますが、属性の異なる同一商品と同時に注文することは可能となります。 | |
| 別注商品グループ | 半角英数 | 100 | 別注商品管理を行う場合に、別注対象外とするグループを半角文字列で指定します。 | |
| 公開会員ランク | 数値 | 8 | 空白(null):ランクを設定しない、ランクを設定すると会員以外ではその商品が購入できなくなります。 また会員のランクと連動し、ログイン中の会員よりも上位のランクの商品は表示されなくなります。 ランクは数値が小さいほど上位ランクを意味します。 | |
| 配送希望日指定可能最小日数 | 数値 | 8 | 配送希望日に指定できる受注からの最小日数 | |
| 配送希望日指定可能最大日数 | 数値 | 8 | 配送希望日に指定できる受注からの最大日数 | |
| カートオプション設定 | 半角英数 | 1000 | 空白(null):精算時にオプション商品一覧が表示されません。 1:精算時にオプション商品一覧が表示されます。 | |
| オプション商品区分 | 〇 | 数値 | 8 | |
| 受注取消シリアル引当フラグ | 数値 | 1 | ||
| 商品シリアルお知らせメール最低在庫数 | 数値 | 8 | ||
| 注文確認メール商品コメント | 全角 | 2000 | 注文確認メールに設定される商品コメント | |
| 閲覧履歴非表示フラグ | 数値 | 1 | ||
| 登録者 | 数値 | 8 | ||
| 登録日時 | 日付 | - | ||
| 更新者 | 数値 | 8 | ||
| 更新日時 | 日付 | - | ||
| PC向け商品テンプレート | 全角 | 100 | ||
| SmartPhone向け商品テンプレート | 全角 | 100 | ||
| 商品の自由項目 | 自由項目の設定による（最大2000バイト） | 自由項目の設定による（最大2000バイト） | ||
| 商品詳細表示フラグ | 数値 | 1 | ||
| 公開会員ランク指定フラグ | 数値 | 1 | ||
| 代表カテゴリ | 半角英数 | 20 | ||
| 軽減税率フラグ | 数値 | 1 | 空白(null):通常商品,1:軽減税率対象商品 | |
| 受注残管理 | 数値 | 1 | 空白(null):しない,1:する | |
| 受注残用在庫引当 | 数値 | 1 | 空白(null):手動で確定する,1:自動で確定する | |
| 受注残受付上限 | 数値 | 8 |
※NAMEは全て半角大文字です。
※上記にあるすべての項目が設定されます。（初期設定の「商品データ連携OUT 連携項目定義」を変更していない場合に限る）
※自由項目は「利用する」項目のみが設定されます。
※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
④返却値
外部システムへ通信し、
通信先より、以下のようなレスポンスを受け取ることを想定しています。
■返却値例
（処理OKのとき）
status=0
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※処理が正常か異常かを示す「status」については、初期設定「API結果判定緩和設定」で変更可能です。
初期設定「API結果判定緩和設定」：利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」：利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断
statusがどの値の場合に正常とするかはカスタマイズ可能です。
「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。
パラメータには、複数の返却値をひもづけるために「&」を、項目と値をひもづけるために「=」を必ず使用してください。
この用途以外に「&」「=」を使用した場合は、想定外の挙動になるため、ご注意ください。
外部システムへ、本システム内の受注データの登録・変更通知を行います。
①アクセスURL
初期設定の「受注データ連携OUT 接続先URL」にリクエストします。
アクセスURL：初期設定の「受注データ連携OUT 接続先URL」
※「受注データ連携OUT 接続先URL」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
②連携タイミング
以下の処理実行時にAPI連携が起動されます。
（ユーザーウェブ）
お買い物時
（ショップ管理ツール）
受注新規登録時
受注情報変更時（明細の登録・更新のタイミングも含む）
受注照会画面での受注ステータス変更時（入金区分、配送区分など）
受注データ一括アップロード時
出荷実績取込時
※出荷実績取込時については、下記いずれかのラジオボタンを選択してアップロードした場合
・配送日自動設定「設定する」
・代金引換入金区分チェック「入金済にする」
・後払い決済入金区分チェック「入金済にする」
（その他）
オーソリ確定処理IN（外部システム→本システム）の起動時
受注情報を削除したときは、API連携が実行されません。
③連携項目定義
初期設定の「受注データ連携OUT 連携項目定義」によって定義されている値を送信します（順不同）。
※「受注データ連携OUT 連携項目定義」は、弊社にて設定もしくは設定できるように表示しますのでお問い合わせください。
「受注データ連携OUT 連携項目定義」の設定値の上限は5000バイトです。
| 名称 | 本システムに、データが必ず存在する | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| アクセスURL | 半角英数 | 2000 | ||
| 加算ポイント | 数値 | 13 | ||
| 住所１ | 全角 | 100 | ||
| 住所２ | 全角 | 200 | ||
| 住所３ | 全角 | 200 | ||
| オーソリ確定日 | 日付 | - | ||
| オーソリ日 | 日付 | - | ||
| クレジット処理結果 | 数値 | 1 | 0:正常終了、9:異常終了 | |
| 備考 | 全角 | 2000 | ||
| 注文時のIPアドレス | 半角英数 | 50 | ||
| 内訳（まとめ買い割引値引額） | 数値 | 12 | ||
| 受注取消日 | 日付 | - | ||
| 取消メール配信日 | 日付 | - | ||
| 自動キャンセルメール送信日 | 日付 | - | ||
| 入金督促メール送信日 | 日付 | - | ||
| 有効性エラーフラグ | 数値 | 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 | |
| ダウンロード日 | 日付 | - | ||
| 名（カナ） | 全角 | 30 | ||
| 名（漢字） | 〇 | 全角 | 30 | |
| 配送方法 | 数値 | 4 | 購入する商品の配送方法重みによる選択することができません。 | |
| 払込票URL | 半角英数 | 300 | ||
| 支払方法 | 〇 | 数値 | 3 | 1:郵便振込 2:銀行振込 3:代金引換 |
| 決済連携ID | 数値 | 8 | ||
| 姓（カナ） | 全角 | 30 | ||
| 姓（漢字） | 〇 | 全角 | 30 | |
| 広告媒体コード | 半角英数 | 20 | ||
| 会員ID | 数値 | 8 | 会員登録済みのエンドユーザーの注文時のみ設定されます | |
| 内訳（会員割引額） | 数値 | 12 | ||
| 携帯メールアドレス | 半角英数 | 200 | ||
| 受注日 | 〇 | 日付 | - | |
| 受注表示番号 | 〇 | 半角英数 | 30 | |
| アクセスブラウザ区分 | 半角英数 | 100 | ||
| 受注確認メール配信日 | 日付 | - | ||
| 内部受注ID | 〇 | 数値 | 8 | |
| この注文の商品に関する情報を受信するフラグ | 数値 | 1 | ||
| 払込期限 | 日付 | - | ||
| 入金日 | 日付 | - | ||
| 入金確認メール配信日 | 日付 | - | ||
| 入金額 | 数値 | 12 | ||
| PCメールアドレス | 半角英数 | 200 | PCメールアドレスと携帯メールアドレスのどちらかが必須設定されます。 | |
| 端末区分 | 〇 | 数値 | 1 | 1:PCで購入、3:携帯で購入 |
| 利用ポイント | 数値 | 8 | ||
| 内訳（ポイント使用額） | 数値 | 8 | ||
| 受付番号 | 半角英数 | 32 | ||
| 登録言語 | 〇 | 半角英数 | 100 | |
| キャンペーン付与ポイント | 数値 | 8 | ||
| 内訳（キャンペーン割引額） | 数値 | 12 | ||
| 請求金額合計 | 〇 | 数値 | 12 | |
| 送付先住所１ | 全角 | 100 | ||
| 送付先住所２ | 全角 | 200 | ||
| 送付先住所３ | 全角 | 200 | ||
| 配送日 | 日付 | - | ||
| 送付先名（カナ） | 全角 | 30 | ||
| 送付先名（漢字） | 全角 | 30 | ||
| 配送希望日 | 日付 | - | ||
| 配送希望時間 | 全角 | 100 | 希望なし、午前中、12時から14時、14時から16時、16時から18時、18時から20時、20時から21時 | |
| 送付先姓（カナ） | 全角 | 30 | ||
| 送付先姓（漢字） | 全角 | 30 | 配送先の指定がない場合は、注文者の情報が自動設定されます。 （以下配送先名～配送先電話番号） | |
| 配送確認メール配信日 | 日付 | - | ||
| 送付先電話番号 | 半角英数 | 30 | ||
| 送付先郵便番号 | 半角英数 | 15 | ||
| セッションID | 半角英数 | 50 | ||
| 宅配伝票番号 | 半角英数 | 2000 | ||
| 内訳（仕入金額合計） | 数値 | 12 | ||
| 内訳（送料） | 数値 | 8 | ||
| 内訳（送料消費税） | 〇 | 数値 | 12 | |
| 照会番号 | 半角英数 | 20 | ||
| 内訳（消費税） | 数値 | 12 | ||
| 購入時の値段（受注明細） | 数値 | 12 | ||
| 内訳（商品定価） | 〇 | 数値 | 12 | |
| 内訳（商品定価消費税） | 〇 | 数値 | 12 | |
| 電話番号 | 半角英数 | 30 | ||
| 端末機種情報 | 半角英数 | 512 | ||
| 取引ＩＤ | 半角英数 | 100 | ||
| 郵便番号 | 半角英数 | 15 | ||
| 誕生日 | 日付 | - | ||
| 決済種別 | 数値 | 2 | ||
| 標準税率 | 数値 | 5 | ||
| 内訳（消費税額：標準税率対象） | 数値 | 12 | ||
| 内訳（合計：標準税率対象） | 数値 | 12 | ||
| 内訳（クーポン割引額：標準税率対象）<率> | 数値 | 12 | ||
| 内訳（クーポン割引額：標準税率対象）<額> | 数値 | 12 | ||
| 内訳（ポイント割引額：標準税率対象） | 数値 | 8 | ||
| 内訳（まとめ買い割引額：標準税率対象） | 数値 | 12 | ||
| 内訳（キャンペーン割引：標準税率対象） | 数値 | 12 | ||
| 軽減税率 | 数値 | 5 | ||
| 内訳（消費税額：軽減税率対象） | 数値 | 12 | ||
| 内訳（合計：軽減税率対象） | 数値 | 12 | ||
| 内訳（クーポン割引額：軽減税率対象）<率> | 数値 | 12 | ||
| 内訳（クーポン割引額：軽減税率対象）<額> | 数値 | 12 | ||
| 内訳（ポイント割引額：軽減税率対象） | 数値 | 8 | ||
| 内訳（まとめ買い割引額：軽減税率対象） | 数値 | 12 | ||
| 内訳（キャンペーン割引：軽減税率対象） | 数値 | 12 | ||
| 商品コード（受注明細） | 〇 | 半角英数 | 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 | ||
| 割引種別（受注明細） | 数値 | 1 | ||
| 最小注文数（受注明細） | 数値 | 8 | ||
| 受注明細番号 | 〇 | 数値 | 4 | |
| 受注日フォーマット | 半角英数 | 19 | ||
| 受注配送先番号（受注明細） | 〇 | 数値 | 4 | |
| 購入履歴表示フラグ（受注明細） | 数値 | 1 | 商品情報をメールや購入履歴に出力するかどうか 空白(null):出力しない、1:出力する | |
| 数量（受注明細） | 数値 | 8 | ||
| 加算ポイント（受注明細） | 数値 | 12 | ||
| 仕入金額（受注明細） | 数値 | 12 | ||
| セット商品フラグ（受注明細） | 数値 | 1 | ||
| オプション商品対象受注明細番号 | 数値 | 4 | ||
| 軽減税率フラグ（受注明細） | 数値 | 1 | 受注明細から取得 | |
| クーポン割引額（受注明細） | 数値 | 12 | 受注明細から取得 | |
| まとめ買い割引額（受注明細） | 数値 | 12 | 受注明細から取得 | |
| 受注残区分（受注明細） | 数値 | 1 | 空白(null):通常受注、1:受注残 | |
| 引当済在庫数（受注明細） | 数値 | 8 | ||
| 引当ステータス（受注明細） | 数値 | 1 | 空白(null):仮引当、1:引当確定 | |
| 出荷指示（受注明細） | 数値 | 1 | 空白(null):指定なし、1:全納（全数揃い次第）、2:分納（不足分は入荷次第） | |
| 受注ヘッダの自由項目 | - | - | - | |
| 受注明細の自由項目 | - | - | - | |
| 受注送付先の自由項目 | - | - | - | |
| 決済キー項目1 | 全角 | 2000 | 決済のキー項目を設定してください。決済毎に利用可能な汎用項目です。 | |
| 決済キー項目2 | 全角 | 2000 | 決済のキー項目を設定してください。決済毎に利用可能な汎用項目です。 | |
| 決済項目1 | 全角 | 2000 | 決済のキー項目以外の項目を設定してください。決済毎に利用可能な汎用項目です。 | |
| 決済項目2 | 全角 | 2000 | 決済のキー項目以外の項目を設定してください。決済毎に利用可能な汎用項目です。 | |
| 営業会員受注フラグ | 数値 | 1 | ||
| 受注残区分 | 数値 | 1 | 空白(null):通常受注、1:受注残 |
※NAMEは全て半角大文字です。
※上記にあるすべての項目の内、初期設定の「受注データ連携OUT 連携項目定義」に定義されている項目が連携されます。
※受注明細項目のNAMEは、アンダーバーに続けて1から連番号で設定されます。(例：ITEM_CD_1)
設定されるデータの連番について、注意点はこちらをご覧ください。
※自由項目は「利用する」項目のみが設定されます。
※自由項目は「利用する」に変更すると、APIの項目も動的に変化しますのでご注意ください。
請求合計金額の算出方法は下記になります。
請求金額合計＝
内訳（商品定価）
＋内訳（消費税）
＋内訳（送料）
＋内訳（代引手数料）
※「内訳（商品定価）」には会員割引後の金額が設定されているため、
「内訳（会員割引額）」は上記算出式の要素になりません。
④返却値
外部システムへ通信し、
通信先より、以下のようなレスポンスを受け取ることを想定しています。
■返却値例
（処理OKのとき）
status=0
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※処理が正常か異常かを示す「status」については、初期設定「API結果判定緩和設定」で変更可能です。
初期設定「API結果判定緩和設定」：利用しない → status=0の場合は正常、それ以外は異常と判断
初期設定「API結果判定緩和設定」：利用する → status=null、空文字列、0のいずれかの場合は正常、それ以外は異常と判断
statusがどの値の場合に正常とするかはカスタマイズ可能です。
「API結果判定緩和設定」は、弊社にて設定しますのでお問い合わせください。
パラメータには、複数の返却値をひもづけるために「&」を、項目と値をひもづけるために「=」を必ず使用してください。
この用途以外に「&」「=」を使用した場合は、想定外の挙動になるため、ご注意ください。
外部システムから受注のステータス（出荷状況）を受け取ります。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
②連携項目定義
項目定義は以下の通りです。項目の定義順は問いません。
| 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| アクセスURL | 半角英数 | 2000 | ||
| 加算ポイント | 数値 | 13 | ||
| 住所１ | 全角 | 100 | ||
| 住所２ | 全角 | 200 | ||
| 住所３ | 全角 | 200 | ||
| 管理ツール登録者 | 数値 | 8 | ||
| 管理ツール更新者 | 数値 | 8 | ||
| 後払い注文ID | 半角英数 | 10 | ||
| 後払いステータス | 全角 | 200 | ||
| オーソリ確定日 | 日付 | - | ||
| オーソリ日 | 日付 | - | ||
| クレジット処理結果 | 数値 | 1 | ||
| 自動お知らせアイコン | 半角英数 | 2000 | ||
| 自動キャンセルメール送信日 | 日付 | - | ||
| 自動キャンセル処理ステータス | 数値 | 1 | ||
| 備考 | 全角 | 2000 | ||
| 内訳（まとめ買い割引値引額） | 数値 | 12 | ||
| 受注取消日 | 日付 | - | ||
| 取消メール配信日 | 日付 | - | ||
| カート一時引当セッションID | 半角英数 | 50 | ||
| メール送信先端末 | 数値 | 1 | ||
| 有効性エラーフラグ | 数値 | 1 | ||
| 法人ID | 数値 | 8 | ||
| 利用クーポンID | 数値 | 8 | ||
| 内訳（クーポン割引額） | 数値 | 12 | ||
| 分割回数 | 数値 | 2 | ||
| カード種別 | 半角英数 | 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 | ||
| 削除日 | 日付 | - | ||
| ダウンロード日 | 日付 | - | ||
| 加算ポイント編集フラグ | 数値 | 1 | ||
| 名（カナ） | 全角 | 30 | ||
| 名（漢字） | 全角 | 30 | ||
| 配送方法 | 数値 | 4 | ||
| 払込票URL | 半角英数 | 300 | ||
| 支払い方法 | 数値 | 3 | ||
| 決済連携ID | 数値 | 8 | ||
| 決済結果文言メールPC | 全角 | 60000 | ||
| 姓（カナ） | 全角 | 30 | ||
| 姓（漢字） | 全角 | 30 | ||
| 広告媒体コード | 半角英数 | 20 | ||
| 会員ID | 数値 | 8 | ||
| 内訳（会員割引額） | 数値 | 12 | ||
| 携帯メールアドレス | 半角英数 | 2000 | ||
| 受注API連携ステータス | 数値 | 1 | ||
| 受注日時 | 日付 | - | ||
| 受注表示番号 | 〇 | 半角 | 30 | |
| 受注アクセスブラウザ区分 | 半角英数 | 100 | ||
| 受注商品属性ID | 数値 | 8 | ||
| 受注確認メール配信日 | 日付 | - | ||
| この注文の商品に関する情報を受信するフラグ | 数値 | 1 | ||
| 払込期限 | 日付 | - | ||
| 入金日 | 日付 | - | ||
| 入金確認メール配信日 | 日付 | - | ||
| 入金額 | 数値 | 12 | ||
| 受注決済ステータス | 全角 | 200 | ||
| PCメールアドレス | 半角英数 | 2000 | ||
| 端末区分 | 数値 | 1 | ||
| 利用ポイント | 数値 | 8 | ||
| 内訳（ポイント使用額） | 数値 | 8 | ||
| 受付番号 | 半角英数 | 32 | ||
| 登録言語 | 半角英数 | 100 | ||
| キャンペーン付与ポイント | 数値 | 8 | ||
| キャンペーンIDリスト | 全角 | 2147483647 | ||
| 内訳（キャンペーン割引額） | 数値 | 12 | ||
| カード番号登録受注フラグ | 数値 | 1 | ||
| マスクされたカード番号 | 半角英数 | 20 | ||
| 使用カード取引ID | 半角英数 | 100 | ||
| 請求金額合計 | 数値 | 12 | ||
| 送付先住所１ | 全角 | 100 | ||
| 送付先住所２ | 全角 | 200 | ||
| 送付先住所３ | 全角 | 200 | ||
| 配送日 | 日付 | - | 指定をすると配送済みとなります。 | |
| 送付先名（カナ） | 全角 | 30 | ||
| 送付先名（漢字） | 全角 | 30 | ||
| 配送希望日 | 日付 | - | ||
| 配送希望時間 | 全角 | 100 | ||
| 送付先姓（カナ） | 全角 | 30 | ||
| 送付先姓（漢字） | 全角 | 30 | ||
| 送付先E-MAIL | 半角英数 | 200 | ||
| 配送確認メール配信日 | 日付 | - | ||
| 送付先電話番号 | 半角英数 | 30 | ||
| 出荷予定日 | 日付 | - | ||
| 送付先郵便番号 | 半角英数 | 15 | ||
| 連携済み宅配伝票番号 | 半角英数 | 4000 | ||
| セッションID | 半角英数 | 50 | ||
| 宅配伝票番号 | 半角英数 | 2000 | 複数ある場合はカンマ区切りで指定してください。 | |
| 内訳（仕入金額合計） | 数値 | 12 | ||
| 内訳（送料） | 数値 | 8 | ||
| 内訳（送料消費税） | 数値 | 12 | ||
| 照会番号 | 半角英数 | 20 | ||
| 内訳（消費税） | 数値 | 12 | ||
| 税率 | 数値 | 5 | ||
| 内訳（商品定価） | 数値 | 12 | ||
| 内訳（商品定価消費税） | 数値 | 12 | ||
| 電話番号 | 半角英数 | 30 | ||
| 端末機種情報 | 半角英数 | 512 | ||
| 取引ＩＤ | 半角英数 | 100 | ||
| 予約日 | 日付 | - | ||
| 郵便番号 | 半角英数 | 15 | ||
| 標準税率 | 数値 | 5 | ||
| 内訳（消費税額：標準税率対象） | 数値 | 12 | ||
| 内訳（合計：標準税率対象） | 数値 | 12 | ||
| 内訳（クーポン割引額：標準税率対象）<率> | 数値 | 12 | ||
| 内訳（クーポン割引額：標準税率対象）<額> | 数値 | 12 | ||
| 内訳（ポイント割引額：標準税率対象） | 数値 | 8 | ||
| 内訳（まとめ買い割引額：標準税率対象） | 数値 | 12 | ||
| 内訳（キャンペーン割引：標準税率対象） | 数値 | 12 | ||
| 軽減税率 | 数値 | 5 | ||
| 内訳（消費税額：軽減税率対象） | 数値 | 12 | ||
| 内訳（合計：軽減税率対象） | 数値 | 12 | ||
| 内訳（クーポン割引額：軽減税率対象）<率> | 数値 | 12 | ||
| 内訳（クーポン割引額：軽減税率対象）<額> | 数値 | 12 | ||
| 内訳（ポイント割引額：軽減税率対象） | 数値 | 8 | ||
| 内訳（まとめ買い割引額：軽減税率対象） | 数値 | 12 | ||
| 内訳（キャンペーン割引：軽減税率対象） | 数値 | 12 | ||
| 営業会員受注フラグ | 数値 | 1 | ||
| 受注残区分 | 数値 | 1 | 空白（null）:通常受注、1:受注残 |
※NAMEは全て半角大文字で指定する必要があります。
※連携された項目に値がない場合、値は空白（null）として処理されます。
項目そのものが無い場合、その項目は更新、登録されません。
※値の設定がある項目は値のチェックが行われ、値の正しくない項目が１つでもある場合はエラーを返却し、処理をキャンセルします。
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&MEMBER_ID=会員ID&message=エラーメッセージ１~エラーメッセージ２
※ 異常系レスポンスとして、上記以外のHTMLが返却される場合があります。
（サイト混雑時ユーザー整理機能発動時やサーバー高負荷時）
外部システムからオーソリ確定処理の指示を受け取ります。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
②入力パラメータ（外部システム→本システム）
各パラメータ値をPOSTで送信します。
| 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| 受注表示番号 | 〇 | 半角 | 30 | オーソリ確定可能な決済のみ確定処理が行われます。 確定できない決済を含む受注を指定した場合は、status「1：値のチェックエラー」として扱われ、「オーソリ確定に失敗しました。」というメッセージが返されます。 |
③出力パラメータ（本システム→外部システム)
| 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|
| ステータス | 数値 | 1 | 0：処理OK 1：値のチェックエラー 9：システム障害エラー | |
| メッセージ | 数値 | エラー時のみ設定されます。 |
④返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&message=エラーメッセージ１~エラーメッセージ２
※ 異常系レスポンスとして、上記以外のHTMLが返却される場合があります。
（サイト混雑時ユーザー整理機能発動時やサーバー高負荷時）
外部システムからAPI接続することにより、本システム内会員マスタデータを取得することができます。 ※オプション機能のため弊社での設定が必要となります。ご希望の場合はサポートまでお問い合わせください。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
MEMBER_ID,LOGINID,PC_MAIL,MOBILE_MAILのいずれかをキーとして、取得対象項目を「COLUMN」パラメータで指定します。
■入力パラメータ
| NAME | 名称 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| MEMBER_ID | 会員ID | 〇※1 | 数値 | |
| LOGINID | ログインID | 〇※1 | 半角英数 | |
| PASSWORD | パスワード | 半角英数 | ログインID,PCメールアドレス,携帯メールアドレス いずれかの指定時は必須 | |
| PC_MAIL | PCメールアドレス | 〇※1 | 半角英数 | |
| MOBILE_MAIL | 携帯メールアドレス | 〇※1 | 半角英数 | |
| COLUMN | 取得カラム | 〇 | 半角英数 | カンマ区切りで指定してください |
| NOT_GET_INVALID_MEMBER_KBN | 削除済み・退会済み会員取得フラグ | 数値 | 削除・退会済みの会員情報も含めて取得するかどうかを指定します 空白(null)：削除・退会済み会員も取得する 1：削除・退会済み会員は取得しない |
※1 以下のいずれかの値、または組み合わせの指定が必須です。
・会員ID（MEMBER_ID）
・ログインID（LOGINID）とパスワード（PASSWORD）
・PCメールアドレス（PC_MAIL）とパスワード（PASSWORD）
・携帯メールアドレス（MOBILE_MAIL）とパスワード（PASSWORD）
以下の設定をしている場合、【ログインIDとパスワード】と【PC,携帯メールアドレスとパスワード】では
条件を満たす会員データが複数存在する可能性があります。
・初期設定「退会済ログインID重複許可」が、「利用する」
・初期設定「メールアドレス重複許可」が、「利用する」または「退会のみ重複可」
条件を満たす会員データが複数存在する場合、以下の優先順で会員データを取得します。
有効な会員* ＞ 仮登録会員* ＞ 退会済み・削除済み会員
※同じ優先順位の会員同士で、メールアドレスとパスワードいずれも重複する場合は、会員を特定できないとしてエラーにします。
*有効な会員：非退会・非削除の会員
*仮登録会員：承認制会員登録オプションをご利用の店舗様で「登録区分：仮登録」の会員
②連携項目定義
「COLUMN」パラメータで指定できる項目は以下の通りです。項目の定義順は問いません。
| 対象テーブル | 名称 | 説明 |
|---|---|---|
| 会員 | 会員ID | |
| 会員 | 端末区分 | 1:PCのみ,2:PC+携帯,3携帯のみ |
| 会員 | アクセスブラウザ区分 | 1_0_0:PC 2_0_0:携帯 3_0_0:スマートフォン 4_0_0:タブレット 0_0_0:その他 |
| 会員 | 端末機種情報 | |
| 会員 | 登録言語 | |
| 会員 | 姓（漢字） | |
| 会員 | 名（漢字） | |
| 会員 | 姓（カナ） | |
| 会員 | 名（カナ） | |
| 会員 | 郵便番号 | |
| 会員 | 住所１(都道府県) | |
| 会員 | 住所２(市区町村、番地) | |
| 会員 | 住所３(マンション名等) | |
| 会員 | 性別 | M:男性 F:女性 X:その他（初期設定『性別「その他」利用フラグ』が「利用する」の場合） :設定なし |
| 会員 | 生年月日 | |
| 会員 | 自宅電話番号 | |
| 会員 | 緊急時電話番号（未使用） | |
| 会員 | PCメールアドレス | |
| 会員 | PCメールタイプ | :テキストメール,1:HTMLメール |
| 会員 | 携帯メールアドレス | |
| 会員 | 携帯メールタイプ | :テキストメール,1:HTMLメール |
| 会員 | ログインID | |
| 会員 | パスワード | |
| 会員 | ポイント残高 | |
| 会員 | 備考 | |
| 会員 | メルマガ受付区分 | :受け付けない 1:PC/携帯の両方で受け付ける 2:PCで受け付ける 3:携帯で受け付ける |
| 会員 | 削除日 | |
| 会員 | 退会日 | |
| 会員 | 自動お知らせアイコン | |
| 会員 | 会員ランク | |
| 会員 | ニックネーム | |
| 会員 | アクセスURL | |
| 会員 | ログイン誤り回数 | |
| 会員 | ログイン誤り上限回数 | |
| 会員 | ログイン回数 | |
| 会員 | 最終ログイン日時 | |
| 会員 | アカウントロック日時 | |
| 会員 | 請求先 | |
| 会員 | 標準利用支払い方法 | |
| 会員 | 標準利用クレジットカード | |
| 会員 | 標準利用クレジットカード支払い回数 | |
| 会員 | 2段階ログイン利用区分 | |
| 会員 | 登録区分 | :本登録,1:仮登録 |
| 会員 | 本登録 | |
| 会員 | ポイント利用設定 | :都度指定する 1:購入時に全て利用する 2:定期子受注作成時に全て利用する 3:購入時及び定期子受注作成時に全て利用する |
| 会員 | 法人ID | |
| 会員 | 利用制限決済 | |
| 会員 | 事業所ID | |
| 会員 | 会員種別 | :子アカウント,1:親アカウント |
| 会員 | 会員権限 | 1:制限なし,2:発注不可,3:発注・見積不可,4:価格非表示,5:停止 |
| 会員 | 会員・注文閲覧可能フラグ（事業所） | :操作不可,1:閲覧可能 |
| 会員 | 会員の自由項目 | 「使用する」としている自由項目のみ指定可能です |
| 会員 | 登録者 | |
| 会員 | 管理ツール登録者 | |
| 会員 | 登録日時 | |
| 会員 | 更新者 | |
| 会員 | 管理ツール更新者 | |
| 会員 | 更新日時 |
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0&指定カラム=指定したカラムの値&指定カラム=...
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&message=エラーメッセージ１~エラーメッセージ２
外部システムからAPI接続することにより、本システム内会員マスタデータのポイントを取得することができます。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
「MEMBER_ID」をキーとして、取得対象項目を「COLUMN」パラメータで指定します。
■入力パラメータ
| NAME | 名称 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| MEMBER_ID | 会員ID | 〇 | 数値 | |
| COLUMN | 取得カラム | 〇 | 半角英数 | カンマ区切りで指定してください |
②連携項目定義
「COLUMN」パラメータで指定できる項目は以下の通りです。項目の定義順は問いません。
| 対象テーブル | 名称 | 説明 |
|---|---|---|
| 会員 | 会員ID | |
| 会員 | ポイント残高 |
③返却値
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=エラーメッセージ１~エラーメッセージ２
外部システムから本システムへAPI接続することにより、本システムの受注情報を取得することができます。
※オプション機能のため弊社での設定が必要となります。ご希望の場合はサポートまでお問い合わせください。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
「ORDER_DISP_NO」をキーとして、取得対象項目を「COLUMN」パラメータで指定します。
■入力パラメータ
| NAME | 名称 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| ACCESS_KEY | アクセスキー | 〇 | 半角英数 | 【共通のキー＋本日日付】と 【初期設定「受注情報取得API アクセスキー固定文字列」の 値】を「:」で繋いだものを、sha1で暗号化したもの。 ※「受注情報取得API アクセスキー固定文字列」が未設定の 場合は、初期設定「パスワード固定文字列」の値を取得します。 |
| ORDER_DISP_NO | 受注表示番号 | 〇 | 半角英数 | |
| COLUMN | 取得カラム | 〇 | 半角英数 | カンマ区切りで指定してください |
| ORDER_D | 明細番号 | 数値 | ※数字で指定することで任意の明細番号に絞って取得可能。 カンマ区切りで複数指定可能。 ※パラメータを記述しない、または、ALLを指定することで 全ての明細を取得可能。 |
②連携項目定義
「COLUMN」パラメータで指定できる項目は以下の通りです。項目の定義順は問いません。
| 対象テーブル | 名称 | 説明 |
|---|---|---|
| 受注ヘッダ | 内部受注ID | |
| 受注ヘッダ | 端末区分 | 1:PCのみ, 2:PC+携帯, 3携帯のみ |
| 受注ヘッダ | アクセスブラウザ区分 | 1_0_0:PC 2_0_0:携帯 3_0_0:スマートフォン 4_0_0:タブレット 0_0_0:その他 |
| 受注ヘッダ | 登録言語 | |
| 受注ヘッダ | 受注表示番号 | |
| 受注ヘッダ | 顧客ID | |
| 受注ヘッダ | セッションID | |
| 受注ヘッダ | カート引当セッションID | |
| 受注ヘッダ | 端末機種情報 | |
| 受注ヘッダ | アクセスURL | |
| 受注ヘッダ | 受注日 | |
| 受注ヘッダ | 支払方法 | |
| 受注ヘッダ | 配送方法 | |
| 受注ヘッダ | 請求金額合計 | |
| 受注ヘッダ | 内訳（合計：標準税率対象） | |
| 受注ヘッダ | 内訳（合計：軽減税率対象） | |
| 受注ヘッダ | 内訳（消費税） | |
| 受注ヘッダ | 内訳（消費税額：標準税率対象） | |
| 受注ヘッダ | 内訳（消費税額：軽減税率対象） | |
| 受注ヘッダ | 内訳（商品定価） | |
| 受注ヘッダ | 内訳（商品定価消費税） | |
| 受注ヘッダ | 内訳（仕入金額合計） | |
| 受注ヘッダ | 内訳（送料） | |
| 受注ヘッダ | 内訳（送料消費税） | |
| 受注ヘッダ | 内訳（代引手数料） | |
| 受注ヘッダ | 内訳（代引手数料消費税） | |
| 受注ヘッダ | 内訳（会員割引額） | |
| 受注ヘッダ | 内訳（クーポン割引額） | |
| 受注ヘッダ | 内訳（クーポン割引額：標準税率対象）<率> | |
| 受注ヘッダ | 内訳（クーポン割引額：標準税率対象）<額> | |
| 受注ヘッダ | 内訳（クーポン割引額：軽減税率対象）<率> | |
| 受注ヘッダ | 内訳（クーポン割引額：軽減税率対象）<額> | |
| 受注ヘッダ | 内訳（ポイント使用額） | |
| 受注ヘッダ | 内訳（ポイント使用額：標準税率対象） | |
| 受注ヘッダ | 内訳（ポイント使用額：軽減税率対象） | |
| 受注ヘッダ | 内訳（まとめ買い割引値引額） | |
| 受注ヘッダ | 内訳（まとめ買い割引額：標準税率対象） | |
| 受注ヘッダ | 内訳（まとめ買い割引額：軽減税率対象） | |
| 受注ヘッダ | 内訳（キャンペーン割引額） | |
| 受注ヘッダ | 内訳（キャンペーン割引：標準税率対象） | |
| 受注ヘッダ | 内訳（キャンペーン割引：軽減税率対象） | |
| 受注ヘッダ | 内訳（出精割引額） | |
| 受注ヘッダ | 税率 | |
| 受注ヘッダ | 内訳（消費税率：標準税率対象） | |
| 受注ヘッダ | 内訳（消費税率：軽減税率対象） | |
| 受注ヘッダ | 利用ポイント | |
| 受注ヘッダ | 加算ポイント | |
| 受注ヘッダ | 加算ポイント編集フラグ | 1:加算ポイント編集済み |
| 受注ヘッダ | キャンペーン付与ポイント | |
| 受注ヘッダ | 配送日 | |
| 受注ヘッダ | 入金日 | |
| 受注ヘッダ | 受注取消日 | |
| 受注ヘッダ | オーソリ日 | |
| 受注ヘッダ | オーソリ確定日 | |
| 受注ヘッダ | 削除日 | |
| 受注ヘッダ | 受注確認メール配信日 | |
| 受注ヘッダ | 配送確認メール配信日 | |
| 受注ヘッダ | 入金確認メール配信日 | |
| 受注ヘッダ | 取消メール配信日 | |
| 受注ヘッダ | ダウンロード日 | |
| 受注ヘッダ | 入金額 | |
| 受注ヘッダ | 備考 | |
| 受注ヘッダ | 姓（漢字） | |
| 受注ヘッダ | 名（漢字） | |
| 受注ヘッダ | 姓（カナ） | |
| 受注ヘッダ | 名（カナ） | |
| 受注ヘッダ | PCメールアドレス | |
| 受注ヘッダ | 携帯メールアドレス | |
| 受注ヘッダ | 郵便番号 | |
| 受注ヘッダ | 住所１ | |
| 受注ヘッダ | 住所２ | |
| 受注ヘッダ | 住所３ | |
| 受注ヘッダ | 電話番号 | |
| 受注ヘッダ | 送付先姓（漢字） | |
| 受注ヘッダ | 送付先名（漢字） | |
| 受注ヘッダ | 送付先姓（カナ） | |
| 受注ヘッダ | 送付先名（カナ） | |
| 受注ヘッダ | 送付先E-MAIL | |
| 受注ヘッダ | 送付先郵便番号 | |
| 受注ヘッダ | 送付先住所１ | |
| 受注ヘッダ | 送付先住所２ | |
| 受注ヘッダ | 送付先住所３ | |
| 受注ヘッダ | 送付先電話番号 | |
| 受注ヘッダ | 配送希望日 | |
| 受注ヘッダ | 配送希望時間 | |
| 受注ヘッダ | カード種別 | |
| 受注ヘッダ | カード名義 | |
| 受注ヘッダ | カード番号 | |
| 受注ヘッダ | 有効期限 | |
| 受注ヘッダ | 分割回数 | |
| 受注ヘッダ | クレジット処理結果 | 0:正常終了, 9:異常終了 |
| 受注ヘッダ | 受注決済ステータス | |
| 受注ヘッダ | 決済連携ID | |
| 受注ヘッダ | 照会番号 | |
| 受注ヘッダ | 取引ＩＤ | |
| 受注ヘッダ | カード番号登録受注フラグ | 1:カード保存用ダミー受注 |
| 受注ヘッダ | マスクされたカード番号 | |
| 受注ヘッダ | 使用カード取引ID | |
| 受注ヘッダ | 払込期限 | |
| 受注ヘッダ | 受付番号 | |
| 受注ヘッダ | 払込票URL | |
| 受注ヘッダ | 決済結果文言メールPC | |
| 受注ヘッダ | 自動お知らせアイコン | |
| 受注ヘッダ | 宅配伝票番号 | |
| 受注ヘッダ | 連携済み宅配伝票番号 | |
| 受注ヘッダ | 出荷予定日 | |
| 受注ヘッダ | 広告媒体コード | |
| 受注ヘッダ | 利用クーポンID | |
| 受注ヘッダ | 受注バリエーションID | |
| 受注ヘッダ | この注文の商品に関する情報を受信するフラグ | :受信しない, :受信する |
| 受注ヘッダ | 有効性エラーフラグ | |
| 受注ヘッダ | メール送信先端末 | |
| 受注ヘッダ | 後払い注文ID | |
| 受注ヘッダ | 後払いステータス | |
| 受注ヘッダ | 法人ID | |
| 受注ヘッダ | 受注API連携ステータス | 1:連携済み, 2:連携エラー |
| 受注ヘッダ | 入金督促メール送信日 | |
| 受注ヘッダ | 自動キャンセル処理ステータス | :未処理 0:正常終了 1:エラーあり 8:処理中 9:例外発生 |
| 受注ヘッダ | 自動キャンセルメール送信日 | |
| 受注ヘッダ | キャンペーンIDリスト | |
| 受注ヘッダ | キャンペーン付与クーポンIDリスト | |
| 受注ヘッダ | 見積フラグ | :通常受注, 1:見積受注 |
| 受注ヘッダ | 見積番号 | |
| 受注ヘッダ | 見積作成日 | |
| 受注ヘッダ | 見積有効期限 | |
| 受注ヘッダ | 見積コメント | |
| 受注ヘッダ | 見積回答コメント | |
| 受注ヘッダ | 見積回答日 | |
| 受注ヘッダ | 見積時決済ID | |
| 受注ヘッダ | 事業所ID | |
| 受注ヘッダ | 請求先コード | |
| 受注ヘッダ | 受注残区分 | :通常受注,1:受注残 |
| 受注ヘッダ | 自由処理日１ | |
| 受注ヘッダ | 自由処理日２ | |
| 受注ヘッダ | 自由処理日３ | |
| 受注ヘッダ | 自由処理日４ | |
| 受注ヘッダ | 自由処理日５ | |
| 受注ヘッダ | 自由処理メール配信日１ | |
| 受注ヘッダ | 自由処理メール配信日２ | |
| 受注ヘッダ | 自由処理メール配信日３ | |
| 受注ヘッダ | 自由処理メール配信日４ | |
| 受注ヘッダ | 自由処理メール配信日５ | |
| 受注ヘッダ | 受注ヘッダの自由項目 | 「使用する」としている自由項目のみ指定可能です |
| 受注ヘッダ | 送付先の自由項目 | 「使用する」としている自由項目のみ指定可能です |
| 受注ヘッダ | 登録者 | |
| 受注ヘッダ | 管理ツール登録者 | |
| 受注ヘッダ | 登録日時 | |
| 受注ヘッダ | 更新者 | |
| 受注ヘッダ | 管理ツール更新者 | |
| 受注ヘッダ | 更新日時 | |
| 受注明細 | 受注番号 | |
| 受注明細 | 明細番号 | |
| 受注明細 | 受注配送番号 | |
| 受注明細 | 商品ID | |
| 受注明細 | 購入時の商品名 | |
| 受注明細 | 購入時の商品属性コード | |
| 受注明細 | 商品属性文字列 | |
| 受注明細 | 購入時の値段 | |
| 受注明細 | 個数 | |
| 受注明細 | ケース数 | |
| 受注明細 | 加算ポイント | |
| 受注明細 | 会員割引額 | |
| 受注明細 | 購入履歴表示フラグ | :非表示, 1:表示 |
| 受注明細 | 仕入金額 | |
| 受注明細 | ダウンロードURL | |
| 受注明細 | ダウンロード回数 | |
| 受注明細 | ダウンロード有効期限 | |
| 受注明細 | 商品シリアル番号 | |
| 受注明細 | オプション商品対象受注明細番号 | |
| 受注明細 | セット商品フラグ | 0:通常商品 1:セット親商品 2:セット子商品 |
| 受注明細 | まとめ買い割引ID | |
| 受注明細 | 軽減税率フラグ | :通常商品 1:軽減税率対象商品 |
| 受注明細 | クーポン割引額 | |
| 受注明細 | まとめ買い割引額 | |
| 受注明細 | 受注残区分 | :通常受注,1:受注残 |
| 受注明細 | 引当済在庫数 | |
| 受注明細 | 引当ステータス | :仮引当,1:引当確定 |
| 受注明細 | 出荷指示 | :指定なし,1:全納（全数揃い次第）,2:分納（不足分は入荷次第） |
| 受注明細 | 受注明細の自由項目 | 「使用する」としている自由項目のみ指定可能です |
| 受注明細 | 登録者 | |
| 受注明細 | 登録日時 | |
| 受注明細 | 更新者 | |
| 受注明細 | 更新日時 |
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0&指定カラム=指定したカラムの値&指定カラム=...
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&message=エラーメッセージ１~エラーメッセージ２
外部システムから本システムへAPI接続することにより、本システムの商品情報を取得することができます。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
「ITEM_ID」もしくは「ITEM_CD」をキーとして、取得対象項目を「COLUMN」パラメータで指定します。
■入力パラメータ
| NAME | 名称 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| ITEM_ID | 商品ID | 〇※1 | 数値 | |
| ITEM_CD | 商品コード | 〇※1 | 半角英数 | |
| COLUMN | 取得カラム | 〇 | 半角英数 | カンマ区切りで指定してください |
※1 商品ID（ITEM_ID）または 商品コード（ITEM_CD）の指定が必須です。
②連携項目定義
「COLUMN」パラメータで指定できる項目は以下の通りです。項目の定義順は問いません。
| 対象テーブル | 名称 | 説明 |
|---|---|---|
| 商品 | 商品ID | |
| 商品 | 商品コード | |
| 商品 | 端末区分 | 1:PCのみ, 2:PC+携帯, 3携帯のみ |
| 商品 | ダウンロード販売商品 | :通常商品, 1:ダウンロード商品 |
| 商品 | ダウンロードファイル名 | |
| 商品 | 商品名 | |
| 商品 | 商品名（外国語１） | |
| 商品 | 商品名(カナ) | |
| 商品 | 商品名(カナ)（外国語１） | |
| 商品 | 販売価格 | |
| 商品 | 希望小売価格 | |
| 商品 | 表示期間FROM | |
| 商品 | 表示期間TO | |
| 商品 | 商品画像１ | |
| 商品 | 商品画像２ | |
| 商品 | 商品画像３ | |
| 商品 | 商品画像４ | |
| 商品 | アピール画像 | |
| 商品 | アピールポイント | |
| 商品 | アピールポイント（外国語１） | |
| 商品 | 商品コメント１ | |
| 商品 | 商品コメント１（外国語１） | |
| 商品 | 商品コメント２ | |
| 商品 | 商品コメント２（外国語１） | |
| 商品 | 商品コメント３ | |
| 商品 | 商品コメント３（外国語１） | |
| 商品 | カート用商品コメント | |
| 商品 | 商品説明３（外国語１） | |
| 商品 | 最低在庫数 | |
| 商品 | 在庫単位フラグ | :商品ごとに在庫管理する 1:バリエーションごとに在庫管理する |
| 商品 | 在庫管理 | :在庫管理しない, 1:在庫管理する |
| 商品 | 在庫数表示 | :表示しない, 1:表示する |
| 商品 | 会員割引 | :会員割引しない, 1:会員割引する |
| 商品 | ポイントフラグ | :ポイント利用不可, 1:ポイント利用可能 |
| 商品 | 加算ポイント | |
| 商品 | ポイント還元率 | |
| 商品 | 発売日 | |
| 商品 | 配送方法 | |
| 商品 | 配送方法重み | |
| 商品 | 登録区分 | :本登録, 1:仮登録 |
| 商品 | 検索結果表示フラグ | :表示, 1:非表示, 2:会員ログイン中のみ表示 |
| 商品 | タイトルタグ表示名 | |
| 商品 | タイトルタグ表示名（外国語１） | |
| 商品 | メタキーワード | |
| 商品 | メタディスクリプション | |
| 商品 | 会員割引額 | |
| 商品 | 最低注文数 | |
| 商品 | 最高注文数 | |
| 商品 | 同一注文者購入個数制限 | |
| 商品 | 販売単位制限数 | |
| 商品 | 入数 | |
| 商品 | 新着順用更新日 | |
| 商品 | 仕入先ID | |
| 商品 | 仕入金額 | |
| 商品 | 「買い物かごに入れる」リンク表示 | :表示する, 1:表示しない |
| 商品 | 利用制限決済 | |
| 商品 | レコメンドカテゴリ | |
| 商品 | 送料無料フラグ | :有料, 1:無料 |
| 商品 | 決済手数料無料フラグ | :有料, 1:無料 |
| 商品 | 別注商品フラグ | :通常商品 1:別注商品(バリエーション単位) 2:別注商品(商品単位) |
| 商品 | 別注商品グループ | |
| 商品 | 公開会員ランク | |
| 商品 | 在庫数 | |
| 商品 | EC在庫総数 | |
| 商品 | 配送希望日指定可能最小日数 | |
| 商品 | 配送希望日指定可能最大日数 | |
| 商品 | 注文確認メール商品コメント | |
| 商品 | 注文確認メール商品コメント（外国語１） | |
| 商品 | カートオプション設定 | :精算時にオプション商品一覧が表示されません。 1:精算時にオプション商品一覧が表示されます。 |
| 商品 | オプション商品区分 | 0:受注ごと 1:配送先ごと 2:商品ごと |
| 商品 | 受注取消シリアル引当フラグ | :受注取消時にシリアルの引当解除を行わない 1:受注取消時にシリアルの引当解除を行う |
| 商品 | 商品シリアルお知らせメール最低在庫数 | |
| 商品 | 閲覧履歴非表示フラグ | :表示, 1:非表示 |
| 商品 | セット子商品在庫切れフラグ | :在庫あり, 1:在庫切れ |
| 商品 | PC向け商品テンプレート | |
| 商品 | SmartPhone向け商品テンプレート | |
| 商品 | 商品詳細表示フラグ | :表示 1:非表示 2:会員ログイン中のみ表示 |
| 商品 | 代表カテゴリ | |
| 商品 | 公開会員ランク指定フラグ | :指定した会員ランク以上に公開 1:指定した会員ランクのみ公開 |
| 商品 | 軽減税率フラグ | :通常商品, 1:軽減税率対象商品 |
| 商品 | 受注残管理 | :しない,1:する |
| 商品 | 受注残用在庫引当 | :手動で確定する,1:自動で確定する |
| 商品 | 受注残用在庫数 | |
| 商品 | 受注残受付上限 | |
| 商品 | 商品の自由項目 | 「使用する」としている自由項目のみ指定可能です |
| 商品 | 登録者 | |
| 商品 | 管理ツール登録者 | |
| 商品 | 登録日時 | |
| 商品 | 更新者 | |
| 商品 | 管理ツール更新者 | |
| 商品 | 更新日時 |
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0&指定カラム=指定したカラムの値&指定カラム=...
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&message=エラーメッセージ１~エラーメッセージ２
外部システムからAPI接続することにより、会員ポイントデータの登録を可能とします。
本APIは、ショップ管理ツールのメニュー構成が以下となっている店舗様のみご利用いただけます。
会員・お問い合わせ管理
└ポイント管理
└会員ポイント新規登録／履歴一覧
└会員ポイント有効期限管理
└会員ポイント一括アップロード
ポイントに関する詳細は本システムでのポイントについてをご覧ください。
ポイントの加算・減算の仕様について、以下の通りです。
■該当会員が保持するポイントのポイント有効期限を、レコード単位で管理する場合
| 操作 | ポイント設定 「ポイント有効期間」 | ポイント有効期限 | 処理概要 |
|---|---|---|---|
| 加算 | 未設定（無期限） | 無視する | 無期限のポイントとして有効期限管理レコードに加算する。 |
| 設定あり | 指定あり | 指定されたポイント有効期限で、有効期限管理レコードを新規登録する。 有効期限が一致する有効期限管理レコードが存在した場合は該当レコードに加算する。 | |
| 指定なし | ポイント設定の「ポイント有効期間」を基にポイント有効期間 の算出を行い、有効期限管理レコードを新規登録する。 有効期限が一致する有効期限管理レコードが存在した場合は 該当レコードに加算する。 ※ポイント設定「ポイント有効期間」の設定がある場合、 無期限のポイントデータは作成できません。 | ||
| 減算 | - | 無視する | 有効期限が近い有効期限管理レコードからポイントの減算を行う。 |
■該当会員が保持する総ポイント数を、一律のポイント有効期限で管理する場合（1会員につき1つの有効期限）
| 操作 | ポイント設定 「ポイント有効期間」 | 期間限定ポイントフラグ | ポイント有効期限 | 処理概要 |
|---|---|---|---|---|
| 加算 | 未設定（無期限） | 通常ポイント | 無視する | 無期限の通常ポイントとして有効期限管理レコードに加算する。 | 期間限定ポイント | 指定あり | 指定されたポイント有効期限で、期間限定ポイントとして 有効期限管理レコードを新規登録する。 有効期限が一致する有効期限管理レコードが存在した場合は該当レコードに加算する。 |
指定なし | 有効期限必須チェックエラーとする。 |
| 設定あり | 通常ポイント | 指定あり | 通常ポイントとして有効期限管理レコードを新規登録する。 指定された有効期限と現在の通常ポイントの有効期限を 比較し、長いほうの日付で有効期限を更新する。 | |
| 指定なし | 通常ポイントとして有効期限管理レコードに加算する。 ポイント設定「ポイント有効期間」を基にポイント 有効期限の算出を行い、有効期限を更新する。 | |||
| 期間限定ポイント | 指定あり | 指定されたポイント有効期限で、期間限定ポイントとして 有効期限管理レコードを新規登録する。 有効期限が一致する有効期限管理レコードが存在した場合は該当レコードに加算する。 ※通常ポイントの有効期限の延長は行いません。 | ||
| 指定なし | 有効期限必須チェックエラーとする。 | |||
| 減算 | - | 無視する | 無視する | 有効期限が近い有効期限管理レコードからポイントの減算を 行う。 （通常ポイント、期間限定ポイントすべて含める） 通常ポイントから減算を行った場合、ポイント設定「ポイント 有効期間」を基にポイント有効期限の算出を行い、通常ポイントの有効期限を更新する。 ※期間限定ポイントのみ減算を行った場合、 通常ポイントの有効期限の延長は行いません。 |
外部システムからのポイント操作となるため、ポイント履歴区分は「9:その他」にて登録されます。
①アクセスURL
アクセス元IPアドレスをご連絡ください。アクセスURLはサポートよりお知らせ致します。
②連携項目定義
項目定義は以下の通りです。項目の定義順は問いません。
| 対象テーブル | 名称 | 必須 | 型 | 桁数 | 説明 |
|---|---|---|---|---|---|
| ポイント履歴 | 会員ID | 〇 | 数値 | 8 | 会員マスタに存在しない場合はエラーとします。 登録時、会員のポイント残高も増減します。 |
| ポイント履歴 | 増減ポイント | 〇 | 数値 | 8 | マイナスの値を指定することも可能です。 の場合は加算とみなして処理を行います。（有効期限の延長も行う） |
| ポイント履歴 | ポイント有効期限 | ※1 | 日付 | 10 | |
| ポイント履歴 | 期間限定ポイントフラグ | 数値 | 1 | :通常ポイント、1:期間限定ポイント ※以下の場合のみ使用 ポイント有効期限の管理方法：会員単位 増減ポイント：プラス値 | |
| ポイント履歴 | 備考 | 全角 | 100 | ||
| ポイント履歴 | 管理用備考 | 全角 | 100 |
※1 以下の場合のみ必須です。
・ポイント有効期限の管理方法：会員単位
・増減ポイント：プラス値
・期間限定ポイントフラグ：期間限定ポイント
③返却値
HTTPアクセスにより以下の値が返却されます。
（処理OKのとき）
status=0&指定カラム=指定したカラムの値&指定カラム=...
（値のチェックエラー）
status=1&message=エラーメッセージ
（システム障害エラー）
status=9&message=エラーメッセージ
※ エラーメッセージが複数ある場合は、メッセージが半角チルダ「~」で分割されています。
例）status=1&message=エラーメッセージ１~エラーメッセージ２
※ 異常系レスポンスとして、上記以外のHTMLが返却される場合があります。
（サイト混雑時ユーザー整理機能発動時やサーバー高負荷時）
当ページの記載内容は、標準機能に関するものです。
機能に関するカスタマイズをされている場合にはこの限りではありません。