コンテンツにスキップ

企業情報取得

POST

/api_v1_login_company/info

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'uid=xxxxxxxxxxxxxx&state=xxxxxxxxxxxxxx' "https://api.next-engine.org/api_v1_login_company/info"

// POST /api_v1_login_company/info - 企業情報取得
const params = new URLSearchParams({
  access_token: '<access_token>',
})
const res = await fetch('https://api.next-engine.org/api_v1_login_company/info', {
  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_login_company/info - 企業情報取得
import requests

params = {
    'access_token': '<access_token>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_login_company/info',
    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

ネクストエンジン API 共通リクエストパラメータ

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

company_name

企業名 / 文字列型

string | integer | number | boolean | null

company_kana

企業名カナ / 文字列型

string | integer | number | boolean | null

company_zip_code

郵便番号 / 文字列型

string | integer | number | boolean | null

company_address1

住所1 / 文字列型

string | integer | number | boolean | null

company_address2

住所2 / 文字列型

string | integer | number | boolean | null

company_post_name

部署名 / 文字列型

string | integer | number | boolean | null

company_pic_name

担当者名 / 文字列型

string | integer | number | boolean | null

company_mail_address

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

string | integer | number | boolean | null

company_phone

電話番号 / 文字列型

string | integer | number | boolean | null

company_fax

FAX / 文字列型

string | integer | number | boolean | null

company_url

企業URL / 文字列型

string | integer | number | boolean | null

company_closing_day

締日 / 文字列型

string | integer | number | boolean | null

company_last_closing_date

最終締日 / 日時型

string | integer | number | boolean | null

company_fraction_number_digit

端数処理桁数 / 数値型

string | integer | number | boolean | null

company_fraction_id

端数処理区分 / 文字列型

string | integer | number | boolean | null

company_fraction_name

端数処理名 / 文字列型

string | integer | number | boolean | null

company_tax_id

税抜き・税込み区分 / 文字列型

string | integer | number | boolean | null

company_tax_name

税抜き・税込み名 / 文字列型

string | integer | number | boolean | null

company_temporarily_suspend_flag

一時利用停止フラグ / 文字列型

string | integer | number | boolean | null

company_available_date

有効日 / 日時型

string | integer | number | boolean | null

company_unavailable_date

無効日 / 日時型

string | integer | number | boolean | null

company_notice_mail_address

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

string | integer | number | boolean | null

company_buying_type

仕入れタイプ / 文字列型

string | integer | number | boolean | null

company_batch_type

バッチタイプ / 文字列型

string | integer | number | boolean | null

company_coupon_code

クーポンコード / 文字列型

string | integer | number | boolean | null

company_type_id

企業区分 / 文字列型

string | integer | number | boolean | null

company_ip_address

IPアドレス / 文字列型

string | integer | number | boolean | null

company_row_order

明細ソート / 数値型

string | integer | number | boolean | null

company_id

メイン機能企業ID / 文字列型 / アプリを起動した企業の「メイン機能単位」で一意になるID。１つの企業が複数のメイン機能を所有することがあります。

string | integer | number | boolean | null

company_ne_id

ネクストエンジン企業ID / 文字列型 / アプリを起動した企業の一意になるID。

string | integer | number | boolean | null

company_host

メイン機能ホスト / 文字列型

string | integer | number | boolean | null

company_now_tax_percent

現在の税率 / 数値型 / 10%の場合、10

string | integer | number | boolean | null

company_primary_tax_rate_for_discount

値引きの優先適用先 / 数値型 / NULL:按分10:10%8:8%0:0%

string | integer | number | boolean | null

company_invoice_registration_number

適格請求書発行事業者の登録番号 / 文字列型

string | integer | number | boolean | null

company_hit_syohin_alert_hour

ヒット商品お知らせ期間 / 数値型 / 0の場合、お知らせしない

string | integer | number | boolean | null

company_hit_syohin_alert_quantity

ヒット商品お知らせ個数 / 数値型 / 全商品に対して有効です。商品マスタに商品ごとの設定がある場合は、そちらが優先されます。

string | integer | number | boolean | null

company_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

company_creation_date

作成日 / 日時型

string | integer | number | boolean | null

company_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

company_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

company_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

company_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

company_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "company_name": "xxxxxxxx",
      "company_kana": "xxxxxxxx",
      "company_zip_code": "1500013",
      "company_address1": "xxxxxxxx",
      "company_address2": "",
      "company_post_name": null,
      "company_pic_name": "xxxxxxxx",
      "company_mail_address": "xxxx@xxxx.xxx",
      "company_phone": "0361231231",
      "company_fax": "",
      "company_url": "",
      "company_closing_day": null,
      "company_last_closing_date": null,
      "company_fraction_number_digit": "0",
      "company_fraction_id": "1",
      "company_fraction_name": "xxxxxxxx",
      "company_tax_id": "0",
      "company_tax_name": "xxxxxxxx",
      "company_temporarily_suspend_flag": "",
      "company_available_date": "2016-12-19 14:02:20",
      "company_unavailable_date": "0000-00-00 00:00:00",
      "company_notice_mail_address": null,
      "company_buying_type": "0",
      "company_batch_type": "U",
      "company_coupon_code": "",
      "company_type_id": "",
      "company_ip_address": null,
      "company_row_order": "0",
      "company_now_tax_percent": "8",
      "company_hit_syohin_alert_hour": "0",
      "company_hit_syohin_alert_quantity": "0",
      "company_primary_tax_rate_for_discount": "10",
      "company_invoice_registration_number": "T1234567890123",
      "company_creation_date": "2017-03-16 19:16:56",
      "company_last_modified_date": "2017-03-16 19:16:56",
      "company_creator_id": "0",
      "company_creator_name": "System",
      "company_last_modified_by_id": "0",
      "company_last_modified_by_name": "System",
      "company_last_modified_null_safe_date": "2017-03-16 19:16:56",
      "company_last_modified_by_null_safe_id": "0",
      "company_last_modified_by_null_safe_name": "System",
      "company_id": "xxxxxxxx",
      "company_ne_id": "xxxxxxxx",
      "company_host": "xxxxxxxx",
      "company_app_header": "xxxxxxxx"
    }
  ],
  "access_token": "xxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

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