形式

URL	https://api.s-oj.com/[バージョン]/delete/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

共通で必要なデータ

要素L0	要素L1	項目名	形式	必須	最大長	備考
data	sync	削除メタデータ	文字列	●	-	データを削除するための可逆暗号化されたメタデータ

「mall_my」の削除に必要なデータ

要素L0	要素L1	項目名	形式	必須	最大長	備考
-	-	-	-	-	-	-

レスポンス

要素L0	要素L1	項目名	備考
-	-	-	-

形式

URL	https://api.s-oj.com/[バージョン]/mall_my_list/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

要素L0	要素L1	項目名	形式	必須	最大長	備考
-	-	-	-	-	-	-

レスポンス

要素L0	要素L1	項目名	備考
count		モール数	返却されるモールの総数

要素L0	要素L1	項目名	備考
インデックス(num)	-	-	-
	id	モールマイID	「AUTO_INCREMENT」にて生成されたユニークなID
	c_mall_id	モール共通ID	モールの共通ID
	c_name	モール共通名称	モールの共通名称
	my_name	モールの名称	任意に変更したモールの名称
	my_name_sync	メタデータ	モールの名称を更新するためのメタデータ
	c_version	モールのバージョン	インストール済みモールのバージョン
	edit_user	最終編集者
	add_user	追加者
	edit_date	編集日時	編集日時
	add_date	追加日時	追加日時
	delete_sync	削除	削除するためのメタデータ

形式

URL	https://api.s-oj.com/[バージョン]/mall_list/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

要素L0	要素L1	項目名	形式	必須	最大長	備考
-	-	-	-	-	-	-

レスポンス

要素L0	要素L1	項目名	備考
count		モール数	返却されるモールの総数

要素L0	要素L1	項目名	備考
インデックス(num)	-	-	-
	id	ユニークID	「AUTO_INCREMENT」にて生成されたユニークなID
	group	グループ	モールのグループ
	author	開発者	モールを追加した個人・法人
	name	モールの名称	名称
	description	モールの詳細	詳細説明
	version	バージョン
	edit_date	編集日時	編集日時
	add_date	追加日時	追加日時

形式

URL	https://api.s-oj.com/[バージョン]/update/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

共通で必要なデータ

要素L0	要素L1	項目名	形式	必須	最大長	備考
data	sync	更新メタデータ	文字列	●	-	データを更新するための可逆暗号化されたメタデータ

「md_custom_data」の更新に必要なデータ

要素L0	要素L1	項目名	形式	必須	最大長	備考
data	md_maindata_id	maindataID	文字列	●	-	「AUTO_INCREMENT」にて生成されたユニークなmaindataID
data	md_custom_parent_id	custom_parentID	文字列	●	-	「AUTO_INCREMENT」にて生成されたユニークなcustom_parentID
data	mall_my_id	更新メタデータ	文字列	●	-	データを更新するための可逆暗号化されたメタデータ
data	key	項目管理文字列	文字列	●	-	項目管理文字列（キー）

レスポンス

要素L0	要素L1	項目名	備考
data	value	返却データ	任意に設定された変換規則に沿って変換された値が返却されてきますので、必要な場合はvalueにセットして下さい。
data	sync	更新用メタデータ	テーブルにレコードが新規追加された場合に更新用のメタデータが返却されますので、必要な場合は任意のカスタム属性にセットして下さい。

形式

URL	https://api.s-oj.com/[バージョン]/item/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

要素L0	要素L1	項目名	形式	必須	最大長	備考
data	id	商品ID	半角数字	●	-	自動生成されたユニークなID
data	mall_my_id	モールマイID	半角数字	●	-	0:共通、1～:インストール済みのモールマイID
data	c_mall_id	共通モールID	半角数字	●	-	0：共通、1～:(例)楽天市場は1

レスポンス

要素L0	要素L1	項目名	備考
インデックス(num)	edit_name	固有データの名称	入力欄の名称
	edit_str	項目管理文字列	項目管理文字列（キー）
	edit_place	項目の出現位置	出現場所
	edit_order	項目の順番	順番
	max_length	最大文字数	文字数の上限
	length_type	文字数のカウント方法	文字数かバイト数か（※現状では文字数に固定しています）
	regex	入力規則	正規表現
	regex_error	入力規則エラー内容	入力規則に沿わなかった場合に出すメッセージ
	convert	変換規則	文字列を変換する
	input_type	入力タイプ	0:一行テキスト,1:複数行テキスト,2:セレクトボックス,3:ラジオボタン,4:チェックボックス
	input_arr	選択肢の編集	セレクトボックス,ラジオボタン,チェックボックスの場合に入力、[key]:[value]の形式でカンマ区切り
	inherit	学習機能	1:大分類、中分類が同一で引き継ぐ(推奨),2:引継ぎをしない,3:大分類、中分類、小分類が同一で引き継ぐ,4:大分類、小分類が同一で引き継ぐ,5:中分類、小分類が同一で引き継ぐ,6:大分類が同一で引き継ぐ,7:中分類が同一で引き継ぐ,8:小分類が同一で引き継ぐ
	default_setting	初期セットデータ	新規出品時にセットされる値
	icon_num	表示アイコン	共通モール番号、複数ある場合はカンマ区切り
	edit_user	編集者	最後に編集した人のユーザー番号
	edit_date	編集日時	最後に編集した日時
	delete	削除フラグ	1:削除
	sync	更新用メタデータ	新規レコード追加の場合、更新用のメタデータが返却されるので代入をして下さい

形式

URL	https://api.s-oj.com/[バージョン]/session/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

なし

レスポンス

要素L0	要素L1	項目名	備考
session	privilege	ロール	admin:管理者、staff:スタッフ
session	ip	IP	要求を受けたIPアドレス
session	time	日付	要求を受けた日付、YYYYMMDD形式

要素L0	要素L1	項目名	備考
name	ユーザーID(num)	ユーザー名	同一グループのユーザー一覧の名称

要素L0	要素L1	要素L2	項目名	備考
mall	my_name	モールマイID(num)	インストール済みモールの名称	任意に変更可能な値
mall	common_num	モールマイID(num)	モールの共通ID	(例)楽天市場は1
mall	common_str	モールマイID(num)	モールの共通文字列	(例)楽天市場はrakuten

要素L0	要素L1	要素L2	項目名	備考
define	0	group3	小分類の名称
define	0	group2	中分類の名称
define	0	group1	大分類の名称
define	0	inherit	商品情報の引き継ぎ	前回の入力項目の引き継ぎ（自動入力）を行う際の条件を指定します。1:大分類、中分類が同一で引き継ぐ(推奨)、2:引継ぎをしない、3:大分類、中分類、小分類が同一で引き継ぐ、4:大分類、小分類が同一で引き継ぐ、5:中分類、小分類が同一で引き継ぐ、6:大分類が同一で引き継ぐ、7:中分類が同一で引き継ぐ、8:小分類が同一で引き継ぐ
define	0	inherit_degree	商品情報の引き継ぎの度合い	どの部分について引き継ぎを行うか選択できます。1:項目名のみ(推奨)、2:項目名＋内容
define	0	inherit_stock	項目別選択肢在庫(SKU)の引き継ぎ
define	0	prx	プレフックス	商品コードの先頭に指定されるコードです。
define	0	image_size_max	画像サイズの最大値	画像サイズの最大値(px)、最大で1000pxまで。
define	0	image_reduction	画像の加工方法	画像の最大値を超えていた場合の処理方法。1:画像のはみ出た部分を切る、2:画像を縮小する
define	0	compression_ratio	画像の圧縮率	画像の圧縮率を指定してください、100が最大（綺麗、サイズ大）で1が最小（粗い、サイズ小）です。
define	0	descimg_width_max	商品説明画像の横幅	商品説明画像の横幅を指定してください。（最大1000px）
define	0	stock_product_id_flg
define	0	notax2tax	税抜→税込の小数点	税抜価格から税込価格を計算する際に出た小数点をどのように扱うか。1:四捨五入、2:切り捨て、3:切り上げ
define	0	tax2notax	税込→税抜の小数点	税込価格から税抜価格を計算する際に出た小数点をどのように扱うか。1:四捨五入、2:切り捨て、3:切り上げ
define	0	discrate	割引率の小数点	定価と販売価格から割引率を計算する際に出た小数点をどのように扱うか。1:四捨五入、2:切り捨て、3:切り上げ
define	0	officialcode
define	0	tax_num	消費税率	本項目は消費税率が変更される日の前後1ヶ月に変更が可能。
define	0	field_num	商品情報の項目数	商品情報の項目数を入力して下さい（最大50まで）
define	0	field_title_num	商品情報タイトルの全角最大値(推奨：10)	商品情報タイトルの全角最大値を入力して下さい、10文字程度が理想です。
define	0	field_description_num	商品情報内容の全角最大値(推奨：200)	商品情報内容の全角最大値を入力して下さい、200文字程度が理想です。
define	0	stock_default	在庫数の初期値	在庫数の初期値を入力して下さい、リサイクル品などを扱うお客様の場合は1にしておくと便利です。
define	0	stock_sku_default	SKU在庫数の初期値	SKU在庫数の初期値を入力して下さい、リサイクル品などを扱うお客様の場合は1にしておくと便利です。
define	0	stock_zero_alert	在庫0でエラー	在庫が0で完成エリアに移動させた場合にエラーを出す。0:なにもしない、1:エラーを出す
define	0	own_itemid_alert	自社商品番号が「空」でエラー	自社商品番号が必須で運用する場合「空」で完成エリアに移動させた場合にエラーにする。0:なにもしない、1:エラーを出す
define	0	1x1_sku_alert	1×1のSKU登録でエラー	1×1のSKUで完成エリアに移動した場合にエラーを出す。出品不可モールが出てくるため「エラーを出す」を推奨。0:なにもしない、1:エラーを出す
define	0	dock_behavior	ドックを表示/隠す	作業画面がせまい方は「自動的に隠す」、広い方は「常に表示」にしておくのがお勧めです。1:自動的に隠す、2:常に表示
define	0	own_lower	自社管理番号を小文字に	自社管理番号に大文字英語が使われた場合に自動で小文字に変換します。0:設定しない、1:設定する
define	モールマイID(num)	設定項目(str)	各インストールモール別の初期設定値

はじめに

本ページは簡単出品王子APIの認証についての資料です

APIの認証フロー

以下に、認証フローの図について詳細を説明します

「アプリケーションサーバー」は御社が提供するアプリのWebサーバーです

「必須項目有り？」の判断はGETパラメータに以下の値があるか判定します

• client_id
• client_secret
• state
• uid
• gid
• sid

「リダイレクト？」の判断はレスポンスボディ(JSON形式)のresultの値が”redirect”か判定します

番号	概要	備考
1	ユーザーがアプリを起動	出品王子から起動した場合は、設定した「Redirect URI」にuid及びstateがGETパラメータで渡されます。直接ユーザーがアプリケーションサーバーにアクセスした場合は、uid及びstateはありません
2-1	access_tokenの取得	必須項目を元にAPIサーバーにaccess_tokenの発行を依頼します
2-2	uid・stateの取得	client_id、client_secretを元に出品王子サーバーにuid、gid、sid、stateの発行を依頼します
3	access_tokenの返却	正しいuid及びstateの場合、access_tokenを発行し返却します
4-1	uid・stateの取得	stateの有効期限が切れている場合、stateを再発行します
4-2	データアクセス	access_tokenが取得出来た場合、APIを用いてデータの取得・更新などを実行します
5	実行結果の返却	データアクセスの実行結果を返却します。またaccess_tokenの有効期限(※1)が切れていてrefresh_tokenの有効期限内(※2)の場合は、実行結果と共に新しいaccess_tokenとrefresh_tokenを返却します(※3)
6-1	uid・stateの取得	refresh_tokenの有効期限が切れている場合、stateを再発行します
6-2	アプリのビジネスロジック	データアクセスの結果を元にアプリのビジネスロジックを実施します。再びデータアクセスが必要な場合、4-2を実施します
7-1	アプリにリダイレクト	uid、gid、sid、stateを発行し、リダイレクトします
7-2	ログイン画面の表示	ユーザーへ出品王子のログイン画面を表示します
8	ログイン	ユーザーが出品王子にログインします。ログインしなかった場合は、アプリにリダイレクトされません

※1:「access_token」の有効期限は30分です

※2:「refresh_token」の有効期限は3日です

API上の比較演算子

パラメータにフィールド名+演算子を指定することで、検索条件の比較演算子を設定できます

例えば、商品コードitemidがsa,ap,cdのいずれかであること、と指定する場合パラメータ”itemid-in”に”sa,ap,cd”を指定します。

複数の検索条件を指定した場合は、かつ(AND)条件になります。

fieldsに指定可能な項目は全て検索条件に設定することが出来ます。

演算子	意味	値について	文字列型	数値型	日時型
-eq	=		利用可能	利用可能	利用可能
-neq	!=		利用可能	利用可能	利用可能
-lt	<			利用可能	利用可能
-lte	<=			利用可能	利用可能
-gt	>			利用可能	利用可能
-gte	>=			利用可能	利用可能
-in	IN()	カンマ区切りで指定する	利用可能	利用可能
-nin	NOT IN()	カンマ区切りで指定する	利用可能	利用可能
-like	LIKE	MySQLのLIKE演算子と同じ	利用可能
-nlike	NOT LIKE	MySQLのNOT LIKE演算子と同じ	利用可能
-blank	(IS NULL OR <> “”)	値は不要(無視)	利用可能	利用可能	利用可能
-nblank	(IS NOT NULL OR = “”)	値は不要(無視)	利用可能	利用可能	利用可能
-null	IS NULL	値は不要(無視)	利用可能	利用可能	利用可能
-nnull	IS NOT NULL	値は不要(無視)	利用可能	利用可能	利用可能

形式

URL	https://api.s-oj.com/[バージョン]/list/
メソッド	POST
データ形式	JSON
文字エンコーディング	UTF-8

リクエスト

要素L0	要素L1	項目名	形式	必須	最大長	備考
data	area	呼び出しエリア	半角数字	●	1	1:編集エリア、2:完成エリア、3：完了エリア
data	advance	詳細検索	半角数字	●	1	0:なし、1:詳細検索
data	page	ページナンバー	半角数字	●	1	0からはじまる
data	arrival_st	入荷日から	半角数字,ハイフン	●	1	YYYY-MM-DD形式、指定しない場合は空
data	arrival_en	入荷日まで	半角数字,ハイフン	●	1	YYYY-MM-DD形式、指定しない場合は空
data	out_mall	出品モール	半角数字,カンマ	●	1	複数ある場合はカンマ区切り
data	add_user	追加者	半角数字	●	1
data	edit_user	最終更新者	半角数字	●	1
data	search_window	検索キーワード	文字列	●	1

レスポンス

要素L0	要素L1	項目名	備考
count		商品数	返却される商品の総数

要素L0	要素L1	項目名	備考
インデックス(num)	id	ユニークID	「AUTO_INCREMENT」にて生成された完全にユニークなID
	itemid	管理番号	出品王子の管理番号
	own_itemid	自社管理番号	自社の管理番号
	item_name	商品名	共通商品名
	makerprice	定価(税込)	税込みの定価
	makerpricenotax	定価(税抜)	税抜きの定価
	price	価格(税込)	税込みの価格
	pricenotax	価格(税抜)	税抜きの価格
	wholesaleprice	卸値(税込)	税込みの卸値
	wholesalepricenotax	卸値(税抜)	税抜きの卸値
	discountrate	割引率	割引率
	serch_word	SEO対策	SEOやSEM等、サーチ対策用項目
	desc1	説明文1	商品説明文１
	desc2	説明文2	商品説明文2
	desc3	説明文3	商品説明文3
	desc4	説明文4	商品説明文4
	mgr_flg	管理者フラグ	商品の状態フラグ
	out_mall	出品モール	出品するモールの「mall_my_id」一覧（複数ある場合は、カンマ区切り）
	supplier	仕入先	仕入先一覧（複数ある場合は、カンマ区切り）
	official_name	メーカー品名	メーカー品名（楽天物流で使用）
	complete_flg	完成フラグ	完成エリアに移動した場合は「1」
	edit_user	編集者	編集者のID
	add_user	追加者	追加者のIDの
	arrival	入荷日	入荷日（YYYY-MMDD形式）
	edit_date	編集日時	編集日時
	add_date	追加日時	追加日時
	delete	削除フラグ	削除されている場合は「1」
	datastate	データ位置	1:編集エリア、2:完成エリア、3：完了エリア

HTTPステータスコード

HTTPステータスコードの一覧とその説明です

コード	メッセージ	意味
200	OK	閲覧リクエストは成功し、レスポンスとともに要求に応じた情報が返されます。
201	Created	更新リクエストは完了し、新たに作成されたリソースのURIが返されます。
400	Bad Request	リクエストが不正です。
403	Forbidden	アクセストークンの認証に失敗したか、許可されていない店舗、ユーザーです。
404	Not Found	指定のリクエストURIは存在しません。

エラーコード

エラーコードの一覧とその説明です

コード	メッセージ	意味
E00001	ご指定のURLは存在しません。	POSTしたURLが存在しない
E00002	JSONデータを送信して下さい。	ヘッダのContentTypeが「application/json」でない
E00003	JSONデータのパースに失敗しました。	POSTしたJSONのデータが不正でパース出来なかった
E00004	POSTされたデータが不正です。	POSTしたデータ形式またはデータ長が不正
E00005	要求されたデータはありませんでした。	参照要求したデータが存在しない
E00006	認証コードが不正です。	認証コードが存在しない
E00007	リフレッシュトークンの期限が切れました。	リフレッシュトークンの期限が切れたので認証メソッドからリフレッシュトークンを再取得して下さい
E00008	更新要求は許可されていません。	更新が許可されていないレコードを更新しようとした