店舗マスタ店舗更新

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_master_shop/update

リファレンス内容

店舗更新

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

動作はメイン機能の店舗更新と同じです

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`shop_id`	店舗ID	必須	更新する店舗のshop_id
`shop_last_modified_date`	最終更新日	必須	更新する店舗のshop_last_modified_date API実行時にメイン機能またはアプリで、店舗が更新されていないかを確認するために利用しますメイン機能またはアプリで店舗が更新されている場合はエラーになりますエラーになったら再度、店舗を検索してAPIを実行して下さい
`data`	作成する店舗情報のXML	必須	詳細はこちらを参照

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります

XML形式

入力パラメータのdataで指定する値です店舗作成と同じです。更新可能なフィールドのみ異なります

XMLサンプル

<?xml version="1.0" encoding="utf-8"?>
<root>
 <shop>
 <shop_kana>ラクテン</shop_kana>
 </shop>
</root>

更新仕様

APIで指定できるフィールドの一覧です

ここに記載されていないフィールドは指定できません

店舗情報

項目名	フィールド名	データ型	値必須	備考
店舗名	`shop_name`	文字列型	○
店舗略名	`shop_abbreviated_name`	文字列型	○
店舗カナ	`shop_kana`	文字列型
備考	`shop_note`	文字列型
取扱商品名	`shop_handling_goods_name`	文字列型
税区分ID	`shop_tax_id`	文字列型	○	税区分のIDを指定します
税計算順序	`shop_tax_calculation_sequence_id`	文字列型	○	0:商品計で税計算, 1:単価から税計算
通貨単位ID	`shop_currency_unit_id`	文字列型	○	通貨単位のIDを指定します
オーソリ区分ID	`shop_authorization_type_id`	文字列型		オーソリ区分のIDを指定します
ログインID_1	`mall_login_id1`	文字列型		各ログインID/パスワードはモール/カートの種類により扱いが異なります。詳細は店舗作成のログインID/パスワードの扱いを参照下さいこれらの項目は検索することは出来ませんが、接続確認することで正しい値か確認することが出来ます
ログインID_2	`mall_login_id2`	文字列型
ログインID_3	`mall_login_id3`	文字列型
パスワード_1	`mall_password1`	文字列型
パスワード_2	`mall_password2`	文字列型
パスワード_3	`mall_password3`	文字列型
インボイス形式を適用	`shop_enabled_invoice`	文字列型		1:適用する1以外:適用しない省略時:変更しない
ヤマト請求先顧客コード	`claim_id_yamato`	文字列型
西濃荷送人コード	`claim_id_seinou`	文字列型
福山荷送人コード	`claim_id_fukuyama`	文字列型
後払い.com サイトID	`shop_type_id`	文字列型

サンプル

リクエスト

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&shop_id=1&shop_last_modified_date=xxx&data=xxx' \ https://api.next-engine.org/api_v1_master_shop/update

レスポンス

{
  "result": "success",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-19 11:21:13",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-21 11:21:13"
}

エラー

エラーコード

エンドポイント固有のエラーコードを以下に示します。共通エラーコードはメッセージコード一覧を参照してください。

エラーコード	メッセージ	対処方法
`014001`	アクセス情報[xxxxxx]の許可が必要です。	ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります
`014002`	POSTパラメータにshop_idが指定されていない、または値が空です。	shop_idを指定してください
`014003`	POSTパラメータにdataが指定されていない、または値が空です。	dataを指定してください
`014004`	POSTパラメータにshop_last_modified_dateが指定されておりません。	shop_last_modified_dateを指定してください
`014005`	店舗[xxx]は存在しません。	shop_idを確認してください
`014006`	dataの値を解析できませんでした。正しい形式で指定して下さい。	XMLの形式を修正してください
`014007`	dataにshopタグが設定されておりません。	shopタグを設定してください
`014008`	[xxxxxx]タグを指定する場合、値が必須です。	タグ xxxxxx に値を設定してください
`014009`	[xxxxxx]タグは指定出来ません。	タグ xxxxxx は指定できません
`014010`	shopタグにネストしたタグを設定することは出来ません。	shopタグのネストは指定できません
`014011`	更新フィールドが設定されておりません。	更新するフィールドを設定してください
`014012`	xxxxxx[xxxxxxxxxxxx]は、メイン機能に登録されていない値です。	フィールド xxxxxx の値を確認してください
`014013`	shop_tax_calculation_sequence_id[xxx]には0又は1を設定して下さい。	0または1の値を設定してください
`014014`	shop_last_modified_dateが更新されています。再度店舗を検索してAPIを実行して下さい。	店舗を再検索して最新の日時を取得してください