コンテンツにスキップ

セット在庫マスタ検索

POST
/api_v1_master_setstock/search
curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&offset=0&limit=10000&fields=set_stock_set_goods_id,set_stock_free_quantity,set_stock_advance_order_free_quantity,set_stock_type_id,set_stock_last_modified_date&set_stock_set_goods_id-eq=set-test-syohin00001" https://api.next-engine.org/api_v1_master_setstock/search
Media type application/x-www-form-urlencoded
object
access_token
required

OAuth2 アクセストークン (必須)

string
refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string
wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string
Allowed values: 0 1
fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string
offset

検索開始位置 (search 系のみ)

integer
limit

取得件数 (search 系のみ)

integer
>= 1

実行結果 (result が success / error / redirect のいずれか)

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
string
access_token

更新後のアクセストークン

string
access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string
refresh_token

更新後のリフレッシュトークン

string
refresh_token_end_date

リフレッシュトークン有効期限

string
data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string
data
Array<object>
object
set_stock_set_goods_id

セット商品コード / 文字列型

string | integer | number | boolean | null
set_stock_free_quantity

フリー在庫数 / 数値型

string | integer | number | boolean | null
set_stock_advance_order_free_quantity

予約フリー在庫数 / 数値型

string | integer | number | boolean | null
set_stock_type_id

商品区分 / 文字列型 / セット商品に含まれる商品の商品区分の中で最大の数字 0:通常, 10:予約, 20:受注発注

string | integer | number | boolean | null
set_stock_last_modified_date

最終更新日 / 日時型 / 以下のうちで最も直近の日時 1. セット商品に含まれる商品の組み合わせか数量が変更された日時 2. セット商品に含まれる商品の在庫数が変更された日時 3. セット商品に含まれる商品が更新された日時

string | integer | number | boolean | null
key
additional properties
any
Example
{
"result": "success",
"count": "1",
"data": [
{
"set_stock_set_goods_id": "set-test-syohin00001",
"set_stock_free_quantity": "0",
"set_stock_advance_order_free_quantity": "0",
"set_stock_type_id": "0",
"set_stock_last_modified_date": "2022-08-25 18:52:46"
}
],
"access_token": "xxx",
"access_token_end_date": "2022-09-02 12:10:10",
"refresh_token": "xxx",
"refresh_token_end_date": "2022-09-04 12:10:10"
}

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

Media type application/json
object
result
required

実行結果ステータス

string
Allowed values: success error redirect
code

エラー時のエラーコード

string
message
One of:
string
access_token

更新後のアクセストークン

string
access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string
refresh_token

更新後のリフレッシュトークン

string
refresh_token_end_date

リフレッシュトークン有効期限

string
data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string
Example
{
"result": "success"
}