コンテンツにスキップ

在庫マスタ検索

POST
/api_v1_master_stock/search
curl -X POST https://api.next-engine.org/api_v1_master_stock/search -H 'cache-control: no-cache' -F access_token=xxxxxx -F refresh_token=xxxxxx -F wait_flag=1 -F 'fields=stock_goods_id,stock_quantity,stock_allocation_quantity,stock_defective_quantity,stock_remaining_order_quantity,stock_out_quantity,stock_free_quantity,stock_advance_order_quantity,stock_advance_order_allocation_quantity,stock_advance_order_free_quantity,stock_deleted_flag,stock_creation_date,stock_last_modified_date,stock_last_modified_null_safe_date,stock_creator_id,stock_creator_name,stock_last_modified_by_id,stock_last_modified_by_null_safe_id,stock_last_modified_by_name,stock_last_modified_by_null_safe_name' -F stock_goods_id-eq="abcd" -F offset=0 -F limit=1
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
stock_goods_id

商品コード / 文字列型

string | integer | number | boolean | null
stock_quantity

在庫数 / 数値型

string | integer | number | boolean | null
stock_allocation_quantity

引当数 / 数値型

string | integer | number | boolean | null
stock_defective_quantity

不良在庫数 / 数値型

string | integer | number | boolean | null
stock_remaining_order_quantity

発注残数 / 数値型

string | integer | number | boolean | null
stock_out_quantity

欠品数 / 数値型

string | integer | number | boolean | null
stock_free_quantity

フリー在庫数 / 数値型

string | integer | number | boolean | null
stock_advance_order_quantity

予約在庫数 / 数値型

string | integer | number | boolean | null
stock_advance_order_allocation_quantity

予約引当数 / 数値型

string | integer | number | boolean | null
stock_advance_order_free_quantity

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

string | integer | number | boolean | null
stock_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null
stock_creation_date

作成日 / 日時型

string | integer | number | boolean | null
stock_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null
stock_last_modified_null_safe_date

最終更新日 / 日時型 / NULLの場合作成日

string | integer | number | boolean | null
stock_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null
stock_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null
stock_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null
stock_last_modified_by_null_safe_id

最終更新者ID / 数値型 / NULLの場合作成者ID

string | integer | number | boolean | null
stock_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null
stock_last_modified_by_null_safe_name

最終更新者名 / 文字列型 / NULLの場合作成者名

string | integer | number | boolean | null
key
additional properties
any
Example
{
"result": "success",
"count": "1",
"data": [
{
"stock_goods_id": "abcd",
"stock_quantity": "170",
"stock_allocation_quantity": "0",
"stock_defective_quantity": "0",
"stock_remaining_order_quantity": "0",
"stock_out_quantity": "0",
"stock_free_quantity": "170",
"stock_advance_order_quantity": "102",
"stock_advance_order_allocation_quantity": "0",
"stock_advance_order_free_quantity": "102",
"stock_deleted_flag": "0",
"stock_creation_date": "2017-02-09 17:04:44",
"stock_last_modified_date": "2017-02-23 15:06:55",
"stock_last_modified_null_safe_date": "2017-02-23 15:06:55",
"stock_creator_id": "10003",
"stock_creator_name": "xxxxxxxx",
"stock_last_modified_by_id": "10003",
"stock_last_modified_by_null_safe_id": "10003",
"stock_last_modified_by_name": "xxxxxxxx",
"stock_last_modified_by_null_safe_name": "xxxxxxxxx"
}
],
"access_token": "xxxxxxxxxxx",
"access_token_end_date": "2017-04-13 18:24:53",
"refresh_token": "xxxxxxxxxxx",
"refresh_token_end_date": "2017-04-15 18:24:53"
}

クライアントエラー (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"
}