コンテンツにスキップ

商品別卸先マスタ検索

POST

/api_v1_master_goodswholesale/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_wholesale_goods_id-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodswholesale/search

// POST /api_v1_master_goodswholesale/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_goodswholesale/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_goodswholesale/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_goodswholesale/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

goods_wholesale_goods_id

商品コード / 文字列型

string | integer | number | boolean | null

goods_wholesale_wholesale_id

卸先コード / 文字列型

string | integer | number | boolean | null

goods_wholesale_wholesale_retail_ratio

商品別卸先掛率 / 数値型

string | integer | number | boolean | null

goods_wholesale_creation_date

作成日 / 日時型

string | integer | number | boolean | null

goods_wholesale_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

goods_wholesale_last_modified_null_safe_date

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

string | integer | number | boolean | null

goods_wholesale_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

goods_wholesale_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

goods_wholesale_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

goods_wholesale_last_modified_by_null_safe_id

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

string | integer | number | boolean | null

goods_wholesale_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

goods_wholesale_last_modified_by_null_safe_name

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

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "goods_wholesale_goods_id": "T101-Red",
      "goods_wholesale_wholesale_id": "5555",
      "goods_wholesale_wholesale_retail_ratio": "10.0",
      "goods_wholesale_creation_date": "2017-02-13 13:02:37",
      "goods_wholesale_last_modified_date": "2017-02-13 13:02:37",
      "goods_wholesale_last_modified_null_safe_date": "2017-02-13 13:02:37",
      "goods_wholesale_creator_id": "10003",
      "goods_wholesale_creator_name": "xxxxx",
      "goods_wholesale_last_modified_by_id": "10003",
      "goods_wholesale_last_modified_by_null_safe_id": "10003",
      "goods_wholesale_last_modified_by_name": "xxxxx",
      "goods_wholesale_last_modified_by_null_safe_name": "xxxxx",
      "wholesale_id": "5555",
      "wholesale_name": "hcm - wholesaler",
      "wholesale_kana": "",
      "wholesale_post_name": "",
      "wholesale_zip_code": "70000",
      "wholesale_address1": "HCM",
      "wholesale_address2": "",
      "wholesale_phone": "",
      "wholesale_fax": "",
      "wholesale_mail_address": "",
      "wholesale_destination_pic_name": "Tokyo",
      "wholesale_destination_pic_kana": "",
      "wholesale_destination_zip_code": "18000",
      "wholesale_destination_address1": "Tokyo",
      "wholesale_destination_address2": "",
      "wholesale_destination_phone": "",
      "wholesale_delivery_id": "10",
      "wholesale_delivery_name": "佐川急便(e飛伝PRO)",
      "wholesale_payment_method_id": "0",
      "wholesale_payment_method_name": "クレジットカード",
      "wholesale_retail_ratio": null,
      "wholesale_destination_no": "1",
      "wholesale_credit_line_price": null,
      "wholesale_closing_day": null,
      "wholesale_note": null,
      "wholesale_deleted_flag": "0",
      "wholesale_creation_date": "2017-02-09 16:24:31",
      "wholesale_last_modified_date": "2017-02-13 12:52:58",
      "wholesale_last_modified_null_safe_date": "2017-02-13 12:52:58",
      "wholesale_creator_id": "0",
      "wholesale_creator_name": "System",
      "wholesale_last_modified_by_id": "0",
      "wholesale_last_modified_by_null_safe_id": "0",
      "wholesale_last_modified_by_name": "System",
      "wholesale_last_modified_by_null_safe_name": "System"
    }
  ],
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2017-04-20 11:19:26"
}

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