実店舗削除API
URL
URLにstoreCode(店舗コード)を指定してリクエストを行って下さい。
https://{APIドメイン}/admin-api/v1/realstore/{storeCode}
HTTPメソッド
DELETE
リクエストヘッダー
アクセストークンなどの詳細はアクセストークンによる認証を参照してください。
リクエストボディ
なし
パラメータ
なし
レスポンス
key | 項目名 | 必須 | 型 | byte | 内容 | |
---|---|---|---|---|---|---|
status | ステータス | ○ | String | - | 成功:success 失敗:failed |
|
errors | エラーリスト | Array | - | リクエストのエラー発生時に出力 | ||
code | コード | ○ | String | - | ||
path | パス | String | - | 入力値エラーの場合、対象のjson位置を出力 | ||
message | メッセージ | ○ | String | - | エラーの概要が出力されます。 |
エラーコード
コード | メッセージ | 説明 |
---|---|---|
InvalidValue | storeCodeの指定が不正です | 英数が正しく指定されてない場合に返却されます。 |
NotFound | リソースが存在しません | 存在しないstoreCodeが指定された場合に返却します。 |
サンプル
サンプル(エラー時)
{
"status": "failed",
"errors": [
{
"code": "Invalid",
"path": "storeCode",
"message": "storeCodeの指定が不正です"
}
]
}
サンプル(成功時)
{
"status": "success"
}