コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

仕入先登録

POST
/suppliers

仕入先情報を登録します。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
supplierCode
required
仕入先コード

ユニーク値 仕入先コード
※ 実際の入力チェックは20文字ですが、10文字以内で設定して下さい。

string
<= 10 characters /^[ -~]+$/
supplierDivisionId
仕入先区分ID

仕入先区分毎に付与するID

string format: int
supplierName
required
仕入先名

仕入先名

string
<= 85 characters
supplierAbbr
仕入先名略称

仕入先名略称

string
<= 85 characters
address
住所

住所

string
<= 255 characters
phoneNumber
電話番号

電話番号　（ハイフン付）

string
/^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$/
faxNumber
FAX番号

FAX番号

string
/^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$/
mailAddress
メールアドレス

メールアドレス

string format: email
/(?:[_p{L}0-9][-_p{L}0-9]*.)*(?:[p{L}0-9][-p{L}0-9]{0,62}).(?:(?:[a-z]{2}.)?[a-z]{2,})$/ui/
staffName
担当者名

担当者名

string
<= 255 characters
orderPriority
発注先優先度

発注先優先度

string format: int
>= 1 <= 99999
Example
{
  "supplierCode": "string",
  "supplierDivisionId": "1",
  "supplierName": "string",
  "supplierAbbr": "string",
  "address": "string",
  "phoneNumber": "string",
  "faxNumber": "string",
  "mailAddress": "test@example.com",
  "staffName": "string",
  "orderPriority": "12345"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

更新成功

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

400

Section titled “400 ”
  • 入力チェックエラーの場合
  • 仕入先コードが重複している場合
  • 指定された仕入先区分が見つからない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "既に登録されている仕入先コードです",
  "status": 400
}