コンテンツにスキップ

拠点マスタ検索

POST
/api_v1_warehouse_base/search
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=warehouse_id,warehouse_name&warehouse_id-eq=1&offset=0&limit=100' https://api.next-engine.org/api_v1_warehouse_base/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
warehouse_id

拠点ID / 数値型 / ネクストエンジンで付与したユニークな拠点識別番号

string | integer | number | boolean | null
warehouse_name

拠点名 / 文字列型

string | integer | number | boolean | null
warehouse_creation_date

作成日 / 日時型 / 拠点の作成日

string | integer | number | boolean | null
warehouse_last_modified_date

最終更新日 / 日時型 / 拠点マスタの最終更新日

string | integer | number | boolean | null
warehouse_creator_id

作成担当者ID / 数値型 / 拠点の作成担当者ID

string | integer | number | boolean | null
warehouse_creator_name

作成担当者名 / 文字列型 / 拠点の作成担当者名

string | integer | number | boolean | null
warehouse_last_modified_by_id

最終更新者ID / 数値型 / 拠点マスタの最終更新者ID

string | integer | number | boolean | null
warehouse_last_modified_by_name

最終更新者名 / 文字列型 / 拠点マスタの最終更新者名

string | integer | number | boolean | null
key
additional properties
any
Example
{
"result": "success",
"count": "1",
"data": [
{
"warehouse_id": "1",
"warehouse_name": "拠点A"
}
],
"access_token": "xxx",
"access_token_end_date": "2023-04-18 17:24:28",
"refresh_token": "xxx",
"refresh_token_end_date": "2023-04-20 17:24:28"
}

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