仕入先一覧取得

GET

/suppliers

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/suppliers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/suppliers \
  --header 'Authorization: Bearer <token>'

仕入先情報一覧を取得します。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.suppliers:read
UserAccessToken
pos.suppliers:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

supplierId：仕入先ID
supplierCode：仕入先コード
orderPriority：発注先優先度
updDateTime：更新日時

limit

integer

上限数

page

integer

ページ

supplier_id

integer

仕入先ID

supplier_code

string

仕入先コード

supplier_division_id

string

仕入先区分ID

Responses

200

取得成功

application/json

Array<object>

object

supplierId

仕入先ID：半角数字5桁以内。

string

supplierCode

仕入先コード：半角英数10文字以内。

string

supplierDivisionId

仕入先区分ID：半角英数20文字以内。

string

supplierName

仕入先名：85文字以内。

string

supplierAbbr

仕入先名略称：85文字以内。

string

address

住所：255文字以内。

string

phoneNumber

電話番号：半角英数記号20文字以内。

string

faxNumber

FAX：半角英数記号20文字以内。

string

mailAddress

メールアドレス：半角英数記号255文字以内。

string

staffName

担当者名：85文字以内。

string

orderPriority

発注先優先度：半角数字5桁以内。

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "supplierId": "string",
    "supplierCode": "string",
    "supplierDivisionId": "string",
    "supplierName": "string",
    "supplierAbbr": "string",
    "address": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "mailAddress": "string",
    "staffName": "string",
    "orderPriority": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]