商品停止削除
/api/v1.0/goods/bulk_stop
商品の停止、削除処理を実行します。
アウトライン
リクエスト
- Path:
/api/v1.0/goods/bulk_stop
- Preferred HTTP method:
POST
- Accepted content types:
application/json
- Encode:
UTF-8
Parameters
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
user_id | ユーザーID(管理画面へのログインID) | 100 | メール形式 | 必須 |
access_key | アクセスキー | 100 | 半角英数 | 必須 |
goods | 商品に属するパラメータ | array |
goods (request)
下記のような項目のオブジェクトを持つリスト
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
item_number | 商品番号 | 20 | 数値 | (必須)^1 |
item_code | 商品コード | 20 | 半角英数 + 記号 | (必須)^1 |
del_flg | 商品削除フラグ 0:停止 1:削除 |
1 | 数値 | 必須 |
レスポンス
- Type:
application/json
- Encode:
UTF-8
Fields
名前 | 概要 | 型 |
---|---|---|
user_id | ユーザーID | string |
goods | 商品に属するパラメータ | array |
goods (response)
下記のような項目のオブジェクトを持つリスト
名前 | 概要 | 型 |
---|---|---|
error_code | エラーコード ※正常時はnull |
int |
error_message | エラーメッセージ ※正常時はnull |
string |
item_number | 請求書番号 | int |
item_code | 請求先コード | string |
del_flg | 商品削除フラグ 0:停止 1:削除 |
int |
使用例
リクエスト例
{
"user_id": "sample@robotpayment.co.jp",
"access_key": "xxxxxxxxxxxxxxxx",
"goods": [
{
"item_number": 4,
"del_flg": 1
}
]
}
レスポンス例
Status: 200 OK
{
"user_id": "sample@robotpayment.co.jp",
"goods":[
{
"error_code": null,
"error_message": null,
"item_number": 4,
"item_code": null,
"del_flg": 1
}
]
}
エラー
個別エラー
エラーコード | 内容 |
---|---|
1901 | 商品番号が不正 |
1902 | 商品コードが不正 |
1903 | 更新対象の商品が存在しません |
1904 | すでに無効な商品です。 |
1906 | 商品番号と商品コードは同時に指定できません。 |
1907 | 商品削除フラグが不正 |
1908 | 請求情報で使用されている商品は削除できません。 |
1909 | 売上で使用されている商品は削除できません。 |
1910 | 請求書明細で使用されている商品は削除できません。 |