コンテンツにスキップ

卸先マスタ検索

POST

/api_v1_master_wholesale/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=wholesale_id, wholesale_name,wholesale_kana,wholesale_deleted_flag&wholesale_deleted_flag-eq=0&offset=0&limit=100' https://api.next-engine.org/api_v1_master_wholesale/search

// POST /api_v1_master_wholesale/search - 卸先マスタ検索
const params = new URLSearchParams({
  access_token: '<access_token>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
})
const res = await fetch('https://api.next-engine.org/api_v1_master_wholesale/search', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_master_wholesale/search - 卸先マスタ検索
import requests

params = {
    'access_token': '<access_token>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_wholesale/search',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

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

Responses

200

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

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

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

wholesale_id

卸先コード / 文字列型

string | integer | number | boolean | null

wholesale_name

卸先名 / 文字列型

string | integer | number | boolean | null

wholesale_kana

卸先カナ / 文字列型

string | integer | number | boolean | null

wholesale_post_name

部署名 / 文字列型

string | integer | number | boolean | null

wholesale_zip_code

郵便番号 / 文字列型

string | integer | number | boolean | null

wholesale_address1

住所1 / 文字列型

string | integer | number | boolean | null

wholesale_address2

住所2 / 文字列型

string | integer | number | boolean | null

wholesale_phone

電話番号 / 文字列型

string | integer | number | boolean | null

wholesale_fax

FAX番号 / 文字列型

string | integer | number | boolean | null

wholesale_mail_address

メールアドレス / 文字列型

string | integer | number | boolean | null

wholesale_destination_pic_name

送付先名 / 文字列型

string | integer | number | boolean | null

wholesale_destination_pic_kana

送付先カナ / 文字列型

string | integer | number | boolean | null

wholesale_destination_zip_code

送付先郵便番号 / 文字列型

string | integer | number | boolean | null

wholesale_destination_address1

送付先住所1 / 文字列型

string | integer | number | boolean | null

wholesale_destination_address2

送付先住所2 / 文字列型

string | integer | number | boolean | null

wholesale_destination_phone

送付先電話番号 / 文字列型

string | integer | number | boolean | null

wholesale_delivery_id

発送方法区分 / 文字列型

string | integer | number | boolean | null

wholesale_delivery_name

発送方法名 / 文字列型

string | integer | number | boolean | null

wholesale_payment_method_id

支払区分 / 文字列型

string | integer | number | boolean | null

wholesale_payment_method_name

支払名 / 文字列型

string | integer | number | boolean | null

wholesale_retail_ratio

掛率 / 数値型

string | integer | number | boolean | null

wholesale_destination_no

卸先番号 / 数値型

string | integer | number | boolean | null

wholesale_credit_line_price

与信枠（円） / 数値型

string | integer | number | boolean | null

wholesale_closing_day

締日 / 数値型

string | integer | number | boolean | null

wholesale_note

備考 / 文字列型

string | integer | number | boolean | null

wholesale_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

wholesale_creation_date

作成日 / 日時型

string | integer | number | boolean | null

wholesale_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

wholesale_last_modified_null_safe_date

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

string | integer | number | boolean | null

wholesale_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

wholesale_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

wholesale_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

wholesale_last_modified_by_null_safe_id

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

string | integer | number | boolean | null

wholesale_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

wholesale_last_modified_by_null_safe_name

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

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "wholesale_id": "5555",
      "wholesale_name": "hcm - wholesaler",
      "wholesale_kana": "",
      "wholesale_deleted_flag": "0"
    }
  ],
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-15 13:03:47",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2017-04-17 13:03:47"
}

4XX

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

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

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"
}