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

受注店舗登録

POST
/stores

受注店舗を登録します。

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Store
object
storeId

受注店舗ID

string
23
storeCode
required

店舗コード
※契約ID内でユニークでなければエラーになります。

string
<= 20 characters /^[ -~]+$/ 
999002
storeName
required

店舗名

string
>= 1 characters <= 85 characters 
物産店
storeAbbr

店舗名略称

string
<= 85 characters 
物産店
sellDivision

販売区分：受注店舗での販売時の消費税の扱いを指定できます。

  • included: 内税販売
  • excluded: 外税販売
string
default: included
Allowed values: included excluded 
included
sumDateChangeTime

指定した時刻を起点として締めを行なう日付が切り替わります。

string
default: 00:00 /^(2[0-3]|[01][0-9]):([0-5][0-9])$/ 
23:59
displaySequence

店舗の並び順。

integer
nullable >= 1 <= 999999999 
1
pauseFlag

休止フラグ

  • true:休止
  • false:通常
boolean
pointPaymentMethodId

ポイント支払方法
スマレジで取引を作成する際に、ポイント支払に割り当てるスマレジの支払方法IDを設定してください。
※管理画面では必須項目です。未設定の場合、受注店舗登録後に受注店舗詳細画面より設定してください。

string
>= 1 characters 
2
Example
{
  "storeCode": "999002",
  "storeName": "物産店",
  "storeAbbr": "物産店",
  "sellDivision": "included",
  "sumDateChangeTime": "23:59",
  "displaySequence": 1,
  "pointPaymentMethodId": "2"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

更新成功

Store
object
storeId

受注店舗ID

string
23
storeCode
required

店舗コード
※契約ID内でユニークでなければエラーになります。

string
<= 20 characters /^[ -~]+$/ 
999002
storeName
required

店舗名

string
>= 1 characters <= 85 characters 
物産店
storeAbbr

店舗名略称

string
<= 85 characters 
物産店
sellDivision

販売区分：受注店舗での販売時の消費税の扱いを指定できます。

  • included: 内税販売
  • excluded: 外税販売
string
default: included
Allowed values: included excluded 
included
sumDateChangeTime

指定した時刻を起点として締めを行なう日付が切り替わります。

string
default: 00:00 /^(2[0-3]|[01][0-9]):([0-5][0-9])$/ 
23:59
displaySequence

店舗の並び順。

integer
nullable >= 1 <= 999999999 
1
pauseFlag

休止フラグ

  • true:休止
  • false:通常
boolean
pointPaymentMethodId

ポイント支払方法
スマレジで取引を作成する際に、ポイント支払に割り当てるスマレジの支払方法IDを設定してください。
※管理画面では必須項目です。未設定の場合、受注店舗登録後に受注店舗詳細画面より設定してください。

string
>= 1 characters 
2
Example
{
  "storeId": "23",
  "storeCode": "999002",
  "storeName": "物産店",
  "storeAbbr": "物産店",
  "sellDivision": "included",
  "sumDateChangeTime": "23:59",
  "displaySequence": 1,
  "pauseFlag": false,
  "pointPaymentMethodId": "2"
}

400

Section titled “400 ”
  • 店舗コードが重複している場合
  • 受注店舗件数が上限に達している場合
  • 指定されたスマレジの支払方法（ポイント支払方法）が存在しない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "指定された店舗コードは既に登録されています。",
  "status": 400
}