スマレジ・プラットフォームAPI POS仕様書 (ver.1.0.0)

概要


エンドポイント

サンドボックス

https://api.smaregi.dev/{契約ID}/pos

本番

https://api.smaregi.jp/{契約ID}/pos


ページネーション

一度に返すアイテム数は limitパラメータで指定でき、上限は1000個です。
取得する対象ページは page で指定できます( 1 始まり)。
並び順はsortパラメータで指定可能です。

QUERY PARAMETER 値の範囲 初期値
limit integer 1 〜 1000 100
page integer 1 〜 1
sort string パラメータ名指定 カンマ区切り複数指定可、並び替え順指定「パラメータ名:desc」での指定が可能 (各APIで主キーとなるID):asc

リクエスト例) 商品一覧、10件ずつ表示の1ページ目、並び順がproductCodeの降順 の場合

https://api.smaregi.dev/{契約ID}/pos/products/?limit=10&page=1&sort=productCode:desc



Plan

APIを利用するシステムのユーザーがご利用中のプランにより、実行できるAPIや、取得・登録・更新できるパラメータの種類が異なります。
APIを利用可能なプランについては各APIのページをご確認ください。
プランの種類は以下の通りです。

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


ユーザー権限

ユーザー権限による実行制御は「役割・役職による制御」、「所属店舗による制御」の2種類があります。

役割・役職による制御

ユーザーがスタッフとして属している役割・役職によりAPIの実行を制御します。
また、各APIの項目に「UserAccessToken」と記載があるものはスコープに対応する機能による制御も行います。
例)
役割・役職の取引履歴機能が「閲覧」の場合、取引取得APIは実行可能、取引登録APIはエラーになります。

スタッフの役割・役職は管理画面で設定可能です。
役割・役職の各機能の権限は管理画面、APIで設定可能です。
スマレジ・ヘルプ:スタッフの権限を設定する(役割・役職)

所属店舗による制御

ユーザーがスタッフとして所属している店舗の情報のみ取得・登録・更新・削除が可能です。
制御の詳細は各APIのページをご確認ください。



Authentication

AppAccessToken

アプリアクセストークン。

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://id.smaregi.dev/app/{contractId}/token
Refresh URL: https://id.smaregi.dev/app/{contractId}/token
Scopes:
  • pos.products:read -

    商品/部門の参照ができます。

  • pos.products:write -

    商品/部門の更新ができます。

  • pos.customers:read -

    会員/ポイントの参照ができます。

  • pos.customers:write -

    会員/ポイントの更新ができます。

  • pos.stock:read -

    在庫の参照ができます。

  • pos.stock:write -

    在庫の更新ができます。

  • pos.stock-changes:read -

    在庫変動履歴の参照ができます。

  • pos.transactions:read -

    取引/予算/精算/日次締め情報の参照ができます。

  • pos.transactions:write -

    取引/予算/精算/日次締め情報の更新ができます。

  • pos.suppliers:read -

    仕入先の参照ができます。

  • pos.suppliers:write -

    仕入先の更新ができます。

  • pos.stores:read -

    店舗の参照ができます。

  • pos.stores:write -

    店舗の更新ができます。

  • pos.staffs:read -

    スタッフの参照ができます。

  • pos.staffs:write -

    スタッフの更新ができます。

  • pos.losses:read -

    ロスの参照ができます。

  • pos.losses:write -

    ロスの更新ができます。

  • pos.orders:read -

    発注/入荷/出荷の参照ができます。

  • pos.orders:write -

    発注/入荷/出荷の更新ができます。

  • pos.transfers:read -

    店間移動(入出庫)の参照ができます。

  • pos.transfers:write -

    店間移動(入出庫)の更新ができます。

  • pos.stocktaking:read -

    棚卸の参照ができます。

UserAccessToken

ユーザーアクセストークン。
管理画面における制御と同等の、ユーザー(=スタッフ)の所属店舗による制御や、属する役割・役職に設定された各種権限に基づく実行制御が適用されます。

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://id.smaregi.dev/authorize
Token URL: https://id.smaregi.dev/authorize/token
Refresh URL: https://id.smaregi.dev/authorize/token
Scopes:
  • pos.products:read -

    商品/部門の参照ができます。

  • pos.products:write -

    商品/部門の更新ができます。

  • pos.customers:read -

    会員/ポイントの参照ができます。

  • pos.customers:write -

    会員/ポイントの更新ができます。

  • pos.stock:read -

    在庫の参照ができます。

  • pos.stock:write -

    在庫の更新ができます。

  • pos.stock-changes:read -

    在庫変動履歴の参照ができます。

  • pos.transactions:read -

    取引/予算/精算/日次締め情報の参照ができます。

  • pos.transactions:write -

    取引/予算/精算/日次締め情報の更新ができます。

  • pos.suppliers:read -

    仕入先の参照ができます。

  • pos.suppliers:write -

    仕入先の更新ができます。

  • pos.stores:read -

    店舗の参照ができます。

  • pos.stores:write -

    店舗の更新ができます。

  • pos.staffs:read -

    スタッフの参照ができます。

  • pos.staffs:write -

    スタッフの更新ができます。

部門

部門一覧取得

部門情報一覧を取得します。

Plans:
スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
sortで使用可能なパラメータ ■categoryId:部門ID
■categoryCode:部門コード
■level:階層レベル
■displaySequence:表示順
■updDateTime:更新日時

Authorizations:
AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
path Parameters
contract_id
required
string

契約ID

query Parameters
fields
array

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

sort
string

並び順(カンマ区切りで指定可)
指定可能な項目については上記参照

limit
integer

上限数

page
integer

ページ

category_code
string

部門コード

level
string
Enum: 1 2 3

階層レベル

Responses

200

取得成功

get /categories

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/categories

本番

https://api.smaregi.jp/{契約ID}/pos/categories

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

部門登録

部門情報を登録します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

Request Body schema: application/json
categoryCode
string (部門コード) <= 20 characters ^[ -~]+$

ユニーク値 部門コード

categoryName
required
string (部門名) <= 85 characters

部門名

categoryAbbr
string (部門名略称) <= 85 characters

部門名略称

displaySequence
string <int> (表示番号) [ 0 .. 999999999 ]

表示順序

displayFlag
string (表示フラグ)
Default: 1
Enum: 0 1

端末で表示するか判定
(0:表示しない、1:表示する)

taxDivision
string (税区分)
Enum: 0 1 2

商品単価の税区分 (0:税込、1:税抜、2:非課税)

pointNotApplicable
string (ポイント対象区分)
Default: 0
Enum: 0 1

(0:ポイント対象、1:ポイント対象外)

taxFreeDivision
string (免税区分)
Default: 0
Enum: 0 1 2

(0:対象外、1:一般品、2:消耗品)

reduceTaxId
string <int> (軽減税率ID)

軽減税率ID
標準:null(または未設定)
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。

color
string (端末表示カラー) <= 7 characters #([0-9a-fA-F]{1,6})$

端末表示カラー:#000000形式

categoryGroupId
string <int> (部門グループID)

部門グループID:部門グループID未設定の場合null

parentCategoryId
string <int> (親部門ID)

親部門ID:親部門IDは階層レベル1〜2のもののみ指定可能。(3のものを指定した場合エラー)。
親部門IDがない場合はnull。
存在しない親部門IDを指定した場合エラー。

tag
string (タグ) <= 85 characters

タグ

Responses

200

更新成功

400
  • 入力チェックエラーの場合
  • 親部門IDに階層レベル3のものが指定された場合
post /categories

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/categories

本番

https://api.smaregi.jp/{契約ID}/pos/categories

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryCode": "string",
  • "categoryName": "string",
  • "categoryAbbr": "string",
  • "displaySequence": "string",
  • "displayFlag": 1,
  • "taxDivision": 0,
  • "pointNotApplicable": 0,
  • "taxFreeDivision": 0,
  • "reduceTaxId": "string",
  • "color": "string",
  • "categoryGroupId": "string",
  • "parentCategoryId": "string",
  • "tag": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryId": "string",
  • "categoryCode": "string",
  • "categoryName": "string",
  • "categoryAbbr": "string",
  • "displaySequence": "string",
  • "displayFlag": 0,
  • "taxDivision": 0,
  • "pointNotApplicable": 0,
  • "taxFreeDivision": 0,
  • "reduceTaxId": "string",
  • "color": "string",
  • "categoryGroupId": "string",
  • "parentCategoryId": "string",
  • "level": "string",
  • "tag": "string",
  • "insDateTime": "string",
  • "updDateTime": "string"
}

部門取得

部門情報を取得します。

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

Authorizations:
AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
path Parameters
contract_id
required
string

契約ID

id
required
string

部門ID

query Parameters
fields
array

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

Responses

200

取得成功

get /categories/{id}

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/categories/{id}

本番

https://api.smaregi.jp/{契約ID}/pos/categories/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryId": "string",
  • "categoryCode": "string",
  • "categoryName": "string",
  • "categoryAbbr": "string",
  • "displaySequence": "string",
  • "displayFlag": "string",
  • "taxDivision": "string",
  • "pointNotApplicable": "string",
  • "taxFreeDivision": "string",
  • "reduceTaxId": "string",
  • "color": "string",
  • "categoryGroupId": "string",
  • "parentCategoryId": "string",
  • "level": "string",
  • "tag": "string",
  • "insDateTime": "string",
  • "updDateTime": "string"
}

部門更新

部門情報を更新します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

id
required
string

部門ID

Request Body schema: application/json
categoryCode
string (部門コード) <= 20 characters ^[ -~]+$

ユニーク値 部門コード

categoryName
string (部門名) <= 85 characters

部門名

categoryAbbr
string (部門名略称) <= 85 characters

部門名略称

displaySequence
string <int> (表示番号) [ 0 .. 999999999 ]

表示順序

displayFlag
string (表示フラグ)
Default: 1
Enum: 0 1

端末で表示するか判定
(0:表示しない、1:表示する)

taxDivision
string (税区分)
Enum: 0 1 2

商品単価の税区分 (0:税込、1:税抜、2:非課税)

pointNotApplicable
string (ポイント対象区分)
Default: 0
Enum: 0 1

(0:ポイント対象、1:ポイント対象外)

taxFreeDivision
string (免税区分)
Default: 0
Enum: 0 1 2

(0:対象外、1:一般品、2:消耗品)

reduceTaxId
string <int> (軽減税率ID)

軽減税率ID
標準:null
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])
上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
※存在しない軽減税率IDを指定した場合エラー。

color
string (端末表示カラー) <= 7 characters #([0-9a-fA-F]{1,6})$

端末表示カラー:#000000形式

categoryGroupId
string <int> (部門グループID)

部門グループID:部門グループID未設定の場合null

parentCategoryId
string <int> (親部門ID)

親部門ID:親部門IDは階層レベル1〜2のもののみ指定可能。(3のものを指定した場合エラー)。
親部門IDがない場合はnull。
存在しない親部門IDを指定した場合エラー。

tag
string (タグ) <= 85 characters

タグ

Responses

200

更新成功

400
  • 入力チェックエラーの場合
  • 親部門IDに階層レベル3のものが指定された場合
404

部門IDが存在しない場合

patch /categories/{id}

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/categories/{id}

本番

https://api.smaregi.jp/{契約ID}/pos/categories/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryCode": "string",
  • "categoryName": "string",
  • "categoryAbbr": "string",
  • "displaySequence": "string",
  • "displayFlag": 1,
  • "taxDivision": 0,
  • "pointNotApplicable": 0,
  • "taxFreeDivision": 0,
  • "reduceTaxId": "string",
  • "color": "string",
  • "categoryGroupId": "string",
  • "parentCategoryId": "string",
  • "tag": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryId": "string",
  • "categoryCode": "string",
  • "categoryName": "string",
  • "categoryAbbr": "string",
  • "displaySequence": "string",
  • "displayFlag": 0,
  • "taxDivision": 0,
  • "pointNotApplicable": 0,
  • "taxFreeDivision": 0,
  • "reduceTaxId": "string",
  • "color": "string",
  • "categoryGroupId": "string",
  • "parentCategoryId": "string",
  • "level": "string",
  • "tag": "string",
  • "insDateTime": "string",
  • "updDateTime": "string"
}

部門削除

部門情報を削除します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

id
required
string

部門ID

Responses

200

削除成功

400

指定された部門IDが削除不可の場合

  • 紐づく商品が存在する場合
  • 親部門IDに指定されている場合

404

指定した部門データが存在しない場合

delete /categories/{id}

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/categories/{id}

本番

https://api.smaregi.jp/{契約ID}/pos/categories/{id}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "type": "about:blank",
  • "title": "Bad Request",
  • "detail": "関連商品が存在するため削除できません",
  • "status": 400
}

部門グループ

部門グループ一覧取得

部門グループの一覧を取得します。


sortで使用可能なパラメータ
■categoryGroupId:部門グループID
■displaySequence:表示順
■updDateTime:更新日時:登録時・更新時の日時
Plans:
スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

Authorizations:
AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
path Parameters
contract_id
required
string

契約ID

query Parameters
fields
array

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

sort
string

並び順(カンマ区切りで指定可)
指定可能な項目については上記参照

limit
integer

上限数

page
integer

ページ

category_group_id
string

部門グループID

category_group_code
string

部門グループコード

Responses

200

取得成功

get /category_groups

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/category_groups

本番

https://api.smaregi.jp/{契約ID}/pos/category_groups

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

部門グループ登録

部門グループを登録します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

Request Body schema: application/json
categoryGroupCode
string (部門グループコード) <= 10 characters ^[ -~]+$

部門グループコード

categoryGroupName
required
string (部門グループ名) <= 85 characters

部門グループ名

displaySequence
string <int> (表示順) [ 0 .. 999999999 ]

表示順

Responses

200

更新成功

400
  • 入力チェックエラーの場合
  • 指定された部門グループコードが重複する場合
post /category_groups

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/category_groups

本番

https://api.smaregi.jp/{契約ID}/pos/category_groups

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryGroupCode": "string",
  • "categoryGroupName": "string",
  • "displaySequence": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryGroupId": "string",
  • "categoryGroupCode": "string",
  • "categoryGroupName": "string",
  • "displaySequence": "string",
  • "insDateTime": "string",
  • "updDateTime": "string"
}

部門グループ更新

指定された部門グループを更新します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

id
required
string

部門グループID

Request Body schema: application/json
categoryGroupCode
string (部門グループコード) <= 10 characters ^[ -~]+$

部門グループコード

categoryGroupName
string (部門グループ名) <= 85 characters

部門グループ名

displaySequence
string <int> (表示順) [ 0 .. 999999999 ]

表示順

Responses

200

更新成功

400
  • 入力チェックエラーの場合
  • 指定された部門グループコードが重複する場合
404
  • 指定されたIDが存在しない場合
patch /category_groups/{id}

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/category_groups/{id}

本番

https://api.smaregi.jp/{契約ID}/pos/category_groups/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryGroupCode": "string",
  • "categoryGroupName": "string",
  • "displaySequence": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "categoryGroupId": "string",
  • "categoryGroupCode": "string",
  • "categoryGroupName": "string",
  • "displaySequence": "string",
  • "insDateTime": "string",
  • "updDateTime": "string"
}

部門グループ削除

指定された部門グループを削除します。

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

Authorizations:
AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
path Parameters
contract_id
required
string

契約ID

id
required
string

部門グループID

Responses

200

削除成功

400
  • 指定された部門グループに紐付いている部門が存在する場合
404
  • 指定されたIDが存在しない場合
delete /category_groups/{id}

サンドボックス

https://api.smaregi.dev/{契約ID}/pos/category_groups/{id}

本番

https://api.smaregi.jp/{契約ID}/pos/category_groups/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "type": "about:blank",
  • "title": "Bad Request",
  • "detail": "指定された部門グループに紐付いている部門が存在するため、削除できません。",
  • "status": 400
}

商品

商品一覧取得

商品情報一覧を取得します。

Plans:
スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
sortで使用可能なパラメータ ■productId:商品ID
■categoryId:部門ID
■productCode:商品コード
■groupCode:グループコード
■displaySequence:表示順
■updDateTime:更新日時

Authorizations:
AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
path Parameters
contract_id
required
string

契約ID

query Parameters
fields
array

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

sort
string

並び順(カンマ区切りで指定可)
指定可能な項目については上記参照

limit
integer

上限数

page
integer

ページ

category_id
integer

部門ID

product_code
string

商品コード

group_code
string

グループコード

display_flag
string
Enum: 0 1

端末表示 (0:表示しない、1:表示する)

division
string
Enum: 0 1 2

商品区分 (0:通常商品、1:回数券、2:オプション商品)

sales_division
string
Enum: 0 1

売上区分 (0:売上対象、1:売上対象外)

stock_control_division
string
Enum: 0 1

在庫管理区分 (0:在庫管理対象、1:在庫管理対象外)

supplier_product_no
string

品番

upd_date_time-from
string

更新日時(From):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

upd_date_time-to
string

更新日時(To):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

Responses

200

取得成功

400
  • 更新日時のFrom/To片方しか設定されていない場合
  • 更新日時のFrom-Toの範囲が上限を超えている場合
    get /products

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products

    本番

    https://api.smaregi.jp/{契約ID}/pos/products

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品登録

    商品情報を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    categoryId
    required
    string (部門ID)

    部門毎に付与するID

    productCode
    string (商品コード) <= 20 characters ^[ -~]+$

    ユニーク値

    productName
    required
    string (商品名) <= 85 characters
    productKana
    string (商品カナ) <= 85 characters
    taxDivision
    string (税区分)
    Default: 1
    Enum: 0 1 2

    商品単価の税区分 (0:税込、1:税抜、2:非課税)

    productPriceDivision
    string (商品価格区分)
    Default: 1
    Enum: 1 2

    商品をオープン価格販売するかどうかの設定
    (1:通常価格、2:オープン価格)

    price
    required
    string <int> (商品単価) [ -99999999 .. 99999999 ]

    商品単価

    customerPrice
    string <int> (会員価格) [ -99999999 .. 99999999 ]
    cost
    string <decimal> (原価) [ -99999999.99999 .. 99999999.99999 ]
    attribute
    string (規格) <= 1000 characters

    商品属性

    description
    string (説明) <= 1000 characters

    商品の説明

    catchCopy
    string (キャッチコピー) <= 1000 characters

    商品のキャッチコピー

    size
    string (サイズ) <= 85 characters

    サイズの和名を設定

    color
    string (カラー) <= 85 characters

    色の和名を設定

    tag
    string (タグ) <= 85 characters

    タグの和名を設定

    groupCode
    string (グループコード) <= 85 characters

    グルーピングする為の一意のキー (親の商品IDになる)

    url
    string (URL) <= 255 characters

    スマレジ端末でWEBページを表示する場合設定

    printReceiptProductName
    string (レシート印字商品名) <= 64 characters

    レシートに印字する商品名。(64文字以内)

    displaySequence
    string <int> (表示順) [ 0 .. 999999999 ]

    表示順序

    displayFlag
    string (端末表示)
    Default: 1
    Enum: 0 1

    端末で表示するか判定
    (0:表示しない、1:表示する)

    division
    string (商品区分)
    Default: 0
    Enum: 0 1 2

    商品区分(0:通常、1:回数券、2:オプション)
    ※回数券 は回数券機能が利用可能な契約のみ指定可能。ご利用できない契約で指定された場合エラー。

    productOptionGroupId
    string <int> (オプショングループID) [ 1 .. 999999999 ]

    商品オプショングループのID(商品区分が0:通常の場合のみ設定可能)。オプショングループの設定方法が「全店舗共通」の場合、適用可能なオプショングループのIDをこちらに設定します。

    salesDivision
    string (売上区分)
    Default: 0
    Enum: 0 1

    (0:売上対象、1:売上対象外)

    stockControlDivision
    string (在庫管理区分)
    Default: 0
    Enum: 0 1

    (0:在庫管理対象、1:在庫管理対象外)

    pointNotApplicable
    string (ポイント対象区分)
    Default: 0
    Enum: 0 1

    (0:ポイント対象、1:ポイント対象外)

    taxFreeDivision
    string (免税区分)
    Default: 0
    Enum: 0 1 2

    (0:対象外、1:一般品、2:消耗品)

    calcDiscount
    string (値引割引計算対象)
    Default: 1
    Enum: 0 1

    小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを識別する。
    (0:対象外、1:対象)

    staffDiscountRate
    string <int> (社員販売割引率) [ 0 .. 100 ]

    社員販売時の割引率

    useCategoryReduceTax
    string (部門税設定参照フラグ)
    Default: 1
    Enum: 0 1

    軽減税率個別設定フラグ(0:reduceTaxIdを使用、1:部門の税設定を使用)
    画面項目「部門の税設定を使用」

    reduceTaxId
    string <int> (軽減税率ID) [ 0 .. 999999999 ]

    軽減税率ID
    標準:null(または未設定)
    軽減:10000001 (特定商品の軽減税率適用)
    選択[標準]:10000002(状態による適用[適用しない])
    選択[軽減]:10000003(状態による適用[適用する])
    選択[選択]:10000004(状態による適用[都度選択する])
    上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

    ※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
    ※存在しない軽減税率IDを指定した場合エラー。

    reduceTaxPrice
    string <int> (軽減税率用商品単価) [ -99999999 .. 99999999 ]
    reduceTaxCustomerPrice
    string <int> (軽減税率用商品会員単価) [ -99999999 .. 99999999 ]
    orderPoint
    string <int> (発注点) [ 0 .. 999999999 ]

    発注をかけるべき在庫数

    purchaseCost
    string <decimal> (仕入原価) [ -99999999.99999 .. 99999999.99999 ]

    商品の仕入原価

    supplierProductNo
    string (品番) <= 85 characters

    メーカー品番  【在庫PKG用】

    appStartDateTime
    string <date-time> (適用開始日時)

    端末に適用を開始する日時[YYYY-MM-DDThh:mm:ssTZD]

    reserveItems
    Array of objects (商品自由項目)
    prices
    Array of objects (商品価格)
    stores
    Array of objects (商品取扱店舗)
    inventoryReservations
    Array of objects (在庫引当商品)
    attributeItems
    Array of objects (商品属性項目)
    orderSetting
    object (発注設定)

    未設定の場合default値で登録されます。

    Responses

    200

    更新成功

    400
    • 入力チェックエラーの場合
    • 商品コードが重複している場合
    • 商品価格の店舗IDと価格区分の組み合わせが重複している場合
    • 商品自由項目の商品自由項目番号が重複している場合
    • 商品取扱店舗の店舗IDが重複している場合
    • 在庫引当商品の在庫引当商品IDが重複している場合
    • 指定されたオプショングループIDが存在しない場合
    • 商品区分が「0:通常」でない商品に対してオプショングループIDが設定された場合
    • 設定方法が「全店舗共通」のオプショングループIDと「店舗ごと」のオプショングループIDがともに設定された場合
    • 店舗区分が「倉庫」の店舗に対して設定方法が「店舗ごと」のオプショングループIDが設定された場合
    • 商品の登録上限数を超えてしまう場合
    • 商品属性項目の項目番号とコードの組み合わせが存在しない場合
    • 商品属性項目の項目番号がリクエスト内で重複している場合
    • 発注設定の店舗別発注設定の店舗IDが重複している場合
    • 発注設定の継続区分に存在しないコードを設定している場合
    • 発注状態または発注不可理由を設定していて、どちらかが未設定の場合
    • 発注設定の発注状態に「1:発注可」を設定していて、発注不可理由にnull以外を設定している場合
    • 発注設定の発注状態に「0:発注不可」を設定していて、発注不可理由に存在しないコードを設定している場合
    • 発注設定の発注単位区分に「1:単位あり」を設定していて、発注単位名または発注数を設定していない場合
    • 発注設定の発注単位区分に「0:単位なし」を設定していて、発注単位名または発注数にnullを設定していない場合
    post /products

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products

    本番

    https://api.smaregi.jp/{契約ID}/pos/products

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "categoryId": "string",
    • "productCode": "string",
    • "productName": "string",
    • "productKana": "string",
    • "taxDivision": 1,
    • "productPriceDivision": 1,
    • "price": "string",
    • "customerPrice": "string",
    • "cost": "string",
    • "attribute": "string",
    • "description": "string",
    • "catchCopy": "string",
    • "size": "string",
    • "color": "string",
    • "tag": "string",
    • "groupCode": "string",
    • "url": "string",
    • "printReceiptProductName": "string",
    • "displaySequence": "string",
    • "displayFlag": 1,
    • "division": 0,
    • "productOptionGroupId": "string",
    • "salesDivision": 0,
    • "stockControlDivision": 0,
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 1,
    • "staffDiscountRate": "string",
    • "useCategoryReduceTax": 1,
    • "reduceTaxId": "string",
    • "reduceTaxPrice": "string",
    • "reduceTaxCustomerPrice": "string",
    • "orderPoint": "string",
    • "purchaseCost": "string",
    • "supplierProductNo": "string",
    • "appStartDateTime": "2023-12-01T10:09:41Z",
    • "reserveItems":
      [
      ],
    • "prices":
      [
      ],
    • "stores":
      [
      ],
    • "inventoryReservations":
      [
      ],
    • "attributeItems":
      [
      ],
    • "orderSetting":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productId": "string",
    • "categoryId": "string",
    • "productCode": "string",
    • "productName": "string",
    • "productKana": "string",
    • "taxDivision": 0,
    • "productPriceDivision": 1,
    • "price": "string",
    • "customerPrice": "string",
    • "cost": "string",
    • "attribute": "string",
    • "description": "string",
    • "catchCopy": "string",
    • "size": "string",
    • "color": "string",
    • "tag": "string",
    • "groupCode": "string",
    • "url": "string",
    • "printReceiptProductName": "string",
    • "displaySequence": "string",
    • "displayFlag": 0,
    • "division": 0,
    • "productOptionGroupId": "string",
    • "salesDivision": 0,
    • "stockControlDivision": 0,
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 0,
    • "staffDiscountRate": "string",
    • "useCategoryReduceTax": 0,
    • "reduceTaxId": "string",
    • "reduceTaxPrice": "string",
    • "reduceTaxCustomerPrice": "string",
    • "orderPoint": "string",
    • "purchaseCost": "string",
    • "supplierProductNo": "string",
    • "appStartDateTime": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "prices":
      [
      ],
    • "reserveItems":
      [
      ],
    • "stores":
      [
      ],
    • "inventoryReservations":
      [
      ],
    • "attributeItems":
      [
      ],
    • "orderSetting":
      {
      }
    }

    商品一括登録

    商品情報を一括登録します。
    ※ 商品の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 商品は1リクエストにつき100件まで登録できます。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    products
    required
    Array of objects (商品情報)
    callbackUrl
    required
    string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

    処理が完了した際にその結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 処理完了通知URLで指定されたURLのフォーマットが正しくない場合
    • 商品コードがリクエスト内で重複している場合
    • 商品価格の店舗IDと価格区分と適応開始日の組み合わせがリクエスト内で重複している場合
    • 商品自由項目の商品自由項目番号がリクエスト内で重複している場合
    • 商品取扱店舗の店舗IDがリクエスト内で重複している場合
    • 在庫引当商品の在庫引当商品IDがリクエスト内で重複している場合
    • 商品属性項目の項目番号が重複している場合
    • 発注設定の店舗別発注設定の店舗IDが重複している場合
    • 商品区分が「0:通常」以外を指定して、商品オプショングループIDを指定した場合
    • 設定方法が「全店舗共通」のオプショングループIDと「店舗ごと」のオプショングループIDがともに指定された場合
    • 発注状態または発注不可理由を設定していて、どちらかが未設定の場合
    • 発注設定の発注状態に「1:発注可」を設定していて、発注不可理由にnull以外を設定している場合
    • 発注設定の発注単位区分に「1:単位あり」を設定していて、発注単位名または発注数を設定していない場合
    post /products/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "products":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    商品一括更新

    商品情報を一括更新します。
    ※ 商品の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 商品は1リクエストにつき100件まで更新できます。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    products
    required
    Array of objects (商品情報)
    callbackUrl
    required
    string (商品更新完了通知URL) <= 511 characters

    商品の更新が完了した際に、更新結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 商品IDがリクエスト内で重複している場合
    • 商品コードがリクエスト内で重複している場合
    • 商品価格の店舗IDと価格区分と適応開始日の組み合わせが重複している場合
    • 商品自由項目の商品自由項目番号がリクエスト内で重複している場合
    • 商品取扱店舗の店舗IDがリクエスト内で重複している場合
    • 在庫引当商品の在庫引当商品IDがリクエスト内で重複している場合
    • 商品属性項目の項目番号が重複している場合
    • リクエスト上限数が超えている場合
    • 商品情報が1件も送られてこなかった場合
    • 回数券を利用できない契約で、商品区分に回数券を指定した場合
    • 商品区分が「0:通常」以外を指定して、設定方法が「全店舗共通」の商品オプショングループIDを指定した場合(将来的に「店舗ごと」の商品オプショングループIDを指定した場合と同じメッセージ内容で統合となる予定です)
    • 商品区分が「0:通常」以外を指定して、設定方法が「店舗ごと」の商品オプショングループIDを指定した場合
    • 設定方法が「全店舗共通」のオプショングループIDと「店舗ごと」のオプショングループIDがともに指定された場合
    • 軽減税率時の会員単価が指定されているが、標準時の会員単価が指定されていない場合
    • 商品価格の商品単価か適用終了日のいずれも指定していない場合
    • 商品価格の適用開始日を適用終了日よりも未来を指定した場合
    • 発注設定の店舗別発注設定の店舗IDが重複している場合
    • 発注状態または発注不可理由を設定していて、どちらかが未設定の場合
    • 発注設定の発注状態に「1:発注可」を設定していて、発注不可理由にnull以外を設定している場合
    • 発注設定の発注単位区分に「1:単位あり」を設定していて、発注単位名または発注数を設定していない場合
    • 発注設定の発注単位区分に「0:単位なし」を設定していて、発注単位名または発注数にnullを設定していない場合
    • リクエスト内の全ての商品情報で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての商品価格で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての商品取扱店舗で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての商品自由項目で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての在庫引当商品で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての商品属性項目で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての発注設定で指定しているフィールドが揃っていない場合
    • リクエスト内の全ての店舗別発注設定で指定しているフィールドが揃っていない場合
    patch /products/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "products":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    商品取得

    商品情報を取得します。

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

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    query Parameters
    fields
    array

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

    with_prices
    string
    Default: "none"
    Enum: "all" "none"

    商品価格情報を付加するか(付加する場合はall, しない場合はnone)

    with_reserve_items
    string
    Default: "none"
    Enum: "all" "none"

    商品自由項目情報を付加するか(付加する場合はall, しない場合はnone)

    with_stores
    string
    Default: "none"
    Enum: "all" "none"

    店舗情報を付加するか(付加する場合はall, しない場合はnone)

    with_inventory_reservations
    string
    Default: "none"
    Enum: "all" "none"

    在庫引当情報を付加するか(付加する場合はall, しない場合はnone)

    with_attribute_items
    string
    Default: "none"
    Enum: "all" "none"

    商品属性項目情報を付加するか(付加する場合はall, しない場合はnone)

    with_order_setting
    string
    Default: "none"
    Enum: "all" "none"

    発注設定情報を付加するか(付加する場合はall, しない場合はnone)

    Responses

    200

    取得成功

    get /products/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productId": "string",
    • "categoryId": "string",
    • "productCode": "string",
    • "productName": "string",
    • "productKana": "string",
    • "taxDivision": "string",
    • "productPriceDivision": "string",
    • "price": "string",
    • "customerPrice": "string",
    • "cost": "string",
    • "attribute": "string",
    • "description": "string",
    • "catchCopy": "string",
    • "size": "string",
    • "color": "string",
    • "tag": "string",
    • "groupCode": "string",
    • "url": "string",
    • "printReceiptProductName": "string",
    • "displaySequence": "string",
    • "salesDivision": "string",
    • "stockControlDivision": "string",
    • "displayFlag": "string",
    • "division": "string",
    • "productOptionGroupId": "string",
    • "pointNotApplicable": "string",
    • "taxFreeDivision": "string",
    • "supplierProductNo": "string",
    • "calcDiscount": "string",
    • "staffDiscountRate": "string",
    • "useCategoryReduceTax": "string",
    • "reduceTaxId": "string",
    • "reduceTaxPrice": "string",
    • "reduceTaxCustomerPrice": "string",
    • "orderPoint": "string",
    • "purchaseCost": "string",
    • "appStartDateTime": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "reserveItems":
      [
      ],
    • "prices":
      [
      ],
    • "stores":
      [
      ],
    • "inventoryReservations":
      [
      ],
    • "attributeItems":
      [
      ],
    • "orderSetting":
      {
      }
    }

    商品更新

    商品情報を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Request Body schema: application/json
    categoryId
    string <int> (部門ID)

    部門毎に付与するID

    productCode
    string (商品コード) <= 20 characters ^[ -~]+$

    ユニーク値

    productName
    string (商品名) <= 85 characters
    productKana
    string (商品カナ) <= 85 characters
    taxDivision
    string (税区分)
    Default: 1
    Enum: 0 1 2

    商品単価の税区分 (0:税込、1:税抜、2:非課税)

    productPriceDivision
    string (商品価格区分)
    Default: 1
    Enum: 1 2

    商品をオープン価格販売するかどうかの設定
    (1:通常価格、2:オープン価格)

    price
    string <int> (商品単価) [ -99999999 .. 99999999 ]

    商品単価

    customerPrice
    string <int> (会員価格) [ -99999999 .. 99999999 ]
    cost
    string <decimal> (原価) [ -99999999.99999 .. 99999999.99999 ]
    attribute
    string (規格) <= 1000 characters

    商品属性

    description
    string (説明) <= 1000 characters

    商品の説明

    catchCopy
    string (キャッチコピー) <= 1000 characters

    商品のキャッチコピー

    size
    string (サイズ) <= 85 characters

    サイズの和名を設定

    color
    string (カラー) <= 85 characters

    色の和名を設定

    tag
    string (タグ) <= 85 characters

    タグの和名を設定

    groupCode
    string (グループコード) <= 85 characters

    グルーピングする為の一意のキー (親の商品IDになる)

    url
    string (URL) <= 255 characters

    スマレジ端末でWEBページを表示する場合設定

    printReceiptProductName
    string (レシート印字商品名) <= 64 characters

    レシートに印字する商品名。(64文字以内)

    displaySequence
    string <int> (表示順) [ 0 .. 999999999 ]

    表示順序

    displayFlag
    string (端末表示)
    Default: 1
    Enum: 0 1

    端末で表示するか判定
    (0:表示しない、1:表示する)

    division
    string (商品区分)
    Default: 0
    Enum: 0 1 2

    商品区分(0:通常、1:回数券、2:オプション)
    ※回数券 は回数券機能が利用可能な契約のみ指定可能。ご利用できない契約で指定された場合エラー。
    ※(注)既にオプショングループ設定方法が「店舗ごと」のオプショングループが設定されている商品に対して、このフィールドを0以外に指定することは非推奨です。将来的にそのようなケースは入力チェックでエラーとなる可能性がございます。(同じリクエストにおいてすべての商品取扱店舗に対してオプショングループIDをnullに指定される場合は問題ございません。)

    productOptionGroupId
    string <int> (オプショングループID) [ 1 .. 999999999 ]

    商品オプショングループのID(商品区分が0:通常の場合のみ設定可能)。オプショングループの設定方法が「全店舗共通」の場合、適用可能なオプショングループのIDをこちらに設定します。
    nullの場合は未設定として更新します。
    (注)既にオプショングループ設定方法が「店舗ごと」のオプショングループが設定されている商品に対して、このフィールドをnull以外で指定することは非推奨です。将来的にそのようなケースは入力チェックでエラーとなる予定です。(同じリクエストにおいてすべての商品取扱店舗に対してオプショングループIDをnullに指定される場合は問題ございません。) なお、「店舗ごと」のオプショングループが設定されている商品に対して「全店舗共通」のオプショングループを設定してしまった場合、更新前と変わらず店舗ごと設定のオプショングループ設定がそのまま適用されますが、プラットフォームAPIにおけるレスポンスデータの本フィールドにおいては、更新時に指定された全店舗共通のproductOptionGroupIdが取得されるようになりますのでご注意下さい。

    salesDivision
    string (売上区分)
    Default: 0
    Enum: 0 1

    (0:売上対象、1:売上対象外)

    stockControlDivision
    string (在庫管理区分)
    Default: 0
    Enum: 0 1

    (0:在庫管理対象、1:在庫管理対象外)

    pointNotApplicable
    string (ポイント対象区分)
    Default: 0
    Enum: 0 1

    (0:ポイント対象、1:ポイント対象外)

    taxFreeDivision
    string (免税区分)
    Default: 0
    Enum: 0 1 2

    (0:対象外、1:一般品、2:消耗品)

    calcDiscount
    string (値引割引計算対象)
    Default: 1
    Enum: 0 1

    小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを識別する。
    (0:対象外、1:対象)

    staffDiscountRate
    string <int> (社員販売割引率) [ 0 .. 100 ]

    社員販売時の割引率

    useCategoryReduceTax
    string (部門税設定参照フラグ)
    Default: 1
    Enum: 0 1

    軽減税率個別設定フラグ(0:reduceTaxIdを使用、1:部門の税設定を使用)
    画面項目「部門の税設定を使用」

    reduceTaxId
    string <int> (軽減税率ID) [ 0 .. 999999999 ]

    軽減税率ID
    標準:null
    軽減:10000001 (特定商品の軽減税率適用)
    選択[標準]:10000002(状態による適用[適用しない])
    選択[軽減]:10000003(状態による適用[適用する])
    選択[選択]:10000004(状態による適用[都度選択する])
    上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

    ※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
    ※存在しない軽減税率IDを指定した場合エラー。

    reduceTaxPrice
    string <int> (軽減税率用商品単価) [ -99999999 .. 99999999 ]
    reduceTaxCustomerPrice
    string <int> (軽減税率用商品会員単価) [ -99999999 .. 99999999 ]
    orderPoint
    string <int> (発注点) [ 0 .. 999999999 ]

    発注をかけるべき在庫数

    purchaseCost
    string <decimal> (仕入原価) [ -99999999.99999 .. 99999999.99999 ]

    商品の仕入原価

    supplierProductNo
    string (品番) <= 85 characters

    メーカー品番  【在庫PKG用】

    appStartDateTime
    string <date-time> (適用開始日時)

    端末に適用を開始する日時[YYYY-MM-DDThh:mm:ssTZD]

    prices
    Array of objects (商品価格)

    商品価格

    reserveItems
    Array of objects (商品自由項目)

    商品自由項目

    stores
    Array of objects (商品取扱店舗)

    商品取扱店舗

    inventoryReservations
    Array of objects (在庫引当商品)

    在庫引当商品

    attributeItems
    Array of objects (商品属性項目)

    商品属性項目

    orderSetting
    object (発注設定)

    発注設定が存在しない場合default値で登録されます。

    Responses

    200

    更新成功

    400
    • 入力チェックエラーの場合
    • 商品コードが重複している場合
    • 商品価格の店舗IDと価格区分の組み合わせが重複している場合
    • 商品自由項目の商品自由項目番号が重複している場合
    • 商品取扱店舗の店舗IDが重複している場合
    • 在庫引当商品の在庫引当商品IDが重複している場合
    • 回数券の内容になっている商品の区分を回数券に設定する場合
    • 指定されたオプショングループIDが存在しない場合
    • 商品区分が「0:通常」でない商品に対してオプショングループIDが設定された場合(店舗ごとのオプショングループが既に設定されている商品の商品区分を「通常」に設定しようとするケースは現状エラーではありませんが、将来的にエラーとする可能性がございます)
    • 設定方法が「全店舗共通」のオプショングループIDと「店舗ごと」のオプショングループIDがともに設定された場合(店舗ごとのオプショングループが既に設定されている商品に全店舗共通のオプショングループを設定しようとするケースは現状エラーではありませんが、将来的にエラーとする予定です)
    • 店舗区分が「倉庫」の店舗に対して設定方法が「店舗ごと」のオプショングループIDが設定された場合
    • 商品属性項目の項目番号とコードの組み合わせが存在しない場合
    • 商品属性項目の項目番号がリクエスト内で重複している場合
    • 発注設定の店舗別発注設定の店舗IDが重複している場合
    • 発注設定の継続区分に存在しないコードを設定している場合
    • 発注状態または発注不可理由を設定していて、どちらかが未設定の場合
    • 発注設定の発注状態に「1:発注可」を設定していて、発注不可理由にnull以外を設定している場合
    • 発注設定の発注状態に「0:発注不可」を設定していて、発注不可理由に存在しないコードを設定している場合
    • 発注設定の発注単位区分に「1:単位あり」を設定していて、発注単位名または発注数を設定していない場合
    • 発注設定の発注単位区分に「0:単位なし」を設定していて、発注単位名または発注数にnullを設定していない場合
    404

    指定した商品データが存在しない場合

    patch /products/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "categoryId": "string",
    • "productCode": "string",
    • "productName": "string",
    • "productKana": "string",
    • "taxDivision": 1,
    • "productPriceDivision": 1,
    • "price": "string",
    • "customerPrice": "string",
    • "cost": "string",
    • "attribute": "string",
    • "description": "string",
    • "catchCopy": "string",
    • "size": "string",
    • "color": "string",
    • "tag": "string",
    • "groupCode": "string",
    • "url": "string",
    • "printReceiptProductName": "string",
    • "displaySequence": "string",
    • "displayFlag": 1,
    • "division": 0,
    • "productOptionGroupId": "string",
    • "salesDivision": 0,
    • "stockControlDivision": 0,
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 1,
    • "staffDiscountRate": "string",
    • "useCategoryReduceTax": 1,
    • "reduceTaxId": "string",
    • "reduceTaxPrice": "string",
    • "reduceTaxCustomerPrice": "string",
    • "orderPoint": "string",
    • "purchaseCost": "string",
    • "supplierProductNo": "string",
    • "appStartDateTime": "2023-12-01T10:09:41Z",
    • "prices":
      [
      ],
    • "reserveItems":
      [
      ],
    • "stores":
      [
      ],
    • "inventoryReservations":
      [
      ],
    • "attributeItems":
      [
      ],
    • "orderSetting":
      {
      }
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productId": "string",
    • "categoryId": "string",
    • "productCode": "string",
    • "productName": "string",
    • "productKana": "string",
    • "taxDivision": 0,
    • "productPriceDivision": 1,
    • "price": "string",
    • "customerPrice": "string",
    • "cost": "string",
    • "attribute": "string",
    • "description": "string",
    • "catchCopy": "string",
    • "size": "string",
    • "color": "string",
    • "tag": "string",
    • "groupCode": "string",
    • "url": "string",
    • "printReceiptProductName": "string",
    • "displaySequence": "string",
    • "displayFlag": 0,
    • "division": 0,
    • "productOptionGroupId": "string",
    • "salesDivision": 0,
    • "stockControlDivision": 0,
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 0,
    • "staffDiscountRate": "string",
    • "useCategoryReduceTax": 0,
    • "reduceTaxId": "string",
    • "reduceTaxPrice": "string",
    • "reduceTaxCustomerPrice": "string",
    • "orderPoint": "string",
    • "purchaseCost": "string",
    • "supplierProductNo": "string",
    • "appStartDateTime": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "prices":
      [
      ],
    • "reserveItems":
      [
      ],
    • "stores":
      [
      ],
    • "inventoryReservations":
      [
      ],
    • "attributeItems":
      [
      ],
    • "orderSetting":
      {
      }
    }

    商品削除

    商品情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    削除成功

    404

    指定した商品データが存在しない場合

    delete /products/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    商品価格一覧取得

    商品価格情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■storeId:店舗ID
    ■priceDivision:価格区分
    ■startDate:適用開始日
    ■endDate:適用終了日

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    store_id
    integer

    店舗ID (全店を指定する場合 -1)

    price_division
    string
    Enum: 1 2

    価格区分 (1:商品単価、2:会員単価)

    Responses

    200

    取得成功

    get /products/{id}/prices

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/prices

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/prices

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品価格削除

    商品価格を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    product_id
    required
    string

    商品毎に付与するID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    price_division
    required
    string

    価格区分(1:商品単価、2:会員価格)

    store_id
    required
    string

    店舗ID (全店の場合、-1を設定)

    start_date
    required
    string

    適用開始日:[YYYY-MM-DD]

    Responses

    200

    削除成功

    400
    • URIの適用開始日がYYYY-MM-DD形式でなかった場合
    404
    • URIで指定された商品が存在しなかった場合
    • URIで指定された店舗が存在しなかった場合
    • URIで指定されたパラメータの組み合わせが存在しなかった場合
    delete /products/{product_id}/prices/{price_division}/{store_id}/{start_date}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{product_id}/prices/{price_division}/{store_id}/{start_date}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{product_id}/prices/{price_division}/{store_id}/{start_date}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "適用開始日は\"YYYY-MM-DD\"形式を指定してください",
    • "status": 400
    }

    商品価格変更履歴一覧取得

    商品価格変更履歴の一覧を取得します。


    sortで使用可能なパラメータ
    ■updDateTime:更新日時
    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    price_division
    string

    価格区分:(1:商品単価、2:会員価格、3:原価、4:商品単価詳細、5:会員価格詳細)

    Responses

    200

    取得成功

    400

    価格区分が[1, 2, 3, 4, 5]の何れかの値ではない場合

    404

    指定した商品IDが存在しない場合

    get /products/{id}/prices/changes

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/prices/changes

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/prices/changes

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品自由項目一覧取得

    商品自由項目情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■no:商品自由項目番号

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    Responses

    200

    取得成功

    get /products/{id}/reserve_items

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/reserve_items

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/reserve_items

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品自由項目削除

    商品自由項目情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    product_id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    no
    required
    string

    商品自由項目番号

    Responses

    200

    削除成功

    404
    • URI指定された商品IDが存在しなかった場合
    • URI指定の商品IDと商品自由項目番号の組み合わせが存在しなかった場合
    delete /products/{product_id}/reserve_items/{no}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{product_id}/reserve_items/{no}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{product_id}/reserve_items/{no}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    商品属性一覧取得

    商品属性一覧を取得します。


    sortで使用可能なパラメータ
    ■項目番号:商品属性に付与されている連番
    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    Responses

    200

    取得成功

    get /products/attributes

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attributes

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attributes

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品属性更新

    商品属性を更新します。
    URI指定した項目番号が存在しなければ登録処理、存在すれば更新処理を行います。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    no
    required
    string [ 1 .. 3 ]

    項目番号

    Request Body schema: application/json
    name
    required
    string <string> (属性名) <= 15 characters

    商品属性の名称

    Responses

    200

    取得成功

    400
    • URI指定の項目番号が1未満である場合
    • URI指定の項目番号が4以上である場合
    • URI指定の項目番号が文字列である場合
    put /products/attributes/{no}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attributes/{no}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attributes/{no}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "no": "string",
    • "name": "string"
    }

    商品属性削除

    商品属性を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    no
    required
    string [ 1 .. 3 ]

    項目番号

    Responses

    200

    削除成功

    400
    • 指定した商品属性に紐づく商品属性項目が存在する場合
    • 指定した商品属性が売上比較(商品属性別)の集計パターンに利用されている場合
    • URI指定の項目番号が1未満である場合
    • URI指定の項目番号が4以上である場合
    • URI指定の項目番号が文字列である場合
    404
    • URI指定された項目番号が存在しなかった場合
    delete /products/attributes/{no}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attributes/{no}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attributes/{no}

    Response samples

    Content type
    application/json
    Example
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "指定された商品属性に紐づく商品属性項目が存在するため削除できません",
    • "status": 400
    }

    商品属性項目一覧取得

    商品属性項目一覧を取得します。


    sortで使用可能なパラメータ
    ■項目番号:商品属性に付与されている連番
    ■コード:商品属性項目を一意にする項目
    ■表示順:表示順序
    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    code
    string

    コード:商品属性項目を一意にする項目

    no
    integer [ 1 .. 3 ]

    項目番号:商品属性に付与されている連番

    Responses

    200

    取得成功

    get /products/attribute_items

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attribute_items

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attribute_items

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品属性項目登録

    商品属性項目を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    no
    required
    string <int> (項目番号) [ 1 .. 3 ]

    商品属性に付与されている連番

    name
    required
    string <string> (選択肢名) <= 30 characters

    商品属性項目の名称

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順序

    Responses

    200

    取得成功

    400
    • 項目番号で指定された商品属性が存在しなかった場合
    • 上限を超えて登録しようとした場合
    post /products/attribute_items

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attribute_items

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attribute_items

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "no": "string",
    • "name": "string",
    • "displaySequence": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "code": "string",
    • "no": "string",
    • "name": "string",
    • "displaySequence": "string"
    }

    商品属性項目更新

    商品属性項目を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    code
    required
    string

    コード

    Request Body schema: application/json
    name
    required
    string <string> (選択肢名) <= 30 characters

    商品属性項目の名称

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順序

    Responses

    200

    取得成功

    404
    • URI指定された商品属性項目が存在しなかった場合
    patch /products/attribute_items/{code}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attribute_items/{code}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attribute_items/{code}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "name": "string",
    • "displaySequence": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "code": "string",
    • "no": "string",
    • "name": "string",
    • "displaySequence": "string"
    }

    商品属性項目削除

    商品属性項目を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    code
    required
    string

    コード

    Responses

    200

    削除成功

    404
    • URI指定された商品属性項目が存在しなかった場合
    delete /products/attribute_items/{code}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/attribute_items/{code}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/attribute_items/{code}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    商品取扱店舗一覧取得

    商品取扱店舗情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■storeId:店舗ID

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    store_id
    integer

    店舗ID

    assign_division
    string
    Enum: 0 1

    取扱区分 (0:販売する、1:販売しない)

    Responses

    200

    取得成功

    get /products/{id}/stores

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/stores

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/stores

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    店舗取扱商品一覧取得

    指定した店舗が取り扱っている商品一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■productId:商品ID
    ■categoryId:部門ID
    ■productCode:商品コード
    ■groupCode:グループコード
    ■displaySequence:表示順
    ■updDateTime:更新日時

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    store_id
    required
    string

    店舗ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    category_id
    string

    部門ID

    product_code
    string

    商品コード

    group_code
    string

    グループコード

    display_flag
    string

    端末表示 (0:表示しない、1:表示する)

    division
    string

    商品区分(0:通常、1:セット、2:オプション)

    sales_division
    string

    売上区分(0:売上対象、1:売上対象外)

    stock_control_division
    string
    Enum: 0 1

    在庫管理区分:(0:在庫管理対象、1:在庫管理対象外)

    supplier_product_no
    string

    品番

    with_stores
    string
    Default: "none"
    Enum: "all" "none"

    店舗情報を付加するか(付加する場合はall, しない場合はnone)
    "all" を指定した場合、store_idに指定したIDの店舗情報を1件のみ取得します。

    Responses

    200

    取得成功

    get /stores/{store_id}/products

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/stores/{store_id}/products

    本番

    https://api.smaregi.jp/{契約ID}/pos/stores/{store_id}/products

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    在庫引当商品一覧取得

    在庫引当商品情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■reservationProductId:引当商品商品ID

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    Responses

    200

    取得成功

    get /products/{id}/inventory_reservations

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/inventory_reservations

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/inventory_reservations

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    在庫引当商品削除

    在庫引当商品を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合でも、ユーザーの所属する店舗で販売しているかに関わらず商品IDを指定できます。

    reservation_product_id
    required
    string

    在庫引当商品ID

    Responses

    200

    削除成功

    404
    • 指定された商品が存在しなかった場合
    • 指定された在庫引当商品が存在しなかった場合
    • URIで指定されたパラメータの組み合わせが存在しなかった場合
    delete /products/{id}/inventory_reservations/{reservation_product_id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/inventory_reservations/{reservation_product_id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/inventory_reservations/{reservation_product_id}

    Response samples

    Content type
    application/json
    Example
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定された商品IDのリソースが見つかりません",
    • "status": 404
    }

    商品自由項目ラベル一覧取得

    商品自由項目ラベル情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■no:商品自由項目番号

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    Responses

    200

    取得成功

    get /products/reserve_item_labels

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/reserve_item_labels

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/reserve_item_labels

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品自由項目ラベル更新

    商品自由項目ラベル情報を登録または更新します。
    URI指定した商品自由項目番号が存在しなければ登録処理、存在すれば更新処理を行います。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    no
    required
    string

    商品自由項目番号

    Request Body schema: application/json
    label
    required
    string (ラベル) <= 85 characters

    Responses

    200

    取得成功

    400
    • URI指定の商品自由項目番号が1未満である場合
    • URI指定の商品自由項目番号が100以上である場合
    • URI指定の商品自由項目番号が文字列である場合
    put /products/reserve_item_labels/{no}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/reserve_item_labels/{no}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/reserve_item_labels/{no}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "label": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "no": "string",
    • "label": "string"
    }

    商品自由項目ラベル削除

    商品自由項目ラベル情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    no
    required
    string

    商品自由項目番号

    Responses

    200

    削除成功

    400
    • 自由項目ラベルが使用中の場合
    404
    • URI指定の自由項目ラベルが存在しない場合
    delete /products/reserve_item_labels/{no}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/reserve_item_labels/{no}

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/reserve_item_labels/{no}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "指定された項目番号は使用中です",
    • "status": 400
    }

    商品画像一覧取得

    商品の画像URLを一覧を取得します。

    sortで使用可能なパラメータ
    ■productId:商品ID
    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    product_id
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    取得成功

    get /products/images

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/images

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/images

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    商品画像登録

    商品画像を登録を受付します。すでに商品画像が存在しているときは上書きします。
    ※ 商品画像の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Request Body schema: application/json
    imageUrl
    required
    string (商品画像URL) <= 511 characters

    設定したい商品画像のURL
    弊社システムから本項目に指定されたURLにアクセスして取得しますので、アクセス可能なURLを指定してください。
    画像サイズは最大10MB、対応フォーマットは、JPEG,PNG,GIFです。

    callbackUrl
    string (画像登録完了通知URL) <= 511 characters

    画像の登録が完了した際に、登録結果をWebhook通知するURL

    state
    string (完了通知ステートメント) <= 20 characters

    画像登録完了通知URLに完了通知する際に設定できる任意の文字列
    クエリパラメータとして同時に通知されます

    リクエスト例(stateにxxxx1234を指定した場合):
    成功例
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    proc_name=callback_product_image_check&state=xxxx1234&params=[
      {
        "id": "1",
        "requestId": "700",
        "productId": "113",
        "imageUrl": "https://www.example.com/sample.png",
        "thumbnailImageUrl": "https://www.example.com/xxxxxx.png"
      }
    ]

    失敗例
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    proc_name=callback_product_image_update_and_notification&state=xxxx1234&params=[
      {
        "id": "1",
        "requestId": "700",
        "productId": "113",
        "imageUrl": "https://www.example.com/sample.png",
        "errorMessage": "画像ダウンロードに失敗:https://www.example.com/sample.png"
      }
    ]

    Responses

    200

    取得成功

    400
    • imageUrlで指定されたUrlのフォーマットが正しくない場合
    • imageUrlで指定されたUrlの画像が最大容量を超えていた場合
    404
    • 指定した商品データが存在しない場合
    put /products/{id}/image

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/image

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/image

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "imageUrl": "string",
    • "callbackUrl": "string",
    • "state": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productId": "string",
    • "callbackUrl": "string",
    • "state": "string"
    }

    商品画像削除

    商品画像を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    削除成功

    404
    • URI指定の商品が存在しない場合
    delete /products/{id}/image

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/image

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/image

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定された商品IDのリソースが見つかりません",
    • "status": 404
    }

    商品アイコン画像登録

    商品アイコン画像の登録を受付します。すでに商品アイコン画像が存在しているときは上書きします。
    ※ 商品アイコン画像の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Request Body schema: application/json
    imageUrl
    required
    string (商品アイコン画像URL) <= 511 characters

    設定したい商品アイコン画像のURL
    弊社システムから本項目に指定されたURLにアクセスして取得しますので、アクセス可能なURLを指定してください。
    画像サイズは最大10MB、対応フォーマットは、JPEG,PNG,GIFです。

    callbackUrl
    string (画像登録完了通知URL) <= 511 characters

    画像の登録が完了した際に、登録結果をWebhook通知するURL

    state
    string (完了通知ステートメント) <= 20 characters

    画像登録完了通知URLに完了通知する際に設定できる任意の文字列
    クエリパラメータとして同時に通知されます

    リクエスト例(stateにxxxx1234を指定した場合):
    成功例
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    proc_name=callback_product_icon_image_check&state=xxxx1234&params=[
      {
        "id": "1",
        "requestId": "700",
        "productId": "113",
        "imageUrl": "https://www.example.com/sample.png",
        "thumbnailImageUrl": "https://www.example.com/xxxxxx.png"
      }
    ]

    失敗例
      Content-Type: application/x-www-form-urlencoded;charset=UTF-8
    proc_name=callback_product_image_update_and_notification&state=xxxx1234&params=[
      {
        "id": "1",
        "requestId": "700",
        "productId": "113",
        "imageUrl": "https://www.example.com/sample.png",
        "errorMessage": "画像ダウンロードに失敗:https://www.example.com/sample.png"
      }
    ]

    Responses

    200

    取得成功

    400
    • imageUrlで指定されたUrlのフォーマットが正しくない場合
    • imageUrlで指定されたUrlの画像が最大容量を超えていた場合
    404
    • 指定した商品データが存在しない場合
    put /products/{id}/icon_image

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/icon_image

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/icon_image

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "imageUrl": "string",
    • "callbackUrl": "string",
    • "state": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productId": "string",
    • "callbackUrl": "string",
    • "state": "string"
    }

    商品アイコン画像削除

    商品アイコン画像を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    削除成功

    404
    • URI指定の商品が存在しない場合
    delete /products/{id}/icon_image

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/products/{id}/icon_image

    本番

    https://api.smaregi.jp/{契約ID}/pos/products/{id}/icon_image

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    セール

    セール一覧取得

    セール情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■bargainId:セールID:
    ■termStart:適用開始日時:[YYYY-MM-DD]
    ■termEnd:適用終了日時:[YYYY-MM-DD]

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    bargain_id
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    bargain_product_id
    string

    セール商品ID:
    セールID、対象区分、対象ID の3つの値によって定まる一意なID
    ※ 対象区分(部門、商品、グループ)・対象ID(部門ID、商品ID、グループコード)

    term_start
    string

    適用開始日時:[YYYY-MM-DD]

    term_end
    string

    適用終了日時:[YYYY-MM-DD]

    Responses

    200

    取得成功

    get /bargain

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    セール登録

    セール情報を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    bargainName
    required
    string (セール名) <= 85 characters

    セール名称

    termStart
    required
    string <date> (セール開始日)

    [YYYY-MM-DD] セールの開始日

    termEnd
    required
    string <date> (セール終了日)

    [YYYY-MM-DD] セールの終了日

    Responses

    200

    取得成功

    400
    • セール終了日が開始日以前の場合
    post /bargain

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainName": "string",
    • "termStart": "2023-12-01",
    • "termEnd": "2023-12-01"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainId": "string",
    • "bargainName": "string",
    • "termStart": "string",
    • "termEnd": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール更新

    セール情報を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    Request Body schema: application/json
    bargainName
    string (セール名) <= 85 characters

    セール名称

    termStart
    string <date> (セール開始日)

    [YYYY-MM-DD] セールの開始日

    termEnd
    string <date> (セール終了日)

    [YYYY-MM-DD] セールの終了日

    Responses

    200

    取得成功

    400
    • セール終了日が開始日以前の場合
    patch /bargain/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainName": "string",
    • "termStart": "2023-12-01",
    • "termEnd": "2023-12-01"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainId": "string",
    • "bargainName": "string",
    • "termStart": "string",
    • "termEnd": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール削除

    セール情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    Responses

    200

    削除成功

    404

    指定したセールデータが存在しない場合

    delete /bargain/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    セール店舗一覧取得

    セール店舗情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■storeId:店舗ID:

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    store_id
    string

    店舗ID:

    Responses

    200

    取得成功

    get /bargain/{id}/stores

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/stores

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/stores

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    セール店舗登録

    セール店舗情報を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    Request Body schema: application/json
    storeId
    required
    string <int> (店舗ID) [ 1 .. 999999999 ]

    対象の店舗ID

    Responses

    200

    取得成功

    400
    • 指定された店舗が登録済みの場合
    post /bargain/{id}/stores

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/stores

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/stores

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "storeId": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainStoreId": "string",
    • "bargainId": "string",
    • "storeId": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール店舗更新

    セール店舗情報を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    bargainStoreId
    required
    string

    セール店舗ID

    Request Body schema: application/json
    storeId
    string <int> (店舗ID) [ 1 .. 999999999 ]

    対象の店舗ID

    Responses

    200

    取得成功

    400
    • 指定された店舗が登録済みの場合
    patch /bargain/{id}/stores/{bargainStoreId}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/stores/{bargainStoreId}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/stores/{bargainStoreId}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "storeId": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainStoreId": "string",
    • "bargainId": "string",
    • "storeId": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール店舗削除

    セール店舗情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    bargainStoreId
    required
    string

    セール店舗ID

    Responses

    200

    削除成功

    404

    指定したセール店舗データが存在しない場合

    delete /bargain/{id}/stores/{bargainStoreId}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/stores/{bargainStoreId}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/stores/{bargainStoreId}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    セール商品一覧取得

    セール商品情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■targetDivision:対象区分:(1:部門、2:商品、3:グループコード)
    ■targetId:対象ID:部門ID, 商品ID, グループコードのいずれかを設定

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    target_division
    string
    Enum: 1 2 3

    対象区分:(1:部門、2:商品、3:グループコード)

    target_id
    string

    対象ID:部門ID, 商品ID, グループコードのいずれかを設定
    ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    取得成功

    get /bargain/{id}/products

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/products

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/products

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    セール商品登録

    セール商品情報を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    Request Body schema: application/json
    targetDivision
    required
    string (対象区分)
    Enum: 1 2 3

    1:カテゴリー, 2:商品, 3:グループコード

    targetId
    required
    string (対象ID) <= 255 characters

    カテゴリーID, 商品ID, グループコードのいずれか
    ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    division
    required
    string (割引区分)
    Enum: 1 2 3

    1:割引 2:値引 3:価格指定

    value
    required
    string <int> () <= 9999999999

    割引、値引き、価格指定の値

    Responses

    200

    取得成功

    400
    • targetDivision=1かつtargetIdに一致する部門が存在しない場合
    • targetDivision=2かつtargetIdに一致する商品が存在しない場合
    • targetDivision=3かつtargetIdに一致するグループコードの商品が存在しない場合
    • 同一データの重複している場合
    • 割引率のチェックエラー
    post /bargain/{id}/products

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/products

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/products

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "targetDivision": 1,
    • "targetId": "string",
    • "division": 1,
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainProductId": "string",
    • "bargainId": "string",
    • "targetDivision": "string",
    • "targetId": "string",
    • "division": "string",
    • "value": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール商品更新

    セール商品情報を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    bargainProductId
    required
    string

    セール商品ID:セールID、対象区分、対象ID の3つの値によって定まる一意なID

    Request Body schema: application/json
    targetDivision
    string (対象区分)
    Enum: 1 2 3

    1:カテゴリー, 2:商品, 3:グループコード

    targetId
    string (対象ID) <= 255 characters

    カテゴリーID, 商品ID, グループコードのいずれか
    ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    division
    string (割引区分)
    Enum: 1 2 3

    1:割引 2:値引 3:価格指定

    value
    string <int> () <= 9999999999

    割引、値引き、価格指定の値

    Responses

    200

    取得成功

    400
    • 指定されたidとbargainProductIdの組み合わせがおかしい場合
    • targetDivision=1かつtargetIdに一致する部門が存在しない場合
    • targetDivision=2かつtargetIdに一致する商品が存在しない場合
    • targetDivision=3かつtargetIdに一致するグループコードの商品が存在しない場合
    • 同一データの重複している場合
    • 割引率のチェックエラー
    patch /bargain/{id}/products/{bargainProductId}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/products/{bargainProductId}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/products/{bargainProductId}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "targetDivision": 1,
    • "targetId": "string",
    • "division": 1,
    • "value": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "bargainProductId": "string",
    • "bargainId": "string",
    • "targetDivision": "string",
    • "targetId": "string",
    • "division": "string",
    • "value": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    セール商品削除

    セール商品情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    セールID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で実施されるセールIDを指定してください。

    bargainProductId
    required
    string

    セール商品ID:セールID、対象区分、対象ID の3つの値によって定まる一意なID

    Responses

    200

    削除成功

    404

    指定したセール商品データが存在しない場合

    delete /bargain/{id}/products/{bargainProductId}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bargain/{id}/products/{bargainProductId}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bargain/{id}/products/{bargainProductId}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    オプショングループ

    オプショングループ一覧取得

    オプショングループの一覧を取得します。


    sortで使用可能なパラメータ
    ■productOptionGroupId:商品オプショングループID
    ■conditionId:条件ID
    ■updDateTime:更新日時
    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    product_option_group_name
    string

    オプショングループ名

    condition_id
    string

    条件ID:(0:条件なし、1:全体、2:部門毎)

    Responses

    200

    取得成功

    get /product_option_groups

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    オプショングループ登録

    オプショングループを登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    productOptionGroupName
    required
    string (オプショングループ名) <= 85 characters

    オプショングループ名

    conditionId
    required
    string (条件ID)
    Enum: 0 1 2

    条件ID。(0:条件なし、1:全体、2:部門毎)

    max
    string <int> (適用条件の上限) [ 1 .. 999 ]

    適用条件の上限:条件IDが 1:全体、2:部門毎 のときは必須。

    min
    string <int> (適用条件の下限) [ 0 .. 999 ]

    適用条件の下限:条件IDが 1:全体、2:部門毎 のときは必須。

    products
    required
    Array of objects (オプショングループ商品)

    オプショングループ商品:オプショングループ1件につき1件以上の登録必須。

    Responses

    200

    更新成功

    400
    • 下限数が上限数を上回っている場合
    • 条件IDが 1:全体、2:部門毎 のときで、上限数と下限数が設定されていない場合
    • 条件IDが 0:条件なし のときで、上限数か下限数が設定されている場合
    • 指定された商品が存在しない場合
    • 商品が1件も指定されなかった場合
    • 指定された商品がオプション商品でない場合
    • 指定された商品が重複する場合
    • 本部商品が指定された場合
    post /product_option_groups

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productOptionGroupName": "string",
    • "conditionId": 0,
    • "max": "string",
    • "min": "string",
    • "products":
      [
      ]
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productOptionGroupId": "string",
    • "productOptionGroupName": "string",
    • "conditionId": "string",
    • "max": "string",
    • "min": "string",
    • "syncDivision": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "products":
      {
      }
    }

    オプショングループ取得

    指定されたオプショングループを取得します。

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

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    オプショングループID

    query Parameters
    fields
    array

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

    with_products
    string
    Default: "none"
    Enum: "all" "none"

    オプショングループ商品情報を付加するか(付加する場合はall, しない場合はnone)

    Responses

    200

    取得成功

    404
    • 指定されたIDが存在しない場合
    get /product_option_groups/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    オプショングループ更新

    オプショングループを更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    オプショングループID

    Request Body schema: application/json
    productOptionGroupName
    string (オプショングループ名) <= 85 characters

    オプショングループ名

    conditionId
    string (条件ID)
    Enum: 0 1 2

    条件ID:(0:条件なし、1:全体、2:部門毎)

    max
    string <int> (適用条件の上限) [ 1 .. 999 ]

    適用条件の上限:条件IDが 1:全体、2:部門毎 のときは必須。

    min
    string <int> (適用条件の下限) [ 0 .. 999 ]

    適用条件の下限:条件IDが 1:全体、2:部門毎 のときは必須。

    products
    Array of objects (オプショングループ商品)

    オプショングループ商品:指定した商品をオプショングループに追加します。

    Responses

    200

    更新成功

    400
    • 下限数が上限数を上回っている場合
    • 条件IDが 1:全体、2:部門毎 のときで、上限数と下限数が設定されていない場合
    • 条件IDが 0:条件なし のときで、上限数か下限数が設定されている場合
    • 指定された商品が存在しない場合
    • 指定された商品がオプション商品でない場合
    • 指定された商品が重複する場合
    • 本部商品が指定された場合
    404
    • 指定されたIDが存在しない場合
    patch /product_option_groups/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups/{id}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productOptionGroupName": "string",
    • "conditionId": 0,
    • "max": "string",
    • "min": "string",
    • "products":
      [
      ]
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productOptionGroupId": "string",
    • "productOptionGroupName": "string",
    • "conditionId": "string",
    • "max": "string",
    • "min": "string",
    • "syncDivision": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "products":
      {
      }
    }

    オプショングループ削除

    オプショングループを削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    オプショングループID

    Responses

    200

    削除成功

    400
    • 指定されたオプショングループが使用中の場合
    404
    • 指定されたIDが存在しない場合
    delete /product_option_groups/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "指定されたオプショングループは使用中のため、削除できません。",
    • "status": 400
    }

    オプショングループ商品削除

    指定されたオプショングループ商品を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    オプショングループID

    product_id
    required
    string

    商品ID
    ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

    Responses

    200

    削除成功

    400
    • 指定されたオプショングループのオプション商品が1件の場合
    404
    • URIで指定されたオプショングループが存在しない場合
    • URIで指定された商品が存在しない場合
    • URIで指定されたパラメータの組み合わせが存在しない場合
    delete /product_option_groups/{id}/products/{product_id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/product_option_groups/{id}/products/{product_id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/product_option_groups/{id}/products/{product_id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "オプション商品が0件になるため削除できません。",
    • "status": 400
    }

    バンドル販売

    バンドル販売一覧取得

    バンドル販売情報一覧を取得します。

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■productBundleGroupId:商品バンドルグループID
    ■termFrom:適用開始日
    ■termTo:適用終了日

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    product_bundle_group_id
    string

    商品バンドルグループID
    ※ ユーザーアクセストークンを利用する場合でセット売りを指定する場合、ユーザーの所属する店舗で販売している商品のみで構成されるセット売りの商品バンドルグループIDを指定してください。

    term_from
    string

    適用開始日:[YYYY-MM-DD]

    term_to
    string

    適用終了日:[YYYY-MM-DD]

    Responses

    200

    取得成功

    get /bundles

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    バンドル販売登録

    バンドル販売情報を登録します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    productBundleGroupName
    required
    string (商品バンドルグループ名) <= 85 characters

    商品バンドルグループの名称。

    type
    required
    string (種類)
    Enum: 1 2 3 4

    種類:バンドル販売の種類。
    1:バンドル売り+販売金額指定
    2:バンドル売り+値引金額指定
    3:バンドル売り+割引率指定
    4:セット売り+販売金額指定

    taxDivision
    string (税区分)
    Enum: 0 1 2

    税区分 (0:税込、1:税抜、2:非課税)

    reduceTaxId
    string <int> (軽減税率ID)

    軽減税率ID
    標準:null(または未設定)
    軽減:10000001 (特定商品の軽減税率適用)
    選択[標準]:10000002(状態による適用[適用しない])
    選択[軽減]:10000003(状態による適用[適用する])
    選択[選択]:10000004(状態による適用[都度選択する])
    上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

    ※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
    ※存在しない軽減税率IDを指定した場合エラー。

    quantity
    string <int> (数量) [ 1 .. 999 ]

    バンドル販売の条件となる数量。

    value
    required
    string <int> () [ -99999999 .. 999999999 ]

    種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
    ※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

    reduceTaxValue
    string <int> (軽減税率適用時の値) [ -99999999 .. 999999999 ]

    種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
    ※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

    priority
    string <int> (優先順位) [ 0 .. 999 ]

    バンドル販売適用の優先順位。

    termFrom
    required
    string <date> (適用開始日)

    適用開始日 [YYYY-MM-DD]

    termTo
    required
    string <date> (適用終了日)

    適用終了日 [YYYY-MM-DD]

    pointNotApplicable
    string (ポイント対象区分)
    Enum: 0 1

    ポイント対象区分 (0:ポイント対象、1:ポイント対象外)
    ※省略時は 0:ポイント対象 を設定

    taxFreeDivision
    string (免税区分)
    Enum: 0 1 2

    免税区分 (0:対象外、1:一般品、2:消耗品)
    ※省略時は 0:対象外 を設定

    calcDiscount
    string (値引割引計算対象区分)
    Enum: 0 1

    値引割引計算対象区分 (0:対象外、1:対象)
    ※省略時は 1:対象 を設定

    products
    required
    Array of objects (対象商品)

    対象商品:バンドル販売の対象商品
    ※1件以上の登録必須。
    ※部門ID、商品ID、商品グループコードのいずれか必須。(複数指定不可。複数設定された場合はエラー)
    ※種類=4の場合、商品IDのみ設定可能。(部門ID、商品グループコードが設定された場合エラー)

    Responses

    200

    更新成功

    400
    • 適用終了日が適用開始日より前の場合
    • 税区分が非課税の場合に軽減税率IDが設定された場合
    • 税区分が非課税の場合に軽減税率適用時の値が設定された場合
    • 指定された軽減税率IDが存在しない場合
    • 軽減税率IDが選択(10000002-10000004) かつ 税区分が税込 以外の場合に、軽減税率適用時の値が設定された場合
    • 対象商品が設定されていない場合
    • 対象商品に部門ID、商品ID、商品グループコードのいずれも設定されていない場合
    • 対象商品に部門ID、商品ID、商品グループコードのうち複数設定された場合
    • セット販売の場合に、対象商品に部門ID、商品グループコードが設定された場合
    • 指定された部門IDが重複している場合
    • 指定された商品IDが重複している場合
    • 指定された商品グループコードが重複している場合
    • 指定された部門IDが存在しない場合
    • 指定された商品IDが存在しない場合
    • 指定された商品グループコードが設定された商品が存在しない場合
    • 指定された商品IDがオプション商品だった場合
    post /bundles

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productBundleGroupName": "string",
    • "type": 1,
    • "taxDivision": 0,
    • "reduceTaxId": "string",
    • "quantity": "string",
    • "value": "string",
    • "reduceTaxValue": "string",
    • "priority": "string",
    • "termFrom": "2023-12-01",
    • "termTo": "2023-12-01",
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 0,
    • "products":
      [
      ]
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productBundleGroupId": "string",
    • "productBundleGroupName": "string",
    • "type": "string",
    • "taxDivision": "string",
    • "reduceTaxId": "string",
    • "quantity": "string",
    • "value": "string",
    • "reduceTaxValue": "string",
    • "priority": "string",
    • "termFrom": "string",
    • "termTo": "string",
    • "pointNotApplicable": "string",
    • "taxFreeDivision": "string",
    • "calcDiscount": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "products":
      [
      ]
    }

    バンドル販売取得

    バンドル販売情報を取得します。

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

    Authorizations:
    AppAccessToken (pos.products:read) UserAccessToken (pos.products:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品バンドルグループID
    ※ ユーザーアクセストークンを利用する場合でセット売りを指定する場合、ユーザーの所属する店舗で販売している商品のみで構成されるセット売りの商品バンドルグループIDを指定してください。

    query Parameters
    fields
    array

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

    with_products
    string
    Default: "none"
    Enum: "all" "none"

    バンドル販売対象商品情報を付加するか(付加する場合はall, しない場合はnone)

    Responses

    200

    取得成功

    404
    • 指定した商品バンドルグループIDが存在しない場合
    get /bundles/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productBundleGroupId": "string",
    • "productBundleGroupName": "string",
    • "type": "string",
    • "taxDivision": "string",
    • "reduceTaxId": "string",
    • "quantity": "string",
    • "value": "string",
    • "reduceTaxValue": "string",
    • "priority": "string",
    • "termFrom": "string",
    • "termTo": "string",
    • "pointNotApplicable": "string",
    • "taxFreeDivision": "string",
    • "calcDiscount": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "products":
      [
      ]
    }

    バンドル販売更新

    バンドル販売情報を更新します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品バンドルグループID
    ※ ユーザーアクセストークンを利用する場合でセット売りを指定する場合、ユーザーの所属する店舗で販売している商品のみで構成されるセット売りの商品バンドルグループIDを指定してください。

    Request Body schema: application/json
    productBundleGroupName
    string (商品バンドルグループ名) <= 85 characters

    商品バンドルグループの名称。

    type
    string (種類)
    Enum: 1 2 3 4

    種類:バンドル販売の種類。
    1:バンドル売り+販売金額指定
    2:バンドル売り+値引金額指定
    3:バンドル売り+割引率指定
    4:セット売り+販売金額指定
    ※更新元データの種類=1,2,3の場合、1,2,3以外は設定不可。
    ※更新元データの種類=4の場合、4以外は設定不可。

    taxDivision
    string (税区分)
    Enum: 0 1 2

    税区分 (0:税込、1:税抜、2:非課税)

    reduceTaxId
    string <int> (軽減税率ID)

    軽減税率ID
    標準:null
    軽減:10000001 (特定商品の軽減税率適用)
    選択[標準]:10000002(状態による適用[適用しない])
    選択[軽減]:10000003(状態による適用[適用する])
    選択[選択]:10000004(状態による適用[都度選択する])
    上記以外の場合、カスタム軽減税率で登録されている軽減税率ID

    ※10000001〜10000004における軽減税率は日本国における軽減税率(8%)です。
    ※存在しない軽減税率IDを指定した場合エラー。

    quantity
    string <int> (数量) [ 1 .. 999 ]

    バンドル販売の条件となる数量。

    value
    string <int> () [ -99999999 .. 999999999 ]

    種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
    ※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

    reduceTaxValue
    string <int> (軽減税率適用時の値) [ -99999999 .. 999999999 ]

    種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。
    ※割引率の場合は [ 0 .. 100 ] (単位:%)を設定。

    priority
    string <int> (優先順位) [ 0 .. 999 ]

    バンドル販売適用の優先順位。

    termFrom
    string <date> (適用開始日)

    適用開始日 [YYYY-MM-DD]

    termTo
    string <date> (適用終了日)

    適用終了日 [YYYY-MM-DD]

    pointNotApplicable
    string (ポイント対象区分)
    Enum: 0 1

    ポイント対象区分 (0:ポイント対象、1:ポイント対象外)

    taxFreeDivision
    string (免税区分)
    Enum: 0 1 2

    免税区分 (0:対象外、1:一般品、2:消耗品)

    calcDiscount
    string (値引割引計算対象区分)
    Enum: 0 1

    値引割引計算対象区分 (0:対象外、1:対象)

    products
    Array of objects (対象商品)

    対象商品:バンドル販売の対象商品
    ※部門ID、商品ID、商品グループコードのいずれか必須。(複数指定不可。複数設定された場合はエラー)
    ※種類=4の場合、商品IDのみ設定可能。(部門ID、商品グループコードが設定された場合エラー)
    ※商品バンドル明細IDが指定されていない場合、もしくはnullが指定された場合は新規登録する。
    ※商品バンドル明細IDが指定された場合は更新する。(存在しない場合エラー)

    Responses

    200

    更新成功

    400
    • 適用終了日が適用開始日より前の場合
    • 税区分が非課税の場合に軽減税率IDが設定された場合
    • 税区分が非課税の場合に軽減税率適用時の値が設定された場合
    • 指定された軽減税率IDが存在しない場合
    • 軽減税率IDが選択(10000002-10000004) かつ 税区分が税込 以外の場合に、軽減税率適用時の値が設定された場合
    • バンドル販売の場合に、種類=1,2,3以外が設定された場合
    • セット販売の場合に、種類=4以外が設定された場合
    • 対象商品に部門ID、商品ID、商品グループコードのいずれも設定されていない場合
    • 対象商品に部門ID、商品ID、商品グループコードのうち複数設定された場合
    • セット販売の場合に、対象商品に部門ID、商品グループコードが設定された場合
    • 指定された商品バンドル明細IDが重複している場合
    • 指定された商品バンドル明細IDが存在しない場合
    • 指定された商品バンドル明細IDが他の商品バンドルグループに紐ついている場合
    • 指定された部門IDが重複している場合
    • 指定された商品IDが重複している場合
    • 指定された商品グループコードが重複している場合
    • 指定された部門IDが存在しない場合
    • 指定された商品IDが存在しない場合
    • 指定された商品グループコードが設定された商品が存在しない場合
    • 指定された商品IDがオプション商品だった場合
    404
    • 指定した商品バンドルグループIDが存在しない場合
    patch /bundles/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles/{id}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productBundleGroupName": "string",
    • "type": 1,
    • "taxDivision": 0,
    • "reduceTaxId": "string",
    • "quantity": "string",
    • "value": "string",
    • "reduceTaxValue": "string",
    • "priority": "string",
    • "termFrom": "2023-12-01",
    • "termTo": "2023-12-01",
    • "pointNotApplicable": 0,
    • "taxFreeDivision": 0,
    • "calcDiscount": 0,
    • "products":
      [
      ]
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "productBundleGroupId": "string",
    • "productBundleGroupName": "string",
    • "type": "string",
    • "taxDivision": "string",
    • "reduceTaxId": "string",
    • "quantity": "string",
    • "value": "string",
    • "reduceTaxValue": "string",
    • "priority": "string",
    • "termFrom": "string",
    • "termTo": "string",
    • "pointNotApplicable": "string",
    • "taxFreeDivision": "string",
    • "calcDiscount": "string",
    • "insDateTime": "string",
    • "updDateTime": "string",
    • "products":
      [
      ]
    }

    バンドル販売削除

    バンドル販売情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    商品バンドルグループID
    ※ ユーザーアクセストークンを利用する場合でセット売りを指定する場合、ユーザーの所属する店舗で販売している商品のみで構成されるセット売りの商品バンドルグループIDを指定してください。

    Responses

    200

    削除成功

    404
    • 指定した商品バンドルグループIDが存在しない場合
    delete /bundles/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": "404"
    }

    バンドル販売商品削除

    バンドル販売商品情報を削除します。

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

    Authorizations:
    AppAccessToken (pos.products:write) UserAccessToken (pos.products:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    productBundleGroupId
    required
    string

    商品バンドルグループID
    ※ ユーザーアクセストークンを利用する場合でセット売りを指定する場合、ユーザーの所属する店舗で販売している商品のみで構成されるセット売りの商品バンドルグループIDを指定してください。

    productBundleId
    required
    string

    商品バンドル明細ID
    ※ ユーザーアクセストークンを利用する場合で商品IDが設定されている明細を指定する場合、ユーザーの所属する店舗で販売している商品が設定されている明細の商品バンドル明細IDを指定してください。

    Responses

    200

    削除成功

    400
    • 指定した商品バンドルグループIDのバンドル販売商品が1件の場合
    404
    • 指定した商品バンドルグループIDが存在しない場合
    • 指定した商品バンドル明細IDが存在しない場合
    • URIで指定されたパラメータの組み合わせが存在しなかった場合
    delete /bundles/{productBundleGroupId}/products/{productBundleId}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/bundles/{productBundleGroupId}/products/{productBundleId}

    本番

    https://api.smaregi.jp/{契約ID}/pos/bundles/{productBundleGroupId}/products/{productBundleId}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "バンドル販売商品が0件になるため削除できません。",
    • "status": 400
    }

    会員

    会員一覧取得

    会員情報一覧を取得します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■customerId:会員ID
    ■customerCode:会員コード

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    customer_code
    string

    会員コード

    customer_id-from
    string

    会員ID(From)

    customer_id-to
    string

    会員ID(To)

    customer_no
    string

    会員番号

    upd_date_time-from
    string

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

    upd_date_time-to
    string

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

    Responses

    200

    取得成功

    get /customers

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    会員登録

    会員情報を登録します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    customerCode
    required
    string (会員コード) <= 20 characters /^[ -~]+$/

    ユニーク値

    customerNo
    string (会員番号) <= 20 characters /^[ -~]+$/

    ユニーク値 会員必須項目設定で必須項目に設定されている場合必須

    rank
    string (会員ランク) <= 20 characters

    会員必須項目設定で必須項目に設定されている場合必須

    staffRank
    string (社員ランク) <= 20 characters
    firstName
    required
    string () <= 85 characters
    lastName
    required
    string () <= 85 characters
    firstKana
    string (フリガナ(名)) <= 85 characters ^[ァ-ヶ  -~ー-・]+$

    会員必須項目設定で必須項目に設定されている場合必須

    lastKana
    string (フリガナ(姓)) <= 85 characters ^[ァ-ヶ  -~ー-・]+$

    会員必須項目設定で必須項目に設定されている場合必須

    postCode
    string (郵便番号) <= 10 characters

    会員必須項目設定で必須項目に設定されている場合必須

    address
    string (住所) <= 85 characters

    会員必須項目設定で必須項目に設定されている場合必須

    phoneNumber
    string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

    会員必須項目設定で必須項目に設定されている場合必須

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

    会員必須項目設定で必須項目に設定されている場合必須

    mobileNumber
    string (携帯電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

    会員必須項目設定で必須項目に設定されている場合必須

    mailAddress
    string <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

    会員必須項目設定で必須項目に設定されている場合必須

    mailAddress2
    string <email> (メールアドレス2) (?:[_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
    mailAddress3
    string <email> (メールアドレス3) (?:[_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
    companyName
    string (会社名) <= 85 characters
    departmentName
    string (部署名) <= 85 characters
    managerialPosition
    string (役職) <= 85 characters
    sex
    string (性別)
    Default: 0
    Enum: 0 1 2

    (0:不明、1:男、2:女)

    birthDate
    string <date> (生年月日)

    会員必須項目設定で必須項目に設定されている場合必須

    pointExpireDate
    string <date> (ポイント失効予定日)

    会員必須項目設定で必須項目に設定されている場合必須

    entryDate
    string <date> (入会日)

    会員必須項目設定で必須項目に設定されている場合必須

    leaveDate
    string <date> (退会日)
    pointGivingUnitPrice
    string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

    値を指定した場合、ポイント付与単位(ポイント)も必須

    pointGivingUnit
    string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

    値を指定した場合、ポイント付与単位(金額)も必須

    pinCode
    string (PINコード) <= 32 characters

    会員必須項目設定で必須項目に設定されている場合必須

    passportNo
    string (旅券番号) <= 32 characters /^[ -~]+$/
    nationality
    string (国籍) <= 85 characters
    alphabetName
    string (アルファベット氏名) <= 85 characters
    mailReceiveFlag
    string (案内メール受取許可フラグ)
    Default: 1
    Enum: 0 1

    (0:拒否、1:許可)

    note
    string (備考) <= 1000 characters
    note2
    string (備考2) <= 1000 characters
    favoriteList
    string (お気に入りリスト) <= 1000 characters

    スマレジAPIからのみ登録可能。商品コードをカンマ区切りで設定可能。

    browsingList
    string (閲覧履歴リスト) <= 1000 characters

    スマレジAPIからのみ登録可能。商品コードをカンマ区切りで設定可能。

    status
    string (会員状態区分)
    Default: 0
    Enum: 0 1 2 3 4

    (0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ)

    storeId
    string <int> (対象店舗ID)

    Responses

    200

    更新成功

    400
    • 入力チェックエラーの場合
    • 指定した会員ランクが存在しない場合
    • 指定した社員ランクが存在しない場合
    • 会員コードが重複している場合
    • 対象店舗IDの店舗が存在しない場合
    • 対象店舗IDに倉庫のIDが指定された場合
    • 会員の登録上限数を超えてしまう場合
    post /customers

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerCode": "string",
    • "customerNo": "string",
    • "rank": "string",
    • "staffRank": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "firstKana": "string",
    • "lastKana": "string",
    • "postCode": "string",
    • "address": "string",
    • "phoneNumber": "string",
    • "faxNumber": "string",
    • "mobileNumber": "string",
    • "mailAddress": "user@example.com",
    • "mailAddress2": "user@example.com",
    • "mailAddress3": "user@example.com",
    • "companyName": "string",
    • "departmentName": "string",
    • "managerialPosition": "string",
    • "sex": 0,
    • "birthDate": "2023-12-01",
    • "pointExpireDate": "2023-12-01",
    • "entryDate": "2023-12-01",
    • "leaveDate": "2023-12-01",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "pinCode": "string",
    • "passportNo": "string",
    • "nationality": "string",
    • "alphabetName": "string",
    • "mailReceiveFlag": 1,
    • "note": "string",
    • "note2": "string",
    • "favoriteList": "string",
    • "browsingList": "string",
    • "status": 0,
    • "storeId": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerId": "string",
    • "customerCode": "string",
    • "customerNo": "string",
    • "rank": "string",
    • "staffRank": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "firstKana": "string",
    • "lastKana": "string",
    • "postCode": "string",
    • "address": "string",
    • "phoneNumber": "string",
    • "faxNumber": "string",
    • "mobileNumber": "string",
    • "mailAddress": "string",
    • "mailAddress2": "string",
    • "mailAddress3": "string",
    • "companyName": "string",
    • "departmentName": "string",
    • "managerialPosition": "string",
    • "sex": 0,
    • "birthDate": "string",
    • "pointExpireDate": "string",
    • "lastComeDateTime": "string",
    • "entryDate": "string",
    • "leaveDate": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "pinCode": "string",
    • "passportNo": "string",
    • "nationality": "string",
    • "alphabetName": "string",
    • "mailReceiveFlag": 0,
    • "note": "string",
    • "note2": "string",
    • "favoriteList": "string",
    • "browsingList": "string",
    • "status": 0,
    • "storeId": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    会員一括登録

    会員情報を一括登録します。
    ※ 会員の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 会員は1リクエストにつき100件まで登録できます。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    customers
    required
    Array of objects (会員情報)
    callbackUrl
    required
    string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

    処理が完了した際にその結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 会員コードがリクエスト内で重複している場合
    • リクエスト上限数が超えている場合
    • 会員情報が1件も送られてこなかった場合
    post /customers/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customers":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    会員一括更新

    会員情報を一括更新します。
    ※ 会員の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 会員は1リクエストにつき100件まで更新できます。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    customers
    required
    Array of objects (会員情報)
    callbackUrl
    required
    string (会員更新完了通知URL) <= 511 characters

    会員の更新が完了した際に、更新結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 会員IDがリクエスト内で重複している場合
    • リクエスト上限数が超えている場合
    • 会員情報が1件も送られてこなかった場合
    • 会員状態区分が 0:利用可 であり、退会日を指定した場合
    • 会員状態区分が 3:退会 であり、退会日にnullを指定した場合
    • リクエスト内の全ての会員情報で指定しているフィールドが揃っていない場合
    patch /customers/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customers":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    会員取得

    会員情報を取得します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    会員ID

    query Parameters
    fields
    array

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

    Responses

    200

    取得成功

    get /customers/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerId": "string",
    • "customerCode": "string",
    • "customerNo": "string",
    • "rank": "string",
    • "staffRank": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "firstKana": "string",
    • "lastKana": "string",
    • "postCode": "string",
    • "address": "string",
    • "phoneNumber": "string",
    • "faxNumber": "string",
    • "mobileNumber": "string",
    • "mailAddress": "string",
    • "mailAddress2": "string",
    • "mailAddress3": "string",
    • "companyName": "string",
    • "departmentName": "string",
    • "managerialPosition": "string",
    • "sex": "string",
    • "birthDate": "string",
    • "pointExpireDate": "string",
    • "lastComeDateTime": "string",
    • "entryDate": "string",
    • "leaveDate": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "pinCode": "string",
    • "passportNo": "string",
    • "nationality": "string",
    • "alphabetName": "string",
    • "mailReceiveFlag": "string",
    • "note": "string",
    • "note2": "string",
    • "favoriteList": "string",
    • "browsingList": "string",
    • "status": "string",
    • "storeId": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    会員更新

    会員情報を更新します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    会員ID

    Request Body schema: application/json
    customerCode
    string (会員コード) <= 20 characters /^[ -~]+$/

    ユニーク値

    customerNo
    string (会員番号) <= 20 characters /^[ -~]+$/

    ユニーク値 会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    rank
    string (会員ランク)

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    staffRank
    string (社員ランク)
    firstName
    string () <= 85 characters
    lastName
    string () <= 85 characters
    firstKana
    string (フリガナ(名)) <= 85 characters ^[ァ-ヶ  -~ー-・]+$

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    lastKana
    string (フリガナ(姓)) <= 85 characters ^[ァ-ヶ  -~ー-・]+$

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    postCode
    string (郵便番号) <= 10 characters

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    address
    string (住所) <= 85 characters

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    phoneNumber
    string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

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

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    mobileNumber
    string (携帯電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    mailAddress
    string <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

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    mailAddress2
    string <email> (メールアドレス2) (?:[_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
    mailAddress3
    string <email> (メールアドレス3) (?:[_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
    companyName
    string (会社名) <= 85 characters
    departmentName
    string (部署名) <= 85 characters
    managerialPosition
    string (役職) <= 85 characters
    sex
    string (性別)
    Default: 0
    Enum: 0 1 2

    (0:不明、1:男、2:女)

    birthDate
    string <date> (生年月日)

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    pointExpireDate
    string <date> (ポイント失効予定日)

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    entryDate
    string <date> (入会日)

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    leaveDate
    string <date> (退会日)
    pointGivingUnitPrice
    string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

    値を指定した場合、ポイント付与単位(ポイント)も必須

    pointGivingUnit
    string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

    値を指定した場合、ポイント付与単位(金額)も必須

    pinCode
    string (PINコード) <= 32 characters

    会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

    passportNo
    string (旅券番号) <= 32 characters /^[ -~]+$/
    nationality
    string (国籍) <= 85 characters
    alphabetName
    string (アルファベット氏名) <= 85 characters
    mailReceiveFlag
    string (案内メール受取許可フラグ)
    Default: 1
    Enum: 0 1

    (0:拒否、1:許可)

    note
    string (備考) <= 1000 characters
    note2
    string (備考2) <= 1000 characters
    favoriteList
    string (お気に入りリスト) <= 1000 characters

    スマレジAPIからのみ登録可能。商品コードをカンマ区切りで設定可能。

    browsingList
    string (閲覧履歴リスト)

    スマレジAPIからのみ登録可能。商品コードをカンマ区切りで設定可能。

    status
    string (会員状態区分)
    Default: 0
    Enum: 0 1 2 3 4

    (0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ)

    storeId
    string <int> (対象店舗ID)

    Responses

    200

    更新成功

    400
    • 入力チェックエラーの場合
    • 指定した会員ランクが存在しない場合
    • 指定した社員ランクが存在しない場合
    • 会員コードが重複している場合
    • 対象店舗IDの店舗が存在しない場合
    • 対象店舗IDに倉庫の店舗IDが指定された場合
    404
    • レコードが見つからない場合
    patch /customers/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/{id}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerCode": "string",
    • "customerNo": "string",
    • "rank": "string",
    • "staffRank": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "firstKana": "string",
    • "lastKana": "string",
    • "postCode": "string",
    • "address": "string",
    • "phoneNumber": "string",
    • "faxNumber": "string",
    • "mobileNumber": "string",
    • "mailAddress": "user@example.com",
    • "mailAddress2": "user@example.com",
    • "mailAddress3": "user@example.com",
    • "companyName": "string",
    • "departmentName": "string",
    • "managerialPosition": "string",
    • "sex": 0,
    • "birthDate": "2023-12-01",
    • "pointExpireDate": "2023-12-01",
    • "entryDate": "2023-12-01",
    • "leaveDate": "2023-12-01",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "pinCode": "string",
    • "passportNo": "string",
    • "nationality": "string",
    • "alphabetName": "string",
    • "mailReceiveFlag": 1,
    • "note": "string",
    • "note2": "string",
    • "favoriteList": "string",
    • "browsingList": "string",
    • "status": 0,
    • "storeId": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerId": "string",
    • "customerCode": "string",
    • "customerNo": "string",
    • "rank": "string",
    • "staffRank": "string",
    • "firstName": "string",
    • "lastName": "string",
    • "firstKana": "string",
    • "lastKana": "string",
    • "postCode": "string",
    • "address": "string",
    • "phoneNumber": "string",
    • "faxNumber": "string",
    • "mobileNumber": "string",
    • "mailAddress": "string",
    • "mailAddress2": "string",
    • "mailAddress3": "string",
    • "companyName": "string",
    • "departmentName": "string",
    • "managerialPosition": "string",
    • "sex": 0,
    • "birthDate": "string",
    • "pointExpireDate": "string",
    • "lastComeDateTime": "string",
    • "entryDate": "string",
    • "leaveDate": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "pinCode": "string",
    • "passportNo": "string",
    • "nationality": "string",
    • "alphabetName": "string",
    • "mailReceiveFlag": 0,
    • "note": "string",
    • "note2": "string",
    • "favoriteList": "string",
    • "browsingList": "string",
    • "status": 0,
    • "storeId": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    会員削除

    会員情報を削除します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    会員ID

    Responses

    200

    削除成功

    404

    指定した会員データが存在しない場合

    delete /customers/{id}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/{id}

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/{id}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定されたIDのリソースが見つかりません",
    • "status": 404
    }

    会員ポイント一覧取得

    会員ポイント情報一覧を取得します。
    参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから返します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■会員ID:
    ■ポイント失効予定日:会員必須項目設定で必須項目に設定されている場合必須

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    customer_id
    string

    会員ID

    mile
    string

    マイル

    point
    string

    ポイント

    point_expire_date
    string

    ポイント失効予定日

    customerId
    string

    (非推奨)会員ID
    ※customer_idと両方指定された場合はcustomer_idの方の設定値が優先されます。

    pointExpireDate
    string

    (非推奨)ポイント失効予定日
    ※point_expire_dateと両方指定された場合はpoint_expire_dateの方の設定値が優先されます。

    Responses

    200

    取得成功

    get /customers/point

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/point

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/point

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    会員ポイント更新

    会員ポイント情報を更新します。
    ポイントおよびマイルは、入力された値と同じになるよう更新します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    会員ID

    Request Body schema: application/json
    mile
    string <int> (マイル) <= 999999999

    マイル

    point
    string <int> (ポイント) <= 999999999

    ポイント

    pointExpireDate
    string <date> (ポイント失効予定日)

    ポイント失効予定日:指定しない場合ポイント失効日は更新されません。

    Responses

    200

    取得成功

    404
    • URI指定の会員IDが存在しない場合
    patch /customers/{id}/point

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/{id}/point

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/{id}/point

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "mile": "string",
    • "point": "string",
    • "pointExpireDate": "2023-12-01"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerId": "string",
    • "mile": "string",
    • "point": "string",
    • "pointExpireDate": "string",
    • "updDateTime": "string",
    • "transactionHeadIds":
      [
      ]
    }

    会員ポイント相対値更新

    会員ポイント情報を更新します。
    ポイントおよびマイルは、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
    現在値参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから加算を行います(失効で0になっているので減算はエラー)。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:readpos.customers:write) UserAccessToken (pos.customers:readpos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    id
    required
    string

    会員ID

    Request Body schema: application/json
    mile
    string <int> (マイル) [ -999999999 .. 999999999 ]

    マイル

    point
    string <int> (ポイント) [ -999999999 .. 999999999 ]

    ポイント

    pointExpireDate
    string <date> (ポイント失効予定日)

    ポイント失効予定日:指定しない場合ポイント失効日は更新されません。

    Responses

    200

    取得成功

    400
    • 加算後のポイントが入力可能な値の範囲を上回る場合。
    • 減算後のポイントが0を下回る場合。
    • 加算後のマイルが入力可能な値の範囲を上回る場合。
    • 減算後のマイルが0を下回る場合。
    404
    • URI指定の会員IDが存在しない場合
    post /customers/{id}/point/add

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/{id}/point/add

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/{id}/point/add

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "mile": "string",
    • "point": "string",
    • "pointExpireDate": "2023-12-01"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerId": "string",
    • "mile": "string",
    • "point": "string",
    • "pointExpireDate": "string",
    • "updDateTime": "string",
    • "transactionHeadIds":
      [
      ]
    }

    会員ポイント一括更新

    会員ポイント情報を一括更新します。
    ポイントおよびマイルは、入力された値と同じになるよう更新します。
    ※ 会員ポイント情報の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 会員ポイント情報は1リクエストにつき100件まで更新できます。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    customerPoints
    required
    Array of objects (会員ポイント情報)
    callbackUrl
    required
    string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

    処理が完了した際にその結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 会員IDがリクエスト内で重複している場合
    • リクエスト上限数が超えている場合
    • 会員ポイント情報が1件も送られてこなかった場合
    • リクエスト内の全ての会員ポイント情報で指定しているフィールドが揃っていない場合
    patch /customers/point/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/point/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/point/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerPoints":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    会員ポイント一括相対値更新

    会員ポイント情報を一括更新します。
    ポイントおよびマイルは、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
    現在値参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから加算を行います(失効で0になっているので減算はエラー)。
    ※ 会員ポイント情報の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
    ※ 会員ポイント情報は1リクエストにつき100件まで更新できます。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:readpos.customers:write) UserAccessToken (pos.customers:readpos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    customerPoints
    required
    Array of objects (会員ポイント情報)
    callbackUrl
    required
    string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

    処理が完了した際にその結果をWebhook通知するURL

    Responses

    202

    処理受付完了

    400
    • 会員IDがリクエスト内で重複している場合
    • リクエスト上限数が超えている場合
    • 会員ポイント情報が1件も送られてこなかった場合
    • リクエスト内の全ての会員ポイント情報で指定しているフィールドが揃っていない場合
    post /customers/point/add/bulk

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customers/point/add/bulk

    本番

    https://api.smaregi.jp/{契約ID}/pos/customers/point/add/bulk

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "customerPoints":
      [
      ],
    • "callbackUrl": "string"
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "requestId": "string",
    • "callbackUrl": "string"
    }

    会員必須項目設定取得

    会員必須項目設定を取得します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■displaySequence:表示順序

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    column_name
    string

    カラム名

    value
    string
    Enum: 0 1

    設定値:会員登録・更新時に必須項目とするかどうかの設定値。 (0:任意、1:必須)

    Responses

    200

    取得成功

    get /customer_required_column_setting

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customer_required_column_setting

    本番

    https://api.smaregi.jp/{契約ID}/pos/customer_required_column_setting

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    会員ランク

    会員ランク一覧取得

    会員ランクの一覧を取得します。


    sortで使用可能なパラメータ ■rank:会員ランク
    ■displaySequence:表示順
    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    rank
    string

    会員ランク

    display_flag
    string
    Enum: 0 1

    有効/無効:端末で表示するかを設定。(0:無効、1:有効)

    Responses

    200

    取得成功

    get /customer_ranks

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customer_ranks

    本番

    https://api.smaregi.jp/{契約ID}/pos/customer_ranks

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    会員ランク登録

    会員ランクを登録します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    name
    required
    string (名称) <= 85 characters

    名称

    pointGivingUnitPrice
    string <int> (ポイント付与単位) [ 1 .. 99999 ]

    ポイント付与単位:ポイントを付与する単位(金額)
    ※付与ポイント数を指定した場合、必須。

    pointGivingUnit
    string <decimal> (付与ポイント数) [ 0 .. 99999.99 ]

    付与ポイント数:付与するポイント数
    ※ポイント付与単位を指定した場合、必須。

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順

    displayFlag
    string (有効/無効)
    Default: 1
    Enum: 0 1

    有効/無効:端末で表示するかを設定。(0:無効、1:有効)

    Responses

    200

    更新成功

    400
    • ポイント付与単位を指定し、付与ポイント数を指定しなかった場合
    • 付与ポイント数を指定し、ポイント付与単位を指定しなかった場合
    post /customer_ranks

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customer_ranks

    本番

    https://api.smaregi.jp/{契約ID}/pos/customer_ranks

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "name": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "displaySequence": "string",
    • "displayFlag": 1
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "rank": "string",
    • "name": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "displaySequence": "string",
    • "displayFlag": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    会員ランク更新

    会員ランクを更新します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    rank
    required
    string

    会員ランク

    Request Body schema: application/json
    name
    string (名称) <= 85 characters

    名称

    pointGivingUnitPrice
    string <int> (ポイント付与単位) [ 1 .. 99999 ]

    ポイント付与単位:ポイントを付与する単位(金額)
    ※付与ポイント数を指定した場合、必須。

    pointGivingUnit
    string <decimal> (付与ポイント数) [ 0 .. 99999.99 ]

    付与ポイント数:付与するポイント数
    ※ポイント付与単位を指定した場合、必須。

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順

    displayFlag
    string (有効/無効)
    Default: 1
    Enum: 0 1

    有効/無効:端末で表示するかを設定。(0:無効、1:有効)

    Responses

    200

    更新成功

    400
    • ポイント付与単位を指定し、付与ポイント数を指定しなかった場合
    • 付与ポイント数を指定し、ポイント付与単位を指定しなかった場合
    404
    • 指定された会員ランクIDのリソースが見つからない場合
    patch /customer_ranks/{rank}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customer_ranks/{rank}

    本番

    https://api.smaregi.jp/{契約ID}/pos/customer_ranks/{rank}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "name": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "displaySequence": "string",
    • "displayFlag": 1
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "rank": "string",
    • "name": "string",
    • "pointGivingUnitPrice": "string",
    • "pointGivingUnit": "string",
    • "displaySequence": "string",
    • "displayFlag": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    会員ランク削除

    会員ランクを削除します。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    rank
    required
    string

    会員ランク

    Responses

    200

    削除成功

    404
    • 指定された会員ランクのリソースが見つからない場合
    delete /customer_ranks/{rank}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/customer_ranks/{rank}

    本番

    https://api.smaregi.jp/{契約ID}/pos/customer_ranks/{rank}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "NotFound",
    • "detail": "指定された会員ランクのリソースが見つかりません",
    • "status": 404
    }

    社員ランク

    社員ランク一覧取得

    社員ランクの一覧を取得します。
    ※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。


    sortで使用可能なパラメータ
    ■staffRank:社員ランク。社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。
    ■displaySequence:表示順。一覧表示時の並び順の優先順位です。
    ■updDateTime:更新日時。登録時・更新時の日時
    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:read) UserAccessToken (pos.customers:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    staff_rank
    string

    社員ランク:社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。

    display_flag
    string

    有効/無効:表示区分。(0:無効、1:有効)

    Responses

    200

    取得成功

    400
    • 契約IDが会員本部連携が有効な契約のものである場合
    get /staff_ranks

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/staff_ranks

    本番

    https://api.smaregi.jp/{契約ID}/pos/staff_ranks

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    社員ランク登録

    社員ランクを登録します。
    ※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    Request Body schema: application/json
    staffRankFullName
    required
    string (名称) <= 85 characters

    名称:社員ランクの正式名称です。

    staffRankDisplayName
    string (表示名称) <= 85 characters

    表示名称:社員販売時に表示される名称です。未設定の場合は「名称」がそのまま表示されます。

    displayFlag
    string (有効/無効)
    Default: 1
    Enum: 0 1

    有効/無効:表示区分。(0:無効、1:有効)

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順:一覧表示時の並び順の優先順位です。

    staffDiscountRate
    required
    string <int> (社員販売割引率) [ 0 .. 100 ]

    社員販売割引率:社員販売を行う際に適用される割引率を入力します。

    useProductStaffDiscountRateDivision
    string (商品マスタ社員販売割引率利用区分)
    Default: 1
    Enum: 0 1

    商品マスタ社員販売割引率利用区分:社員販売の割引率に商品マスタの社員販売割引率を適用するかを設定します。(0:利用しない、1:利用する)

    staffApplicationSellingPriceDivision
    string (社員販売適用価格区分)
    Default: 2
    Enum: 0 1 2

    社員販売適用価格区分:セール期間中の社員販売をする際、適用される価格を設定します。(0:セール価格と社員販売割引率を掛け合わせて適用、1:セール価格と社員販売価格を比較して安い方を適用、2:セール価格と社員販売価格を比較して高い方を適用)

    Responses

    200

    取得成功

    400
    • 契約IDが会員本部連携が有効な契約のものである場合
    post /staff_ranks

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/staff_ranks

    本番

    https://api.smaregi.jp/{契約ID}/pos/staff_ranks

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "staffRankFullName": "string",
    • "staffRankDisplayName": "string",
    • "displayFlag": 1,
    • "displaySequence": "string",
    • "staffDiscountRate": "string",
    • "useProductStaffDiscountRateDivision": 1,
    • "staffApplicationSellingPriceDivision": 2
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "staffRank": "string",
    • "staffRankFullName": "string",
    • "staffRankDisplayName": "string",
    • "displayFlag": "string",
    • "displaySequence": "string",
    • "staffDiscountRate": "string",
    • "useProductStaffDiscountRateDIvision": "string",
    • "staffApplicationSellingPriceDivision": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    社員ランク更新

    社員ランクを更新します。
    ※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    staff_rank
    required
    string

    社員ランク

    Request Body schema: application/json
    staffRankFullName
    string (名称) <= 85 characters

    名称:社員ランクの正式名称です。

    staffRankDisplayName
    string (表示名称) <= 85 characters

    表示名称:社員販売時に表示される名称です。未設定の場合は「名称」がそのまま表示されます。

    displayFlag
    string (有効/無効)
    Enum: 0 1

    有効/無効:表示区分。(0:無効、1:有効)

    displaySequence
    string <int> (表示順) [ 1 .. 999 ]

    表示順:一覧表示時の並び順の優先順位です。

    staffDiscountRate
    string <int> (社員販売割引率) [ 0 .. 100 ]

    社員販売割引率:社員販売を行う際に適用される割引率を入力します。

    useProductStaffDiscountRateDivision
    string (商品マスタ社員販売割引率利用区分)
    Enum: 0 1

    商品マスタ社員販売割引率利用区分:社員販売の割引率に商品マスタの社員販売割引率を適用するかを設定します。(0:利用しない、1:利用する)

    staffApplicationSellingPriceDivision
    string (社員販売適用価格区分)
    Enum: 0 1 2

    社員販売適用価格区分:セール期間中の社員販売をする際、適用される価格を設定します。(0:セール価格と社員販売割引率を掛け合わせて適用、1:セール価格と社員販売価格を比較して安い方を適用、2:セール価格と社員販売価格を比較して高い方を適用)

    Responses

    200

    取得成功

    400
    • 契約IDが会員本部連携が有効な契約のものである場合
    404
    • 指定されたIDが存在しない場合
    patch /staff_ranks/{staff_rank}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/staff_ranks/{staff_rank}

    本番

    https://api.smaregi.jp/{契約ID}/pos/staff_ranks/{staff_rank}

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "staffRankFullName": "string",
    • "staffRankDisplayName": "string",
    • "displayFlag": 0,
    • "displaySequence": "string",
    • "staffDiscountRate": "string",
    • "useProductStaffDiscountRateDivision": 0,
    • "staffApplicationSellingPriceDivision": 0
    }

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "staffRank": "string",
    • "staffRankFullName": "string",
    • "staffRankDisplayName": "string",
    • "displayFlag": "string",
    • "displaySequence": "string",
    • "staffDiscountRate": "string",
    • "useProductStaffDiscountRateDIvision": "string",
    • "staffApplicationSellingPriceDivision": "string",
    • "insDateTime": "string",
    • "updDateTime": "string"
    }

    社員ランク削除

    社員ランクを削除します。
    ※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。

    Plans:
    プレミアムプラス・フードビジネス・リテールビジネス

    Authorizations:
    AppAccessToken (pos.customers:write) UserAccessToken (pos.customers:write)
    path Parameters
    contract_id
    required
    string

    契約ID

    staff_rank
    required
    string

    社員ランク

    Responses

    200

    削除成功

    400
    • 契約IDが会員本部連携が有効な契約のものである場合
    404
    • 指定されたIDが存在しない場合
    delete /staff_ranks/{staff_rank}

    サンドボックス

    https://api.smaregi.dev/{契約ID}/pos/staff_ranks/{staff_rank}

    本番

    https://api.smaregi.jp/{契約ID}/pos/staff_ranks/{staff_rank}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "type": "about:blank",
    • "title": "Bad Request",
    • "detail": "会員本部連携が有効な契約では社員ランクはご利用できないため、本APIもご利用できません。",
    • "status": 400
    }

    在庫

    在庫一覧取得

    在庫情報一覧を取得します。
    ※ 商品の在庫情報はその商品の在庫数が変動してはじめて取得できます。
    (在庫数の変動例: 販売・入出荷・店間移動・棚卸・在庫調整・ロス登録など)

    Plans:
    スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
    sortで使用可能なパラメータ ■productId:商品ID
    ■storeId:店舗ID

    Authorizations:
    AppAccessToken (pos.stock:read) UserAccessToken (pos.stock:read)
    path Parameters
    contract_id
    required
    string

    契約ID

    query Parameters
    fields
    array

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

    sort
    string

    並び順(カンマ区切りで指定可)
    指定可能な項目については上記参照

    limit
    integer

    上限数

    page
    integer

    ページ

    store_id
    integer

    店舗ID

    product_id
    string

    商品ID

    upd_date_time-from
    string

    更新日時(from):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
    ※ From〜Toの期間は最大31日までの指定でご利用ください

    upd_date_time-to
    string

    更新日時(to):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
    ※ From〜Toの期間は最大31日までの指定でご利用ください

    Responses

    200

    取得成功

    400
    • 更新日時のFrom/To片方しか設定されていない場合
    • 更新日時のFrom-Toの範囲が上限を超えている場合
      get /stock

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      [
      • {
        }
      ]

      在庫更新

      在庫情報を更新します。
      在庫数は、入力された値と同じになるよう更新します。

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

      Authorizations:
      AppAccessToken (pos.stock:write) UserAccessToken (pos.stock:write)
      path Parameters
      contract_id
      required
      string

      契約ID

      product_id
      required
      string

      商品ID

      Request Body schema: application/json
      storeId
      required
      string <int> (店舗ID) <= 15 characters
      stockAmount
      required
      string <int> (在庫数) [ -999999999 .. 999999999 ]
      stockHistory
      object (在庫変動履歴)

      Responses

      200

      取得成功

      400
      • 店舗IDが存在しない場合
      404
      • URI指定の商品IDが存在しない場合
      patch /stock/{product_id}

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock/{product_id}

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock/{product_id}

      Request samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "storeId": "string",
      • "stockAmount": "string",
      • "stockHistory":
        {
        }
      }

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "productId": "string",
      • "storeId": "string",
      • "stockAmount": "string",
      • "updDateTime": "string",
      • "stockHistory":
        {
        }
      }

      在庫相対値更新

      在庫情報を更新します。
      在庫数は、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。

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

      Authorizations:
      AppAccessToken (pos.stock:readpos.stock:write) UserAccessToken (pos.stock:readpos.stock:write)
      path Parameters
      contract_id
      required
      string

      契約ID

      product_id
      required
      string

      商品ID

      Request Body schema: application/json
      storeId
      required
      string <int> (店舗ID) <= 15 characters
      stockAmount
      required
      string <int> (在庫数) [ -1999999998 .. 1999999998 ]
      stockHistory
      object (在庫変動履歴)

      Responses

      200

      取得成功

      400
    • 計算後の在庫数が999999999より大きい場合
    • 計算後の在庫数が-999999999未満の場合
    • 店舗IDが存在しない場合
    • 404
      • URI指定の商品IDが存在しない場合
      post /stock/{product_id}/add

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock/{product_id}/add

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock/{product_id}/add

      Request samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "storeId": "string",
      • "stockAmount": "string",
      • "stockHistory":
        {
        }
      }

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "productId": "string",
      • "storeId": "string",
      • "stockAmount": "string",
      • "updDateTime": "string",
      • "stockHistory":
        {
        }
      }

      在庫一括更新

      在庫情報を一括更新します。
      在庫数は、入力された値と同じになるよう更新します。
      ※ 在庫の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
      ※ 在庫は1リクエストにつき100件(店舗)まで登録できます。

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

      Authorizations:
      AppAccessToken (pos.stock:write) UserAccessToken (pos.stock:write)
      path Parameters
      contract_id
      required
      string

      契約ID

      Request Body schema: application/json
      stock
      required
      Array of objects (在庫情報)
      callbackUrl
      required
      string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

      処理が完了した際にその結果をWebhook通知するURL

      Responses

      202

      処理受付完了

      400
      • 商品IDと店舗IDの組み合わせがリクエスト内で重複している場合
      • リクエスト上限数が超えている場合
      • 在庫情報が1件も送られてこなかった場合
      • リクエスト内の全ての在庫情報で指定しているフィールドが揃っていない場合
      • リクエスト内の全ての在庫変動履歴で指定しているフィールドが揃っていない場合
      patch /stock/bulk

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock/bulk

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock/bulk

      Request samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "stock":
        [
        ],
      • "callbackUrl": "string"
      }

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "requestId": "string",
      • "callbackUrl": "string"
      }

      在庫一括相対値更新

      在庫情報を一括更新します。
      在庫数は、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
      ※ 在庫の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
      ※ 在庫は1リクエストにつき100件(店舗)まで登録できます。

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

      Authorizations:
      AppAccessToken (pos.stock:readpos.stock:write) UserAccessToken (pos.stock:readpos.stock:write)
      path Parameters
      contract_id
      required
      string

      契約ID

      Request Body schema: application/json
      stock
      required
      Array of objects (在庫情報)
      callbackUrl
      required
      string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$

      処理が完了した際にその結果をWebhook通知するURL

      Responses

      202

      処理受付完了

      400
      • 商品IDと店舗IDの組み合わせがリクエスト内で重複している場合
      • 在庫数に0が指定された場合
      • リクエスト上限数が超えている場合
      • 在庫情報が1件も送られてこなかった場合
      • リクエスト内の全ての在庫情報で指定しているフィールドが揃っていない場合
      • リクエスト内の全ての在庫変動履歴で指定しているフィールドが揃っていない場合
      post /stock/add/bulk

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock/add/bulk

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock/add/bulk

      Request samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "stock":
        [
        ],
      • "callbackUrl": "string"
      }

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      {
      • "requestId": "string",
      • "callbackUrl": "string"
      }

      在庫変動履歴取得

      在庫変動履歴情報を取得します。

      Plans:
      リテールビジネス
      sortで使用可能なパラメータ
      ■id : 在庫変動履歴ID
      ■updDateTime : 更新日時
      ■targetDateTime : 対象日時
      ■stockAmount : 在庫数
      ■stockDivision : 在庫区分
      ■fromStoreId : 配送元店舗ID
      ■toStoreId : 配送先店舗ID
      ■price : 商品単価
      ■cost : 原価

      Authorizations:
      AppAccessToken (pos.stock-changes:read) UserAccessToken (pos.stock-changes:read)
      path Parameters
      contract_id
      required
      string

      契約ID

      product_id
      required
      string

      商品ID

      store_id
      required
      string

      店舗ID

      query Parameters
      fields
      array

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

      sort
      string

      並び順(カンマ区切りで指定可)
      指定可能な項目については上記参照

      limit
      integer

      上限数

      page
      integer

      ページ

      id
      string

      在庫変動履歴ID

      target_date
      string

      対象日:在庫履歴集計画面用に日付を保持する。 入庫と入荷の時は検品日を設定する。

      stock_amount
      string

      在庫数:処理後の在庫数

      stock_division
      string

      在庫区分:在庫を更新理由となる区分 (01:修正、02:売上、03:仕入、04:出庫、05:入庫、06:レンタル、07:取置き、08:棚卸、09:調整、10:出荷、12:返品、13:販促品、14:ロス、15:スマレジAPI連携、16:売上引当、17:入庫欠品、18:受注在庫引当)

      from_store_id
      string

      配送元店舗ID:入出庫時の配送元店舗の店舗ID

      to_store_id
      string

      配送先店舗ID:入出庫時の配送先店舗の店舗ID

      Responses

      200

      取得成功

      get /stock/changes/{product_id}/{store_id}

      サンドボックス

      https://api.smaregi.dev/{契約ID}/pos/stock/changes/{product_id}/{store_id}

      本番

      https://api.smaregi.jp/{契約ID}/pos/stock/changes/{product_id}/{store_id}

      Response samples

      Content type
      application/json
      Copy
      Expand all Collapse all
      [
      • {
        }
      ]

      取引

      取引一覧取得

      取引情報一覧を取得します。

      Plans:
      スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
      sortで使用可能なパラメータ ■transactionHeadId:取引ID
      ■transactionDateTime:取引日時
      ■transactionHeadDivision:取引区分
      ■storeId:店舗ID
      ■terminalId:端末ID
      ■customerId:会員ID
      ■terminalTranId:端末取引ID
      ■terminalTranDateTime:端末取引日時
      ■sumDate:締め日
      ■updDateTime:更新日時
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します。

      Authorizations:
      AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
      path Parameters
      contract_id
      required
      string

      契約ID

      query Parameters
      fields
      array

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

      sort
      string

      並び順(カンマ区切りで指定可)
      指定可能な項目については上記参照

      limit
      integer

      上限数

      page
      integer

      ページ

      transaction_head_id-from
      string

      取引ID(From)

      transaction_head_id-to
      string

      取引ID(To)

      transaction_date_time-from
      string

      取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      transaction_date_time-to
      string

      取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      transaction_head_division
      string
      Enum: 1 2 3 4 5 6 7 8 9 11 13 14 15 16

      取引区分(1:通常,2:入金,3:出金,4:預かり金,5:預かり金返金,6:ポイント加算,7:ポイント減算,8:ポイント失効,9:回数券,11:チップ,13:マイル加算,14:マイル減算,15:バリューカード入金,16:領収証)

      store_id
      integer

      店舗ID

      terminal_tran_date_time-from
      string

      端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      terminal_tran_date_time-to
      string

      端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      adjustment_date_time
      string

      精算日時 [YYYY-MM-DDThh:mm:ssTZD]

      sum_date
      string

      締め日 [YYYY-MM-DD]

      sum_date-from
      string

      締め日(From)[YYYY-MM-DD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      sum_date-to
      string

      締め日(To)[YYYY-MM-DD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      customer_code
      string

      会員コード

      transaction_uuid
      string

      レシート番号:指定した値を完全一致で検索します

      barcode
      string

      バーコード:指定したバーコードの仮販売データに紐づく、取引データを取得します。

      upd_date_time-from
      string

      更新日時(From):登録時・更新時の日時。締め日(From)[YYYY-MM-DD]

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      upd_date_time-to
      string

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

      ※ From〜Toの期間は最大31日までの指定でご利用ください
      ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
      ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


      ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

      with_details
      string
      Default: "none"
      Enum: "all" "summary" "none"

      取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)
      ※ none以外に設定する場合、limitは100以下のみ設定可能。
      大量に取引及び取引明細データを取得する際のご注意
      with_detailsに none 以外を指定して、下記のケースのような大量の取引データの取得処理を実行すると、弊社サーバが高負荷になり、処理に影響が出る場合がございます。
        ・大量の取引・取引明細の取得
        ・日次バッチなど、毎日定まった期間の取引を取得する処理

      上記のようなケースについては、
        ・取引についてはwith_details=noneで本APIを複数回コールして取得(最大で1コールで1000件取得)
        ・取引明細については取引明細一覧CSV作成APIで必要期間分コールして取得 (取引明細データを最大1ヶ月分取得)

      上記の2つのAPIを組み合わせてご利用いただきますようお願いいたします。

      with_deposit_others
      string
      Default: "none"
      Enum: "all" "none"

      その他支払い情報を付加するか(付加する場合はall, しない場合はnone)

      with_layaway
      string
      Default: "none"
      Enum: "all" "none"

      (非推奨)取置き情報を付加するか(付加する場合はall, しない場合はnone)
      ※ with_layawaysを活用するようにしてください。
      ※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
      ※ 既存のwith_layaway: "all" を指定して取得できる取置きデータには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置きデータしか返りません。

      with_layaways
      string
      Default: "none"
      Enum: "all" "none"

      取置き情報を付加するか(付加する場合はall, しない場合はnone)

      with_layaway_pick_up
      string
      Default: "none"
      Enum: "all" "none"

      (非推奨)取置き引取情報を付加するか(付加する場合はall, しない場合はnone)
      ※ with_layaway_pick_upsを活用するようにしてください。
      ※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
      ※ 既存のwith_layaway_pick_up: "all" を指定して取得できる取置き引取データには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置き引取データしか返りません。

      with_layaway_pick_ups
      string
      Default: "none"
      Enum: "all" "none"

      取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

      with_money_control
      string
      Default: "none"
      Enum: "all" "none"

      取引金操作情報を付加するか(付加する場合はall, しない場合はnone)

      with_detail_product_attributes
      string
      Default: "none"
      Enum: "all" "none"

      販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone)

      Responses

      200

      取得成功

      400
      • with_detailsがnone以外で、limitに100を超える値が設定された場合
      • with_detailsがnoneで、with_detail_product_attributesにnone以外が設定された場合
      • 必須検索条件の設定が必要で、必須検索条件が1つも設定されていない場合
      • 必須検索条件の設定が必要で、範囲指定の必須検索条件のうちFrom/To片方しか設定されていない場合
      • 必須検索条件の設定が必要で、範囲指定の必須検索条件におけるFrom-Toの範囲が上限を超えている場合
        get /transactions

        サンドボックス

        https://api.smaregi.dev/{契約ID}/pos/transactions

        本番

        https://api.smaregi.jp/{契約ID}/pos/transactions

        Response samples

        Content type
        application/json
        Copy
        Expand all Collapse all
        [
        • {
          }
        ]

        取引登録

        取引を登録します。

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

        Authorizations:
        AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
        path Parameters
        contract_id
        required
        string

        契約ID

        Request Body schema: application/json
        transactionHeadDivision
        required
        string (取引区分)
        Enum: 1 2 3 4 5 6 7 13 14

        取引を識別する区分。
        (1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
        ※ 10:取置きについては、取置き登録APIをご使用ください。
        ※ 8:ポイント失効、9:回数券、11:チップ、15バリューカード入金、16:領収証は対応しておりません。

        cancelDivision
        string (取消区分)
        Default: 0
        Enum: 0 1

        取引の取消を識別する区分。 (0:通常、1取消)

        subtotal
        required
        string <int> (小計) [ -999999999 .. 999999999 ]

        取引明細の値引き後小計の合計。
        ※明細合計と異なる場合エラー

        subtotalDiscountPrice
        string <int> (小計値引き) [ -999999999 .. 999999999 ]

        小計の値引き金額を設定。

        subtotalDiscountRate
        string <int> (小計割引率) [ -999 .. 999 ]

        小計の割引を設定 (単位%) デフォルトは未設定。
        設定された場合、小計値引は必須。
        ※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

        subtotalDiscountDivision
        string <int> (小計値引き/割引区分) [ 1 .. 999999999 ]

        小計値引き/割引時に指定された区分を設定。
        管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

        pointDiscount
        string <int> (ポイント値引き) [ -999999999 .. 999999999 ]

        使用ポイント * ポイント還元率。

        total
        required
        string <int> (合計) [ -999999999 .. 999999999 ]

        小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
        ※ 端数値引き機能は現在ご利用いただけません

        taxInclude
        string <int> (内税額) [ -999999999 .. 999999999 ]

        内税商品計 / 110 * 10。
        ※税率が10%の場合
        ※小数点以下は税の丸め方式で指定の通り

        taxExclude
        string <int> (外税額) [ -999999999 .. 999999999 ]

        外税商品計 * 10 / 100。
        ※税率が10%の場合
        ※小数点以下は税の丸め方式で指定の通り

        roundingDivision
        string (端数値引区分)
        Enum: "00" "11" "12" "13" "21" "22" "23" "31" "32" "33" "41" "42" "43" "99"

        販売時の合計金額の端数を丸めるか否かを設定する。
        00:なし
        11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
        21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
        31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
        41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
        99:手入力

        roundingPrice
        string <int> (端数値引額) [ -999999999 .. 999999999 ]
        deposit
        string <int> (預かり金) [ -999999999 .. 999999999 ]

        会計時に預かった金額。(預かり金現金 + 預かり金クレジット + 預かり金その他)
        ※預かり金を正しく設定しないと、日報が正しく表示されません。

        depositCash
        string <int> (預かり金現金) [ -999999999 .. 999999999 ]

        会計時に預かった現金金額。
        ※現金支払の場合必ず設定。(預かり金現金 - 釣銭)が現金支払額に設定されます。
        ※預かり金を正しく設定しないと、日報が正しく表示されません。

        depositCredit
        string <int> (預かり金クレジット) [ -999999999 .. 999999999 ]

        会計時に預かったクレジット金額。
        ※クレジット払いの場合必ず設定。預かり金クレジットが内クレジット支払金額に設定されます。
        ※預かり金を正しく設定しないと、日報が正しく表示されません。

        change
        string <int> (釣銭) [ -999999999 .. 999999999 ]

        釣銭。現金の返却金額。
        ※預かり金を正しく設定しないと、日報が正しく表示されません。

        newPoint
        string <int> (付与ポイント) [ -999999999 .. 999999999 ]
        Default: 0

        取引で付与されるポイント。 合計 * ポイント付与率
        会員IDが設定されている場合、会員ポイント情報を更新。
        ※省略時は0を設定

        1. スマレジのポイント算出方式について
        1. カード会社・支払方法にポイント付与単位(金額)とポイント付与単位(ポイント)の設定がない場合
          • 付与されるポイントはポイント対象金額 / ポイント付与単位(金額) * ポイント付与単位(ポイント)で計算されます。(端数切り捨て) スマレジ・アプリから取引登録された時に採用されるポイント付与情報は会員のポイント付与率が未設定だった場合は会員ランクを、 会員ランクも未設定だった場合は店舗のポイント付与単位(金額)及びポイント付与単位(ポイント)が採用されます。
            • 会員ランクのポイント付与単位(金額)及びポイント付与単位(金額)については、スマレジ管理画面の[設定]->[会員設定]->[会員ランク]よりご確認ください。
            • 店舗のポイント付与単位(金額)については店舗登録APIのRequest Body記載のpointCondition.pointGivingUnitPriceをご確認ください。
            • 会員のポイント付与単位(金額)については会員登録APIのRequest Body記載のpointGivingUnitPriceをご確認ください。
        2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合
          • 下記の「2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合のポイント計算例」をご参照ください。
        2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合のポイント計算例

        支払い方法毎のポイント付与率

        支払方法 TransactionHead上の金額対象項目 TransactionHead.depositOthers上の金額対象項目 ポイント付与単位(金額) ポイント付与単位(ポイント)
        現金 depositCash - change + tax(※1) + pointDiscount(※2) - 100 1
        提携クレジットカード depositCredit - 100 5
        電子マネー - depositOthers 100 3
        (※1)
        取引(TransactionHead)の98: ポイント付与区分(pointGivingDivision)が
        1 or 3のときはtax = taxExclude
        2 or 4のときは tax = -1 * taxInclude
        となります。
        (※2)
        取引(TransactionHead)の98: ポイント付与区分(pointGivingDivision)が
        1 or 2のときはpointDiscount = TransactionHead.pointDiscount
        3 or 4のときはpointDiscount = 0
        となります。

        1取引におけるポイント付与状況

        各支払方法に対するポイントを計算します。
        また、付与ポイント計算時に生じた端数金額については合算し、
        その取引で最も高いポイント付与率を使用して再付与を行います。
        支払方法 金額(円) 付与ポイント 端数金額(円) ポイント付与率(%) 端数金額より算出されるポイント
        現金 1050 1050 / 100 * 1 = 10 1050 % 100 * 1 = 50 1 0 (付与率が最も高くないため)
        提携クレジットカード 2070 2070 / 100 * 5 = 100 2070 % 100 * 5 = 70 5 (50 + 70 + 80) / 100 * 5 = 10
        電子マネー 80 80 / 100 * 3 = 0 80 % 100 * 3 = 80 3 0 (付与率が最も高くないため)

        合計ポイントの計算

        合計付与ポイント: 10 + 100 + 0 + 10 = 120ポイント

        注意事項

        1. スマレジ管理画面にて、指定のカード情報にポイント付与情報が設定されている場合は、そのポイント付与情報が優先されます。
        2. 1つの取引の中で釣銭を発生させる支払方法を指定した場合でも、発生した釣銭はdepositCash(現金)より減算されます。
        spendPoint
        string <int> (使用ポイント) [ -999999999 .. 999999999 ]

        取引で使用したポイント。
        会員IDが設定されている場合、会員ポイント情報を更新。
        ※省略時は0を設定

        point
        string <int> (現在ポイント) [ -999999999 .. 999999999 ]

        取引前のポイント。

        totalPoint
        string <int> (合計ポイント) [ -999999999 .. 999999999 ]

        取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。

        currentMile
        string <int> (現在マイル) [ -999999999 .. 999999999 ]

        取引前のマイル

        earnMile
        string <int> (獲得マイル) [ -999999999 .. 999999999 ]

        取引で付与されるマイル
        合計 * ポイント付与率

        totalMile
        string <int> (合計マイル) [ -999999999 .. 999999999 ]

        取引後のマイル
        現在マイル + 獲得マイル + 調整マイル

        adjustmentMile
        string <int> (調整マイル) [ -999999999 .. 999999999 ]

        取引で手動で付与されるマイル

        adjustmentMileDivision
        string (調整マイル区分)
        Enum: 1 2 3 4

        調整マイルの区分
        1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)
        2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)
        3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)
        4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」

        adjustmentMileValue
        string <int> (調整マイル区分値) [ 1 .. 99999999 ]

        調整マイルの入力値

        storeId
        required
        string <int> (店舗ID) [ 1 .. 999999999 ]

        店舗毎に付与するID。
        ※店舗情報が存在しない場合エラー
        ※休止中の店舗IDを指定するとエラー

        terminalId
        required
        string <int> (端末ID) [ 1 .. 999999999 ]

        店舗の端末毎に付与するID。
        ※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)

        customerId
        string <int> (会員ID) [ 1 .. 9999999999 ]

        会員毎に付与するID。
        ※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
        ※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

        customerCode
        string (会員コード) <= 20 characters /^[ -~]+$/

        会員毎に付与する一意のコード。
        ※設定された場合、会員IDは必須。
        ※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。
        ※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。(スマレジ管理画面ver.4.12.0リリース以降)

        terminalTranId
        required
        string <int> (端末取引ID) <= 10 characters

        端末で設定された取引ID。(連携元システムで任意の連番を設定してください)

        terminalTranDateTime
        required
        string <date-time> (端末取引日時)

        端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD](連携元システムで処理日時を設定してください)

        sumDivision
        string (締め区分)
        Default: 0
        Enum: 0 1 2

        締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)
        ※省略時は、店舗情報の締め方式区分に合わせて設定します。
        ※0:未処理または1:精算処理済みは、店舗の締め方式区分が「手動締め処理」のときのみ設定可能。
        ※存在しない端末IDを設定した場合、2:締め処理済みを設定してください。

        sumDate
        string <date> (締め日)

        締めをしたら年月日が入る。 [YYYY-MM-DD]
        ※締め区分を2に設定した場合必須。締め区分を0に設定した場合設定不可。

        customerRank
        string (会員ランク) <= 20 characters

        管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。
        存在しないコードを設定するとエラーになります。

        customerGroupId
        string <int> (客層ID) [ 1 .. 999999999 ]

        客層ID。客層セクションIDが1の客層IDを設定。
        ※客層情報が存在しない場合エラー

        customerGroupId2
        string <int> (客層ID2) [ 1 .. 999999999 ]

        客層ID2。客層セクションIDが2の客層IDを設定。
        ※客層情報が存在しない場合エラー

        customerGroupId3
        string <int> (客層ID3) [ 1 .. 999999999 ]

        客層ID3。客層セクションIDが3の客層IDを設定。
        ※客層情報が存在しない場合エラー

        customerGroupId4
        string <int> (客層ID4) [ 1 .. 999999999 ]

        客層ID4。客層セクションIDが4の客層IDを設定。
        ※客層情報が存在しない場合エラー

        customerGroupId5
        string <int> (客層ID5) [ 1 .. 999999999 ]

        客層ID5。客層セクションIDが5の客層IDを設定。
        ※客層情報が存在しない場合エラー

        staffId
        string <int> (販売員ID) [ 1 .. 999999999 ]

        販売員ID(スタッフID)
        ※スタッフ情報が存在しない場合エラー
        ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

        memo
        string (メモ) <= 1000 characters

        入出金時のメモなどを設定。 1000文字以内。

        receiptMemo
        string (レシートメモ) <= 100 characters

        レシートに印字するメモを設定。100文字以内。

        carriage
        string <int> (送料) [ -999999999 .. 999999999 ]

        EC連携用送料。

        commission
        string <int> (手数料) [ -999999999 .. 999999999 ]

        EC連携用手数料。

        guestNumbers
        string <int> (客数) [ 0 .. 9999 ]

        客数。

        guestNumbersMale
        string <int> (客数(男)) [ 0 .. 9999 ]

        客数(男)。

        guestNumbersFemale
        string <int> (客数(女)) [ 0 .. 9999 ]

        客数(女)。

        guestNumbersUnknown
        string <int> (客数(不明)) [ 0 .. 9999 ]

        客数(不明)。

        enterDateTime
        string <date-time> (入店日時)

        入店日時。[YYYY-MM-DDThh:mm:ssTZD]

        taxFreeSalesDivision
        string (免税販売区分)
        Default: 0
        Enum: 0 1 2 3 4 5

        免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
        ※未設定の場合、0:通常販売

        netTaxFreeGeneralTaxInclude
        string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ]

        内税商品の一般品免税額。

        netTaxFreeGeneralTaxExclude
        string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ]

        外税商品の一般品免税額。

        netTaxFreeConsumableTaxInclude
        string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ]

        内税商品の消耗品免税額。

        netTaxFreeConsumableTaxExclude
        string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ]

        外税商品の消耗品免税額。

        tags
        string (取引タグ) <= 255 characters

        レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
        ※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

        pointGivingDivision
        string (ポイント付与税区分)
        Enum: 1 2 3 4

        1:税額を含める + 利用ポイント分を含める、
        2:税額を含めない + 利用ポイント分を含める、
        3:税額を含める + 利用ポイント分を含めない、
        4:税額を含めない + 利用ポイント分を含めない
        ※省略時、店舗マスタから設定。

        pointGivingUnitPrice
        string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

        ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)
        (例10円ごとに2ポイントの場合、10円)
        ※未設定の場合は店舗マスタから設定。

        pointGivingUnit
        string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

        ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
        (例10円ごとに0.2ポイントの場合、0.2ポイント)
        ※未設定の場合は店舗マスタから設定。

        pointSpendDivision
        string (ポイント利用区分)
        Default: 1
        Enum: 1 2

        ポイント利用時の税を含む/含まないを判定。
        1:ポイント利用を現金として扱う (税を含む値引き)
        2:ポイント利用を値引として扱う (税を含まない値引き)
        ※未設定の場合は店舗マスタから設定。 初期値:1。

        mileageDivision
        string (マイレージ利用区分)
        Default: 0
        Enum: 0 1 2

        マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
        ※未設定の場合は店舗マスタから設定。 初期値:0。

        mileageLabel
        string (マイレージラベル) <= 32 characters

        マイレージの名称。未設定の場合は「マイル」

        customerPinCode
        string (PINコード) <= 32 characters

        自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。

        sellDivision
        string (販売区分)
        Enum: 0 1

        取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
        ※省略時は0:内税販売を設定

        taxRate
        string <decimal> (税率) [ 0 .. 99999.999 ]

        税率 (単位%)
        ※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)

        taxRounding
        string (税の丸め方式)
        Enum: 0 1 2

        税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
        ※省略時はスマレジに設定されている税の丸め方式を設定

        discountRoundingDivision
        string (割引丸め区分)
        Enum: 0 1 2

        割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
        ※省略時は店舗マスタに設定されている税の丸め方式を設定

        transactionUuid
        string (レシート番号) <= 20 characters

        レシートに印字する番号。ユニークな値を設定してください。
        ※レシート番号が重複するとスマレジ・アプリにて取引データの呼び出しができなくなる可能性があります
        ※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁

        exchangeTicketNo
        string (引換券番号) <= 20 characters
        giftReceiptValidDays
        string <int> (ギフトレシート引換有効日数) [ 0 .. 999999999 ]

        有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

        discountCalculateDivision
        string (割引額計算対象)
        Default: 0
        Enum: 0 1

        小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。
        0:小計(明細から算出された、値引・割引前の小計を一律対象に割引率を乗算したものを割引額とします。)
        1:他の値引割引に追従した小計(小計に対し他の値引・割引で変動した後の金額を都度対象に割引率を乗算したものを割引額とします。小計値引・割引 → クーポン値引・割引 の順番で計算されます。)
        ※割引額計算対象の設定値は取引登録後にスマレジ・アプリにて取引を編集する際の割引額算出に使用します。
        ※(注)取引登録APIでは、自動算出した値ではなくsubtotalDiscountPrice(小計値引き)の設定値を割引額に登録します。そのため、APIで登録される取引の割引額が割引額計算対象の設定値によって変動することはありません。

        barcode
        string (バーコード) <= 255 characters

        仮販売のバーコード。
        ※ 複数ある場合はカンマ区切り。

        layawayServerTransactionHeadId
        string <int> (取置き取引ID) [ 1 .. 999999999999 ]

        取置きの取引ID。
        ※ 指定した取置き取引を引取済にします。

        details
        Array of objects (取引明細)
        depositOthers
        Array of objects (その他支払方法)
        coupons
        Array of objects (クーポン明細)

        対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス

        couponItems
        Array of objects (クーポン商品付与明細)

        対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス

        Responses

        200

        更新成功

        400
        • 小計割引率が設定されており、小計値引きが未指定の場合
        • 存在しない店舗IDを指定した場合
        • 店舗が倉庫の店舗IDを指定した場合
        • 店舗が休止中の店舗IDを指定した場合
        • 存在しない端末IDを指定し、締め区分を 2:締め処理済み 以外を指定した場合
        • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 1:清算処理済み を指定した場合
        • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 0:未処理 を指定した場合
        • 締め区分が 2:締め処理済み以外で、締め日を設定した場合
        • 締め区分が2:締め処理済で、締め日が未指定の場合
        • 会員コードを設定し、会員IDが未設定の場合
        • 現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
        • 客層IDが指定した客層セクションに存在しない場合
        • 存在しない販売員IDを指定した場合
        • レシート番号が重複した場合
        • 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
        • 1取引タグが64文字を超える場合
        • ステータスが通常以外のバーコードを指定した場合
        • バーコードを指定し、取引区分が 1:通常 以外を指定した場合
        • バーコードを指定し、取消区分が 0:通常 以外を指定した場合
        • バーコードが重複した場合
        • 取置き取引IDを指定し、取引区分が 1:通常 以外を指定した場合
        • 取置き取引IDを指定し、取消区分が 0:通常 以外を指定した場合
        • 取置き取引IDを指定し、対象の取置き取引データが存在しない場合
        • 取置き取引IDを指定し、対象の取置き取引データの取引区分が、10:取置き 以外の場合
        • 取置き取引IDを指定し、対象の取置き取引データが、取消済または引取済の場合
        • 基本設定が「取置き店舗でのみ受取り可」 かつ 取置き取引IDに指定された取置き取引の店舗IDと登録する店舗IDが同一ではない場合
        • 取引区分が 1:通常 以外で、取引明細が存在している場合
        • 取引区分が 1:通常 で、取引明細が存在しない場合
        • 取引区分が 1:通常 以外で、その他支払方法が存在している場合
        • その他支払方法が4リクエスト以上ある場合
        • 取引明細IDが明細間で重複した場合
        • 同じ取引の明細に存在しない親取引明細IDを指定した場合
        • 商品IDで指定された商品の持つ商品区分が回数券である場合
        • 商品区分が 0:通常/4:バンドル販売(親)であり、親取引明細IDを指定した場合
        • 商品区分が 2:オプション商品/7:バンドル商品(子)/8:バンドル値引(子)で親取引明細IDが未指定の場合
        • 商品区分が 2:オプション商品 であるが、商品IDで指定された商品の持つ商品区分が 2:オプション商品 でない場合
        • 商品区分が 2:オプション商品 の明細で、販売数が親取引明細における販売数の整数倍でない場合
        • 商品区分が 2:オプション商品 である取引明細とその親取引明細に対して、存在する商品IDがともに設定されており、かつ前者の商品が後者の商品に対して付与可能なオプショングループに所属していない場合
        • 商品区分が 4:バンドル販売(親)の明細以外で商品バンドルグループを指定した場合
        • 商品区分が 0:通常販売/4:バンドル(親) の場合に親取引明細IDを指定した場合
        • 商品区分が 4:バンドル(親) の場合で、同じ取引の明細に 7:バンドル子/8:バンドル値引 かつ親取引明細IDが親自身であるものが存在しない場合
        • 商品区分が 7:バンドル子/8:バンドル値引 で、親取引IDにバンドル(親)の取引明細IDが設定されていない場合
        • 商品バンドルグループIDを設定し、商品区分が 4:バンドル(親) でない場合
        • 単品割引率を設定し、単品値引が未設定の場合
        • 現在の商品マスタの部門IDと、リクエストの部門IDが異なる場合
        • 部門IDが存在しない場合
        • 小計が明細合計と一致しない場合
        • 合計が計算値と一致しない場合
        • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が重複した場合
        • その他支払方法の項番が重複している場合
        • 同一のその他支払方法内で、ポイント付与単位(金額)とポイント付与単位(ポイント)のどちらか片方のみが指定されている場合
        • その他支払方法にて、支払方法IDに個別アプリ専用支払方法登録APIで登録していない支払方法IDを指定せずに、キャッシュレス伝票番号・支払金種コード・クレジットカード会社を設定した場合
        • その他支払方法にて、支払方法IDに個別アプリ専用支払方法登録APIで登録した支払方法IDを指定し、支払金種コードを設定しない場合
        • その他支払方法にて、クレジットカード会社名を指定できない支払金種コードを指定の上、クレジットカード会社名を指定した場合
        • その他支払方法にて、2つ以上の個別アプリ専用支払方法が指定された場合
        • 取引区分が 1:通常 以外で、クーポン明細が存在している場合
        • 取引区分が 1:通常 以外で、クーポン商品付与明細が存在している場合
        • クーポン商品付与明細を指定し、クーポン明細が存在しない場合
        • 端末取引クーポンIDが明細間で重複した場合
        • クーポンIDが明細間で重複した場合
        • クーポンIDに指定されたクーポンが存在しない場合
        • giftee連携の利用設定が「利用しない」の場合に、クーポン区分が 1:giftee のクーポンが指定された場合
        • クーポンIDに指定されたクーポンのクーポン区分が 1:giftee で、クーポン明細のシリアル番号が設定されていない場合
        • クーポンIDに指定されたクーポンの利用可能期間外の場合
        • クーポンIDに指定されたクーポンの指定商品条件を満たしていない場合
        • クーポンIDに指定されたクーポンの対象金額を満たしていない場合
        • 併用区分が 1:併用不可 のクーポンが他のクーポンと併用された場合
        • 併用区分が 2:一部のクーポン(3:併用可能)と併用可能 のクーポンが 3:併用可能 以外のクーポンと併用された場合
        • 特典タイプが 1:値引き/2:割引 で、値引額が設定されていない場合
        • 特典タイプが 3:商品付与 で、特典値に0以外が設定されている場合
        • 特典タイプが 3:商品付与 で、値引額に0以外が設定されている場合
        • クーポン商品付与明細に指定された端末取引クーポンIDがクーポン明細に存在しない場合
        • クーポン商品付与明細に指定された端末取引クーポンIDに紐つくクーポン明細の特典タイプが 3:商品付与 以外の場合
        • クーポン商品付与明細に指定された取引明細IDが重複している場合
        • クーポン商品付与明細に指定された取引明細IDが取引明細に存在しない場合
        • クーポン商品付与明細に指定されたクーポンアイテムIDが重複している場合
        • クーポンアイテムIDが存在しない場合
        • クーポン商品付与明細に指定された取引明細IDの商品IDとクーポンアイテムIDに紐つく商品IDが一致しない場合
        403
        • プレミアムプラスプラン未満で、クーポン区分が 1:giftee のクーポンが指定された場合
        post /transactions

        サンドボックス

        https://api.smaregi.dev/{契約ID}/pos/transactions

        本番

        https://api.smaregi.jp/{契約ID}/pos/transactions

        Request samples

        Content type
        application/json
        Copy
        Expand all Collapse all
        {
        • "transactionHeadDivision": 1,
        • "cancelDivision": 0,
        • "subtotal": "string",
        • "subtotalDiscountPrice": "string",
        • "subtotalDiscountRate": "string",
        • "subtotalDiscountDivision": "string",
        • "pointDiscount": "string",
        • "total": "string",
        • "taxInclude": "string",
        • "taxExclude": "string",
        • "roundingDivision": "00",
        • "roundingPrice": "string",
        • "deposit": "string",
        • "depositCash": "string",
        • "depositCredit": "string",
        • "change": "string",
        • "newPoint": 0,
        • "spendPoint": "string",
        • "point": "string",
        • "totalPoint": "string",
        • "currentMile": "string",
        • "earnMile": "string",
        • "totalMile": "string",
        • "adjustmentMile": "string",
        • "adjustmentMileDivision": 1,
        • "adjustmentMileValue": "string",
        • "storeId": "string",
        • "terminalId": "string",
        • "customerId": "string",
        • "customerCode": "string",
        • "terminalTranId": "string",
        • "terminalTranDateTime": "2023-12-01T10:09:41Z",
        • "sumDivision": 0,
        • "sumDate": "2023-12-01",
        • "customerRank": "string",
        • "customerGroupId": "string",
        • "customerGroupId2": "string",
        • "customerGroupId3": "string",
        • "customerGroupId4": "string",
        • "customerGroupId5": "string",
        • "staffId": "string",
        • "memo": "string",
        • "receiptMemo": "string",
        • "carriage": "string",
        • "commission": "string",
        • "guestNumbers": "string",
        • "guestNumbersMale": "string",
        • "guestNumbersFemale": "string",
        • "guestNumbersUnknown": "string",
        • "enterDateTime": "2023-12-01T10:09:41Z",
        • "taxFreeSalesDivision": 0,
        • "netTaxFreeGeneralTaxInclude": "string",
        • "netTaxFreeGeneralTaxExclude": "string",
        • "netTaxFreeConsumableTaxInclude": "string",
        • "netTaxFreeConsumableTaxExclude": "string",
        • "tags": "string",
        • "pointGivingDivision": 1,
        • "pointGivingUnitPrice": "string",
        • "pointGivingUnit": "string",
        • "pointSpendDivision": 1,
        • "mileageDivision": 0,
        • "mileageLabel": "string",
        • "customerPinCode": "string",
        • "sellDivision": 0,
        • "taxRate": "string",
        • "taxRounding": 0,
        • "discountRoundingDivision": 0,
        • "transactionUuid": "string",
        • "exchangeTicketNo": "string",
        • "giftReceiptValidDays": "string",
        • "discountCalculateDivision": 0,
        • "barcode": "string",
        • "layawayServerTransactionHeadId": "string",
        • "details":
          [
          ],
        • "depositOthers":
          [
          ],
        • "coupons":
          [
          ],
        • "couponItems":
          [
          ]
        }

        Response samples

        Content type
        application/json
        Copy
        Expand all Collapse all
        {
        • "transactionHeadId": "string",
        • "transactionDateTime": "string",
        • "transactionHeadDivision": "string",
        • "cancelDivision": "string",
        • "unitNonDiscountsubtotal": "string",
        • "unitDiscountsubtotal": "string",
        • "unitStaffDiscountsubtotal": "string",
        • "unitBargainDiscountsubtotal": "string",
        • "subtotal": "string",
        • "subtotalForDiscount": "string",
        • "subtotalDiscountPrice": "string",
        • "subtotalDiscountRate": "string",
        • "subtotalDiscountDivision": "string",
        • "pointDiscount": "string",
        • "couponDiscount": "string",
        • "total": "string",
        • "taxInclude": "string",
        • "taxExclude": "string",
        • "roundingDivision": "string",
        • "roundingPrice": "string",
        • "cashTotal": "string",
        • "creditTotal": "string",
        • "deposit": "string",
        • "depositCash": "string",
        • "depositCredit": "string",
        • "change": "string",
        • "tipCash": "string",
        • "tipCredit": "string",
        • "amount": "string",
        • "returnAmount": "string",
        • "costTotal": "string",
        • "salesHeadDivision": "string",
        • "inTaxSalesTotal": "string",
        • "outTaxSalesTotal": "string",
        • "nonTaxSalesTotal": "string",
        • "nonSalesTargetTotal": "string",
        • "nonSalesTargetInTaxTotal": "string",
        • "nonSalesTargetOutTaxTotal": "string",
        • "nonSalesTargetTaxFreeTotal": "string",
        • "nonSalesTargetCostTotal": "string",
        • "nonSalesTargetAmount": "string",
        • "nonSalesTargetReturnAmount": "string",
        • "newPoint": "string",
        • "spendPoint": "string",
        • "point": "string",
        • "totalPoint": "string",
        • "currentMile": "string",
        • "earnMile": "string",
        • "totalMile": "string",
        • "adjustmentMile": "string",
        • "adjustmentMileDivision": "string",
        • "adjustmentMileValue": "string",
        • "storeId": "string",
        • "terminalId": "string",
        • "customerId": "string",
        • "terminalTranId": "string",
        • "terminalTranDateTime": "string",
        • "sumDivision": "string",
        • "adjustmentDateTime": "string",
        • "sumDate": "string",
        • "customerRank": "string",
        • "customerGroupId": "string",
        • "customerGroupId2": "string",
        • "customerGroupId3": "string",
        • "customerGroupId4": "string",
        • "customerGroupId5": "string",
        • "staffId": "string",
        • "staffName": "string",
        • "creditDivision": "string",
        • "paymentCount": "string",
        • "slipNumber": "string",
        • "cancelSlipNumber": "string",
        • "authNumber": "string",
        • "authDate": "string",
        • "cardCompany": "string",
        • "denomination": "string",
        • "memo": "string",
        • "receiptMemo": "string",
        • "carriage": "string",
        • "commission": "string",
        • "guestNumbers": "string",
        • "guestNumbersMale": "string",
        • "guestNumbersFemale": "string",
        • "guestNumbersUnknown": "string",
        • "enterDateTime": "string",
        • "taxFreeSalesDivision": "string",
        • "netTaxFreeGeneralTaxInclude": "string",
        • "netTaxFreeGeneralTaxExclude": "string",
        • "netTaxFreeConsumableTaxInclude": "string",
        • "netTaxFreeConsumableTaxExclude": "string",
        • "tags": "string",
        • "pointGivingDivision": "string",
        • "pointGivingUnitPrice": "string",
        • "pointGivingUnit": "string",
        • "pointSpendDivision": "string",
        • "mileageDivision": "string",
        • "mileageLabel": "string",
        • "customerPinCode": "string",
        • "returnSales": "string",
        • "disposeDivision": "string",
        • "disposeServerTransactionHeadId": "string",
        • "cancelDateTime": "string",
        • "sellDivision": "string",
        • "taxRate": "string",
        • "taxRounding": "string",
        • "discountRoundingDivision": "string",
        • "transactionUuid": "string",
        • "exchangeTicketNo": "string",
        • "giftReceiptValidDays": "string",
        • "discountCalculateDivision": "string",
        • "barcode": "string",
        • "updDateTime": "string",
        • "details":
          [
          ],
        • "depositOthers":
          [
          ],
        • "coupons":
          [
          ],
        • "couponItems":
          [
          ],
        • "layaway":
          {
          },
        • "layawayPickUp":
          {
          }
        }

        取引取得

        取引情報を取得します。

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

        Authorizations:
        AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
        path Parameters
        contract_id
        required
        string

        契約ID

        id
        required
        string

        取引ID

        query Parameters
        fields
        array

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

        with_details
        string
        Default: "none"
        Enum: "all" "summary" "none"

        取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

        with_deposit_others
        string
        Default: "none"
        Enum: "all" "none"

        その他支払方法情報を付加するか(付加する場合はall, しない場合はnone)

        with_coupons
        string
        Default: "none"
        Enum: "all" "none"

        対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
        クーポン情報を付加するか(付加する場合はall, しない場合はnone)

        with_coupon_items
        string
        Default: "none"
        Enum: "all" "none"

        対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
        クーポン商品付与情報を付加するか(付加する場合はall, しない場合はnone)

        with_discounts
        string
        Default: "none"
        Enum: "all" "none"

        小計値引/割引、単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone)

        with_store
        string
        Default: "none"
        Enum: "all" "none"

        店舗情報を付加するか(付加する場合はall, しない場合はnone)

        with_customer
        string
        Default: "none"
        Enum: "all" "none"

        会員情報を付加するか(付加する場合はall, しない場合はnone)

        with_customer_groups
        string
        Default: "none"
        Enum: "all" "none"

        客層情報を付加するか(付加する場合はall, しない場合はnone)

        with_staff
        string
        Default: "none"
        Enum: "all" "none"

        スタッフ情報を付加するか(付加する場合はall, しない場合はnone)

        with_recorded_staff
        string
        Default: "none"
        Enum: "all" "none"

        取引時のスタッフ情報を付加するか(付加する場合はall, しない場合はnone)

        with_layaway
        string
        Default: "none"
        Enum: "all" "none"

        (非推奨)取置き情報を付加するか(付加する場合はall, しない場合はnone)
        ※ with_layawaysを活用するようにしてください。
        ※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
        ※ 既存のwith_layaway: "all" を指定して取得できる取置きデータには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置きデータしか返りません。

        with_layaways
        string
        Default: "none"
        Enum: "all" "none"

        取置き情報を付加するか(付加する場合はall, しない場合はnone)

        with_layaway_pick_up
        string
        Default: "none"
        Enum: "all" "none"

        (非推奨)取置き引取情報を付加するか(付加する場合はall, しない場合はnone)
        ※ with_layaway_pick_upsを活用するようにしてください。
        ※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
        ※ 既存のwith_layaway_pick_up: "all" を指定して取得できる取置き引取データには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置き引取データしか返りません。

        with_layaway_pick_ups
        string
        Default: "none"
        Enum: "all" "none"

        取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

        with_money_control
        string
        Default: "none"
        Enum: "all" "none"

        取引金操作情報を付加するか(付加する場合はall, しない場合はnone)

        with_detail_product_attributes
        string
        Default: "none"
        Enum: "all" "none"

        販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone)

        Responses

        200

        取得成功

        400
        • with_detailsがnoneで、with_detail_product_attributesにnone以外が設定された場合
          get /transactions/{id}

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "couponDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "discountCalculateDivision": "string",
          • "barcode": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "depositOthers":
            [
            ],
          • "coupons":
            [
            ],
          • "couponItems":
            [
            ],
          • "discounts":
            [
            ],
          • "store":
            {
            },
          • "customer":
            {
            },
          • "customerGroups":
            [
            ],
          • "staff":
            {
            },
          • "recordedStaff":
            [
            ],
          • "layaway":
            {
            },
          • "layaways":
            [
            ],
          • "layawayPickUp":
            {
            },
          • "layawayPickUps":
            [
            ],
          • "moneyControl":
            {
            }
          }

          取引更新

          取引情報を更新します。
          ※ 会員情報の更新は、取引会員更新をご利用ください。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          Request Body schema: application/json
          customerGroupId
          string <int> (客層ID) [ 1 .. 999999999 ]

          客層ID。客層セクションIDが1の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId2
          string <int> (客層ID2) [ 1 .. 999999999 ]

          客層ID2。客層セクションIDが2の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId3
          string <int> (客層ID3) [ 1 .. 999999999 ]

          客層ID3。客層セクションIDが3の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId4
          string <int> (客層ID4) [ 1 .. 999999999 ]

          客層ID4。客層セクションIDが4の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId5
          string <int> (客層ID5) [ 1 .. 999999999 ]

          客層ID5。客層セクションIDが5の客層IDを設定。
          ※客層情報が存在しない場合エラー

          staffId
          string <int> (販売員ID) [ 1 .. 999999999 ]

          販売員ID(スタッフID)
          ※スタッフ情報が存在しない場合エラー
          ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

          memo
          string (メモ) <= 1000 characters

          入出金時のメモなどを設定。 1000文字以内。

          receiptMemo
          string (レシートメモ) <= 100 characters

          レシートに印字するメモを設定。100文字以内。

          guestNumbers
          string <int> (客数) [ 0 .. 9999 ]

          客数。

          guestNumbersMale
          string <int> (客数(男)) [ 0 .. 9999 ]

          客数(男)。

          guestNumbersFemale
          string <int> (客数(女)) [ 0 .. 9999 ]

          客数(女)。

          guestNumbersUnknown
          string <int> (客数(不明)) [ 0 .. 9999 ]

          客数(不明)。

          tags
          string (取引タグ) <= 255 characters

          レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
          ※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

          Responses

          200

          更新成功

          400
          • 指定された取引の取引区分が 1:通常 でない場合
          • 更新する項目が指定されていない場合
          • 客層IDが指定した客層セクションに存在しない場合
          • 存在しない販売員IDを指定した場合
          • 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
          • 1取引タグが64文字を超える場合
          • 取消済みの取引IDが指定された場合
          • 削除済み店舗の取引IDが指定された場合
          • 休止店舗の取引IDが指定された場合
          • バリューカードを伴う取引IDが指定された場合
          404
          • URI指定の取引IDが存在しない場合
          patch /transactions/{id}

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "tags": "string"
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "couponDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "barcode": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "depositOthers":
            [
            ],
          • "coupons":
            [
            ],
          • "couponItems":
            [
            ],
          • "layaway":
            {
            },
          • "layaways":
            [
            ],
          • "layawayPickUp":
            {
            },
          • "layawayPickUps":
            [
            ]
          }

          取引取消

          取引を取消します。
          ※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          Request Body schema: application/json
          cancelDateTime
          string <date-time> (取消日時)

          取消/打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD]
          未設定の場合、自動で設定されます。

          depositOthers
          Array of objects (その他支払方法)

          個別アプリ専用支払方法IDを指定した決済で取消伝票番号を登録するのに利用します
          ※現状は最大1つしか指定できません

          Responses

          200

          更新成功

          400
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが存在しない場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が同じ取引データで取消済の場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が同じ取引データで打消取消済の場合
          • 取消対象の取引データの取引区分が、1,2,3,4,5,6,7,13,14,16 以外の場合
          • 取消対象の取引データが、国税庁に免税データを送信している場合
          • 取消対象の取引データが、回数券を購入している取引の場合
          • 指定した項番のその他支払方法が存在しない場合
          • その他支払方法の項番が重複している場合
          • 項番で指定したその他支払方法に含まれる支払方法IDが個別アプリ専用支払方法IDではない場合
          404
          • URI指定された取引IDが存在しなかった場合

          post /transactions/{id}/cancel

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}/cancel

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}/cancel

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "cancelDateTime": "2023-12-01T10:09:41Z",
          • "depositOthers":
            [
            ]
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "couponDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "depositOthers":
            [
            ],
          • "coupons":
            [
            ],
          • "couponItems":
            [
            ],
          • "recordedStaff":
            [
            ]
          }

          取引打消取消

          取引を打消取消します。指定された取引に対して、返品する取引情報を作成します。
          ※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          Request Body schema: application/json
          terminalTranDateTime
          string <date-time> (端末取引日時)

          端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
          未設定の場合、自動で設定されます。

          depositOthers
          Array of objects (その他支払方法)

          個別アプリ専用支払方法IDを指定した取引を打消取消する際に、取消伝票番号を設定するのに利用します。
          ※キャンセル伝票は消込レコードに記録されます
          ※現状は最大1つしか指定できません

          Responses

          200

          更新成功

          400
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが存在しない場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが取消済の場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが打消取消済の場合
          • 取消対象の取引データの取引区分が、1,2,3,4,5,6,7,13,14 以外の場合
          • 取消対象の取引データが、国税庁に免税データを送信している場合
          • 取消対象の取引データが、回数券を購入している取引の場合
          • 指定した項番のその他支払方法が存在しない場合
          • その他支払方法の項番が重複している場合
          • 項番で指定したその他支払方法に含まれる支払方法IDが個別アプリ専用支払方法IDではない場合
          404
          • URI指定された取引IDが存在しなかった場合

          post /transactions/{id}/dispose

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}/dispose

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}/dispose

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "terminalTranDateTime": "2023-12-01T10:09:41Z",
          • "depositOthers":
            [
            ]
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "couponDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "depositOthers":
            [
            ],
          • "coupons":
            [
            ],
          • "couponItems":
            [
            ],
          • "recordedStaff":
            [
            ]
          }

          取引会員更新

          取引の会員情報を更新します。

          Plans:
          プレミアムプラス・フードビジネス・リテールビジネス

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          Request Body schema: application/json
          customerId
          string <int> (会員ID)

          会員コードとどちらかが必須です。(会員を解除する場合はnullを指定)

          customerCode
          string (会員コード) <= 20 characters /^[ -~]+$/

          会員IDとどちらかが必須です。(会員を解除する場合はnullを指定)

          pointUpdateDivision
          string (会員ポイント更新区分)
          Default: 0
          Enum: "0" "1" "2"

          会員ポイントの更新フラグ。
          0:(デフォルト値):ポイント変動なし
          1:変動あり(対象取引によって実際に加算・減算されたポイントの差分を、更新前のユーザーから更新後のユーザーに付け替える形で更新)
          2:変動あり(更新前・更新後の会員それぞれに対して、現在の会員個人設定または会員ランク、店舗のポイント付与区分を対象取引の内容に照らして、再計算した当該取引におけるポイント差分を反映する形で更新)

          Responses

          200

          更新成功

          400
          • 指定された取引の取引区分が1:通常でない場合
          • 会員IDまたは会員コードで指定した会員が存在しない場合
            ※ 会員IDと会員コードの両方を指定した場合は、指定された会員ID、会員コードが両方一致する会員情報が存在するかで判定されます
          • 取消済みの取引IDが指定された場合
          • 削除済み店舗の取引IDが指定された場合
          • 休止店舗の取引IDが指定された場合
          • バリューカードを伴う取引IDが指定された場合
          • ポイントを再計算する際に、会員を指定していない場合
          • ポイントを再計算する際に、取引を立てた店舗がポイント利用しない場合
          • 更新前の会員ポイントがマイナスになってしまう場合
          • 更新後の会員ポイントがマイナスになってしまう場合
          • 指定された取引に存在しない会員IDが設定されている場合
          404
          • URI指定の取引IDが存在しない場合
          patch /transactions/{id}/customer

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}/customer

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}/customer

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "customerId": "string",
          • "customerCode": "string",
          • "pointUpdateDivision": 0
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "couponDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "depositOthers":
            [
            ],
          • "coupons":
            [
            ],
          • "couponItems":
            [
            ]
          }

          取引明細一覧CSV作成

          取引明細情報一覧CSVファイルを作成します。
          ※ 取引明細CSVの作成処理は非同期で実行されます。処理完了後、指定されたコールバックURLに取得結果のCSVファイル(圧縮済み)をダウンロードするURLがWebhook通知されます。
          ※ Webhookで通知されるCSVダウンロードURLの期限は1時間です。
          ※ 取得件数の上限はありませんが、検索条件の取引日時(From)〜取引日時(To)の範囲を31日以内にする必要があります。

          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
          sortで使用可能なパラメータ ■transactionHeadId:取引ID
          ■transactionDetailId:取引明細ID
          ■transactionDetailDivision:取引明細区分
          ■transactionDateTime:取引日時
          ■transactionHeadDivision:取引区分
          ■storeId:店舗ID
          ■terminalId:端末ID
          ■customerId:会員ID
          ■terminalTranId:端末取引ID
          ■terminalTranDateTime:端末取引日時
          ■sumDate:締め日
          ■updDateTime:更新日時

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          Request Body schema: application/json
          fields
          string <string> (検索パラメータ)

          検索パラメータ(カンマ区切りで指定可)
          CSV出力項目(ResponsesのcallbackUrl説明欄参照)を指定可能

          sort
          string <string> (並び順)

          並び順(カンマ区切りで指定可)
          指定可能な項目については上記参照

          transactionHeadIdFrom
          string <string> (取引ID(From))

          取引ID(From)

          transactionHeadIdTo
          string <string> (取引ID(To))

          取引ID(To)

          transactionDateTimeFrom
          required
          string <string> (取引日時(From))

          取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
          ※指定必須。取引日時(From)〜取引日時(To)の期間は最大31日。

          transactionDateTimeTo
          required
          string <string> (取引日時(To))

          取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
          ※指定必須。取引日時(From)〜取引日時(To)の期間は最大31日。

          transactionHeadDivision
          string (取引区分)
          Enum: 1 10

          取引区分(1:通常,2:入金,3:出金,4:預かり金,5:預かり金返金,6:ポイント加算,7:ポイント減算,8:ポイント失効,9:回数券,10:取置き,11:チップ,13:マイル加算,14:マイル減算,15:バリューカード入金,16:領収証)
          ※ 1:通常、10:取置き のみ対応しています。

          storeId
          string <string> (店舗ID)

          店舗ID

          terminalTranDateTimeFrom
          string <string> (端末取引日時(From))

          端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          terminalTranDateTimeTo
          string <string> (端末取引日時(To))

          端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          sumDate
          string <string> (締め日)

          締め日 [YYYY-MM-DD]

          sumDateFrom
          string <string> (締め日(From))

          締め日(From) [YYYY-MM-DD]

          sumDateTo
          string <string> (締め日(To))

          締め日(To) [YYYY-MM-DD]

          customerSaleDivision
          string (取引区分)
          Enum: 0 1

          会員販売区分(0:非会員販売,1:会員販売)

          updDateTimeFrom
          string <string> (更新日時(From))

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

          updDateTimeTo
          string <string> (更新日時(To))

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

          callbackUrl
          required
          string <string> (取引明細CSV作成完了通知URL) <= 511 characters ^https?://\S+$

          取引明細CSVの作成処理が完了、もしくはエラーとなった際に、結果をWebhook通知するURL

          state
          string <string> (完了通知ステートメント) <= 20 characters

          取引明細CSV作成完了通知URLに完了通知する際に設定できる任意の文字列
          クエリパラメータとして同時に通知されます

          リクエスト例:
          リクエストヘッダ
          keyvalue
          Content-Typeapplication/json
          Request-Code問い合わせ用コード。弊社への問い合わせの際にご利用ください。
          リクエストボディ
          keyvalue
          file_urlダウンロードURL。成功時のみ付与
          statussuccess:成功, failed:失敗
          messageメッセージ(成功時:空欄,取得データなし:no data,失敗時:500 internal error)
          proc_nameget_transaction_detail_list
          statestateで指定した文字列
          request_code問い合わせ用コード。弊社への問い合わせの際にご利用ください。
          ※ callbackUrlに通知される生成されたファイルのドメインは予告なく変更される場合があります。

          Responses

          200

          取得成功

          400
          • 取引ID(From)と取引ID(To)の範囲指定が不正な場合
          • 取引日時(From)と取引日時(To)の範囲指定が不正な場合
          • 取引日時(From)と取引日時(To)の範囲が31日を超える場合
          • 端末取引日時(From)と端末取引日時(To)の範囲指定が不正な場合
          • 締め日(From)と締め日(To)の範囲指定が不正な場合
          • 締め日に締め日(From)と締め日(To)の範囲外の日付が指定された場合
          • 更新日時(From)と更新日時(To)の範囲指定が不正な場合
          post /transactions/details/out_file_async

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/details/out_file_async

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/details/out_file_async

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "fields": "string",
          • "sort": "string",
          • "transactionHeadIdFrom": "string",
          • "transactionHeadIdTo": "string",
          • "transactionDateTimeFrom": "string",
          • "transactionDateTimeTo": "string",
          • "transactionHeadDivision": 1,
          • "storeId": "string",
          • "terminalTranDateTimeFrom": "string",
          • "terminalTranDateTimeTo": "string",
          • "sumDate": "string",
          • "sumDateFrom": "string",
          • "sumDateTo": "string",
          • "customerSaleDivision": 0,
          • "updDateTimeFrom": "string",
          • "updDateTimeTo": "string",
          • "callbackUrl": "string",
          • "state": "string"
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "callbackUrl": "string",
          • "state": "string",
          • "requestCode": "string"
          }

          取引明細取得

          取引明細情報を取得します。

          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
          sortで使用可能なパラメータ ■transactionHeadId:取引ID
          ■transactionDetailId:取引明細ID
          ■transactionDetailDivision:取引明細区分

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          query Parameters
          fields
          array

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

          sort
          string

          並び順(カンマ区切りで指定可)
          指定可能な項目については上記参照

          limit
          integer

          上限数

          page
          integer

          ページ

          with_discounts
          string
          Default: "none"
          Enum: "all" "none"

          単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone)

          with_detail_product_attributes
          string
          Default: "none"
          Enum: "all" "none"

          販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone)

          Responses

          200

          取得成功

          get /transactions/{id}/details

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/{id}/details

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/{id}/details

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          [
          • {
            }
          ]

          取置き一覧取得

          取置き一覧を取得します。

          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
          sortで使用可能なパラメータ ■transactionHeadId : 取引ID
          ■transactionDateTime : 取引日時
          ■storeId : 店舗ID
          ■terminalId : 端末ID
          ■customerId : 会員ID
          ■terminalTranId : 端末取引ID
          ■terminalTranDateTime : 端末取引日時
          ■sumDate : 締め日
          ■updDateTime : 更新日時
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します。

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          query Parameters
          fields
          array

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

          sort
          string

          並び順(カンマ区切りで指定可)
          指定可能な項目については上記参照

          limit
          integer

          上限数

          page
          integer

          ページ

          transaction_head_id-from
          string

          取引ID(From)

          transaction_head_id-to
          string

          取引ID(To)

          transaction_date_time-from
          string

          取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          transaction_date_time-to
          string

          取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          store_id
          string

          店舗ID:店舗毎に付与するID。

          terminal_tran_date_time-from
          string

          端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          terminal_tran_date_time-to
          string

          端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          <※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          adjustment_date_time
          string

          精算日時 [YYYY-MM-DDThh:mm:ssTZD]

          sum_date
          string

          締め日:締めをしたら年月日が入る。 [YYYY-MM-DD]

          sum_date-from
          string

          締め日(From) :[YYYY-MM-DD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          sum_date-to
          string

          締め日(To) :[YYYY-MM-DD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取置きデータにアクセスしたい、または、長期間にわたる大量の取置きデータを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          customer_code
          string

          会員コード

          transaction_uuid
          string

          レシート番号:指定した値を完全一致で検索します

          upd_date_time-from
          string

          更新日時(From):登録時・更新時の日時。締め日(From)[YYYY-MM-DD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          upd_date_time-to
          string

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

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
          ※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


          ※ 頻繁に取引データにアクセスしたい、または、長期間にわたる大量の取引データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          with_layaway
          string
          Default: "none"
          Enum: "all" "none"

          取置き情報を付加するか(付加する場合はall, しない場合はnone)

          with_layaway_pick_up
          string
          Default: "none"
          Enum: "all" "none"

          取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

          Responses

          200

          取得成功

          get /transactions/layaways

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/layaways

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/layaways

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          [
          • {
            }
          ]

          取置き登録

          取置き取引を登録します。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          Request Body schema: application/json
          transactionHeadDivision
          required
          string (取引区分)
          Value: 10

          取引を識別する区分。
          (1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
          ※ 取置き登録APIは、10:取置きのみ対応しています。

          subtotal
          required
          string <int> (小計) [ -999999999 .. 999999999 ]

          取引明細の値引き後小計の合計。
          ※明細合計と異なる場合エラー

          subtotalDiscountPrice
          string <int> (小計値引き) [ -999999999 .. 999999999 ]

          小計の値引き金額を設定。

          subtotalDiscountRate
          string <int> (小計割引率) [ -999 .. 999 ]

          小計の割引を設定 (単位%) デフォルトは未設定。
          設定された場合、小計値引は必須。
          ※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

          subtotalDiscountDivision
          string <int> (小計値引き/割引区分) [ 1 .. 999999999 ]

          小計値引き/割引時に指定された区分を設定。
          管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

          pointDiscount
          string <int> (ポイント値引き) [ -999999999 .. 999999999 ]

          使用ポイント * ポイント還元率。

          total
          required
          string <int> (合計) [ -999999999 .. 999999999 ]

          小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
          ※ 端数値引き機能は現在ご利用いただけません

          taxInclude
          string <int> (内税額) [ -999999999 .. 999999999 ]

          内税商品計 / 110 * 10。
          ※税率が10%の場合
          ※小数点以下は税の丸め方式で指定の通り

          taxExclude
          string <int> (外税額) [ -999999999 .. 999999999 ]

          外税商品計 * 10 / 100。
          ※税率が10%の場合
          ※小数点以下は税の丸め方式で指定の通り

          roundingDivision
          string (端数値引区分)
          Enum: "00" "11" "12" "13" "21" "22" "23" "31" "32" "33" "41" "42" "43" "99"

          販売時の合計金額の端数を丸めるか否かを設定する。
          00:なし
          11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
          21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
          31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
          41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
          99:手入力

          roundingPrice
          string <int> (端数値引額) [ -999999999 .. 999999999 ]
          deposit
          string <int> (預かり金) [ -999999999 .. 999999999 ]

          会計時に預かった金額。(預かり金現金 + 預かり金クレジット + 預かり金その他)
          ※預かり金を正しく設定しないと、日報が正しく表示されません。

          depositCash
          string <int> (預かり金現金) [ -999999999 .. 999999999 ]

          会計時に預かった現金金額。
          ※現金支払の場合必ず設定。(預かり金現金 - 釣銭)が現金支払額に設定されます。
          ※預かり金を正しく設定しないと、日報が正しく表示されません。

          depositCredit
          string <int> (預かり金クレジット) [ -999999999 .. 999999999 ]

          会計時に預かったクレジット金額。
          ※クレジット払いの場合必ず設定。預かり金クレジットが内クレジット支払金額に設定されます。
          ※預かり金を正しく設定しないと、日報が正しく表示されません。

          change
          string <int> (釣銭) [ -999999999 .. 999999999 ]

          釣銭。現金の返却金額。
          ※預かり金を正しく設定しないと、日報が正しく表示されません。

          storeId
          required
          string <int> (店舗ID) [ 1 .. 999999999 ]

          店舗毎に付与するID。
          ※店舗情報が存在しない場合エラー
          ※休止中の店舗IDを指定するとエラー

          terminalId
          required
          string <int> (端末ID) [ 1 .. 999999999 ]

          店舗の端末毎に付与するID。
          ※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)

          customerId
          string <int> (会員ID) [ 1 .. 9999999999 ]

          会員毎に付与するID。
          ※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
          ※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

          customerCode
          string (会員コード) <= 20 characters /^[ -~]+$/

          会員毎に付与する一意のコード。
          ※設定された場合、会員IDは必須。
          ※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。
          ※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。(スマレジ管理画面ver.4.12.0リリース以降)

          terminalTranId
          required
          string (端末取引ID) <= 10 characters

          端末で設定された取引ID。(連携元システムで任意の連番を設定してください)

          terminalTranDateTime
          required
          string <date-time> (端末取引日時)

          端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD](連携元システムで処理日時を設定してください)

          sumDivision
          string (締め区分)
          Default: 0
          Enum: 0 1 2

          締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)
          ※省略時は、店舗情報の締め方式区分に合わせて設定します。
          ※0:未処理または1:精算処理済みは、店舗の締め方式区分が「手動締め処理」のときのみ設定可能。
          ※存在しない端末IDを設定した場合、2:締め処理済みを設定してください。

          sumDate
          string <date> (締め日)

          締めをしたら年月日が入る。 [YYYY-MM-DD]
          ※締め区分を2に設定した場合必須。締め区分を0に設定した場合設定不可。

          customerRank
          string (会員ランク) <= 20 characters

          管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。
          存在しないコードを設定するとエラーになります。

          customerGroupId
          string <int> (客層ID) [ 1 .. 999999999 ]

          客層ID。客層セクションIDが1の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId2
          string <int> (客層ID2) [ 1 .. 999999999 ]

          客層ID2。客層セクションIDが2の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId3
          string <int> (客層ID3) [ 1 .. 999999999 ]

          客層ID3。客層セクションIDが3の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId4
          string <int> (客層ID4) [ 1 .. 999999999 ]

          客層ID4。客層セクションIDが4の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId5
          string <int> (客層ID5) [ 1 .. 999999999 ]

          客層ID5。客層セクションIDが5の客層IDを設定。
          ※客層情報が存在しない場合エラー

          staffId
          string <int> (販売員ID) [ 1 .. 999999999 ]

          販売員ID(スタッフID)
          ※スタッフ情報が存在しない場合エラー
          ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

          memo
          string (メモ) <= 1000 characters

          入出金時のメモなどを設定。 1000文字以内。

          receiptMemo
          string (レシートメモ) <= 100 characters

          レシートに印字するメモを設定。100文字以内。

          guestNumbers
          string <int> (客数) [ 0 .. 9999 ]

          客数。

          guestNumbersMale
          string <int> (客数(男)) [ 0 .. 9999 ]

          客数(男)。

          guestNumbersFemale
          string <int> (客数(女)) [ 0 .. 9999 ]

          客数(女)。

          guestNumbersUnknown
          string <int> (客数(不明)) [ 0 .. 9999 ]

          客数(不明)。

          enterDateTime
          string <date-time> (入店日時)

          入店日時。[YYYY-MM-DDThh:mm:ssTZD]

          taxFreeSalesDivision
          string (免税販売区分)
          Default: 0
          Enum: 0 1 2 3 4 5

          免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
          ※未設定の場合、0:通常販売

          netTaxFreeGeneralTaxInclude
          string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ]

          内税商品の一般品免税額。

          netTaxFreeGeneralTaxExclude
          string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ]

          外税商品の一般品免税額。

          netTaxFreeConsumableTaxInclude
          string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ]

          内税商品の消耗品免税額。

          netTaxFreeConsumableTaxExclude
          string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ]

          外税商品の消耗品免税額。

          tags
          string (取引タグ) <= 255 characters

          レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
          ※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

          pointGivingDivision
          string (ポイント付与税区分)
          Enum: 1 2 3 4

          1:税額を含める + 利用ポイント分を含める、
          2:税額を含めない + 利用ポイント分を含める、
          3:税額を含める + 利用ポイント分を含めない、
          4:税額を含めない + 利用ポイント分を含めない
          ※省略時、店舗マスタから設定。

          pointGivingUnitPrice
          string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

          ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)
          (例10円ごとに2ポイントの場合、10円)
          ※未設定の場合は店舗マスタから設定。

          pointGivingUnit
          string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

          ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
          (例10円ごとに0.2ポイントの場合、0.2ポイント)
          ※未設定の場合は店舗マスタから設定。

          pointSpendDivision
          string (ポイント利用区分)
          Default: 1
          Enum: 1 2

          ポイント利用時の税を含む/含まないを判定。
          1:ポイント利用を現金として扱う (税を含む値引き)
          2:ポイント利用を値引として扱う (税を含まない値引き)
          ※未設定の場合は店舗マスタから設定。 初期値:1。

          mileageDivision
          string (マイレージ利用区分)
          Default: 0
          Enum: 0 1 2

          マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
          ※未設定の場合は店舗マスタから設定。 初期値:0。

          mileageLabel
          string (マイレージラベル) <= 32 characters

          マイレージの名称。未設定の場合は「マイル」

          customerPinCode
          string (PINコード) <= 32 characters

          自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。

          sellDivision
          string (販売区分)
          Enum: 0 1

          取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
          ※省略時は0:内税販売を設定

          taxRate
          string <decimal> (税率) [ 0 .. 99999.999 ]

          税率 (単位%)
          ※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)

          taxRounding
          string (税の丸め方式)
          Enum: 0 1 2

          税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
          ※省略時はスマレジに設定されている税の丸め方式を設定

          discountRoundingDivision
          string (割引丸め区分)
          Enum: 0 1 2

          割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
          ※省略時は店舗マスタに設定されている税の丸め方式を設定

          transactionUuid
          string (レシート番号) <= 20 characters

          レシートに印字する番号。ユニークな値を設定してください。
          ※レシート番号が重複するとスマレジ・アプリにて取引データの呼び出しができなくなる可能性があります
          ※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁

          exchangeTicketNo
          string (引換券番号) <= 20 characters
          giftReceiptValidDays
          string <int> (ギフトレシート引換有効日数) [ 0 .. 999999999 ]

          有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

          discountCalculateDivision
          string (割引額計算対象)
          Default: 0
          Enum: 0 1

          小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。
          0:小計(明細から算出された、値引・割引前の小計を一律対象に割引率を乗算したものを割引額とします。)
          1:他の値引割引に追従した小計(小計に対し他の値引・割引で変動した後の金額を都度対象に割引率を乗算したものを割引額とします。小計値引・割引 → クーポン値引・割引 の順番で計算されます。ただし、取置き登録APIでは現状クーポンを指定できないため、クーポン値引・割引の考慮は不要です。)
          ※割引額計算対象の設定値は取引登録後にスマレジ・アプリにて取引を編集する際の割引額算出に使用します。
          ※(注)取置き登録APIでは、自動算出した値ではなくsubtotalDiscountPrice(小計値引き)の設定値を割引額に登録します。そのため、APIで登録される取引の割引額が割引額計算対象の設定値によって変動することはありません。

          details
          Array of objects (取引明細)
          layaway
          object (取置き情報)

          取置き時の情報

          Responses

          200

          更新成功

          400
          • 小計割引率が設定されており、小計値引きが未指定の場合
          • 存在しない店舗IDを指定した場合
          • 店舗が倉庫の店舗IDを指定した場合
          • 店舗が休止中の店舗IDを指定した場合
          • 存在しない端末IDを指定し、締め区分を 2:締め処理済み 以外を指定した場合
          • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 1:清算処理済み を指定した場合
          • 対象店舗の締め方式区分の設定が「自動締め処理」で、締め区分に 0:未処理 を指定した場合
          • 締め区分が 2:締め処理済み以外で、締め日を設定した場合
          • 締め区分が2:締め処理済で、締め日が未指定の場合
          • 会員コードを設定し、会員IDが未設定の場合
          • 現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
          • 客層IDが指定した客層セクションに存在しない場合
          • 存在しない販売員IDを指定した場合
          • レシート番号が重複した場合
          • 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
          • 1取引タグが64文字を超える場合
          • 取引区分が 10:取置き で、取引明細が存在しない場合
          • 取引明細IDが明細間で重複した場合
          • 同じ取引の明細に存在しない親取引明細IDを指定した場合
          • 商品IDで指定された商品の持つ商品区分が回数券である場合
          • 商品区分が 0:通常/4:バンドル販売(親)であり、親取引明細IDを指定した場合
          • 商品区分が 2:オプション商品/7:バンドル商品(子)/8:バンドル値引(子)で親取引明細IDが未指定の場合
          • 商品区分が 2:オプション商品 であるが、商品IDで指定された商品の持つ商品区分が 2:オプション商品 でない場合
          • 商品区分が 2:オプション商品 の明細で、販売数が親取引明細における販売数の整数倍でない場合
          • 商品区分が 2:オプション商品 である取引明細とその親取引明細に対して、存在する商品IDがともに設定されており、かつ前者の商品が後者の商品に対して付与可能なオプショングループに所属していない場合
          • 商品区分が 4:バンドル販売(親)の明細以外で商品バンドルグループを指定した場合
          • 商品区分が 0:通常販売/4:バンドル(親) の場合に親取引明細IDを指定した場合
          • 商品区分が 4:バンドル(親) の場合で、同じ取引の明細に 7:バンドル子/8:バンドル値引 かつ親取引明細IDが親自身であるものが存在しない場合
          • 商品区分が 7:バンドル子/8:バンドル値引 で、親取引IDにバンドル(親)の取引明細IDが設定されていない場合
          • 商品バンドルグループIDを設定し、商品区分が 4:バンドル(親) でない場合
          • 単品割引率を設定し、単品値引が未設定の場合
          • 現在の商品マスタの部門IDと、リクエストの部門IDが異なる場合
          • 部門IDが存在しない場合
          • 小計が明細合計と一致しない場合
          • 合計が計算値と一致しない場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が重複した場合
          • 前受金区分が 2:クレジットで、預り金現金に金額が設定されている場合
          • 前受金区分が 2:クレジット以外で、預り金クレジットに金額が設定されている場合
          • 預り金 = (預かり金現金 + 預かり金クレジット) となるように設定されていない場合
          • 前受金 = (預かり金 - 釣銭) となるように設定されていない場合
          post /transactions/layaways

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/layaways

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/layaways

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadDivision": 10,
          • "subtotal": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "00",
          • "roundingPrice": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "customerCode": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "2023-12-01T10:09:41Z",
          • "sumDivision": 0,
          • "sumDate": "2023-12-01",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "2023-12-01T10:09:41Z",
          • "taxFreeSalesDivision": 0,
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": 1,
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": 1,
          • "mileageDivision": 0,
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "sellDivision": 0,
          • "taxRate": "string",
          • "taxRounding": 0,
          • "discountRoundingDivision": 0,
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "discountCalculateDivision": 0,
          • "details":
            [
            ],
          • "layaway":
            {
            }
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "discountCalculateDivision": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "layaway":
            {
            }
          }

          取置き取得

          取置き情報を取得します。

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

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          query Parameters
          fields
          array

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

          with_details
          string
          Default: "none"
          Enum: "all" "summary" "none"

          取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

          with_discounts
          string
          Default: "none"
          Enum: "all" "none"

          小計値引/割引、単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone)

          with_store
          string
          Default: "none"
          Enum: "all" "none"

          店舗情報を付加するか(付加する場合はall, しない場合はnone)

          with_customer
          string
          Default: "none"
          Enum: "all" "none"

          会員情報を付加するか(付加する場合はall, しない場合はnone)

          with_customer_groups
          string
          Default: "none"
          Enum: "all" "none"

          客層情報を付加するか(付加する場合はall, しない場合はnone)

          with_staff
          string
          Default: "none"
          Enum: "all" "none"

          スタッフ情報を付加するか(付加する場合はall, しない場合はnone)

          with_layaway
          string
          Default: "none"
          Enum: "all" "none"

          取置き情報を付加するか(付加する場合はall, しない場合はnone)

          with_layaway_pick_up
          string
          Default: "none"
          Enum: "all" "none"

          取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

          Responses

          200

          取得成功

          get /transactions/layaways/{id}

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/layaways/{id}

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/layaways/{id}

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": null,
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "discountCalculateDivision": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "discounts":
            [
            ],
          • "layaway":
            {
            },
          • "layawayPickUp":
            {
            },
          • "store":
            {
            },
          • "customer":
            {
            },
          • "customerGroups":
            [
            ],
          • "staff":
            {
            }
          }

          取置き打消取消

          取置きを打消取消します。指定された取置きに対して、返品する取置き情報を作成します。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          取引ID

          Request Body schema: application/json
          terminalTranDateTime
          string <date-time> (端末取引日時)

          端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
          未設定の場合、自動で設定されます。

          Responses

          200

          更新成功

          400
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが存在しない場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが取消済の場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)と同じ取引データが打消取消済の場合
          • 取消対象の取引データの取引区分が、10 以外の場合
          • 取消対象の取引データが、引取済の場合
          404
          • URI指定された取引IDが存在しなかった場合

          post /transactions/layaways/{id}/dispose

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/layaways/{id}/dispose

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/layaways/{id}/dispose

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "terminalTranDateTime": "2023-12-01T10:09:41Z"
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "unitStaffDiscountsubtotal": "string",
          • "unitBargainDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "cashTotal": "string",
          • "creditTotal": "string",
          • "deposit": "string",
          • "depositCash": "string",
          • "depositCredit": "string",
          • "change": "string",
          • "tipCash": "string",
          • "tipCredit": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "salesHeadDivision": "string",
          • "inTaxSalesTotal": "string",
          • "outTaxSalesTotal": "string",
          • "nonTaxSalesTotal": "string",
          • "nonSalesTargetTotal": "string",
          • "nonSalesTargetInTaxTotal": "string",
          • "nonSalesTargetOutTaxTotal": "string",
          • "nonSalesTargetTaxFreeTotal": "string",
          • "nonSalesTargetCostTotal": "string",
          • "nonSalesTargetAmount": "string",
          • "nonSalesTargetReturnAmount": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "currentMile": "string",
          • "earnMile": "string",
          • "totalMile": "string",
          • "adjustmentMile": "string",
          • "adjustmentMileDivision": "string",
          • "adjustmentMileValue": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "sumDivision": "string",
          • "adjustmentDateTime": "string",
          • "sumDate": "string",
          • "customerRank": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "creditDivision": "string",
          • "paymentCount": "string",
          • "slipNumber": "string",
          • "cancelSlipNumber": "string",
          • "authNumber": "string",
          • "authDate": "string",
          • "cardCompany": "string",
          • "denomination": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "carriage": "string",
          • "commission": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "pointGivingDivision": "string",
          • "pointGivingUnitPrice": "string",
          • "pointGivingUnit": "string",
          • "pointSpendDivision": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "customerPinCode": "string",
          • "returnSales": "string",
          • "disposeDivision": "string",
          • "disposeServerTransactionHeadId": "string",
          • "cancelDateTime": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "transactionUuid": "string",
          • "exchangeTicketNo": "string",
          • "giftReceiptValidDays": "string",
          • "updDateTime": "string",
          • "details":
            [
            ],
          • "layaway":
            {
            }
          }

          仮販売一覧取得

          仮販売取引情報一覧を取得します。

          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
          sortで使用可能なパラメータ ■transactionHeadId:取引ID
          ■transactionDateTime:取引日時
          ■barcode:バーコード
          ■sequentialNumber:連番
          ■storeId:店舗ID
          ■terminalId:端末ID
          ■customerId:会員ID
          ■terminalTranId:端末取引ID
          ■terminalTranDateTime:端末取引日時

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          query Parameters
          fields
          array

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

          sort
          string

          並び順(カンマ区切りで指定可)
          指定可能な項目については上記参照

          limit
          integer

          上限数

          page
          integer

          ページ

          transaction_head_id-from
          string

          仮販売取引ID(From)

          transaction_head_id-to
          string

          仮販売取引ID(To)

          transaction_date_time-from
          string

          取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


          ※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          transaction_date_time-to
          string

          取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


          ※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          store_id
          integer

          店舗ID

          terminal_tran_date_time-from
          string

          端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


          ※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          terminal_tran_date_time-to
          string

          端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

          ※ From〜Toの期間は最大31日までの指定でご利用ください
          ※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


          ※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

          customer_code
          string

          会員コード

          status
          string <string>
          Enum: 0 1 2

          ステータス:仮販売のステータス。(0:通常、1:完了、2:取消)

          barcode
          string

          バーコード

          with_details
          string
          Default: "none"
          Enum: "all" "summary" "none"

          仮販売取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

          Responses

          200

          取得成功

          get /transactions/temporaries

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/temporaries

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/temporaries

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          [
          • {
            }
          ]

          仮販売登録

          仮販売取引を登録します。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          Request Body schema: application/json
          transactionHeadDivision
          required
          string (取引区分)
          Value: 1

          取引を識別する区分。
          (1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
          ※ 仮販売登録APIは、1:通常のみ対応しています。

          status
          required
          string (ステータス)
          Value: 0

          仮販売のステータス。(0:通常、1:完了、2:取消)
          ※ 仮販売登録APIは、0:通常のみ対応しています。

          barcode
          string (バーコード) <= 20 characters

          ユニーク値 バーコード
          ※省略時はシステムで一意のバーコードを設定

          sequentialNumber
          string <int> (連番) [ 1 .. 99999999999 ]

          連番
          ※省略時はシステムで日毎の連番を設定

          preRegistrationName
          string (仮取引名) <= 20 characters

          仮取引の名称を設定。20文字以内。
          ※設定した場合、スマレジアプリ取引機能において、仮販売一覧に表示されます。設定しない場合は連番が表示されます。

          subtotal
          required
          string <int> (小計) [ -999999999 .. 999999999 ]

          取引明細の値引き後小計の合計。
          ※明細合計と異なる場合エラー

          subtotalDiscountPrice
          string <int> (小計値引き) [ -999999999 .. 999999999 ]

          小計の値引き金額を設定。

          subtotalDiscountRate
          string <int> (小計割引率) [ -999 .. 999 ]

          小計の割引を設定 (単位%) デフォルトは未設定。
          設定された場合、小計値引は必須。
          ※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

          subtotalDiscountDivision
          string <int> (小計値引き/割引区分) [ 1 .. 999999999 ]

          小計値引き/割引時に指定された区分を設定。
          管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

          pointDiscount
          string <int> (ポイント値引き) [ -999999999 .. 999999999 ]

          使用ポイント * ポイント還元率。

          total
          required
          string <int> (合計) [ -999999999 .. 999999999 ]

          小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額 を設定
          ※ 端数値引き機能は現在ご利用いただけません

          taxInclude
          string <int> (内税額) [ -999999999 .. 999999999 ]

          内税商品計 / 110 * 10。
          ※税率が10%の場合
          ※小数点以下は税の丸め方式で指定の通り

          taxExclude
          string <int> (外税額) [ -999999999 .. 999999999 ]

          外税商品計 * 10 / 100。
          ※税率が10%の場合
          ※小数点以下は税の丸め方式で指定の通り

          roundingDivision
          string (端数値引区分)
          Enum: "00" "11" "12" "13" "21" "22" "23" "31" "32" "33" "41" "42" "43" "99"

          販売時の合計金額の端数を丸めるか否かを設定する。
          00:なし
          11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
          21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
          31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
          41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
          99:手入力

          roundingPrice
          string <int> (端数値引額) [ -999999999 .. 999999999 ]
          newPoint
          string <int> (付与ポイント) [ -999999999 .. 999999999 ]
          Default: 0

          取引で付与されるポイント。 合計 * ポイント付与率
          会員IDが設定されている場合、会員ポイント情報を更新。
          ※省略時は0を設定

          spendPoint
          string <int> (使用ポイント) [ -999999999 .. 999999999 ]

          取引で使用したポイント。
          会員IDが設定されている場合、会員ポイント情報を更新。
          ※省略時は0を設定

          point
          string <int> (現在ポイント) [ -999999999 .. 999999999 ]

          取引前のポイント。

          totalPoint
          string <int> (合計ポイント) [ -999999999 .. 999999999 ]

          取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。

          storeId
          required
          string <int> (店舗ID) [ 1 .. 999999999 ]

          店舗毎に付与するID。
          ※店舗情報が存在しない場合エラー
          ※休止中の店舗IDを指定するとエラー

          terminalId
          required
          string <int> (端末ID) [ 1 .. 999999999 ]

          店舗の端末毎に付与するID。
          ※存在しない端末IDも設定可能。

          customerId
          string <int> (会員ID) [ 1 .. 9999999999 ]

          会員毎に付与するID。
          ※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。

          customerCode
          string (会員コード) <= 20 characters /^[ -~]+$/

          会員毎に付与する一意のコード。
          ※設定された場合、会員IDは必須。
          ※会員マスタに存在する会員IDが設定されている場合、会員情報の会員コードと一致しないとエラー。
          ※省略時、会員IDが設定されている場合、会員マスタの会員コードを設定。(スマレジ管理画面ver.4.12.0リリース以降)

          terminalTranId
          required
          string (端末取引ID) <= 10 characters

          端末で設定された取引ID。(連携元システムで任意の連番を設定してください)

          terminalTranDateTime
          required
          string <date-time> (端末取引日時)

          端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD](連携元システムで処理日時を設定してください)

          customerGroupId
          string <int> (客層ID) [ 1 .. 999999999 ]

          客層ID。客層セクションIDが1の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId2
          string <int> (客層ID2) [ 1 .. 999999999 ]

          客層ID2。客層セクションIDが2の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId3
          string <int> (客層ID3) [ 1 .. 999999999 ]

          客層ID3。客層セクションIDが3の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId4
          string <int> (客層ID4) [ 1 .. 999999999 ]

          客層ID4。客層セクションIDが4の客層IDを設定。
          ※客層情報が存在しない場合エラー

          customerGroupId5
          string <int> (客層ID5) [ 1 .. 999999999 ]

          客層ID5。客層セクションIDが5の客層IDを設定。
          ※客層情報が存在しない場合エラー

          staffId
          string <int> (販売員ID) [ 1 .. 999999999 ]

          販売員ID(スタッフID)
          ※スタッフ情報が存在しない場合エラー
          ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗の販売員IDを指定してください。

          memo
          string (メモ) <= 1000 characters

          入出金時のメモなどを設定。 1000文字以内。

          receiptMemo
          string (レシートメモ) <= 100 characters

          レシートに印字するメモを設定。100文字以内。

          guestNumbers
          string <int> (客数) [ 0 .. 9999 ]

          客数。

          guestNumbersMale
          string <int> (客数(男)) [ 0 .. 9999 ]

          客数(男)。

          guestNumbersFemale
          string <int> (客数(女)) [ 0 .. 9999 ]

          客数(女)。

          guestNumbersUnknown
          string <int> (客数(不明)) [ 0 .. 9999 ]

          客数(不明)。

          enterDateTime
          string <date-time> (入店日時)

          入店日時。[YYYY-MM-DDThh:mm:ssTZD]

          taxFreeSalesDivision
          string (免税販売区分)
          Default: 0
          Enum: 0 1 2 3 4 5

          免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
          ※未設定の場合、0:通常販売

          netTaxFreeGeneralTaxInclude
          string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ]

          内税商品の一般品免税額。

          netTaxFreeGeneralTaxExclude
          string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ]

          外税商品の一般品免税額。

          netTaxFreeConsumableTaxInclude
          string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ]

          内税商品の消耗品免税額。

          netTaxFreeConsumableTaxExclude
          string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ]

          外税商品の消耗品免税額。

          tags
          string (取引タグ) <= 255 characters

          レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
          ※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。

          mileageDivision
          string (マイレージ利用区分)
          Default: 0
          Enum: 0 1 2

          マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
          ※未設定の場合は店舗マスタから設定。 初期値:0。

          mileageLabel
          string (マイレージラベル) <= 32 characters

          マイレージの名称。未設定の場合は「マイル」

          sellDivision
          string (販売区分)
          Enum: 0 1

          取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
          ※省略時は0:内税販売を設定

          taxRate
          string <decimal> (税率) [ 0 .. 99999.999 ]

          税率 (単位%)
          ※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)

          taxRounding
          string (税の丸め方式)
          Enum: 0 1 2

          税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
          ※省略時はスマレジに設定されている税の丸め方式を設定

          discountRoundingDivision
          string (割引丸め区分)
          Enum: 0 1 2

          割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
          ※省略時は店舗マスタに設定されている税の丸め方式を設定

          details
          required
          Array of objects (取引明細)

          Responses

          200

          更新成功

          400
          • 小計割引率が設定されており、小計値引きが未指定の場合
          • 存在しない店舗IDを指定した場合
          • 店舗が倉庫の店舗IDを指定した場合
          • 店舗が休止中の店舗IDを指定した場合
          • 会員コードを設定し、会員IDが未設定の場合
          • 現在の会員マスタの会員コードと、リクエストの会員コードが異なる場合
          • 客層IDが指定した客層セクションに存在しない場合
          • 存在しない販売員IDを指定した場合
          • 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
          • 1取引タグが64文字を超える場合
          • 取引明細が存在しない場合
          • 取引明細IDが明細間で重複した場合
          • 同じ取引の明細に存在しない親取引明細IDを指定した場合
          • 商品IDで指定された商品の持つ商品区分が回数券である場合
          • 商品区分が 0:通常/4:バンドル販売(親)であり、親取引明細IDを指定した場合
          • 商品区分が 2:オプション商品/7:バンドル商品(子)/8:バンドル値引(子)で親取引明細IDが未指定の場合
          • 商品区分が 2:オプション商品 であるが、商品IDで指定された商品の持つ商品区分が 2:オプション商品 でない場合
          • 商品区分が 2:オプション商品 の明細で、販売数が親取引明細における販売数の整数倍でない場合
          • 商品区分が 2:オプション商品 である取引明細とその親取引明細に対して、存在する商品IDがともに設定されており、かつ前者の商品が後者の商品に対して付与可能なオプショングループに所属していない場合
          • 商品区分が 4:バンドル販売(親)の明細以外で商品バンドルグループを指定した場合
          • 商品区分が 0:通常販売/4:バンドル(親) の場合に親取引明細IDを指定した場合
          • 商品区分が 4:バンドル(親) の場合で、同じ取引の明細に 7:バンドル子/8:バンドル値引 かつ親取引明細IDが親自身であるものが存在しない場合
          • 商品区分が 7:バンドル子/8:バンドル値引 で、親取引IDにバンドル(親)の取引明細IDが設定されていない場合
          • 商品バンドルグループIDを設定し、商品区分が 4:バンドル(親) でない場合
          • 単品割引率を設定し、単品値引が未設定の場合
          • 現在の商品マスタの部門IDと、リクエストの部門IDが異なる場合
          • 商品コードが存在しない場合
          • 部門IDが存在しない場合
          • 小計が明細合計と一致しない場合
          • 合計が計算値と一致しない場合
          • バーコードが重複した場合
          • ユニークキー(店舗ID、端末ID、端末取引日時、端末取引ID)が重複した場合
          post /transactions/temporaries

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/temporaries

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/temporaries

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadDivision": 1,
          • "status": 0,
          • "barcode": "string",
          • "sequentialNumber": "string",
          • "preRegistrationName": "string",
          • "subtotal": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "00",
          • "roundingPrice": "string",
          • "newPoint": 0,
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "customerCode": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "2023-12-01T10:09:41Z",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "2023-12-01T10:09:41Z",
          • "taxFreeSalesDivision": 0,
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "mileageDivision": 0,
          • "mileageLabel": "string",
          • "sellDivision": 0,
          • "taxRate": "string",
          • "taxRounding": 0,
          • "discountRoundingDivision": 0,
          • "details":
            [
            ]
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "status": "string",
          • "barcode": "string",
          • "sequentialNumber": "string",
          • "preRegistrationName": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "returnSales": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "details":
            [
            ]
          }

          仮販売取得

          仮販売取引情報を取得します。


          sortで使用可能なパラメータ
          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          仮販売取引ID

          query Parameters
          fields
          array

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

          with_details
          string
          Default: "none"
          Enum: "all" "summary" "none"

          仮販売取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

          with_store
          string
          Default: "none"
          Enum: "all" "none"

          店舗情報を付加するか(付加する場合はall, しない場合はnone)

          with_customer
          string
          Default: "none"
          Enum: "all" "none"

          会員情報を付加するか(付加する場合はall, しない場合はnone)

          with_customer_groups
          string
          Default: "none"
          Enum: "all" "none"

          客層情報を付加するか(付加する場合はall, しない場合はnone)

          with_staff
          string
          Default: "none"
          Enum: "all" "none"

          スタッフ情報を付加するか(付加する場合はall, しない場合はnone)

          Responses

          200

          取得成功

          404
          • 指定した仮販売取引IDが存在しない場合
          get /transactions/temporaries/{id}

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/temporaries/{id}

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/temporaries/{id}

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "status": "string",
          • "barcode": "string",
          • "sequentialNumber": "string",
          • "preRegistrationName": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "returnSales": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "details":
            [
            ],
          • "store":
            {
            },
          • "customer":
            {
            },
          • "customerGroups":
            [
            ],
          • "staff":
            {
            }
          }

          仮販売削除

          指定された仮販売取引を削除します。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          仮販売取引ID

          Responses

          200

          削除成功

          400
          • ステータスが 1:完了 の仮販売が指定された場合
          404
          • 指定した仮販売取引IDが存在しない場合
          delete /transactions/temporaries/{id}

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/temporaries/{id}

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/temporaries/{id}

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "type": "about:blank",
          • "title": "Bad Request",
          • "detail": "既に完了済みの為、削除できません。",
          • "status": 400
          }

          仮販売状態変更

          仮販売取引の状態を変更します。

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

          Authorizations:
          AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
          path Parameters
          contract_id
          required
          string

          契約ID

          id
          required
          string

          仮販売取引ID

          Request Body schema: application/json
          status
          required
          string (ステータス)
          Enum: 0 1 2

          ステータス:仮販売のステータス。(0:通常、1:完了、2:取消)

          Responses

          200

          更新成功

          404
          • 指定した仮販売取引IDが存在しない場合
          patch /transactions/temporaries/{id}/status

          サンドボックス

          https://api.smaregi.dev/{契約ID}/pos/transactions/temporaries/{id}/status

          本番

          https://api.smaregi.jp/{契約ID}/pos/transactions/temporaries/{id}/status

          Request samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "status": 0
          }

          Response samples

          Content type
          application/json
          Copy
          Expand all Collapse all
          {
          • "transactionHeadId": "string",
          • "transactionDateTime": "string",
          • "transactionHeadDivision": "string",
          • "cancelDivision": "string",
          • "status": "string",
          • "barcode": "string",
          • "sequentialNumber": "string",
          • "preRegistrationName": "string",
          • "unitNonDiscountsubtotal": "string",
          • "unitDiscountsubtotal": "string",
          • "subtotal": "string",
          • "subtotalForDiscount": "string",
          • "subtotalDiscountPrice": "string",
          • "subtotalDiscountRate": "string",
          • "subtotalDiscountDivision": "string",
          • "pointDiscount": "string",
          • "total": "string",
          • "taxInclude": "string",
          • "taxExclude": "string",
          • "roundingDivision": "string",
          • "roundingPrice": "string",
          • "amount": "string",
          • "returnAmount": "string",
          • "costTotal": "string",
          • "newPoint": "string",
          • "spendPoint": "string",
          • "point": "string",
          • "totalPoint": "string",
          • "storeId": "string",
          • "terminalId": "string",
          • "customerId": "string",
          • "terminalTranId": "string",
          • "terminalTranDateTime": "string",
          • "customerGroupId": "string",
          • "customerGroupId2": "string",
          • "customerGroupId3": "string",
          • "customerGroupId4": "string",
          • "customerGroupId5": "string",
          • "staffId": "string",
          • "staffName": "string",
          • "memo": "string",
          • "receiptMemo": "string",
          • "guestNumbers": "string",
          • "guestNumbersMale": "string",
          • "guestNumbersFemale": "string",
          • "guestNumbersUnknown": "string",
          • "enterDateTime": "string",
          • "taxFreeSalesDivision": "string",
          • "netTaxFreeGeneralTaxInclude": "string",
          • "netTaxFreeGeneralTaxExclude": "string",
          • "netTaxFreeConsumableTaxInclude": "string",
          • "netTaxFreeConsumableTaxExclude": "string",
          • "tags": "string",
          • "mileageDivision": "string",
          • "mileageLabel": "string",
          • "returnSales": "string",
          • "sellDivision": "string",
          • "taxRate": "string",
          • "taxRounding": "string",
          • "discountRoundingDivision": "string",
          • "details":
            [
            ]
          }

          予算

          月別予算一覧取得

          月別予算を取得します。


          sortで使用可能なパラメータ
          ■予算年月(YYYYMM形式)
          Plans:
          スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

          Authorizations:
          AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
          path Parameters
          contract_id
          required
          string

          契約ID

          store_id
          required
          string

          店舗ID

          query Parameters
          fields
          array

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

          sort
          string

          並び順(カンマ区切りで指定可)
          指定可能な項目については上記参照

          limit
          integer

          上限数

          page
          integer

          ページ

          ym-from
          string

          予算年月(From)(YYYYMM形式)

          ym-to
          string

          予算年月(To)(YYYYMM形式)

          upd_date_time-from
          string

          更新日時(from):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
          ※ From〜Toの期間は最大31日までの指定でご利用ください

          upd_date_time-to
          string

          更新日時(to):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
          ※ From〜Toの期間は最大31日までの指定でご利用ください

          Responses

          200

          取得成功

          400
          • 更新日時のFrom/To片方しか設定されていない場合
          • 更新日時のFrom-Toの範囲が上限を超えている場合
            get /budget/{storeId}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{storeId}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{storeId}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            日別予算取得

            日別予算情報を月単位で取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■day:日:予算年月の日。(DD形式)

            Authorizations:
            AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            year
            required
            string

            年:予算年月の年。(YYYY形式)

            month
            required
            string

            月:予算年月の月。(MM形式)

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            day
            string

            日:予算年月の日。(DD形式)

            Responses

            200

            取得成功

            get /budget/{id}/{year}/{month}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{id}/{year}/{month}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{id}/{year}/{month}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            日別予算登録

            日別予算情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            Request Body schema: application/json
            day
            required
            string () ^(0[1-9]|[12]\d|3[01])$

            予算年月の日。(DD形式)

            salesTargetDaily
            required
            string <int> (売上金額予算額) [ 1 .. 999999999999999 ]

            売上金額の目標額。(最大15桁)

            Responses

            200

            取得成功

            400
            • 年月が2011年より前のものである場合
            • 暦にない日付の場合
            • 店舗が見つからない場合
            • 店舗が休止している場合
            post /budget/{id}/{year}/{month}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{id}/{year}/{month}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{id}/{year}/{month}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "day": "string",
            • "salesTargetDaily": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "ym": "string",
            • "day": "string",
            • "salesTargetDaily": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            日別予算更新

            日別予算情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            Request Body schema: application/json
            day
            required
            string () ^(0[1-9]|[12]\d|3[01])$

            予算年月の日。(DD形式)

            salesTargetDaily
            required
            string <int> (売上金額予算額) [ 1 .. 999999999999999 ]

            売上金額の目標額。(最大15桁)

            Responses

            200

            取得成功

            400
            • 年月が2011年より前のものである場合
            • 暦にない日付の場合
            • 店舗が見つからない場合
            • 店舗が休止している場合
            patch /budget/{id}/{year}/{month}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{id}/{year}/{month}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{id}/{year}/{month}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "day": "string",
            • "salesTargetDaily": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "ym": "string",
            • "day": "string",
            • "salesTargetDaily": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            日別予算削除

            日別予算情報を削除します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            Responses

            200

            削除成功

            400
            • 年月が2011年より前のものである場合
            • 暦にない日付の場合
            404

            指定した部門データが存在しない場合

            delete /budget/{id}/{year}/{month}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{id}/{year}/{month}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{id}/{year}/{month}

            Response samples

            Content type
            application/json
            Example
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "Bad Request",
            • "detail": "2011年1月より前のデータは登録できません。",
            • "status": 400
            }

            スタッフ別予算一覧取得

            スタッフ別予算の一覧を取得します。


            sortで使用可能なパラメータ
            ■スタッフID
            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /budget/{store_id}/{year}/{month}/staffs

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            スタッフ別予算登録

            スタッフ別予算情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            Request Body schema: application/json
            staffId
            required
            string (スタッフID)

            予算登録するスタッフID
            ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗のスタッフIDを指定してください。

            salesTargetStaff
            required
            string <int> (スタッフ別の予算金額) [ 0 .. 999999999999999 ]

            スタッフ別の予算金額。(最大15桁)

            Responses

            200

            更新成功

            400
            • 年月が2011年より前のものである場合
            • 指定された店舗が休止している場合
            • 指定されたスタッフが見つからない場合
            • 既に存在するレコードの場合
            404
            • 暦にない年月の場合
            • 指定された店舗が見つからない場合
            post /budget/{store_id}/{year}/{month}/staffs

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "staffId": "string",
            • "salesTargetStaff": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "ym": "string",
            • "staffId": "string",
            • "salesTargetStaff": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            スタッフ別予算削除

            スタッフ別予算情報を削除します。
            指定された店舗における指定された年月のスタッフ別予算がすべて削除されます。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            Responses

            200

            削除成功

            404
            • 指定した店舗ID・年月の予算が存在しない場合
            delete /budget/{store_id}/{year}/{month}/staffs

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDと年月のリソースが見つかりません",
            • "status": "404"
            }

            スタッフ別予算更新

            スタッフ別予算情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_id
            required
            string

            店舗ID

            year
            required
            string

            予算年(YYYY)

            month
            required
            string

            予算月(MM)

            staff_id
            required
            string

            スタッフID
            ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗のスタッフIDを指定してください。

            Request Body schema: application/json
            salesTargetStaff
            required
            string <int> (スタッフ別の予算金額) [ 0 .. 999999999999999 ]

            スタッフ別の予算金額。(最大15桁)

            Responses

            200

            更新成功

            400
            • 指定された店舗が休止している場合
            • 指定されたスタッフが見つからない場合
            404
            • 暦にない年月の場合
            • 指定した店舗ID・年月・スタッフの予算が存在しない場合
            patch /budget/{store_id}/{year}/{month}/staffs/{staff_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs/{staff_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/budget/{store_id}/{year}/{month}/staffs/{staff_id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "salesTargetStaff": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "ym": "string",
            • "staffId": "string",
            • "salesTargetStaff": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            客層

            客層セクション一覧取得

            客層セクション情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■customerGroupSectionId:客層セクションID

            Authorizations:
            AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /customer_group_sections

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_group_sections

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_group_sections

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            客層セクション更新

            客層セクション情報を更新します。
            指定した客層セクションが存在しない場合、登録処理となります。
            客層セクションラベルが空文字の場合、削除処理となります。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            客層セクションID

            Request Body schema: application/json
            customerGroupSectionLabel
            required
            string (客層セクションラベル) <= 85 characters

            客層セクションラベル

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 指定した客層セクションIDが1未満または5を超える場合
            • 削除時に、セクションIDに紐付いた客層が存在する場合
            put /customer_group_sections/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_group_sections/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_group_sections/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupSectionLabel": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupSectionId": "string",
            • "customerGroupSectionLabel": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            客層一覧取得

            客層情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■customerGroupId:客層ID
            ■customerGroupSectionId:客層セクションID
            ■displaySequence:表示順

            Authorizations:
            AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            customer_group_section_id
            string

            客層セクションID

            display_flag
            string
            Enum: 0 1

            表示フラグ:端末で表示するか判定 (0:表示しない、1:表示する)

            Responses

            200

            取得成功

            get /customer_groups

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_groups

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_groups

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            客層登録

            客層情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            customerGroupSectionId
            required
            string <int> (客層セクションID) [ 1 .. 99999 ]
            label
            required
            string (ラベル) <= 85 characters
            displayFlag
            string (表示フラグ)
            Default: 1
            Enum: 0 1

            端末で表示するか判定 (0:表示しない、1:表示する)

            displaySequence
            required
            string <int> (表示順) [ 0 .. 99999 ]

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 指定された客層セクションIDのリソースが見つからない場合
            post /customer_groups

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_groups

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_groups

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupSectionId": "string",
            • "label": "string",
            • "displayFlag": 1,
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupId": "string",
            • "customerGroupSectionId": "string",
            • "label": "string",
            • "displayFlag": 0,
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            客層更新

            客層情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            客層ID

            Request Body schema: application/json
            customerGroupSectionId
            string <int> (客層セクションID) [ 1 .. 99999 ]
            label
            string (ラベル) <= 85 characters
            displayFlag
            string (表示フラグ)
            Enum: 0 1

            端末で表示するか判定 (0:表示しない、1:表示する)

            displaySequence
            string <int> (表示順) [ 0 .. 99999 ]

            Responses

            200

            更新成功

            400
            • 指定された客層セクションIDのリソースが見つからない場合
            404

            指定された客層IDのリソースが見つからない場合

            patch /customer_groups/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_groups/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_groups/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupSectionId": "string",
            • "label": "string",
            • "displayFlag": 0,
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "customerGroupId": "string",
            • "customerGroupSectionId": "string",
            • "label": "string",
            • "displayFlag": 0,
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            客層削除

            客層情報を削除します。

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

            Authorizations:
            AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            客層ID

            Responses

            200

            削除成功

            404

            指定された客層IDのリソースが見つからない場合

            delete /customer_groups/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/customer_groups/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/customer_groups/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDのリソースが見つかりません",
            • "status": 404
            }

            仕入先

            仕入先一覧取得

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

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■supplierId:仕入先ID
            ■supplierCode:仕入先コード
            ■orderPriority:発注先優先度
            ■updDateTime:更新日時

            Authorizations:
            AppAccessToken (pos.suppliers:read) UserAccessToken (pos.suppliers:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            supplier_id
            any

            仕入先ID

            supplier_code
            any

            仕入先コード

            supplier_division_id
            any

            仕入先区分ID

            Responses

            200

            取得成功

            get /suppliers

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            仕入先登録

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

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            supplierCode
            required
            string (仕入先コード) <= 10 characters ^[ -~]+$

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

            supplierDivisionId
            string <int> (仕入先区分ID)

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

            supplierName
            required
            string (仕入先名) <= 85 characters

            仕入先名

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

            仕入先名略称

            address
            string (住所) <= 255 characters

            住所

            phoneNumber
            string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

            電話番号 (ハイフン付)

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

            FAX番号

            mailAddress
            string <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 <int> (発注先優先度) [ 1 .. 99999 ]

            発注先優先度

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 仕入先コードが重複している場合
            • 指定された仕入先区分が見つからない場合
            post /suppliers

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "supplierCode": "string",
            • "supplierDivisionId": "string",
            • "supplierName": "string",
            • "supplierAbbr": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "user@example.com",
            • "staffName": "string",
            • "orderPriority": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "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"
            }

            仕入先更新

            仕入先情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            仕入先ID

            Request Body schema: application/json
            supplierCode
            string (仕入先コード) <= 10 characters ^[ -~]+$

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

            supplierDivisionId
            string (仕入先区分ID)

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

            supplierName
            string (仕入先名) <= 85 characters

            仕入先名

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

            仕入先名略称

            address
            string (住所) <= 255 characters

            住所

            phoneNumber
            string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

            電話番号 (ハイフン付)

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

            FAX番号

            mailAddress
            string <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 <int> (発注先優先度) [ 1 .. 99999 ]

            発注先優先度

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 仕入先コードが重複している場合
            • 指定された仕入先区分が見つからない場合
            404
            • 指定した仕入先データが存在しない場合
            patch /suppliers/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "supplierCode": "string",
            • "supplierDivisionId": "string",
            • "supplierName": "string",
            • "supplierAbbr": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "user@example.com",
            • "staffName": "string",
            • "orderPriority": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "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"
            }

            仕入先削除

            仕入先情報を削除します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            仕入先ID

            Responses

            200

            削除成功

            404
            • 指定した仕入先データが存在しない場合
            delete /suppliers/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDのリソースが見つかりません",
            • "status": "404"
            }

            仕入先商品一覧取得

            仕入先商品の一覧を取得します。


            sortで使用可能なパラメータ
            ■categoryId:部門ID
            ■productId:商品ID
            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.suppliers:read) UserAccessToken (pos.suppliers:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            supplier_id
            required
            string

            仕入先ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            category_id
            string

            部門ID

            product_id
            string

            商品ID

            Responses

            200

            取得成功

            404
            • 指定されたIDが存在しない場合
            get /suppliers/{supplier_id}/products

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers/{supplier_id}/products

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers/{supplier_id}/products

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            仕入先商品登録

            仕入先商品を登録します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            supplier_id
            required
            string

            仕入先ID

            Request Body schema: application/json
            categoryId
            string <int> (部門ID) [ 1 .. 999999999 ]

            部門ID:仕入先で取り扱っている部門のID
            ※部門IDと商品IDのいずれか必須。(複数指定不可。複数設定された場合はエラー)

            productId
            string <int> (商品ID) [ 1 .. 999999999999999 ]

            商品ID:仕入先で取り扱っている商品のID
            ※部門IDと商品IDのいずれか必須。(複数指定不可。複数設定された場合はエラー)

            Responses

            200

            更新成功

            400
            • 指定された商品IDが存在しない場合
            • 指定された部門IDが存在しない場合
            • 指定された仕入先で、既に同じ仕入先商品が登録されている場合
            • 部門ID、商品IDのいずれも指定されていない場合
            • 部門ID、商品IDの両方を指定された場合
            404
            • 指定されたIDが存在しない場合
            post /suppliers/{supplier_id}/products

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers/{supplier_id}/products

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers/{supplier_id}/products

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "categoryId": "string",
            • "productId": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "supplierId": "string",
            • "categoryId": "string",
            • "productId": "string",
            • "insDateTime": "string"
            }

            仕入先商品削除

            仕入先商品を削除します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            supplier_id
            required
            string

            仕入先ID

            division
            required
            string
            Enum: 1 2

            target_idが部門ID、商品IDのいずれを指すか指定します。(1:部門ID、2:商品ID)

            target_id
            required
            string

            仕入先に紐づく部門IDか商品IDを指定します。

            Responses

            200

            削除成功

            404
            • 指定された仕入先IDが存在しない場合
            • 指定された部門IDが存在しない場合
            • 指定された商品IDが存在しない場合
            • 指定されたパスパラメータの組み合わせが存在しない場合
            delete /suppliers/{supplier_id}/division/{division}/products/{target_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/suppliers/{supplier_id}/division/{division}/products/{target_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/suppliers/{supplier_id}/division/{division}/products/{target_id}

            Response samples

            Content type
            application/json
            Example
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定された仕入先IDのリソースが見つかりません。",
            • "status": 404
            }

            仕入先区分

            仕入先区分一覧取得

            仕入先区分の一覧を取得します。


            sortで使用可能なパラメータ
            ■supplierDivisionId:仕入先区分ID
            ■displaySequence:表示順
            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.suppliers:read) UserAccessToken (pos.suppliers:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            supplier_division_id
            string

            仕入先区分ID

            display_flag
            string
            Enum: 0 1

            有効/無効:端末で表示するかを設定。(0:無効、1:有効)

            Responses

            200

            取得成功

            get /supplier_divisions

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/supplier_divisions

            本番

            https://api.smaregi.jp/{契約ID}/pos/supplier_divisions

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            仕入先区分登録

            仕入先区分を登録します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            name
            required
            string (名称) <= 85 characters

            名称

            displaySequence
            string <int> (表示順) [ 1 .. 999 ]

            表示順

            displayFlag
            string (有効/無効)
            Default: 1
            Enum: 0 1

            有効/無効:端末で表示するかを設定。(0:無効、1:有効)

            Responses

            200

            更新成功

            post /supplier_divisions

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/supplier_divisions

            本番

            https://api.smaregi.jp/{契約ID}/pos/supplier_divisions

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "name": "string",
            • "displaySequence": "string",
            • "displayFlag": 1
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "supplierDivisionId": "string",
            • "name": "string",
            • "displaySequence": "string",
            • "displayFlag": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            仕入先区分更新

            指定された仕入先区分を更新します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            仕入先区分ID

            Request Body schema: application/json
            name
            string (名称) <= 85 characters

            名称

            displaySequence
            string <int> (表示順) [ 1 .. 999 ]

            表示順

            displayFlag
            string (有効/無効)
            Default: 1
            Enum: 0 1

            有効/無効:端末で表示するかを設定。(0:無効、1:有効)

            Responses

            200

            更新成功

            404
            • 指定されたIDが存在しない場合
            patch /supplier_divisions/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/supplier_divisions/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/supplier_divisions/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "name": "string",
            • "displaySequence": "string",
            • "displayFlag": 1
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "supplierDivisionId": "string",
            • "name": "string",
            • "displaySequence": "string",
            • "displayFlag": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            仕入先区分削除

            指定された仕入先区分を削除します。

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

            Authorizations:
            AppAccessToken (pos.suppliers:write) UserAccessToken (pos.suppliers:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            仕入先区分ID

            Responses

            200

            削除成功

            404
            • 指定されたIDが存在しない場合
            delete /supplier_divisions/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/supplier_divisions/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/supplier_divisions/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDのリソースが見つかりません",
            • "status": 404
            }

            店舗

            店舗一覧取得

            店舗情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■storeId:店舗ID
            ■storeCode:店舗コード
            ■displaySequence:表示順
            ■updDateTime:更新日時

            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            store_code
            string

            店舗コード

            division
            string
            Enum: 1 2

            店舗区分 (1:通常店舗、2:倉庫)

            with_point_condition
            string
            Default: "none"
            Enum: "all" "none"

            ポイント情報を付加するか(付加する場合はall, しない場合はnone)

            with_receipt_print_info
            string
            Default: "none"
            Enum: "all" "none"

            レシート印刷情報を付加するか(付加する場合はall, しない場合はnone)

            Responses

            200

            取得成功

            get /stores

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            店舗登録

            店舗情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            storeCode
            required
            string (店舗コード) <= 20 characters ^[ -~]+$

            ユニーク値

            storeName
            required
            string (店舗名) <= 85 characters
            storeAbbr
            string (店舗名略称) <= 85 characters
            printReceiptStoreName
            string (レシート印字店舗名) <= 64 characters

            レシートに印字する店舗名。(64文字以内)

            printStockReceiptStoreName
            string (在庫レシート印字店舗名) <= 64 characters

            在庫レシートに印字する店舗名。(64文字以内)

            division
            string (店舗区分) <= 1 characters
            Default: 1
            Enum: 1 2

            (1:通常店舗、2:倉庫)
            ※登録後、変更できません。

            postCode
            string (郵便番号) <= 10 characters

            店舗郵便番号 (ハイフンあり)

            address
            string (住所) <= 85 characters

            店舗住所

            phoneNumber
            string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

            店舗電話番号 (ハイフン付)

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

            店舗FAX番号

            mailAddress
            string <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

            店舗メールアドレス

            homepage
            string (ホームページ) <= 255 characters

            店舗ホームページ

            tempTranMailAddress
            string <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

            仮取引登録時に送信するメールアドレス
            ※カンマ区切りで複数指定可

            priceChangeFlag
            string (端末価格変更許可フラグ)
            Default: 1
            Enum: 0 1

            iPod,iPadで販売価格を変更できなくするには、0:変更不可を設定してください。(0:変更不可、1:変更可能)

            sellDivision
            string (販売区分)
            Default: 0
            Enum: 0 1

            (0:内税販売、1:外税販売)

            sumProcDivision
            string (締め方式区分)
            Default: 0
            Enum: 0 1

            (0:手動締め処理、1:自動締め処理)

            sumDateChangeTime
            string (締め日付変更時間) ^([0-1][0-9]|2[0-3])[0-5][0-9]$

            日付変更時間。締め処理時に使用 [HHMM]
            締め方式区分が1:自動締め処理の場合必須

            sumRefColumn
            string (締め参照時間項目)
            Default: 0
            Enum: 0 1

            締め処理を行う時に参照する時間。締め処理時に使用
            (0:端末時間、1:サーバー時間)
            締め方式区分が1:自動締め処理の場合必須

            pointNotApplicable
            string (ポイント対象区分)
            Default: 0
            Enum: 0 1

            (0:ポイントをつける、1:ポイントをつけない)

            taxFreeDivision
            string (免税区分)
            Default: 0
            Enum: 0 1 2

            (0:対象外、1:一般品、2:消耗品)

            maxBundleProductCount
            string <int> (簡易バンドル商品登録最大件数) [ 0 .. 999 ]
            Default: 9

            簡易バンドル販売画面の最大商品登録数を設定する。
            ※デフォルト:9 とする。最大999

            maxDiscountRate
            string <int> (最大値引率) [ 0 .. 100 ]

            端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%)
            未設定の場合、上限なし 

            carriageDisplayFlag
            string (送料・手数料表示フラグ)
            Default: 0
            Enum: 0 1

            送料・手数料を表示するフラグ。
            スマレジAPIで送料手数料を設定している場合、日報/月報/日別集計に表示するかしないかを設定する。
            (0:表示しない、1:表示する)

            terminalAdjustmentCashFlag
            string (端末精算時の現金管理フラグ)
            Default: 1
            Enum: 0 1

            端末精算時に現金管理入力画面を表示するか否か
            (0:入力しない、1:入力する)

            terminalCheckCashFlag
            string (端末検査時の現金管理フラグ)
            Default: 1
            Enum: 0 1

            端末精算時に現金管理入力画面を表示するか否か
            (0:入力しない、1:入力する)

            waiterAdjustmentDivision
            string (ウェイター精算可能チェック区分)
            Default: 0
            Enum: 0 1

            未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ)
            0:チェックしない、1:チェックする

            savingAutoDivision
            string (銀行預入金自動入力区分)
            Default: 0
            Enum: 0 1

            締め処理画面の銀行預入金を自動で設定するか否か
            0:自動入力しない、1:自動入力する
            ※金額が未設定の場合、(現金売上+現金化不足)
            ※設定済みの場合、実現金残高 - 銀行預入金自動入力金額

            savingAutoPrice
            string <int> (銀行預入金自動入力金額) [ 0 .. 999999999 ]

            銀行預入金が自動の場合、繰越準備金の金額を設定する。

            cancelSettingDivision
            string (取消設定区分)
            Default: 3
            Enum: 1 2 3

            取消設定区分 (1:自動、2:消込のみ、3:選択)
            1: 「自動で切り替える」 ※締まっている場合、消込レコード作成、締まっていない場合取消を行う。
            2: 「消込レコード作成」のみ表示
            3: 「取消」「消込レコード作成」の両方表示。※デフォルト

            roundingDivision
            string (端数値引区分)
            Default: "00"
            Enum: "00" "11" "12" "13" "21" "22" "23" "31" "32" "33" "41" "42" "43" "99"

            販売時の合計金額の端数を丸めるか否かを設定する
            00:なし
            11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上
            21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上
            31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上
            41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上
            99:手入力

            discountRoundingDivision
            string (割引丸め区分)
            Default: 0
            Enum: 0 1 2 3

            0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め

            cardCompanySelectDivision
            string (カード会社選択区分)
            Default: 0
            Enum: 0 1

            クレジットカード手入力時のカードブランド選択
            0:選択なし、1:選択あり

            giftReceiptValidDays
            string <int> (ギフトレシート引換有効日数) [ 1 .. 999 ]

            引換の有効日数。nullの場合は有効期限なし。

            taxLabelNormal
            string (標準税率のボタンラベル) <= 10 characters

            標準税率のボタンラベル。未指定の場合は「イートイン」。
            ※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。

            taxLabelReduce
            string (軽減税率のボタンラベル) <= 10 characters

            軽減税率のボタンラベル。未指定の場合は「テイクアウト」。
            ※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。

            displaySequence
            string <int> (表示番号) [ 0 .. 999999999 ]

            表示順序

            facePaymentUseDivision
            string (顔認証決済利用区分)
            Default: 0
            Enum: 0 1

            (非推奨)顔認証決済利用区分 (0:利用しない、1:利用する)
            ※ 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能です。

            invoiceRegistrationNo
            string (登録事業者番号) <= 20 characters /^[ -~]+$/

            登録事業者番号:適格請求書発行事業者としての登録番号。

            pointCondition
            object (ポイント条件)
            receiptPrintInfo
            object (レシート印刷情報)

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 店舗コードが重複している場合
            • 締め方式区分が[1:自動締め処理]の場合の必須項目が未入力の場合
            • ポイント利用条件のポイント使用区分が[1:使用する]の場合の必須項目が未入力の場合
            • 店舗の登録上限数を超えてしまう場合
            403
            • 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能な項目が、そうでない契約において設定された場合
            post /stores

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeCode": "string",
            • "storeName": "string",
            • "storeAbbr": "string",
            • "printReceiptStoreName": "string",
            • "printStockReceiptStoreName": "string",
            • "division": 1,
            • "postCode": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "user@example.com",
            • "homepage": "string",
            • "tempTranMailAddress": "user@example.com",
            • "priceChangeFlag": 1,
            • "sellDivision": 0,
            • "sumProcDivision": 0,
            • "sumDateChangeTime": "string",
            • "sumRefColumn": 0,
            • "pointNotApplicable": 0,
            • "taxFreeDivision": 0,
            • "maxBundleProductCount": 9,
            • "maxDiscountRate": "string",
            • "carriageDisplayFlag": 0,
            • "terminalAdjustmentCashFlag": 1,
            • "terminalCheckCashFlag": 1,
            • "waiterAdjustmentDivision": 0,
            • "savingAutoDivision": 0,
            • "savingAutoPrice": "string",
            • "cancelSettingDivision": 3,
            • "roundingDivision": "00",
            • "discountRoundingDivision": 0,
            • "cardCompanySelectDivision": 0,
            • "giftReceiptValidDays": "string",
            • "taxLabelNormal": "string",
            • "taxLabelReduce": "string",
            • "displaySequence": "string",
            • "facePaymentUseDivision": 0,
            • "invoiceRegistrationNo": "string",
            • "pointCondition":
              {
              },
            • "receiptPrintInfo":
              {
              }
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "storeCode": "string",
            • "storeName": "string",
            • "storeAbbr": "string",
            • "printReceiptStoreName": "string",
            • "printStockReceiptStoreName": "string",
            • "division": 1,
            • "postCode": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "string",
            • "homepage": "string",
            • "tempTranMailAddress": "string",
            • "priceChangeFlag": "string",
            • "sellDivision": 0,
            • "sumProcDivision": 0,
            • "sumDateChangeTime": "string",
            • "sumRefColumn": 0,
            • "pointNotApplicable": 0,
            • "taxFreeDivision": 0,
            • "maxBundleProductCount": "string",
            • "maxDiscountRate": "string",
            • "carriageDisplayFlag": 0,
            • "terminalAdjustmentCashFlag": 0,
            • "terminalCheckCashFlag": 0,
            • "waiterAdjustmentDivision": 0,
            • "savingAutoDivision": 0,
            • "savingAutoPrice": "string",
            • "cancelSettingDivision": 1,
            • "roundingDivision": "00",
            • "discountRoundingDivision": 0,
            • "cardCompanySelectDivision": 0,
            • "giftReceiptValidDays": "string",
            • "taxLabelNormal": "string",
            • "taxLabelReduce": "string",
            • "displaySequence": "string",
            • "facePaymentUseDivision": "string",
            • "invoiceRegistrationNo": "string",
            • "insDateTime": "string",
            • "updDateTime": "string",
            • "pointCondition":
              {
              },
            • "receiptPrintInfo":
              {
              }
            }

            店舗取得

            店舗情報を取得します。

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

            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            query Parameters
            fields
            array

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

            with_point_condition
            string
            Default: "none"
            Enum: "all" "none"

            ポイント情報を付加するか(付加する場合はall, しない場合はnone)

            with_receipt_print_info
            string
            Default: "none"
            Enum: "all" "none"

            レシート印刷情報を付加するか(付加する場合はall, しない場合はnone)

            Responses

            200

            取得成功

            get /stores/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "storeCode": "string",
            • "storeName": "string",
            • "storeAbbr": "string",
            • "printReceiptStoreName": "string",
            • "printStockReceiptStoreName": "string",
            • "division": "string",
            • "postCode": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "string",
            • "homepage": "string",
            • "tempTranMailAddress": "string",
            • "priceChangeFlag": "string",
            • "sellDivision": "string",
            • "sumProcDivision": "string",
            • "sumDateChangeTime": "string",
            • "sumRefColumn": "string",
            • "pointNotApplicable": "string",
            • "taxFreeDivision": "string",
            • "maxBundleProductCount": "string",
            • "maxDiscountRate": "string",
            • "carriageDisplayFlag": "string",
            • "terminalAdjustmentCashFlag": "string",
            • "terminalCheckCashFlag": "string",
            • "waiterAdjustmentDivision": "string",
            • "savingAutoDivision": "string",
            • "savingAutoPrice": "string",
            • "cancelSettingDivision": "string",
            • "roundingDivision": "string",
            • "discountRoundingDivision": "string",
            • "cardCompanySelectDivision": "string",
            • "giftReceiptValidDays": "string",
            • "taxLabelNormal": "string",
            • "taxLabelReduce": "string",
            • "pauseFlag": "string",
            • "displaySequence": "string",
            • "facePaymentUseDivision": "string",
            • "invoiceRegistrationNo": "string",
            • "insDateTime": "string",
            • "updDateTime": "string",
            • "pointCondition":
              {
              },
            • "receiptPrintInfo":
              {
              }
            }

            店舗更新

            店舗情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            Request Body schema: application/json
            storeCode
            string (店舗コード) <= 20 characters ^[ -~]+$

            ユニーク値

            storeName
            string (店舗名) <= 85 characters
            storeAbbr
            string (店舗名略称) <= 85 characters
            printReceiptStoreName
            string (レシート印字店舗名) <= 64 characters

            レシートに印字する店舗名。(64文字以内)

            printStockReceiptStoreName
            string (在庫レシート印字店舗名) <= 64 characters

            在庫レシートに印字する店舗名。(64文字以内)

            division
            string (店舗区分) <= 1 characters
            Default: 1
            Enum: 1 2

            (1:通常店舗、2:倉庫)
            ※登録後、変更できません。

            postCode
            string (郵便番号) <= 10 characters

            店舗郵便番号 (ハイフンあり)

            address
            string (住所) <= 85 characters

            店舗住所

            phoneNumber
            string (電話番号) ^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$

            店舗電話番号 (ハイフン付)

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

            店舗FAX番号

            mailAddress
            string <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

            店舗メールアドレス

            homepage
            string (ホームページ) <= 255 characters

            店舗ホームページ

            tempTranMailAddress
            string <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

            仮取引登録時に送信するメールアドレス
            ※カンマ区切りで複数指定可

            priceChangeFlag
            string (端末価格変更許可フラグ)
            Default: 1
            Enum: 0 1

            iPod,iPadで販売価格を変更できなくするには、0:変更不可を設定してください。(0:変更不可、1:変更可能)

            sellDivision
            string (販売区分)
            Default: 0
            Enum: 0 1

            (0:内税販売、1:外税販売)

            sumProcDivision
            string (締め方式区分)
            Default: 0
            Enum: 0 1

            (0:手動締め処理、1:自動締め処理)

            sumDateChangeTime
            string (締め日付変更時間) ^([0-1][0-9]|2[0-3])[0-5][0-9]$

            日付変更時間。締め処理時に使用 [HHMM]
            締め方式区分が1:自動締め処理の場合必須

            sumRefColumn
            string (締め参照時間項目)
            Default: 0
            Enum: 0 1

            締め処理を行う時に参照する時間。締め処理時に使用
            (0:端末時間、1:サーバー時間)
            締め方式区分が1:自動締め処理の場合必須

            pointNotApplicable
            string (ポイント対象区分)
            Default: 0
            Enum: 0 1

            (0:ポイントをつける、1:ポイントをつけない)

            taxFreeDivision
            string (免税区分)
            Default: 0
            Enum: 0 1 2

            (0:対象外、1:一般品、2:消耗品)

            maxBundleProductCount
            string <int> (簡易バンドル商品登録最大件数) [ 0 .. 999 ]
            Default: 9

            簡易バンドル販売画面の最大商品登録数を設定する。
            ※デフォルト:9 とする。最大999

            maxDiscountRate
            string <int> (最大値引率) [ 0 .. 100 ]

            端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%)
            未設定の場合、上限なし 

            carriageDisplayFlag
            string (送料・手数料表示フラグ)
            Default: 0
            Enum: 0 1

            送料・手数料を表示するフラグ。
            スマレジAPIで送料手数料を設定している場合、日報/月報/日別集計に表示するかしないかを設定する。
            (0:表示しない、1:表示する)

            terminalAdjustmentCashFlag
            string (端末精算時の現金管理フラグ)
            Default: 1
            Enum: 0 1

            端末精算時に現金管理入力画面を表示するか否か
            (0:入力しない、1:入力する)

            terminalCheckCashFlag
            string (端末検査時の現金管理フラグ)
            Default: 1
            Enum: 0 1

            端末精算時に現金管理入力画面を表示するか否か
            (0:入力しない、1:入力する)

            waiterAdjustmentDivision
            string (ウェイター精算可能チェック区分)
            Default: 0
            Enum: 0 1

            未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ)
            0:チェックしない、1:チェックする

            savingAutoDivision
            string (銀行預入金自動入力区分)
            Default: 0
            Enum: 0 1

            締め処理画面の銀行預入金を自動で設定するか否か
            0:自動入力しない、1:自動入力する
            ※金額が未設定の場合、(現金売上+現金化不足)
            ※設定済みの場合、実現金残高 - 銀行預入金自動入力金額

            savingAutoPrice
            string <int> (銀行預入金自動入力金額) [ 0 .. 999999999 ]

            銀行預入金が自動の場合、繰越準備金の金額を設定する。

            cancelSettingDivision
            string (取消設定区分)
            Default: 3
            Enum: 1 2 3

            取消設定区分 (1:自動、2:消込のみ、3:選択)
            1: 「自動で切り替える」 ※締まっている場合、消込レコード作成、締まっていない場合取消を行う。
            2: 「消込レコード作成」のみ表示
            3: 「取消」「消込レコード作成」の両方表示。※デフォルト

            roundingDivision
            string (端数値引区分)
            Default: "00"
            Enum: "00" "11" "12" "13" "21" "22" "23" "31" "32" "33" "41" "42" "43" "99"

            販売時の合計金額の端数を丸めるか否かを設定する
            00:なし
            11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上
            21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上
            31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上
            41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上
            99:手入力

            discountRoundingDivision
            string (割引丸め区分)
            Default: 0
            Enum: 0 1 2 3

            0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め

            cardCompanySelectDivision
            string (カード会社選択区分)
            Default: 0
            Enum: 0 1

            クレジットカード手入力時のカードブランド選択
            0:選択なし、1:選択あり

            giftReceiptValidDays
            string <int> (ギフトレシート引換有効日数) [ 1 .. 999 ]

            引換の有効日数。nullの場合は有効期限なし。

            taxLabelNormal
            string (標準税率のボタンラベル) <= 10 characters

            標準税率のボタンラベル。未指定の場合は「イートイン」。
            ※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。

            taxLabelReduce
            string (軽減税率のボタンラベル) <= 10 characters

            軽減税率のボタンラベル。未指定の場合は「テイクアウト」。
            ※この項目は商品の税設定が「販売時に選択」を選ばれているときのみ、有効になります。

            displaySequence
            string <int> (表示番号) [ 0 .. 999999999 ]

            表示順序

            facePaymentUseDivision
            string (顔認証決済利用区分)
            Default: 0
            Enum: 0 1

            (非推奨)顔認証決済利用区分 (0:利用しない、1:利用する)
            ※ 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能です。

            invoiceRegistrationNo
            string (登録事業者番号) <= 20 characters /^[ -~]+$/

            登録事業者番号:適格請求書発行事業者としての登録番号。

            pointCondition
            object (ポイント条件)
            receiptPrintInfo
            object (レシート印刷情報)

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 店舗コードが重複している場合
            • 店舗区分を変更しようとした場合
            • 締め方式区分が[1:自動締め処理]の場合の必須項目が未入力の場合
            • ポイント利用条件のポイント使用区分が[1:使用する]の場合の必須項目が未入力の場合
            403
            • 顔認証決済をスマレジ上で利用可能に個別設定された契約でのみ設定可能な項目が、そうでない契約において設定された場合
            404
            • 指定された店舗が見つからない場合
            patch /stores/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeCode": "string",
            • "storeName": "string",
            • "storeAbbr": "string",
            • "printReceiptStoreName": "string",
            • "printStockReceiptStoreName": "string",
            • "division": 1,
            • "postCode": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "user@example.com",
            • "homepage": "string",
            • "tempTranMailAddress": "user@example.com",
            • "priceChangeFlag": 1,
            • "sellDivision": 0,
            • "sumProcDivision": 0,
            • "sumDateChangeTime": "string",
            • "sumRefColumn": 0,
            • "pointNotApplicable": 0,
            • "taxFreeDivision": 0,
            • "maxBundleProductCount": 9,
            • "maxDiscountRate": "string",
            • "carriageDisplayFlag": 0,
            • "terminalAdjustmentCashFlag": 1,
            • "terminalCheckCashFlag": 1,
            • "waiterAdjustmentDivision": 0,
            • "savingAutoDivision": 0,
            • "savingAutoPrice": "string",
            • "cancelSettingDivision": 3,
            • "roundingDivision": "00",
            • "discountRoundingDivision": 0,
            • "cardCompanySelectDivision": 0,
            • "giftReceiptValidDays": "string",
            • "taxLabelNormal": "string",
            • "taxLabelReduce": "string",
            • "displaySequence": "string",
            • "facePaymentUseDivision": 0,
            • "invoiceRegistrationNo": "string",
            • "pointCondition":
              {
              },
            • "receiptPrintInfo":
              {
              }
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "storeCode": "string",
            • "storeName": "string",
            • "storeAbbr": "string",
            • "printReceiptStoreName": "string",
            • "printStockReceiptStoreName": "string",
            • "division": 1,
            • "postCode": "string",
            • "address": "string",
            • "phoneNumber": "string",
            • "faxNumber": "string",
            • "mailAddress": "string",
            • "homepage": "string",
            • "tempTranMailAddress": "string",
            • "priceChangeFlag": "string",
            • "sellDivision": 0,
            • "sumProcDivision": 0,
            • "sumDateChangeTime": "string",
            • "sumRefColumn": 0,
            • "pointNotApplicable": 0,
            • "taxFreeDivision": 0,
            • "maxBundleProductCount": "string",
            • "maxDiscountRate": "string",
            • "carriageDisplayFlag": 0,
            • "terminalAdjustmentCashFlag": 0,
            • "terminalCheckCashFlag": 0,
            • "waiterAdjustmentDivision": 0,
            • "savingAutoDivision": 0,
            • "savingAutoPrice": "string",
            • "cancelSettingDivision": 1,
            • "roundingDivision": "00",
            • "discountRoundingDivision": 0,
            • "cardCompanySelectDivision": 0,
            • "giftReceiptValidDays": "string",
            • "taxLabelNormal": "string",
            • "taxLabelReduce": "string",
            • "displaySequence": "string",
            • "facePaymentUseDivision": "string",
            • "invoiceRegistrationNo": "string",
            • "insDateTime": "string",
            • "updDateTime": "string",
            • "pointCondition":
              {
              },
            • "receiptPrintInfo":
              {
              }
            }

            店舗削除

            店舗情報を削除します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            Responses

            200

            削除成功

            404

            指定した店舗データが存在しない場合

            delete /stores/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDのリソースが見つかりません",
            • "status": 404
            }

            店舗分類項目関連取得

            店舗と店舗分類項目との関連付け情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■storeClassItemId:店舗分類項目ID

            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /stores/{id}/class_item_relations

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores/{id}/class_item_relations

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores/{id}/class_item_relations

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            店舗分類項目関連削除

            店舗と店舗分類項目との関連付けを削除します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_id
            required
            string

            店舗ID

            store_class_id
            required
            string

            店舗分類ID

            Responses

            200

            削除成功

            404

            店舗IDと店舗分類IDの組み合わせが店舗分類項目関連テーブルに存在しない場合

            delete /stores/{store_id}/class_item_relations/{store_class_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/stores/{store_id}/class_item_relations/{store_class_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/stores/{store_id}/class_item_relations/{store_class_id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定されたIDのリソースが見つかりません",
            • "status": 404
            }

            店舗分類

            店舗分類一覧取得

            店舗分類情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■storeClassId:店舗分類ID
            ■displaySequence:表示順

            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /store_classes

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            店舗分類登録

            店舗分類情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            storeClassName
            required
            string (分類ラベル) <= 85 characters
            displaySequence
            string <int> (表示順) [ 0 .. 999999999 ]

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 店舗分類数が5つを超える場合。
            post /store_classes

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassName": "string",
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassId": "string",
            • "storeClassName": "string",
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            店舗分類更新

            店舗分類情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_class_id
            required
            string

            店舗分類ID

            Request Body schema: application/json
            storeClassName
            string (分類ラベル) <= 85 characters
            displaySequence
            string <int> (表示順) [ 0 .. 999999999 ]

            Responses

            200

            更新成功

            400

            入力チェックエラーの場合

            404

            店舗分類IDが存在しない場合

            patch /store_classes/{store_class_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{store_class_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{store_class_id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassName": "string",
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassId": "string",
            • "storeClassName": "string",
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            店舗分類削除

            店舗分類情報を削除します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            store_class_id
            required
            string

            店舗分類ID

            Responses

            200

            削除成功

            404
            • 指定した店舗分類IDが存在しない場合
            delete /store_classes/{store_class_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{store_class_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{store_class_id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "NotFound",
            • "detail": "指定された店舗分類IDのリソースが見つかりません",
            • "status": 404
            }

            店舗分類項目一覧取得

            店舗分類項目情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■storeClassItemId:店舗分類項目ID
            ■displaySequence:表示順

            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗分類ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /store_classes/{id}/items

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{id}/items

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{id}/items

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            店舗分類項目登録

            店舗分類項目情報を登録します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗分類ID

            Request Body schema: application/json
            storeClassItemName
            required
            string (店舗分類項目名) <= 85 characters
            displaySequence
            string <int> (表示順) [ 0 .. 999999999 ]

            Responses

            200

            更新成功

            400
            • 入力チェックエラーの場合
            • 店舗分類に登録される店舗分類項目件数が99を超える場合
            • 指定した店舗分類IDが存在しない場合
            post /store_classes/{id}/items

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{id}/items

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{id}/items

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassItemName": "string",
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassItemId": "string",
            • "storeClassId": "string",
            • "storeClassItemName": "string",
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            店舗分類項目更新

            店舗分類項目情報を更新します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗分類ID

            item_id
            required
            string

            店舗分類項目ID

            Request Body schema: application/json
            storeClassItemName
            string (店舗分類項目名) <= 85 characters
            displaySequence
            string <int> (表示順) [ 0 .. 999999999 ]

            Responses

            200

            更新成功

            400

            入力チェックエラーの場合

            404

            店舗分類項目IDが存在しない場合

            patch /store_classes/{id}/items/{item_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{id}/items/{item_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{id}/items/{item_id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassItemName": "string",
            • "displaySequence": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeClassItemId": "string",
            • "storeClassId": "string",
            • "storeClassItemName": "string",
            • "displaySequence": "string",
            • "insDateTime": "string",
            • "updDateTime": "string"
            }

            店舗分類項目削除

            店舗分類項目情報を削除します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            店舗分類ID

            item_id
            required
            string

            店舗分類項目ID

            Responses

            200

            削除成功

            400
            • 指定した店舗分類IDの店舗分類項目が1件の場合
            404
            • 指定した店舗分類IDが存在しない場合
            • 指定した店舗分類項目IDが存在しない場合
            • URIで指定されたパラメータの組み合わせが存在しなかった場合
            delete /store_classes/{id}/items/{item_id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/store_classes/{id}/items/{item_id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/store_classes/{id}/items/{item_id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "Bad Request",
            • "detail": "店舗分類項目が0件になるため削除できません",
            • "status": 400
            }

            レジ端末

            レジ端末一覧取得

            レジ端末の一覧を取得します。


            sortで使用可能なパラメータ
            ■storeId:店舗ID
            ■terminalId:端末ID
            ■updDateTime:更新日時
            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            Authorizations:
            AppAccessToken (pos.stores:read) UserAccessToken (pos.stores:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            terminal_id
            string

            端末ID

            store_id
            string

            店舗ID

            cash_drawer_id
            string

            キャッシュドロアID

            uuid
            string

            端末識別番号

            self_checkout_available_flag
            string

            セルフレジ使用可能フラグ。(0:使用できない、1:使用できる)

            use_stop_division
            string

            利用停止区分。(0:利用する、1:利用しない)

            smart_id_engine_available_flag
            string

            Smart ID Engine利用フラグ(0:利用しない、1:利用する)

            Responses

            200

            取得成功

            get /terminals

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/terminals

            本番

            https://api.smaregi.jp/{契約ID}/pos/terminals

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            レジ端末登録

            レジ端末を登録します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            storeId
            required
            string <int> (店舗ID) [ 1 .. 999999999 ]

            店舗毎に付与するID
            ※店舗情報が存在しない場合エラー
            ※休止中の店舗IDを指定するとエラー

            terminalName
            required
            string <string> (端末名) <= 85 characters

            端末名

            uuid
            string <string> (端末識別番号) <= 40 characters /^[ -~]+$/

            ユニーク値 端末を一意に識別する番号

            useStopDivision
            string (利用停止区分)
            Default: 0
            Enum: 0 1

            利用停止区分(0:利用する、1:利用しない)

            transactionEditableFlag
            string (取引編集可能フラグ)
            Default: 0
            Enum: 0 1

            取引編集可能フラグ(0:利用しない、1:利用する)

            selfCheckoutAvailableFlag
            string (セルフレジ使用可能フラグ)
            Default: 0
            Enum: 0 1

            対象プラン プレミアムプラス/フードビジネス/リテールビジネス
            セルフレジ使用可能フラグ(0:使用できない、1:使用できる)

            smartIdEngineAvailableFlag
            string (Smart ID Engine利用フラグ)
            Default: 0
            Enum: 0 1

            対象プラン リテールビジネス
            Smart ID Engine利用フラグ(0:利用しない、1:利用する)

            creditTerminalId
            string <int> (CAT/CCT端末ID) [ 1 .. 999999999 ]

            レジ端末に紐付けるCAT/CCT端末のID
            ※CAT/CCT端末連動が有効な契約でのみ設定可能です
            ※CAT/CCT端末情報が存在しない場合エラー
            ※他のレジ端末で既に登録されているCAT/CCT端末IDを指定するとエラー

            cashDrawerId
            string <int> (キャッシュドロアID) [ 1 .. 999999999 ]

            レジ端末を登録するキャッシュドロアのID
            ※利用可能なキャッシュドロア情報が存在しない場合エラー
            ※同一店舗に所属しないキャッシュドロアIDを指定するとエラー

            parentTerminalId
            string <int> (親端末ID) [ 1 .. 999999999 ]

            親端末として登録するレジ端末の端末ID
            ※端末情報が存在しない場合エラー
            ※同一店舗に所属しない端末IDを指定するとエラー
            ※親端末が設定されている端末IDを指定するとエラー

            Responses

            200

            取得成功

            400
            • 存在しない店舗IDを指定した場合
            • 店舗が休止中の店舗IDを指定した場合
            • 販売用端末の登録上限数を超えてしまう場合
            • 端末識別番号が重複した場合
            • セルフレジ端末の登録上限数を超えてしまう場合
            • Smart ID Engineの利用可能台数上限を超えてしまう場合
            • 存在しないCAT/CCT端末IDを指定した場合
            • 他のレジ端末で既に登録されているCAT/CCT端末IDを指定した場合
            • 存在しないキャッシュドロアIDを指定した場合
            • 異なる店舗に所属するキャッシュドロアIDを指定した場合
            • 利用不可のキャッシュドロアIDを指定した場合
            • 存在しない親端末IDを指定した場合
            • 異なる店舗に所属するレジ端末を親端末IDに指定した場合
            • 親端末が設定されているレジ端末を親端末IDに指定した場合
            403
            • CAT/CCT端末連動が有効な契約でのみ設定可能な項目が、そうでない契約において設定された場合
            post /terminals

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/terminals

            本番

            https://api.smaregi.jp/{契約ID}/pos/terminals

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "terminalName": "string",
            • "uuid": "string",
            • "useStopDivision": 0,
            • "transactionEditableFlag": 0,
            • "selfCheckoutAvailableFlag": 0,
            • "smartIdEngineAvailableFlag": 0,
            • "creditTerminalId": "string",
            • "cashDrawerId": "string",
            • "parentTerminalId": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            レジ端末更新

            レジ端末を更新します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            端末ID

            Request Body schema: application/json
            storeId
            string <int> (店舗ID) [ 1 .. 999999999 ]

            店舗毎に付与するID
            ※店舗情報が存在しない場合エラー
            ※休止中の店舗IDを指定するとエラー

            terminalName
            string <string> (端末名) <= 85 characters

            端末名

            uuid
            string <string> (端末識別番号) <= 40 characters /^[ -~]+$/

            ユニーク値 端末を一意に識別する番号

            useStopDivision
            string (利用停止区分)
            Enum: 0 1

            利用停止区分(0:利用する、1:利用しない)

            transactionEditableFlag
            string (取引編集可能フラグ)
            Enum: 0 1

            取引編集可能フラグ(0:利用しない、1:利用する)

            selfCheckoutAvailableFlag
            string (セルフレジ使用可能フラグ)
            Enum: 0 1

            対象プラン プレミアムプラス/フードビジネス/リテールビジネス
            セルフレジ使用可能フラグ(0:使用できない、1:使用できる)

            smartIdEngineAvailableFlag
            string (Smart ID Engine利用フラグ)
            Enum: 0 1

            対象プラン リテールビジネス
            Smart ID Engine利用フラグ(0:利用しない、1:利用する)

            creditTerminalId
            string <int> (CAT/CCT端末ID) [ 1 .. 999999999 ]

            レジ端末に紐付けるCAT/CCT端末のID
            ※CAT/CCT端末連動が有効な契約でのみ設定可能です
            ※CAT/CCT端末情報が存在しない場合エラー
            ※他のレジ端末で既に登録されているCAT/CCT端末IDを指定するとエラー

            cashDrawerId
            string <int> (キャッシュドロアID) [ 1 .. 999999999 ]

            レジ端末を登録するキャッシュドロアのID
            ※利用可能なキャッシュドロア情報が存在しない場合エラー
            ※同一店舗に所属しないキャッシュドロアIDを指定するとエラー

            parentTerminalId
            string <int> (親端末ID) [ 1 .. 999999999 ]

            親端末として登録するレジ端末の端末ID
            ※端末情報が存在しない場合エラー
            ※同一店舗に所属しない端末IDを指定するとエラー
            ※親端末が設定されている端末IDを指定するとエラー

            Responses

            200

            取得成功

            400
            • 存在しない店舗IDを指定した場合
            • 店舗が休止中の店舗IDを指定した場合
            • 設定されているキャッシュドロアと異なる店舗IDを指定した場合
            • 設定されている親端末と異なる店舗IDを指定した場合
            • 親端末の店舗IDを変更しようとした場合
            • 販売用端末の登録上限数を超えてしまう場合
            • 端末識別番号が重複した場合
            • セルフレジ端末の登録上限数を超えてしまう場合
            • Smart ID Engineの利用可能台数上限を超えてしまう場合
            • 存在しないCAT/CCT端末IDを指定した場合
            • 他のレジ端末で既に登録されているCAT/CCT端末IDを指定した場合
            • 存在しないキャッシュドロアIDを指定した場合
            • 異なる店舗に所属するキャッシュドロアIDを指定した場合
            • 利用不可のキャッシュドロアIDを指定した場合
            • 親端末に親端末IDを指定した場合
            • 存在しない親端末IDを指定した場合
            • 更新対象のレジ端末IDを親端末IDに指定した場合
            • 異なる店舗に所属するレジ端末を親端末IDに指定した場合
            • 親端末が設定されているレジ端末を親端末IDに指定した場合
            403
            • CAT/CCT端末連動が有効な契約でのみ設定可能な項目が、そうでない契約において設定された場合
            404
            • 指定されたIDが存在しない場合
            patch /terminals/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/terminals/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/terminals/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "storeId": "string",
            • "terminalName": "string",
            • "uuid": "string",
            • "useStopDivision": 0,
            • "transactionEditableFlag": 0,
            • "selfCheckoutAvailableFlag": 0,
            • "smartIdEngineAvailableFlag": 0,
            • "creditTerminalId": "string",
            • "cashDrawerId": "string",
            • "parentTerminalId": "string"
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            レジ端末削除

            レジ端末を削除します。

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

            Authorizations:
            AppAccessToken (pos.stores:write) UserAccessToken (pos.stores:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            端末ID

            Responses

            200

            削除成功

            400

            親端末のIDを指定した場合

            404

            指定されたIDが存在しない場合

            delete /terminals/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/terminals/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/terminals/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "Bad Request",
            • "detail": "親端末として設定されているため、削除できません。",
            • "status": 400
            }

            スタッフ

            スタッフ一覧取得

            スタッフ情報一覧を取得します。

            Plans:
            スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
            sortで使用可能なパラメータ ■staffId:スタッフId
            ■staffCode:スタッフコード
            ■rank:ランク
            ■displaySequence:表示順
            ■updDateTime:更新日時

            Authorizations:
            AppAccessToken (pos.staffs:read) UserAccessToken (pos.staffs:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            staff_id
            integer

            スタッフID

            user_id
            integer

            ユーザー識別子:契約ID内において一意なユーザー識別子

            staff_code
            string

            スタッフコード

            role_id
            string

            役割・役職ID

            rank
            string

            ランク

            login_staff_flag
            string
            Enum: 0 1 2 3

            ログインフラグ(0:ログイン不可、1:ログイン可、2:認証待ち、3:停止)

            display_flag
            string
            Enum: 0 1

            表示フラグ(0:表示しない、1:表示する)

            Responses

            200

            取得成功

            get /staffs

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/staffs

            本番

            https://api.smaregi.jp/{契約ID}/pos/staffs

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            スタッフ取得

            スタッフ情報を取得します。

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

            Authorizations:
            AppAccessToken (pos.staffs:read) UserAccessToken (pos.staffs:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            スタッフID

            query Parameters
            fields
            array

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

            with_stores
            string
            Default: "none"
            Enum: "all" "none"

            店舗情報を付加するか(付加する場合はall, しない場合はnone)

            Responses

            200

            取得成功

            get /staffs/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/staffs/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/staffs/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            役割・役職

            役割・役職一覧取得

            役割・役職の一覧を取得します。


            sortで使用可能なパラメータ
            ■roleId:役割・役職ID
            ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
            Plans:
            プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.staffs:read) UserAccessToken (pos.staffs:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            sort
            string

            並び順(カンマ区切りで指定可)
            指定可能な項目については上記参照

            limit
            integer

            上限数

            page
            integer

            ページ

            Responses

            200

            取得成功

            get /roles

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/roles

            本番

            https://api.smaregi.jp/{契約ID}/pos/roles

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            役割・役職登録

            役割・役職を登録します。

            Plans:
            プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.staffs:write) UserAccessToken (pos.staffs:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            Request Body schema: application/json
            roleName
            required
            string (役割名・役職名) <= 30 characters

            役割名・役職名

            note
            string (説明) <= 255 characters

            説明

            functionControls
            Array of objects (機能制限)

            機能制限:POS機能における役割・役職に対する機能制限の一覧です。
            ※ IDが指定されなかった機能の制限区分はすべて 1:使用不可 に設定されます。
            ※ ただし、指定されなかった機能が商品管理機能の個別設定(ID: 2001〜2011)で、かつ機能ID 2:商品管理機能 が指定されている場合、機能ID 2に対して設定された制限区分の値を超えない最大の制限区分の値が付与されます。
            ※ 同様に、指定されなかった機能がスタッフ管理機能の個別設定(ID: 7001〜7003)で、かつ機能ID 7:スタッフ管理機能 が指定されている場合、機能ID 7に対して設定された制限区分の値を超えない最大の制限区分の値が付与されます。(例外として、機能ID 7:スタッフ管理機能の制限区分に「3:編集」が設定された場合、機能ID 7003:ログイン情報編集権限には「4:すべて」の制限区分が付与されます。)
            ※ 本フィールドそのものが指定されなかった場合もしくはnullと指定された場合、すべての機能の制限区分は 1:使用不可 に設定されます。(本フィールドに空の配列が指定された場合と同じ動きとなります。)

            inventoryFunctionControls
            Array of objects (在庫機能制限)

            対象プラン リテールビジネス
            在庫機能制限:在庫機能における役割・役職に対する機能制限の一覧です。
            ※ IDが指定されなかった機能の制限区分はすべて 1:使用不可 に設定されます。
            ※ 本フィールドそのものが指定されなかった場合もしくはnullと指定された場合、すべての機能の制限区分は 1:使用不可 に設定されます。(本フィールドに空の配列が指定された場合と同じ動きとなります。)

            alertFunctionControls
            Array of objects (アラート機能制限)

            対象プラン リテールビジネス
            アラート機能制限:在庫アラートにおける役割・役職に対する機能制限の一覧です。
            ※ IDが指定されなかった機能の制限区分はすべて 0:使用不可 に設定されます。
            ※ 本フィールドそのものが指定されなかった場合もしくはnullと指定された場合、すべての機能の制限区分は 0:使用不可 に設定されます。(本フィールドに空の配列が指定された場合と同じ動きとなります。)

            Responses

            200

            更新成功

            400
            • 機能IDが機能制限内で重複した場合
            • 機能IDが在庫機能制限内で重複した場合
            • アラート種別がアラート機能制限内で重複した場合
            • 機能制限に対して設定できない制限区分が設定されている場合
            • 在庫機能制限に対して設定できない制限区分が設定されている場合
            • 在庫機能制限の機能ID 2:発注設定機能 に制限区分 3:編集 か 4:すべて のいずれも設定されておらず、かつアラート機能設定にて制限区分に 1:使用可 が指定された機能が存在する場合
            post /roles

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/roles

            本番

            https://api.smaregi.jp/{契約ID}/pos/roles

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "roleName": "string",
            • "note": "string",
            • "functionControls":
              [
              ],
            • "inventoryFunctionControls":
              [
              ],
            • "alertFunctionControls":
              [
              ]
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "roleId": "string",
            • "roleName": "string",
            • "note": "string",
            • "insDateTime": "string",
            • "updDateTime": "string",
            • "functionControls":
              [
              ],
            • "inventoryFunctionControls":
              [
              ],
            • "alertFunctionControls":
              [
              ]
            }

            役割・役職取得

            役割・役職の一覧を取得します。

            Plans:
            プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.staffs:read) UserAccessToken (pos.staffs:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            役割・役職ID

            query Parameters
            fields
            array

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

            with_function_controls
            string
            Default: "none"
            Enum: "all" "none"

            機能制限情報を付加するか(付加する場合はall, しない場合はnone)

            with_inventory_function_controls
            string
            Default: "none"
            Enum: "all" "none"

            対象プラン リテールビジネス
            在庫機能制限情報を付加するか(付加する場合はall, しない場合はnone)

            with_alert_function_controls
            string
            Default: "none"
            Enum: "all" "none"

            対象プラン リテールビジネス
            機能制限情報を付加するか(付加する場合はall, しない場合はnone)

            Responses

            200

            取得成功

            404
            • 指定された役割・役職が存在しない場合
            get /roles/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/roles/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/roles/{id}

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            [
            • {
              }
            ]

            役割・役職更新

            役割・役職を更新します。

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

            Authorizations:
            AppAccessToken (pos.staffs:write) UserAccessToken (pos.staffs:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            役割・役職ID

            Request Body schema: application/json
            roleName
            string (役割名・役職名) <= 30 characters

            対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
            役割名・役職名

            note
            string (説明) <= 255 characters

            対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
            説明

            functionControls
            Array of objects (機能制限)

            機能制限:POS機能における役割・役職に対する機能制限の一覧です。
            ※ 機能ID 2:商品管理機能 が指定されている場合、商品管理機能の個別設定(ID: 2001〜2011)のうち指定されていないものに対しては、機能ID 2に対して設定された制限区分の値を超えない最大の制限区分の値が一括で付与されます。
            ※ 機能ID 7:スタッフ管理機能 が指定されている場合、スタッフ管理機能の個別設定(ID: 7001〜7003)のうち指定されていないものに対しては、機能ID 7に対して設定された制限区分の値を超えない最大の制限区分の値が一括で付与されます。(例外として、機能ID 7:スタッフ管理機能の制限区分に「3:編集」が設定された場合、機能ID 7003:ログイン情報編集権限には「4:すべて」の制限区分が付与されます。)
            ※ 上記以外は、IDが指定された機能の制限区分のみ変更されます。

            inventoryFunctionControls
            Array of objects (在庫機能制限)

            対象プラン リテールビジネス
            在庫機能制限:在庫機能における役割・役職に対する機能制限の一覧です。
            ※ IDが指定された機能の制限区分のみ変更されます。

            alertFunctionControls
            Array of objects (アラート機能制限)

            対象プラン リテールビジネス
            アラート機能制限:在庫アラートにおける役割・役職に対する機能制限の一覧です。
            ※ IDが指定された機能の制限区分のみ変更されます。

            Responses

            200

            更新成功

            400
          • 機能IDが機能制限内で重複した場合
          • 機能IDが在庫機能制限内で重複した場合
          • アラート種別がアラート機能制限内で重複した場合
          • 機能制限に対して設定できない制限区分が設定されている場合
          • 在庫機能制限に対して設定できない制限区分が設定されている場合
          • 役割・役職IDが 1:管理者 の役割・役職に対して、機能制御に機能IDが 7:スタッフ管理機能 の要素が含まれた場合
          • 在庫機能制限の機能ID 2:発注設定機能 に制限区分 3:編集 でも 4:すべて でもない区分が指定されているか、機能ID 2:発注設定機能 の要素は含まれておらずかつ既に登録された機能ID 2:発注設定機能 の制限区分が 3:編集 でも 4:すべて でもない場合で、アラート機能設定にて制限区分に 1:使用可 が指定された要素が存在するか、既に登録されており当更新において変更されないアラート機能の制限区分に 1:使用可 が設定されたものが存在する場合
          • 403
            • プレミアムプラン未満で、役割・役職IDに 1:管理者 以外を指定した場合
            • プレミアムプラン未満で、制御区分に 4:すべて 以外を指定した場合
            404
            • 指定された役割・役職が存在しない場合
            patch /roles/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/roles/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/roles/{id}

            Request samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "roleName": "string",
            • "note": "string",
            • "functionControls":
              [
              ],
            • "inventoryFunctionControls":
              [
              ],
            • "alertFunctionControls":
              [
              ]
            }

            Response samples

            Content type
            application/json
            Copy
            Expand all Collapse all
            {
            • "roleId": "string",
            • "roleName": "string",
            • "note": "string",
            • "insDateTime": "string",
            • "updDateTime": "string",
            • "functionControls":
              [
              ],
            • "inventoryFunctionControls":
              [
              ],
            • "alertFunctionControls":
              [
              ]
            }

            役割・役職削除

            役割・役職を削除します。

            Plans:
            プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

            Authorizations:
            AppAccessToken (pos.staffs:write) UserAccessToken (pos.staffs:write)
            path Parameters
            contract_id
            required
            string

            契約ID

            id
            required
            string

            役割・役職ID

            Responses

            200

            削除成功

            400
          • 役割・役職IDが 1:管理者 の役割・役職が指定された場合
          • 指定された役割・役職に紐付いているスタッフが存在する場合
          • 404
            • 指定された役割・役職が存在しない場合
            delete /roles/{id}

            サンドボックス

            https://api.smaregi.dev/{契約ID}/pos/roles/{id}

            本番

            https://api.smaregi.jp/{契約ID}/pos/roles/{id}

            Response samples

            Content type
            application/json
            Example
            Copy
            Expand all Collapse all
            {
            • "type": "about:blank",
            • "title": "Bad Request",
            • "detail": "役割・役職IDが 1:管理者 の役割・役職は削除できません。",
            • "status": 400
            }

            精算

            精算一覧取得

            指定された店舗の精算情報を取得します。
            ※ 精算日、精算日時、精算日時(from)・精算日時(to)のいずれかの指定が必須です

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

            Authorizations:
            AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
            path Parameters
            contract_id
            required
            string

            契約ID

            query Parameters
            fields
            array

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

            store_id
            required
            integer

            店舗ID

            terminal_id
            integer

            端末ID

            adjustment_date
            string

            精算日:精算を実施した日。 [YYYY-MM-DD]
            ※ 精算日時 もしくは 精算日時(From)・精算日時(To) と同時に指定できません

            adjustment_date_time
            string

            精算日時:精算を実施した日時。 [YYYY-MM-DDThh:mm:ssTZD]
            ※ 精算日 もしくは 精算日時(From)・精算日時(To) と同時に指定できません

            adjustment_date_time-from
            string

            精算日時(From):[YYYY-MM-DDThh:mm:ssTZD]
            ※ 精算日時(To)と合わせて指定してください
            ※ From〜Toの期間は最大31日間です(1ヶ月ではありません)
            ※ 精算日 もしくは 精算日時 と同時に指定できません

            adjustment_date_time-to
            string

            精算日時(To):[YYYY-MM-DDThh:mm:ssTZD]
            ※ 精算日時(From)と合わせて指定してください
            ※ From〜Toの期間は最大31日間です(1ヶ月ではありません)
            ※ 精算日 もしくは 精算日時 と同時に指定できません

            Responses

            200

            取得成功

            400
            • 必須検索条件の設定が必要で、必須検索条件が1つも設定されていない場合
            • 必須検索条件の設定が必要で、範囲指定の必須検索条件のうちFrom/To片方しか設定されていない場合
            • 必須検索条件の設定が必要で、範囲指定の必須検索条件におけるFrom-Toの範囲が上限を超えている場合
            • 精算日時と精算日を同時に指定した場合
            • 精算日と精算日時(from)及び精算日時(to)を同時に指定した場合
            • 精算日時と精算日時(from)及び精算日時(to)を同時に指定した場合
            • 指定された店舗IDが存在しない場合
              get /adjustments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/adjustments

              本番

              https://api.smaregi.jp/{契約ID}/pos/adjustments

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              精算実行

              精算を実行します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              storeId
              required
              string <int> (店舗ID)

              店舗ID

              terminalId
              string <int> (端末ID)

              端末IDと端末UUIDのどちらかが必須。

              uuid
              string (端末UUID)

              端末IDと端末UUIDのどちらかが必須。

              cashAdjustment
              object (現金精算情報)

              現金精算を行う際のレジ内の現金状況を保持する。
              店舗IDで指定された店舗の「端末精算時の現金入力」が「入力する」になっている時のみ設定可能。

              Responses

              200

              取得成功

              400
              • 店舗IDで指定された店舗が存在しない場合
              • 倉庫を指定した場合
              • 受注店舗を指定した場合
              • 端末IDと端末UUIDが両方ともリクエストに存在しない場合
              • 端末IDまたは端末UUIDで指定された端末が存在しない場合
              • 端末IDと端末UUIDが端末データと一致しない場合
              • 子端末を指定した場合
              • 指定された店舗と端末が一致しない場合
              • 現金精算が有効な店舗を指定し、かつ現金精算情報がリクエストに存在しない場合
              • 現金精算が無効な店舗を指定し、かつ現金精算情報がリクエストに存在する場合
              • 稼働中のテーブルや未チェックアウトの仮販売データがある場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、釣銭準備金がリクエストに存在した場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、釣銭準備金がリクエストに存在しない場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、銀行預入金がリクエストに存在した場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、銀行預入金がリクエストに存在しない場合
              post /adjustments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/adjustments

              本番

              https://api.smaregi.jp/{契約ID}/pos/adjustments

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storeId": "string",
              • "terminalId": "string",
              • "uuid": "string",
              • "cashAdjustment":
                {
                }
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "adjustmentDateTime": "string",
              • "storeId": "string",
              • "terminalId": "string"
              }

              日次締め情報

              日次締め情報一覧取得

              日次締め情報一覧を取得します。

              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              sortで使用可能なパラメータ ■sumDate:締め日
              ■storeId:店舗ID
              ■cashDrawerId:キャッシュドロアID

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数 (1 〜 100)

              page
              integer

              ページ

              sum_date
              string

              締め日 [YYYY-MM-DD]

              store_id
              integer

              店舗ID

              cash_drawer_id
              integer

              ドロアID

              Responses

              200

              取得成功

              get /daily_summaries

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/daily_summaries

              本番

              https://api.smaregi.jp/{契約ID}/pos/daily_summaries

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              日次締め実行

              締め処理を実行します。
              ※ 本処理は、スマレジ・アプリにおける手動締め処理に相当する処理です
              ※ 精算を実施した取引が締めの対象となります
              ※ キャッシュドロアを設定した店舗で締め処理を実施したい場合は管理画面から実施してください

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              sumDate
              required
              string <date>

              締め日:締め処理を実施する対象日。[YYYY-MM-DD]

              storeId
              required
              string <int> (店舗ID)

              店舗ID

              cashInfo
              object (現金管理情報)

              現金管理情報:「管理画面 > 日次締め画面 > 現金残高・現金管理」の入力可能項目に対応する値を設定します。

              ご利用に際しての注意点と補足情報
              • 現金管理情報は、レジの現金情報について、精算時ではなく、締め処理の時に初めて設定する場合に利用する項目です。端末現金精算時に現金精算情報を登録している場合はリクエストに含めないでください
                (店舗設定にて「端末精算時の現金入力」を「入力する」で運用している店舗にはリクエストに現金管理情報は必要ないということです)
              • 現金精算情報を登録している場合(端末現金精算を実施している場合)、サーバ側で日次締めの現金管理情報を計算します。各端末の現金精算情報を合算した値が設定されます。同一端末で複数回、端末現金精算を実施している場合は、同端末における最新の現金精算情報が計算対象に採用されます
              • 「釣銭準備金」・「銀行預入金」・「繰越準備金」は店舗IDで指定された店舗の「銀行預入金自動入力区分」によって設定金額が異なります
                • 「自動入力しない」場合
                  • 「釣銭準備金」は、リクエストで指定した値を設定します(前日の「繰越準備金」は参照しません)
                  • 「銀行預入金」は、リクエストで指定した値を設定します
                  • 「繰越準備金」は、実現金残高 - 銀行預入金を設定します
                • 「自動入力する」場合
                  • 「釣銭準備金」・「繰越準備金」には、「銀行預入金自動入力金額」を設定します
                  • 「銀行預入金」には 、実現金残高 - 繰越準備金 を設定します
              • 「現金過不足」は、実現金残高 - 計算現金残高 + 銀行預入済金を設定します
              • 「実現金残高」は、実際にレジに残っている現金の合計額です
              • 「計算現金残高」は、締め処理の対象の取引から計算するレジに残っているはずの現金の合計額です
              • 「銀行預入済金」は、同一端末・同一店舗で複数回端末現金精算を実施した場合に発生します。最新の現金精算情報より前の、現金精算情報の「銀行預入金」の合計額を設定します
              • 管理画面から「締め解除」を実施している場合、未締めの現金精算情報が存在する場合と存在しない場合とで設定される値が異なります
                • 未締めの現金精算情報が存在する場合: 未締めの端末現金精算情報を元に現金管理情報を設定します
                • 未締めの現金精算情報がない場合: 現金管理情報のリクエスト通りに設定します

              Responses

              200

              取得成功

              400
              • 店舗IDで指定した店舗が存在しない場合
              • 店舗IDで指定した店舗の締め方式区分が「自動締め処理」の場合
              • 倉庫を指定した場合
              • 受注店舗を指定した場合
              • キャッシュドロアが設定された店舗で締め実行をした場合
              • 未締めの現金精算情報が対象店舗に既に紐づいているにもかかわらず、現金管理情報を指定した場合
              • 指定した締め日・店舗の組み合わせで既に締め済みの場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、釣銭準備金がリクエストに存在した場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、釣銭準備金がリクエストに存在しない場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力する」に設定されていて、銀行預入金がリクエストに存在した場合
              • 対象店舗の銀行預入金自動入力区分が「自動入力しない」に設定されていて、銀行預入金がリクエストに存在しない場合
              post /daily_summaries

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/daily_summaries

              本番

              https://api.smaregi.jp/{契約ID}/pos/daily_summaries

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "sumDate": "2023-12-01",
              • "storeId": "string",
              • "cashInfo":
                {
                }
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "sumDate": "string",
              • "storeId": "string",
              • "cashDrawerId": "string",
              • "terminalIdList": "string"
              }

              消費税率

              消費税率一覧取得

              消費税率一覧を取得します。

              Plans:
              スタンダード,プレミアム,プレミアムプラス,フードビジネス,リテールビジネス
              sortで使用可能なパラメータ ■applyStartDate:適用開始日

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              target_date
              string

              対象日:指定した場合、対象日時点で有効な消費税率を1件取得 [YYYY-MM-DD]

              Responses

              200

              取得成功

              get /consumption_tax_rates

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/consumption_tax_rates

              本番

              https://api.smaregi.jp/{契約ID}/pos/consumption_tax_rates

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              軽減税率

              軽減税率一覧取得

              軽減税率一覧を取得します。
              契約共通で固定のID値で設定されている軽減税率に加え、カスタム軽減税率として契約ごとに設定された軽減税率が取得できます。

              Plans:
              スタンダード,プレミアム,プレミアムプラス,フードビジネス,リテールビジネス
              sortで使用可能なパラメータ ■reduceTaxId:軽減税率ID
              ■division:軽減税率区分
              ■rate:軽減税率
              ■termStart:適用開始日
              ■termEnd:適用終了日

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              reduce_tax_id
              string

              軽減税率ID

              division
              string

              軽減税率区分:軽減税率の適用時、部門や商品にこの軽減税率が設定されている場合にこれをそのまま適用して販売するか、それとも状態(提供方法など)によって標準税率と軽減税率で適用税率を切り替えて販売するかの区分値が設定されます。
              1:特定商品や特定部門の軽減税率適用
              2:状態による軽減税率適用

              target_date
              string

              対象日:指定した場合、対象日時点で有効な軽減税率を取得します。 [YYYY-MM-DD]

              Responses

              200

              取得成功

              get /reduce_tax_rates

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/reduce_tax_rates

              本番

              https://api.smaregi.jp/{契約ID}/pos/reduce_tax_rates

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              但し書き(領収証)

              但し書き(領収証)一覧取得

              但し書き(領収証)の一覧を取得します。

              Plans:
              スタンダード,プレミアム,プレミアムプラス,フードビジネス,リテールビジネス
              sortで使用可能なパラメータ ■receiptProvisoCode:但し書き(領収証)コード
              ■displaySequence:表示順

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              receipt_proviso_code
              string

              但し書き(領収証)コード

              initial_value_flag
              string
              Enum: 0 1

              初期値フラグ:端末で使用する際に、初期値として選択されるかを設定。(0:初期値としない、1:初期値)

              display_flag
              string
              Enum: 0 1

              有効/無効:端末で表示するかを設定。(0:無効、1:有効)

              Responses

              200

              取得成功

              get /receipt_provisoes

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/receipt_provisoes

              本番

              https://api.smaregi.jp/{契約ID}/pos/receipt_provisoes

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              支払方法

              支払方法一覧取得

              支払方法の一覧を取得します。

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


              sortで使用可能なパラメータ ■paymentMethodId : 支払方法ID
              ■paymentMethodCode : 支払方法コード
              ■unitPrice : 単価
              ■displaySequence : 表示番号
              ■updDateTime : 更新日時

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              payment_method_code
              string

              支払方法コード

              display_flag
              string
              Enum: 0 1

              表示フラグ:端末で表示するかを設定。(0:表示しない、1:表示する)

              change_flag
              string
              Enum: 0 1

              釣銭フラグ:釣銭の有無を設定。(0:釣銭なし、1:釣銭あり)

              payment_method_group_id
              string

              支払方法分類ID:[管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。

              securities_flag
              string
              Enum: 0 1

              有価証券フラグ:有価証券であるかを設定。(0:有価証券ではない、1:有価証券である)

              Responses

              200

              取得成功

              get /payment_methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_methods

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              支払方法登録

              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              支払方法を登録します。
              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              paymentMethodCode
              string (支払方法コード) <= 20 characters ^[ -~]+$

              ユニーク値

              paymentMethodName
              required
              string (支払方法名) <= 20 characters
              unitPrice
              string <int> (単価) [ 1 .. 99999999 ]
              displayFlag
              string (表示フラグ)
              Default: 1
              Enum: 0 1

              端末で表示するかを設定。(0:表示しない、1:表示する)

              displaySequence
              string <int> (表示番号) [ 1 .. 999999999 ]
              changeFlag
              string (釣銭フラグ)
              Default: 1
              Enum: 0 1

              釣銭の有無を設定。(0:釣銭なし、1:釣銭あり)

              paymentMethodGroupId
              string <int> (支払方法分類ID) [ 1 .. 999999999 ]

              [管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。

              securitiesFlag
              string (有価証券フラグ)
              Default: 1
              Enum: 0 1

              有価証券であるかを設定。(0:有価証券ではない、1:有価証券である)

              pointGivingUnitPrice
              string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

              ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
              (例10円ごとに2ポイントの場合、10円)
              ※ポイント付与単位(ポイント)を指定した場合、必須。
              ※ポイント付与が重複で設定されている場合、適用される優先度は【カード会社 > 支払方法 > 会員 > 会員ランク > 店舗】の順。

              pointGivingUnit
              string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

              ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
              (例10円ごとに0.2ポイントの場合、0.2ポイント)
              ※ポイント付与単位(金額)を指定した場合、必須。

              stores
              Array of objects (支払方法取扱店舗)

              Responses

              200

              更新成功

              400
              • ポイント付与単位(金額)とポイント付与単位(ポイント)のどちらか片方のみが指定されている場合
              • 支払方法コードが重複している場合
              • 指定された店舗IDが存在しない場合
              • 指定された支払方法分類が存在しない場合
              post /payment_methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_methods

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodCode": "string",
              • "paymentMethodName": "string",
              • "unitPrice": "string",
              • "displayFlag": 1,
              • "displaySequence": "string",
              • "changeFlag": 1,
              • "paymentMethodGroupId": "string",
              • "securitiesFlag": 1,
              • "pointGivingUnitPrice": "string",
              • "pointGivingUnit": "string",
              • "stores":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodId": "string",
              • "paymentMethodCode": "string",
              • "paymentMethodName": "string",
              • "unitPrice": "string",
              • "displayFlag": "string",
              • "displaySequence": "string",
              • "changeFlag": "string",
              • "paymentMethodGroupId": "string",
              • "securitiesFlag": "string",
              • "pointGivingUnitPrice": "string",
              • "pointGivingUnit": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "stores":
                {
                }
              }

              支払方法取得

              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              ID指定された支払方法を取得します。

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              支払方法ID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で取扱いしている支払方法IDを指定してください。

              query Parameters
              fields
              array

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

              with_stores
              string
              Default: "none"
              Enum: "all" "none"

              支払方法取扱店舗を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              get /payment_methods/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_methods/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_methods/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              支払方法更新

              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              ID指定された支払方法を更新します。
              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              支払方法ID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で取扱いしている支払方法IDを指定してください。

              Request Body schema: application/json
              paymentMethodCode
              string (支払方法コード) <= 20 characters ^[ -~]+$

              ユニーク値

              paymentMethodName
              string (支払方法名) <= 20 characters
              unitPrice
              string <int> (単価) [ 1 .. 99999999 ]
              displayFlag
              string (表示フラグ)
              Default: 1
              Enum: 0 1

              端末で表示するかを設定。(0:表示しない、1:表示する)

              displaySequence
              string <int> (表示番号) [ 1 .. 999999999 ]
              changeFlag
              string (釣銭フラグ)
              Default: 1
              Enum: 0 1

              釣銭有無を設定。(0:釣銭なし、1:釣銭あり)

              paymentMethodGroupId
              string <int> (支払方法分類ID) [ 1 .. 999999999 ]

              [管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。

              securitiesFlag
              string (有価証券フラグ)
              Default: 1
              Enum: 0 1

              有価証券であるかを設定。(0:有価証券ではない、1:有価証券である)

              pointGivingUnitPrice
              string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ]

              ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
              (例10円ごとに2ポイントの場合、10円)
              ※ポイント付与単位(ポイント)を指定した場合、必須。
              ※ポイント付与が重複で設定されている場合、適用される優先度は【カード会社 > 支払方法 > 会員 > 会員ランク > 店舗】の順。

              pointGivingUnit
              string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ]

              ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
              (例10円ごとに0.2ポイントの場合、0.2ポイント)
              ※ポイント付与単位(金額)を指定した場合、必須。

              stores
              Array of objects (支払方法取扱店舗)

              Responses

              200

              更新成功

              400
              • ポイント付与単位(金額)とポイント付与単位(ポイント)のどちらか片方のみが指定されている場合
              • 支払方法コードが重複している場合
              • 指定された店舗IDが存在しない場合
              • 指定された支払方法分類が存在しない場合
              404
              • 指定されたIDが存在しない場合
              patch /payment_methods/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_methods/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_methods/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodCode": "string",
              • "paymentMethodName": "string",
              • "unitPrice": "string",
              • "displayFlag": 1,
              • "displaySequence": "string",
              • "changeFlag": 1,
              • "paymentMethodGroupId": "string",
              • "securitiesFlag": 1,
              • "pointGivingUnitPrice": "string",
              • "pointGivingUnit": "string",
              • "stores":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodId": "string",
              • "paymentMethodCode": "string",
              • "paymentMethodName": "string",
              • "unitPrice": "string",
              • "displayFlag": "string",
              • "displaySequence": "string",
              • "changeFlag": "string",
              • "paymentMethodGroupId": "string",
              • "securitiesFlag": "string",
              • "pointGivingUnitPrice": "string",
              • "pointGivingUnit": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "stores":
                {
                }
              }

              支払方法削除

              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              ID指定された支払方法を削除します。
              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              支払方法ID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で取扱いしている支払方法IDを指定してください。

              Responses

              200

              削除成功

              404
              • 指定されたIDが存在しない場合
              delete /payment_methods/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_methods/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_methods/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたIDのリソースが見つかりません",
              • "status": 404
              }

              店舗取扱支払方法一覧取得

              指定した店舗が取扱っている支払方法の一覧を取得します。



              sortで使用可能なパラメータ ■paymentMethodId : 支払方法ID
              ■paymentMethodCode : 支払方法コード
              ■unitPrice : 単価
              ■displaySequence : 表示番号
              ■updDateTime : 更新日時
              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              store_id
              required
              string

              店舗ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              display_flag
              string

              表示フラグ:端末で表示するか判定。(0:表示しない、1:表示する)

              change_flag
              string

              釣銭フラグ:釣銭の有無を設定。(0:釣銭なし、1:釣銭あり)

              payment_method_group_id
              string

              支払方法分類ID:[管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。

              securities_flag
              string

              有価証券フラグ:有価証券であるかを設定。(0:有価証券ではない、1:有価証券である)

              Responses

              200

              取得成功

              get /stores/{store_id}/payment_methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/stores/{store_id}/payment_methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/stores/{store_id}/payment_methods

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              支払方法分類

              支払方法分類一覧取得

              支払方法分類の一覧を取得します。


              sortで使用可能なパラメータ
              ■paymentMethodGroupId:支払方法分類ID
              ■code:コード
              ■displaySequence:表示順
              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              payment_method_group_id
              required
              integer

              支払方法分類ID

              code
              string

              コード:一意にするための値

              display_flag
              string
              Enum: 0 1

              有効/無効:端末で表示するかを設定。(0:無効、1:有効)

              Responses

              200

              取得成功

              get /payment_method_groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_method_groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_method_groups

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              支払方法分類登録

              支払方法分類を登録します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              name
              required
              string (名称) <= 85 characters

              名称

              displaySequence
              string <int> (表示順) [ 1 .. 999 ]

              表示順

              displayFlag
              string (有効/無効)
              Default: 1
              Enum: 0 1

              有効/無効:端末で表示するかを設定。(0:無効、1:有効)

              Responses

              200

              取得成功

              post /payment_method_groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_method_groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_method_groups

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "name": "string",
              • "displaySequence": "string",
              • "displayFlag": 1
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodGroupId": "string",
              • "code": "string",
              • "name": "string",
              • "displaySequence": "string",
              • "displayFlag": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              支払方法分類更新

              支払方法分類を更新します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              支払方法分類ID

              Request Body schema: application/json
              name
              string (名称) <= 85 characters

              名称

              displaySequence
              string <int> (表示順) [ 1 .. 999 ]

              表示順

              displayFlag
              string (有効/無効)
              Default: 1
              Enum: 0 1

              有効/無効:端末で表示するかを設定。(0:無効、1:有効)

              Responses

              200

              取得成功

              404
              • 指定されたIDが存在しない場合
              patch /payment_method_groups/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_method_groups/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_method_groups/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "name": "string",
              • "displaySequence": "string",
              • "displayFlag": 1
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodGroupId": "string",
              • "code": "string",
              • "name": "string",
              • "displaySequence": "string",
              • "displayFlag": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              支払方法分類削除

              支払方法分類を削除します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              支払方法分類ID

              Responses

              200

              削除成功

              404
              • 指定されたIDが存在しない場合
              delete /payment_method_groups/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/payment_method_groups/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/payment_method_groups/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたIDのリソースが見つかりません",
              • "status": 404
              }

              個別アプリ専用支払方法

              個別アプリ専用支払方法一覧取得

              クライアントIDに紐づく個別アプリ専用支払方法の一覧を取得します。
              ※現状、返却される支払方法は最大1つです。

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

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              limit
              integer

              上限数

              page
              integer

              ページ

              payment_method_id
              string

              個別アプリ専用支払方法ID:クライアントIDに紐づく、契約毎に一意な支払方法ID

              Responses

              200

              取得成功

              get /app_payment_methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/app_payment_methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/app_payment_methods

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              個別アプリ専用支払方法登録

              個別アプリ専用支払方法を登録します。
              クライアントIDに基づいて、契約毎に一意な支払方法IDを発行します。
              ※ 本APIで発行される支払方法IDは、取引登録APIでキャッシュレス決済時の伝票番号・金種・クレジットカード会社のデータを登録する場合に使用します。
              ※ 非有価証券・釣銭なしの支払方法として登録されます。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              paymentMethodName
              required
              string (個別アプリ専用支払方法名) <= 20 characters

              Responses

              200

              更新成功

              403
              • 同一クライアントIDに紐づく個別アプリ専用支払方法の登録上限数を超えてしまう場合
              post /app_payment_methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/app_payment_methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/app_payment_methods

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodName": "string"
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "paymentMethodId": "string",
              • "paymentMethodName": "string"
              }

              値引/割引区分

              値引/割引区分一覧取得

              値引/割引区分の一覧を取得します。

              Plans:
              スタンダード,プレミアム,プレミアムプラス,フードビジネス,リテールビジネス
              sortで使用可能なパラメータ ■discountDivision:値引/割引区分
              ■displaySequence:表示順

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              discount_division
              string

              値引/割引区分:値引/割引区分を一意に識別する番号であり、管理画面の[設定]→[販売設定]→[値引区分] / [割引区分]のページで確認できる「ID」に該当する。
              ※取引時、小計値引/割引区分または単品値引/割引区分に対して指定可能。

              award_type
              string
              Enum: 1 2

              1:値引、2:割引

              display_flag
              string
              Enum: 0 1

              有効/無効:端末で表示するかを設定。(0:無効、1:有効)

              Responses

              200

              取得成功

              get /discount_divisions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/discount_divisions

              本番

              https://api.smaregi.jp/{契約ID}/pos/discount_divisions

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              クーポン

              クーポン一覧取得

              クーポンの一覧を取得します。


              sortで使用可能なパラメータ
              ■couponId:クーポンID
              ■updDateTime:更新日時
              Plans:
              プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              serial_number
              string

              シリアル番号:端末側でのクーポンの入力に用いられます。

              award_type
              string
              Enum: "1" "2" "3" "P1" "P2" "P3" "P4" "M1" "M2" "M3" "M4"

              特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍)

              apply_condition_division
              string
              Enum: 0 1

              適用条件区分:クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。(0:全適用、1:対象商品が含まれる場合のみ適用)

              start_date
              date

              利用可能開始日:クーポンの有効期限(開始日)[YYYY-MM-DD]

              end_date
              date

              利用可能終了日:クーポンの有効期限(終了日)。[YYYY-MM-DD]

              applicable-from
              date

              利用可能期間(From):applicable-from から applicable-to までの期間で利用可能なクーポンを検索したい場合に指定します。[YYYY-MM-DD]

              applicable-to
              date

              利用可能期間(To):applicable-from から applicable-to までの期間で利用可能なクーポンを検索したい場合に指定します。[YYYY-MM-DD]

              coupon_division
              string
              Enum: 0 1

              クーポン区分:クーポン区分(0:通常、1:giftee)
              ※ 1:giftee は、プレミアムプラスプラン以上でのみ指定可能です。

              Responses

              200

              取得成功

              403
              • プレミアムプラスプラン未満で、クーポン区分に 1:giftee を指定した場合
              get /coupons

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              クーポン登録

              クーポンを登録します。

              Plans:
              プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              couponName
              required
              string (クーポン名) <= 85 characters

              クーポン名

              couponDivision
              string (クーポン区分)
              Default: 0
              Enum: 0 1

              クーポン区分:クーポン区分(0:通常、1:giftee)
              ※ 1:giftee は、プレミアムプラスプラン以上でのみ指定可能です。

              serialNumber
              required
              string (シリアル番号) <= 20 characters

              シリアル番号:端末側でのクーポンの入力に用いられます。
              ※ クーポン区分が 1:giftee の場合は、gifteeクーポンに付与されているコードの上7桁を指定します。

              summary
              string (概要) <= 255 characters

              概要

              awardType
              required
              string (特典タイプ)
              Enum: "1" "2" "3" "P1" "P2" "P3" "P4" "M1" "M2" "M3" "M4"

              特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍)

              awardValue
              required
              string <int> (特典値)

              特典値: 特典タイプに応じた値を設定。
              特典タイプ 設定値
              1:値引 値引き額[円]
              2:割引 割引率[%]
              3:商品付与 0固定
              P1:0ポイント 0固定
              P2:ポイント指定(上書き) ポイント数
              P3:ポイント追加(加算) 差分ポイント数
              P4:ポイントN倍 ポイントへ乗算する値
              M1:0マイル 0固定
              M2:マイル指定(上書き) マイル数
              M3:マイル追加(加算) 差分マイル数
              M4:マイルN倍 マイルへ乗算する値

              applyConditionDivision
              required
              string (適用条件区分)
              Enum: 0 1

              適用条件区分:クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。(0:全適用、1:対象商品が含まれる場合のみ適用)

              minTargetPrice
              string <int> (最低対象金額) [ 0 .. 9999999999 ]

              最低対象金額

              maxTargetPrice
              string <int> (最高対象金額) [ 0 .. 9999999999 ]

              最高対象金額

              startDate
              string <date> (利用可能開始日)

              利用可能開始日:クーポンの有効期限(開始日)。[YYYY-MM-DD]

              endDate
              string <date> (利用可能期限)

              利用可能終了日:クーポンの有効期限(終了日)。[YYYY-MM-DD]

              combineDivision
              string (併用区分)
              Default: 3
              Enum: 1 2 3

              併用区分:クーポン利用時に他クーポンとの併用が可能か否かを指定します。(1:併用不可、2:一部のクーポン(3:併用可能)と併用可能、3:併用可能)

              Responses

              200

              更新成功

              400
              • クーポン区分が 1:giftee で、シリアル番号が7文字でない場合
              • 最低対象金額が最高対象金額を上回っている場合
              • 利用可能終了日が利用可能開始日より前の日が指定されている場合
              • 特典タイプが 1.値引 指定で、特典値が -9999999999 を下回っている場合
              • 特典タイプが 1.値引 指定で、特典値が 9999999999 を上回っている場合
              • 特典タイプが 2.割引 指定で、特典値が 0 を下回っている場合
              • 特典タイプが 2.割引 指定で、特典値が 100 を上回っている場合
              • 特典タイプが 3.商品付与 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが P1:0ポイント 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが P2:ポイント指定(上書き) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが P2:ポイント指定(上書き) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが P3:ポイント追加(加算) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが P3:ポイント追加(加算) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが P4:ポイントN倍 指定で、特典値が 1 を下回っている場合
              • 特典タイプが P4:ポイントN倍 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M1:0マイル 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが M2:マイル指定(上書き) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが M2:マイル指定(上書き) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M3:マイル追加(加算) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが M3:マイル追加(加算) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M4:マイルN倍 指定で、特典値が 1 を下回っている場合
              • 特典タイプが M4:マイルN倍 指定で、特典値が 999999999 を上回っている場合
              • シリアル番号が重複する場合
              403
              • プレミアムプラスプラン未満で、クーポン区分に 1:giftee を指定した場合
              post /coupons

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponName": "string",
              • "couponDivision": 0,
              • "serialNumber": "string",
              • "summary": "string",
              • "awardType": "1",
              • "awardValue": "string",
              • "applyConditionDivision": 0,
              • "minTargetPrice": "string",
              • "maxTargetPrice": "string",
              • "startDate": "2023-12-01",
              • "endDate": "2023-12-01",
              • "combineDivision": 3
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponId": "string",
              • "couponName": "string",
              • "couponDivision": "string",
              • "serialNumber": "string",
              • "summary": "string",
              • "awardType": "string",
              • "awardValue": "string",
              • "applyConditionDivision": "string",
              • "minTargetPrice": "string",
              • "maxTargetPrice": "string",
              • "startDate": "string",
              • "endDate": "string",
              • "combineDivision": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              クーポン取得

              指定されたクーポンを取得します。

              Plans:
              プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              query Parameters
              fields
              array

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

              with_items
              string
              Default: "none"
              Enum: "all" "none"

              クーポンアイテム情報を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • 指定されたIDが存在しない場合
              get /coupons/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              クーポン更新

              指定されたクーポンを更新します。

              Plans:
              プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              Request Body schema: application/json
              couponName
              string (クーポン名) <= 85 characters

              クーポン名

              serialNumber
              string (シリアル番号) <= 20 characters

              シリアル番号:端末側でのクーポンの入力に用いられます。
              ※ クーポン区分が 1:giftee の場合は、gifteeクーポンに付与されているコードの上7桁を指定します。

              summary
              string (概要) <= 255 characters

              概要

              awardType
              string (特典タイプ)
              Enum: "1" "2" "3" "P1" "P2" "P3" "P4" "M1" "M2" "M3" "M4"

              特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍)

              awardValue
              string <int> (特典値)

              特典値: 特典タイプに応じた値を設定。
              特典タイプ 設定値
              1:値引 値引き額[円]
              2:割引 割引率[%]
              3:商品付与 0固定
              P1:0ポイント 0固定
              P2:ポイント指定(上書き) ポイント数
              P3:ポイント追加(加算) 差分ポイント数
              P4:ポイントN倍 ポイントへ乗算する値
              M1:0マイル 0固定
              M2:マイル指定(上書き) マイル数
              M3:マイル追加(加算) 差分マイル数
              M4:マイルN倍 マイルへ乗算する値

              applyConditionDivision
              string (適用条件区分)
              Enum: 0 1

              適用条件区分:クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。(0:全適用、1:対象商品が含まれる場合のみ適用)

              minTargetPrice
              string <int> (最低対象金額) [ 0 .. 9999999999 ]

              最低対象金額

              maxTargetPrice
              string <int> (最高対象金額) [ 0 .. 9999999999 ]

              最高対象金額

              startDate
              string <date> (利用可能開始日)

              利用可能開始日:クーポンの有効期限(開始日)。[YYYY-MM-DD]

              endDate
              string <date> (利用可能期限)

              利用可能終了日:クーポンの有効期限(終了日)。[YYYY-MM-DD]

              combineDivision
              string (併用区分)
              Enum: 1 2 3

              併用区分:クーポン利用時に他クーポンとの併用が可能か否かを指定します。(1:併用不可、2:一部のクーポン(3:併用可能)と併用可能、3:併用可能)

              Responses

              200

              更新成功

              400
              • クーポン区分が 1:giftee で、シリアル番号が7文字でない場合
              • 最低対象金額が最高対象金額を上回っている場合
              • 利用可能終了日が利用可能開始日より前の日が指定されている場合
              • 特典タイプが 1.値引 指定で、特典値が -9999999999 を下回っている場合
              • 特典タイプが 1.値引 指定で、特典値が 9999999999 を上回っている場合
              • 特典タイプが 2.割引 指定で、特典値が 0 を下回っている場合
              • 特典タイプが 2.割引 指定で、特典値が 100 を上回っている場合
              • 特典タイプが 3.商品付与 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが P1:0ポイント 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが P2:ポイント指定(上書き) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが P2:ポイント指定(上書き) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが P3:ポイント追加(加算) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが P3:ポイント追加(加算) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが P4:ポイントN倍 指定で、特典値が 1 を下回っている場合
              • 特典タイプが P4:ポイントN倍 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M1:0マイル 指定で、特典値が 0 以外の値を指定している場合
              • 特典タイプが M2:マイル指定(上書き) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが M2:マイル指定(上書き) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M3:マイル追加(加算) 指定で、特典値が 0 を下回っている場合
              • 特典タイプが M3:マイル追加(加算) 指定で、特典値が 999999999 を上回っている場合
              • 特典タイプが M4:マイルN倍 指定で、特典値が 1 を下回っている場合
              • 特典タイプが M4:マイルN倍 指定で、特典値が 999999999 を上回っている場合
              • シリアル番号が重複する場合
              404
              • 指定されたIDが存在しない場合
              patch /coupons/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponName": "string",
              • "serialNumber": "string",
              • "summary": "string",
              • "awardType": "1",
              • "awardValue": "string",
              • "applyConditionDivision": 0,
              • "minTargetPrice": "string",
              • "maxTargetPrice": "string",
              • "startDate": "2023-12-01",
              • "endDate": "2023-12-01",
              • "combineDivision": 1
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponId": "string",
              • "couponName": "string",
              • "couponDivision": "string",
              • "serialNumber": "string",
              • "summary": "string",
              • "awardType": "string",
              • "awardValue": "string",
              • "applyConditionDivision": "string",
              • "minTargetPrice": "string",
              • "maxTargetPrice": "string",
              • "startDate": "string",
              • "endDate": "string",
              • "combineDivision": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              クーポン削除

              指定されたクーポンを削除します。

              Plans:
              プレミアム・プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              Responses

              200

              削除成功

              404
              • 指定されたIDが存在しない場合
              delete /coupons/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたIDのリソースが見つかりません",
              • "status": 404
              }

              クーポン商品登録

              クーポン商品を登録します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              coupon_id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              Request Body schema: application/json
              division
              required
              string (クーポンアイテム区分)
              Enum: 1 2 3

              クーポンアイテム区分:itemId の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード)
              ※クーポンアイテムタイプが 2.商品付与 の場合、商品IDのみ指定できます。

              itemId
              required
              string <int> (アイテムID) <= 85 characters

              アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。
              ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

              type
              required
              string (クーポンアイテムタイプ)
              Enum: 1 2

              クーポンアイテムタイプ(1:適用条件、2:商品付与)

              salesPrice
              string <int> (販売価格) [ -9999999999 .. 9999999999 ]

              販売価格:商品付与する際の価格を指定します。
              ※クーポンアイテムタイプが 2.商品付与 の場合必須です。

              Responses

              200

              更新成功

              400
              • 指定したアイテムIDが存在しない場合
              • クーポンアイテムタイプが 2.商品付与 指定で、クーポンアイテム区分が 2.商品ID 以外を指定した場合
              • クーポンアイテムタイプが 1.適用条件 指定で、販売価格を指定した場合
              • クーポンアイテムタイプが 2.商品付与 指定で、販売価格を指定しなかった場合
              • 指定されたクーポンアイテム区分、アイテムID、クーポンアイテムタイプの組み合わせが存在する場合
              • 適用条件区分が 指定商品 でないクーポンを指定して、クーポンアイテムタイプが 1.適用条件 を指定した場合
              • 特典タイプが 商品付与 でないクーポンを指定して、クーポンアイテムタイプが 2.商品付与 を指定した場合
              404
              • 指定されたクーポンIDが存在しない場合
              post /coupons/{coupon_id}/products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{coupon_id}/products

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{coupon_id}/products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "division": 1,
              • "itemId": "string",
              • "type": 1,
              • "salesPrice": "string"
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponId": "string",
              • "division": "string",
              • "itemId": "string",
              • "type": "string",
              • "salesPrice": "string"
              }

              クーポン商品更新

              指定されたクーポン商品を更新します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              coupon_id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              type
              required
              string
              Value: 2

              クーポンアイテムタイプ(1:適用条件、2:商品付与)
              ※クーポン商品更新の場合は 2:商品付与 のみ指定できます。

              division
              required
              string
              Value: 2

              クーポンアイテム区分:item_id の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード)
              ※クーポンアイテムタイプが 2.商品付与 の場合、商品IDのみ指定できます。

              item_id
              required
              string <= 85 characters

              アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。
              ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

              Request Body schema: application/json
              salesPrice
              required
              string <int> (販売価格) [ -9999999999 .. 9999999999 ]

              販売価格:商品付与する際の価格を指定します。

              Responses

              200

              更新成功

              404
              • 指定されたクーポンIDが存在しない場合
              • 指定された商品IDが存在しない場合
              • 指定されたパスの組み合わせのクーポン商品が存在しない場合
              patch /coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "salesPrice": "string"
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "couponId": "string",
              • "division": "string",
              • "itemId": "string",
              • "type": "string",
              • "salesPrice": "string"
              }

              クーポン商品削除

              指定されたクーポン商品を削除します。

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

              Authorizations:
              AppAccessToken (pos.transactions:write) UserAccessToken (pos.transactions:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              coupon_id
              required
              string

              クーポンID
              ※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品のみをクーポン商品として持つクーポンのIDを指定してください。

              type
              required
              string
              Enum: 1 2

              クーポンアイテムタイプ(1:適用条件、2:商品付与)

              division
              required
              string
              Enum: 1 2 3

              クーポンアイテム区分:item_id の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード)
              ※クーポンアイテムタイプが 2.商品付与 の場合、商品IDのみ指定できます。

              item_id
              required
              string <= 85 characters

              アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。
              ※ ユーザーアクセストークンを利用する場合で商品IDを指定する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。

              Responses

              200

              削除成功

              404
              • 指定されたクーポンIDが存在しない場合
              • 指定された部門IDが存在しない場合
              • 指定された商品IDが存在しない場合
              • 指定されたパスの組み合わせのクーポン商品が存在しない場合
              delete /coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/coupons/{coupon_id}/type/{type}/division/{division}/products/{item_id}

              Response samples

              Content type
              application/json
              Example
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたクーポンIDのリソースが見つかりません。",
              • "status": 404
              }

              CAT/CCTカード会社

              CAT/CCTカード会社一覧取得

              CAT/CCTカード会社の一覧を取得します。


              sortで使用可能なパラメータ
              ■catCardCompanyCode:CAT/CCTカード会社コード
              ■displaySequence:表示順
              Plans:
              スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
              Authorizations:
              AppAccessToken (pos.transactions:read) UserAccessToken (pos.transactions:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              Responses

              200

              取得成功

              get /cat_card_companies

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/cat_card_companies

              本番

              https://api.smaregi.jp/{契約ID}/pos/cat_card_companies

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              ロス

              ロス一覧取得

              ロス情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■lossId:ロスID
              ■storeId:店舗ID
              ■division:ロス区分:ロス区分一覧より設定可能。
              ■lossDateTime:ロス発生日時:ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.losses:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              store_id
              string

              店舗ID

              division
              string

              ロス区分:ロス区分一覧より設定可能。

              Responses

              200

              取得成功

              get /losses

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              ロス登録

              ロス情報を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              storeId
              required
              string <int> (店舗ID) [ 1 .. 999999999 ]

              店舗ID。登録時のみ指定可能。更新時は変更不可。
              ※店舗マスタが存在しない場合エラー

              division
              required
              string <int> (ロス区分) [ 1 .. 99 ]

              ロス区分コードを設定。
              ※ロス区分マスタが存在しない場合エラー

              memo
              string (メモ) <= 1000 characters

              メモ

              lossDateTime
              required
              string <date-time> (ロス発生日時)

              ロス発生時の日時。[YYYY-MM-DDThh:mm:ssTZD]
              ※未来日時を設定することはできません

              identificationNo
              string (識別番号) <= 32 characters

              ロス情報を管理するための任意の文字列を設定出来る項目。

              staffId
              string <int> (スタッフID) [ 1 .. 999999999 ]

              スタッフID
              ※スタッフ情報が存在しない場合エラー

              details
              required
              Array of objects (ロス明細)

              ロス明細(objectList) 登録時は明細は必須
              ※明細の最大件数は1000件です

              Responses

              200

              取得成功

              400
              • 店舗IDが存在しない場合
              • ロス区分IDが存在しない場合
              • スタッフIDが存在しない場合
              • 商品IDが存在しない場合
              • ロス明細がない場合
              • ロス明細件数が1000件を超過した場合
              post /losses

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storeId": "string",
              • "division": "string",
              • "memo": "string",
              • "lossDateTime": "2023-12-01T10:09:42Z",
              • "identificationNo": "string",
              • "staffId": "string",
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "lossId": "string",
              • "storeId": "string",
              • "division": "string",
              • "memo": "string",
              • "lossDateTime": "string",
              • "identificationNo": "string",
              • "staffId": "string",
              • "staffName": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              ロス取得

              ロス情報を取得します。


              sortで使用可能なパラメータ
              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              ロスID

              query Parameters
              fields
              array

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

              with_details
              string
              Default: "none"
              Enum: "all" "none"

              ロス明細を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /losses/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "lossId": "string",
              • "storeId": "string",
              • "division": "string",
              • "memo": "string",
              • "lossDateTime": "string",
              • "identificationNo": "string",
              • "staffId": "string",
              • "staffName": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              ロス更新

              ロスを更新します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              ロスID

              Request Body schema: application/json
              division
              string <int> (ロス区分) [ 1 .. 99 ]

              ロス区分コードを設定。
              ※ロス区分マスタが存在しない場合エラー

              memo
              string (メモ) <= 1000 characters

              メモ

              identificationNo
              string (識別番号) <= 32 characters

              ロス情報を管理するための任意の文字列を設定出来る項目。

              staffId
              string <int> (スタッフID) [ 1 .. 999999999 ]

              スタッフID
              ※スタッフ情報が存在しない場合エラー

              details
              Array of objects (ロス明細)

              ロス明細(objectList) ロス更新時にロス明細を追加登録できます
              ※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

              Responses

              200

              取得成功

              400
              • ロス区分IDが存在しない場合
              • スタッフIDが存在しない場合
              • 商品IDが存在しない場合
              • 在庫管理設定にある「ロス完了後の編集可否」が「編集不可」に設定されている場合
              • ロス明細がない場合
              • ロス明細IDも商品IDも指定していない場合
              • ロス明細件数が1000件を超過した場合
              patch /losses/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "division": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "staffId": "string",
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "lossId": "string",
              • "division": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "staffId": "string",
              • "staffName": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              ロス削除

              ロス情報を削除します。

              Plans:
              プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              ロスID

              Responses

              200

              削除成功

              404

              指定したロスデータが存在しない場合

              delete /losses/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたIDのリソースが見つかりません",
              • "status": 404
              }

              ロス明細取得

              ロス明細情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■lossDetailId:ロス明細ID
              ■productId:商品ID
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.losses:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              ロスID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              Responses

              200

              取得成功

              get /losses/{id}/details

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/{id}/details

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/{id}/details

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              ロス区分一覧取得

              ロス区分情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■code:コード
              ■displaySequence:表示順
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.losses:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              active_flag
              string
              Enum: 0 1

              有効フラグ:0:無効 1:有効

              Responses

              200

              取得成功

              get /losses/divisions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/divisions

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/divisions

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              ロス区分登録

              ロス区分を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              name
              required
              string (ロス区分名) <= 8 characters

              ロス区分名

              color
              string () ^#([0-9a-fA-F]{1,6})$

              ロス一覧に表示される色。カラーコード。[#FFFFFF]

              activeFlag
              string (有効フラグ)
              Default: 1
              Enum: 0 1

              有効フラグ(0:無効 1:有効)

              displaySequence
              string <int> (表示順) [ 1 .. 999 ]

              表示順

              Responses

              200

              取得成功

              post /losses/divisions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/divisions

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/divisions

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "name": "string",
              • "color": "string",
              • "activeFlag": 1,
              • "displaySequence": "string"
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "code": "string",
              • "name": "string",
              • "color": "string",
              • "activeFlag": "string",
              • "displaySequence": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              ロス区分更新

              ロス区分を更新します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              code
              required
              string

              コード

              Request Body schema: application/json
              name
              string (ロス区分名) <= 8 characters

              ロス区分名

              color
              string () ^#([0-9a-fA-F]{1,6})$

              ロス一覧に表示される色。カラーコード。[#FFFFFF]

              activeFlag
              string (有効フラグ)
              Enum: 0 1

              有効フラグ(0:無効 1:有効)

              displaySequence
              string <int> (表示順) [ 1 .. 999 ]

              表示順

              Responses

              200

              取得成功

              404

              指定したロス区分データが存在しない場合

              patch /losses/divisions/{code}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/divisions/{code}

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/divisions/{code}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "name": "string",
              • "color": "string",
              • "activeFlag": 0,
              • "displaySequence": "string"
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "code": "string",
              • "name": "string",
              • "color": "string",
              • "activeFlag": "string",
              • "displaySequence": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              ロス区分削除

              ロス区分情報を削除します。

              Plans:
              プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.losses:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              code
              required
              string

              コード

              Responses

              200

              削除成功

              404

              指定したロス区分データが存在しない場合

              delete /losses/divisions/{code}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/losses/divisions/{code}

              本番

              https://api.smaregi.jp/{契約ID}/pos/losses/divisions/{code}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "NotFound",
              • "detail": "指定されたIDのリソースが見つかりません",
              • "status": 404
              }

              発注

              発注一覧取得

              発注情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■storageInfoId:発注ID
              ■recipientOrderId:発注先ID:発注先となる仕入先ID
              ■orderedDate:発注日:YYYY-MM-DD形式
              ■status:ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注)
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              recipient_order_id
              string

              発注先ID:発注先となる仕入先ID

              ordered_date
              string

              発注日:YYYY-MM-DD形式

              status
              string
              Enum: 2 3 4 5

              ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注)

              Responses

              200

              取得成功

              get /purchase_orders

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              発注登録

              発注を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              recipientOrderId
              string <int> (発注先) [ 1 .. 9999999999 ]

              発注先ID:発注先となる仕入先ID
              ※在庫管理設定の発注分割単位設定に仕入先を設定している場合、必須です。

              orderedDate
              string <date> (発注日)

              発注日 [YYYY-MM-DD]

              memo
              string (メモ) <= 1000 characters

              メモ 1000文字以内

              identificationNo
              string (識別番号) <= 32 characters

              識別番号 発注情報を管理するための任意の文字列を設定出来る項目。

              roundingDivision
              string (税丸め)
              Enum: 0 1 2

              税丸め(0:四捨五入、1:切り捨て、2:切り上げ)
              未設定の場合、1:切り捨てで設定する。

              status
              required
              string (ステータス)
              Enum: 2 5

              ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注) 発注登録で指定できるのは、2:発注済と5:仮発注。

              staffId
              string <int> (スタッフID)

              発注処理時のスタッフID

              products
              required
              Array of objects (発注対象商品)

              発注対象商品
              ※発注対象商品の最大件数は1000件です

              stores
              required
              Array of objects (発注対象店舗)

              発注対象店舗

              Responses

              200

              取得成功

              400
              • 発注対象店舗IDが存在しない場合
              • 商品IDが存在しない場合
              • スタッフIDが存在しない場合
              • 発注先マスタIDが存在しない場合
              • 同一発注IDの範囲で商品IDがユニークでない場合(products)
              • 発注対象店舗に指定されていない配送先店舗の店舗に指定した場合
              • 同一商品に対して同一店舗を複数回指定した場合(deliveryStore)
              • 発注設定で発注状態が発注不可となっている商品が指定された場合
              • 発注設定で発注表示が表示しないとなっている商品が指定された場合
              • 発注設定の発注制限数が0の商品が指定された場合
              • 発注設定の発注制限数に入荷予定数が達している場合
              • 発注設定の発注制限数を超える発注数量が指定された場合
              • 発注対象商品が1000件を超過した場合
              • 発注配送商品がない場合
              • 発注分割単位設定で仕入先が設定されていて、発注先が設定されていない場合
              • 発注分割単位設定で仕入先が設定されていて、発注対象商品に仕入先に発注先が登録されていない商品がある場合
              • 発注分割単位設定で部門グループが設定されていて、異なる部門グループの商品が混在している場合
              post /purchase_orders

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "recipientOrderId": "string",
              • "orderedDate": "2023-12-01",
              • "memo": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 2,
              • "staffId": "string",
              • "products":
                [
                ],
              • "stores":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageInfoId": "string",
              • "recipientOrderId": "string",
              • "divisionUnit": "string",
              • "categoryGroupId": "string",
              • "orderedDate": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": "string",
              • "staffId": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "products":
                [
                ],
              • "stores":
                [
                ]
              }

              発注取得

              発注情報を取得します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              発注ID

              query Parameters
              fields
              array

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

              with_products
              string
              Default: "none"
              Enum: "all" "none"

              発注対象商品、発注配送商品を付加するか(付加する場合はall, しない場合はnone)

              with_stores
              string
              Default: "none"
              Enum: "all" "none"

              発注対象店舗を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /purchase_orders/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageInfoId": "string",
              • "recipientOrderId": "string",
              • "divisionUnit": 0,
              • "categoryGroupId": "string",
              • "orderedDate": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 2,
              • "staffId": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "products":
                [
                ],
              • "stores":
                [
                ]
              }

              発注更新

              発注を更新します。

              Plans:
              リテールビジネス
              ※本APIでは配送ルートを設定した発注データは対象外となります

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              発注ID

              Request Body schema: application/json
              recipientOrderId
              string <int> (発注先) [ 1 .. 9999999999 ]

              発注先ID:発注先となる仕入先ID
              ※在庫管理設定の発注分割単位設定に仕入先を設定している場合、必須です。

              orderedDate
              string <date> (発注日)

              発注日 [YYYY-MM-DD]

              memo
              string (メモ) <= 1000 characters

              メモ 1000文字以内

              identificationNo
              string (識別番号) <= 32 characters

              識別番号 発注情報を管理するための任意の文字列を設定出来る項目。

              roundingDivision
              string (税丸め)
              Enum: 0 1 2

              税丸め(0:四捨五入、1:切り捨て、2:切り上げ)

              status
              required
              string (ステータス)
              Enum: 2 5

              ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注)
              発注更新で指定できるのは、2:発注済と5:仮発注。
              2:発注済の場合、5:仮発注に更新できません。

              staffId
              string <int> (スタッフID)

              発注処理時のスタッフID

              products
              Array of objects (発注対象商品)

              発注対象商品
              ※発注対象商品の既存件数と追加件数の合計が1000件以下になるようにしてください

              stores
              Array of objects (発注対象店舗)

              発注対象店舗

              Responses

              200

              取得成功

              400
              • 発注対象店舗IDが存在しない場合
              • 商品IDが存在しない場合
              • スタッフIDが存在しない場合
              • 発注先マスタIDが存在しない場合
              • 同一発注IDの範囲で商品IDがユニークでない場合(products)
              • 発注対象店舗に指定されていない配送先店舗の店舗に指定した場合
              • 同一商品に対して同一店舗を複数回指定した場合(deliveryStore)
              • statusが2または5以外の時に更新しようとした場合
              • statusが2:発注済の発注データを5:仮発注に更新しようとした場合
              • statusが2:発注済の発注データで入荷データが未検品以外の場合
              • 指定した発注商品IDが存在しない場合
              • 指定した発注配送商品IDが存在しない場合
              • 指定した発注配送店舗IDが存在しない場合
              • 配送ルートが設定された発注データを更新しようとした場合
              • 発注設定で発注状態が発注不可となっている商品が指定された場合
              • 発注設定で発注表示が表示しないとなっている商品が指定された場合
              • 発注設定の発注制限数が0の商品が指定された場合
              • 発注設定の発注制限数に入荷予定数が達している場合
              • 発注設定の発注制限数を超える発注数量が指定された場合
              • 発注対象商品が1000件を超過した場合
              • 発注分割単位設定で仕入先が設定されていて、発注先が設定されていない場合
              • 発注分割単位設定で仕入先が設定されていて、発注対象商品に仕入先に発注先が登録されていない商品がある場合
              • 発注分割単位設定で部門グループが設定されていて、異なる部門グループの商品が混在している場合
              404

              指定した発注データが存在しない場合

              patch /purchase_orders/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "recipientOrderId": "string",
              • "orderedDate": "2023-12-01",
              • "memo": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 2,
              • "staffId": "string",
              • "products":
                [
                ],
              • "stores":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageInfoId": "string",
              • "recipientOrderId": "string",
              • "divisionUnit": "string",
              • "categoryGroupId": "string",
              • "orderedDate": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": "string",
              • "staffId": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "products":
                [
                ],
              • "stores":
                [
                ]
              }

              発注削除

              発注情報を削除します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              発注ID

              Responses

              200

              削除成功

              400
              • statusが3または4の時に削除しようとした場合
              404

              指定した発注データが存在しない場合

              delete /purchase_orders/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "Bad Request",
              • "detail": "status:3 入荷検品中または入荷完了しているため発注情報を削除できません。",
              • "status": 400
              }

              発注対象商品取得

              発注対象商品情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■storageInfoProductId:発注商品ID
              ■productId:商品ID
              ■quantity:発注数量
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              発注ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              with_deliveries
              string
              Default: "none"
              Enum: "all" "none"

              配送先店舗付加フラグ:(none:付加しない、all:付加する)

              Responses

              200

              取得成功

              404

              指定した発注データが存在しない場合

              get /purchase_orders/{id}/products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders/{id}/products

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders/{id}/products

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              発注対象店舗取得

              発注対象店舗情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■storageInfoDeliveryId:発注配送店舗ID
              ■storageStoreId:配送店舗ID
              ■storageExpectedDateFrom:入荷予定日From:[YYYY-MM-DD]
              ■storageExpectedDateTo:入荷予定日To:[YYYY-MM-DD]
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              発注ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              storage_store_id
              string

              配送店舗ID

              Responses

              200

              取得成功

              404

              指定した発注データが存在しない場合

              get /purchase_orders/{id}/stores

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/purchase_orders/{id}/stores

              本番

              https://api.smaregi.jp/{契約ID}/pos/purchase_orders/{id}/stores

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              入荷

              入荷一覧取得

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

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■storageId:入荷ID
              ■storageInfoId:発注ID:発注登録から作成された入荷の場合のみ、発注IDを設定。
              ■supplierId:仕入先ID
              ■storageStoreId:入荷店舗ID
              ■storageDate:入荷日:
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              storage_info_id
              string

              発注ID:発注登録から作成された入荷の場合のみ、発注IDを設定。

              supplier_id
              string

              仕入先ID

              storage_store_id
              string

              入荷店舗ID

              storage_date
              string

              入荷日:

              Responses

              200

              取得成功

              get /storage

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/storage

              本番

              https://api.smaregi.jp/{契約ID}/pos/storage

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              入荷登録

              入荷を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              supplierId
              required
              string <int> (仕入先ID) [ 1 .. 9999999999 ]

              仕入先ID 仕入先IDを設定

              storageStoreId
              required
              string <int> (入荷店舗ID) [ 1 .. 999999999 ]

              入荷店舗ID

              storageExpectedDateFrom
              string <date> (入荷予定日From)

              入荷予定日From [YYYY-MM-DD]

              storageExpectedDateTo
              string <date> (入荷予定日To)

              入荷予定日To [YYYY-MM-DD]

              storageDate
              required
              string <date> (入荷日)

              入荷日

              memo
              string (メモ) <= 1000 characters

              メモ

              staffId
              string <int> (スタッフID) [ 1 .. 999999999 ]

              入荷登録時のスタッフID

              identificationNo
              string (識別番号) <= 32 characters

              識別番号 入荷情報を管理するための任意の文字列を設定出来る項目。

              roundingDivision
              string (税丸め)
              Enum: 0 1 2

              税丸め(0:四捨五入、1:切り捨て、2:切り上げ)
              未設定の場合、1:切り捨てで設定する。

              details
              required
              Array of objects (入荷明細)

              入荷明細
              ※明細の最大件数は1000件です

              Responses

              200

              取得成功

              400
              • 仕入先IDが存在しない場合
              • 店舗IDが存在しない場合
              • 商品IDが存在しない場合
              • スタッフIDが存在しない場合
              • 同一発注IDの範囲で商品IDがユニークでない場合(products)
              • 入荷予定日To < 入荷予定日Fromの場合
              • 入荷明細がない場合
              • 入荷明細件数が1000件を超過した場合
              post /storage

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/storage

              本番

              https://api.smaregi.jp/{契約ID}/pos/storage

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "supplierId": "string",
              • "storageStoreId": "string",
              • "storageExpectedDateFrom": "2023-12-01",
              • "storageExpectedDateTo": "2023-12-01",
              • "storageDate": "2023-12-01",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageId": "string",
              • "storageInfoId": "string",
              • "supplierId": "string",
              • "storageStoreId": "string",
              • "storageExpectedDateFrom": "string",
              • "storageExpectedDateTo": "string",
              • "storageDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              入荷取得

              入荷情報を取得します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入荷ID

              query Parameters
              fields
              array

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

              with_details
              string
              Default: "none"
              Enum: "all" "none"

              入荷明細を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /storage/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/storage/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/storage/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageId": "string",
              • "storageInfoId": "string",
              • "supplierId": "string",
              • "storageStoreId": "string",
              • "storageExpectedDateFrom": "string",
              • "storageExpectedDateTo": "string",
              • "storageDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              入荷更新

              入荷を更新します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入荷ID

              Request Body schema: application/json
              storageDate
              string <date> (入荷日)

              入荷日:対象データに入荷日が設定されていない場合必ず設定してください。設定済みの場合は設定不要。
              ※発注登録により自動登録された場合、入荷日がnullになっています。

              identificationNo
              string (識別番号) <= 32 characters

              識別番号 入荷情報を管理するための任意の文字列を設定出来る項目。

              details
              Array of objects (入荷明細)

              入荷明細
              ※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

              Responses

              200

              取得成功

              400
              • 入荷明細IDが存在しない場合
              • 入荷完了後の編集可否が編集不可に設定されており、ステータスが入荷完了の入荷データを更新しようとした場合
              • 検品可能フラグが検品不可の入荷データに対して更新しようとした場合
              • 明細のステータスが検品中または入荷完了で入荷日が未設定の場合
              • 配送ルートを設定した入荷情報の場合
              • 検品数、欠品数を設定して検品日がない場合
              • 入荷明細件数が1000件を超過した場合
              404
              • リソースが存在しない場合
              patch /storage/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/storage/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/storage/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageDate": "2023-12-01",
              • "identificationNo": "string",
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "storageId": "string",
              • "storageInfoId": "string",
              • "supplierId": "string",
              • "storageStoreId": "string",
              • "storageExpectedDateFrom": "string",
              • "storageExpectedDateTo": "string",
              • "storageDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              入荷明細取得

              入荷明細情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■storageDetailId:入荷明細ID
              ■productId:商品ID
              ■status:ステータス:0:未検品、1:検品完了
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入荷ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              status
              string
              Enum: 0 1

              ステータス:0:未検品、1:検品完了

              Responses

              200

              取得成功

              get /storage/{id}/details

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/storage/{id}/details

              本番

              https://api.smaregi.jp/{契約ID}/pos/storage/{id}/details

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              出荷

              出荷一覧取得

              出荷情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■shipmentId:出荷ID
              ■shipmentStoreId:出荷店舗ID
              ■shipmentDivision:出荷区分:0:出荷、1:返品、2:販促品
              ■shipmentDate:出荷日:[YYYY-MM-DD]
              ■status:出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              shipment_store_id
              string

              出荷店舗ID

              shipment_division
              string
              Enum: 0 1 2

              出荷区分:0:出荷、1:返品、2:販促品

              shipment_date
              string

              出荷日:[YYYY-MM-DD]

              status
              string
              Enum: 0 2 3

              出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ

              Responses

              200

              取得成功

              get /shipments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              出荷登録

              出荷を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              shipmentStoreId
              required
              string <int> (出荷店舗ID) [ 1 .. 999999999 ]

              出荷店舗ID

              recipientType
              required
              string (受取先タイプ)
              Enum: 1 3

              受取先タイプ:1:仕入先、3:その他(1,3のみ有効)

              recipientId
              string <int> (受取先ID) [ 1 .. 9999999999 ]

              受取先ID:仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)

              recipientName
              string (受取先名) <= 85 characters

              受取先名:登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。

              shipmentDivision
              required
              string (出荷区分)
              Enum: 0 1 2

              出荷区分:0:出荷、1:返品、2:販促品

              shipmentDate
              string <date> (出荷日)

              出荷日:[YYYY-MM-DD]
              未設定の場合、登録日で設定。

              memo
              string (メモ) <= 1000 characters

              メモ

              staffId
              string <int> (スタッフID) [ 1 .. 9999999999 ]

              スタッフID

              taxRate
              string <decimal> (税率) [ 0 .. 100 ]

              税率:出荷時の税率
              小数点3桁まで
              未設定の場合、出荷登録時の税率を設定。

              identificationNo
              string (識別番号) <= 32 characters

              出荷情報を管理するための任意の文字列を設定出来る項目。

              roundingDivision
              string (税丸め)
              Enum: 0 1 2

              税丸め(0:四捨五入、1:切り捨て、2:切り上げ)
              未設定の場合、1:切り捨てで設定する。

              status
              required
              string (出荷ステータス)
              Enum: 0 2 3

              出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中)
              ※2:出荷済を指定すると、確定データとなり更新不可になります
              ※3:出荷検品中はAPIからのみ指定できます。

              approvalStatus
              string (承認ステータス)
              Enum: 0 1 2

              承認ステータス:0:未承認, 1:承認済, 2:承認拒否
              未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
              未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。

              details
              required
              Array of objects (出荷明細)

              出荷明細
              ※明細の最大件数は500件です

              Responses

              200

              取得成功

              400
              • 店舗IDが存在しない場合
              • 商品IDが存在しない場合
              • スタッフIDが存在しない場合
              • 受取先IDが存在しない場合
              • 出荷明細がない場合
              • 出荷明細件数が500件を超過した場合
              • 受取先タイプがその他の場合に受取先IDを設定している場合
              • 受取先タイプが仕入先の場合に受取先名を設定している場合
              post /shipments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shipmentStoreId": "string",
              • "recipientType": 1,
              • "recipientId": "string",
              • "recipientName": "string",
              • "shipmentDivision": 0,
              • "shipmentDate": "2023-12-01",
              • "memo": "string",
              • "staffId": "string",
              • "taxRate": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "approvalStatus": 0,
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shipmentId": "string",
              • "shipmentStoreId": "string",
              • "recipientType": 1,
              • "recipientId": "string",
              • "recipientName": "string",
              • "shipmentDivision": 0,
              • "shipmentDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "taxRate": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "approvalStatus": 0,
              • "approvalDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出荷取得

              出荷を取得します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出荷ID

              query Parameters
              fields
              array

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

              with_details
              string
              Default: "none"
              Enum: "all" "none"

              出荷明細を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              get /shipments/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shipmentId": "string",
              • "shipmentStoreId": "string",
              • "recipientType": 1,
              • "recipientId": "string",
              • "recipientName": "string",
              • "shipmentDivision": 0,
              • "shipmentDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "taxRate": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "approvalStatus": 0,
              • "approvalDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出荷更新

              出荷を更新します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出荷ID

              Request Body schema: application/json
              shipmentStoreId
              string <int> (出荷店舗ID) [ 1 .. 999999999 ]

              出荷店舗ID

              recipientType
              string (受取先タイプ)
              Enum: 1 3

              受取先タイプ:1:仕入先、3:その他(1,3のみ有効)

              recipientId
              string <int> (受取先ID) [ 1 .. 9999999999 ]

              受取先ID:仕入先IDを入力(受取先タイプ=1の場合、入力必須。それ以外入力不可)

              recipientName
              string (受取先名) <= 85 characters

              受取先名:登録時の受取先名 受取先タイプ=3の場合、入力必須。それ以外入力不可 受取先タイプ=1の場合、仕入先名を自動で設定。

              shipmentDivision
              string (出荷区分)
              Enum: 0 1 2

              出荷区分:0:出荷、1:返品、2:販促品

              shipmentDate
              string <date> (出荷日)

              出荷日:[YYYY-MM-DD]

              memo
              string (メモ) <= 1000 characters

              メモ

              taxRate
              string <decimal> (税率) [ 0 .. 100 ]

              税率:出荷時の税率
              小数点3桁まで

              identificationNo
              string (識別番号) <= 32 characters

              出荷情報を管理するための任意の文字列を設定出来る項目。

              roundingDivision
              string (税丸め)
              Enum: 0 1 2

              税丸め(0:四捨五入、1:切り捨て、2:切り上げ)

              status
              string (出荷ステータス)
              Enum: 0 2 3

              出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中)
              ※2:出荷済の出荷を編集する場合は出荷済のみ指定できます。
              ※3:出荷検品中はAPIからのみ指定できます。

              approvalStatus
              string (承認ステータス)
              Enum: 0 1 2

              承認ステータス:0:未承認, 1:承認済, 2:承認拒否
              未設定の場合かつ在庫管理設定の「承認機能」を利用しない場合、1:承認済が設定されます。
              未設定の場合かつ在庫管理設定の「承認機能」を利用する場合、出荷ステータスが 0:未出荷 の場合は 0:未承認 、出荷ステータスが 2:出荷済 または 3:出荷検品中 の場合は 1:承認済 が設定されます。
              1:承認済, 2:承認拒否の場合、変更できません。

              details
              Array of objects (出荷明細)

              出荷明細
              ※明細は既存件数と追加件数の合計が500件以下になるようにしてください

              Responses

              200

              取得成功

              400
              • 出荷店舗IDが存在しない場合
              • 商品IDが存在しない場合
              • 受取先IDが存在しない場合
              • スタッフIDが存在しない場合
              • 出荷明細IDが存在しない場合
              • 出荷明細件数が500件を超過した場合
              • 出荷完了編集不可設定でステータスが出荷済のレコードを更新しようとした場合
              • 出荷承認ステータスが未承認以外のレコードの出荷承認ステータスを変更しようとした場合
              • 受取先タイプがその他の場合に受取先IDを設定している場合
              • 受取先タイプが仕入先の場合に受取先名を設定している場合
              • 出荷済のレコードを出荷済以外で更新しようとした場合
              • 出荷済のレコードの明細の商品を変更しようとした場合
              404
              • リソースが存在しない場合
              patch /shipments/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shipmentStoreId": "string",
              • "recipientType": 1,
              • "recipientId": "string",
              • "recipientName": "string",
              • "shipmentDivision": 0,
              • "shipmentDate": "2023-12-01",
              • "memo": "string",
              • "taxRate": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "approvalStatus": 0,
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shipmentId": "string",
              • "shipmentStoreId": "string",
              • "recipientType": 1,
              • "recipientId": "string",
              • "recipientName": "string",
              • "shipmentDivision": 0,
              • "shipmentDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "taxRate": "string",
              • "identificationNo": "string",
              • "roundingDivision": 0,
              • "status": 0,
              • "approvalStatus": 0,
              • "approvalDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出荷削除

              出荷情報を削除します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.orders:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出荷ID

              Responses

              200

              削除成功

              400
              • 在庫管理設定の出荷完了後の編集可否が「編集不可」に設定されているかつ、以下のいずれかの条件に当てはまる場合
                • 在庫管理設定の出荷承認機能が「利用する」に設定されている場合、出荷ステータスが「出荷済」または「出荷検品中」または(「未出荷」かつ承認ステータスが「承認済」)
                • 在庫管理設定の出荷承認機能が「利用しない」に設定されている場合、出荷ステータスが「出荷済」または「出荷検品中」
              404

              指定した出荷データが存在しない場合

              delete /shipments/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "Bad Request",
              • "detail": "在庫管理設定の出荷完了後の編集可否で編集不可が設定されているため、削除できません",
              • "status": 400
              }

              出荷明細取得

              出荷明細情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■shipmentDetailId:出荷明細ID:
              ■productId:商品ID
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.orders:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出荷ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              Responses

              200

              取得成功

              get /shipments/{id}/details

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipments/{id}/details

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipments/{id}/details

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              入庫

              入庫一覧取得

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

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■receivingId:入庫ID
              ■shippingId:出庫ID
              ■shippingStoreId:出庫店舗ID
              ■receivingStoreId:入庫店舗ID
              ■receivingDate:入庫日:[YYYY-MM-DD]
              ■status:状態:入庫状態を設定。 0:未入庫、1:検品中、2:入庫完了
              ■identificationNo:識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              receiving_id
              string

              入庫ID

              shipping_id
              string

              出庫ID

              receiving_store_id
              string

              入庫店舗ID

              shipping_store_id
              string

              出庫店舗ID

              receiving_date
              string

              入庫日:[YYYY-MM-DD]

              identification_no
              string

              識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。

              status
              string
              Enum: 0 1 2

              状態:入庫状態を設定。 0:未入庫、1:検品中、2:入庫完了

              Responses

              200

              取得成功

              get /receiving

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/receiving

              本番

              https://api.smaregi.jp/{契約ID}/pos/receiving

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              入庫取得

              指定した入庫情報を取得します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入庫ID

              query Parameters
              fields
              array

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

              with_details
              string

              明細取得フラグ:入庫明細を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /receiving/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/receiving/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/receiving/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingId": "string",
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "receivingDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              入庫更新

              入庫を更新します。
              入庫情報は出庫情報を登録後、status=1:未入庫 に設定されたときに自動生成されます。
              入庫明細を本APIで新規追加した場合、status=1:検品中 のままとなり、検品完了しません。
              スマレジ管理画面上で出庫修正依頼を実施して下さい。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入庫ID

              Request Body schema: application/json
              receivingDate
              required
              string <date> (入庫日)

              入庫日:[YYYY-MM-DD]

              memo
              string (メモ) <= 1000 characters

              メモ:(出庫情報のメモと共有される)

              staffId
              string <int> (スタッフID) [ 1 .. 999999999999999 ]

              スタッフID

              details
              Array of objects (入庫明細)

              入庫明細
              ※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

              Responses

              200

              取得成功

              400
              • スタッフIDが存在しない場合
              • 入庫明細IDが存在しない場合
              • 商品IDが重複している場合
              • 商品IDが存在しない場合
              • 登録済みの入庫明細の商品IDを変更しようとした場合
              • 入庫明細を追加登録時に商品IDが指定されていない場合
              • 入庫完了後の編集可否が編集不可に設定されており、ステータスが入庫完了の入庫データを更新しようとした場合
              • 入庫明細件数が1000件を超過した場合
              404
              • リソースがない場合
              patch /receiving/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/receiving/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/receiving/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingDate": "2023-12-01",
              • "memo": "string",
              • "staffId": "string",
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingId": "string",
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "receivingDate": "string",
              • "memo": "string",
              • "staffId": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              入庫明細取得

              入庫明細情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■receivingDetailId:入庫明細ID
              ■productId:商品ID
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              入庫ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              status
              string
              Enum: 0 1

              状態:商品の検品状況を設定。 0:未検品、1:検品完了

              Responses

              200

              取得成功

              get /receiving/{id}/details

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/receiving/{id}/details

              本番

              https://api.smaregi.jp/{契約ID}/pos/receiving/{id}/details

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              出庫

              出庫一覧取得

              出庫情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■shippingId:出庫ID
              ■shippingStoreId:出庫店舗ID
              ■receivingStoreId:入庫店舗ID
              ■receivingDesiredDate:出庫希望日:[YYYY-MM-DD]
              ■receivingExpectedDateFrom:入庫予定日From:[YYYY-MM-DD]
              ■receivingExpectedDateTo:入庫予定日To:[YYYY-MM-DD]
              ■shippingDate:出庫日:[YYYY-MM-DD]
              ■status:状態:出庫/入庫の状況を設定。 0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              receiving_store_id
              string

              入庫店舗ID

              shipping_store_id
              string

              出庫店舗ID

              receiving_desired_date
              string

              入庫希望日:[YYYY-MM-DD]

              receiving_expected_date_from
              string

              入庫予定日From:[YYYY-MM-DD]

              receiving_expected_date_to
              string

              入庫予定日To:[YYYY-MM-DD]

              shipping_date
              string

              出庫日:[YYYY-MM-DD]

              status
              string
              Enum: 0 1 2 3

              状態:出庫/入庫の状況を設定。 0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了

              identification_no
              string

              識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。

              Responses

              200

              取得成功

              get /shipping

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              出庫登録

              出庫を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              receivingStoreId
              required
              string <int> (入庫店舗ID) [ 1 .. 999999999 ]

              入庫店舗ID

              shippingStoreId
              required
              string <int> (出庫店舗ID) [ 1 .. 999999999 ]

              出庫店舗ID

              receivingExpectedDateFrom
              required
              string <date> (入庫予定日From)

              入庫予定日From:[YYYY-MM-DD]

              receivingExpectedDateTo
              required
              string <date> (入庫予定日To)

              入庫予定日To:[YYYY-MM-DD]

              shippingDate
              required
              string <date> (出庫日)

              出庫日:[YYYY-MM-DD]

              staffId
              string <int> (スタッフID) [ 1 .. 999999999 ]

              スタッフID

              memo
              string (メモ) <= 1000 characters

              メモ

              identificationNo
              string (識別番号) <= 32 characters

              識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。

              status
              required
              string (状態)
              Enum: 0 1

              状態:出庫/入庫の状況を設定。 0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了 ※0:未出庫、1:未入庫のみ指定可能

              approvalStatus
              string (承認ステータス)
              Default: 0
              Enum: 0 1 2

              承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認 未設定の場合、在庫管理設定の「承認機能」を利用しない場合、1承認済が設定されます。利用する場合、0:未承認が設定されます。

              details
              required
              Array of objects (出庫明細)

              出庫明細
              ※明細の最大件数は1000件です

              Responses

              200

              取得成功

              400
              • 入庫店舗IDが存在しない場合
              • 出庫店舗IDと入庫店舗IDが同じ場合
              • 出庫店舗IDが存在しない場合
              • スタッフIDが存在しない場合
              • 出庫明細がない場合
              • 商品IDが重複している場合
              • 商品IDが存在しない場合
              • 出庫明細件数が1000件を超過した場合
              post /shipping

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingExpectedDateFrom": "2023-12-01",
              • "receivingExpectedDateTo": "2023-12-01",
              • "shippingDate": "2023-12-01",
              • "staffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": 0,
              • "approvalStatus": 0,
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "shippingDate": "string",
              • "staffId": "string",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "approvalStatus": "string",
              • "approvalDateTime": "string",
              • "modificationRequestStatus": "string",
              • "modificationRequestDateTime": "string",
              • "modificationRequestCheckedDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出庫依頼登録

              出庫依頼を登録します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              Request Body schema: application/json
              receivingStoreId
              required
              string <int> (入庫店舗ID) [ 1 .. 999999999 ]

              入庫店舗ID

              shippingStoreId
              required
              string <int> (出庫店舗ID) [ 1 .. 999999999 ]

              出庫店舗ID

              receivingDesiredDate
              required
              string <date> (入庫希望日)

              入庫希望日:[YYYY-MM-DD]

              requestStaffId
              string <int> (出庫依頼スタッフID) [ 1 .. 999999999 ]

              出庫依頼スタッフID

              memo
              string (メモ) <= 1000 characters

              メモ

              identificationNo
              string (識別番号) <= 32 characters

              識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。

              details
              required
              Array of objects (出庫明細)

              出庫明細
              ※明細の最大件数は1000件です

              Responses

              200

              取得成功

              400
              • 入庫店舗IDが存在しない場合
              • 出庫店舗IDと入庫店舗IDが同じ場合
              • 出庫店舗IDが存在しない場合
              • 出庫依頼スタッフIDが存在しない場合
              • 出庫明細がない場合
              • 商品IDが重複している場合
              • 商品IDが存在しない場合
              • 出庫明細件数が1000件を超過した場合
              post /shipping/request

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/request

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/request

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "2023-12-01",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "shippingDate": "string",
              • "staffId": "string",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "approvalStatus": "string",
              • "approvalDateTime": "string",
              • "modificationRequestStatus": "string",
              • "modificationRequestDateTime": "string",
              • "modificationRequestCheckedDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出庫取得

              出庫情報を取得します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出庫ID

              query Parameters
              fields
              array

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

              with_details
              string
              Default: "none"
              Enum: "all" "none"

              明細取得フラグ:出庫明細を付加するか(付加する場合はall, しない場合はnone)

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /shipping/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "shippingDate": "string",
              • "staffId": "string",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "approvalStatus": "string",
              • "approvalDateTime": "string",
              • "modificationRequestStatus": "string",
              • "modificationRequestDateTime": "string",
              • "modificationRequestCheckedDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出庫更新

              出庫を更新します。
              承認ステータスの更新については出庫承認APIを実行して下さい。
              出庫修正依頼については管理画面で操作して下さい。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出庫ID

              Request Body schema: application/json
              receivingExpectedDateFrom
              string <date> (入庫予定日From)

              入庫予定日From:[YYYY-MM-DD] ※statusが未入庫の場合に必須

              receivingExpectedDateTo
              string <date> (入庫予定日To)

              入庫予定日To:[YYYY-MM-DD] ※statusが未入庫の場合に必須

              shippingDate
              string <date> (出庫日)

              出庫日:[YYYY-MM-DD] ※statusが未入庫の場合に必須

              staffId
              string <int> (スタッフID) [ 1 .. 999999999 ]

              スタッフID

              memo
              string (メモ) <= 1000 characters

              メモ

              identificationNo
              string (識別番号) <= 32 characters

              識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。

              status
              string (状態)
              Enum: 0 1

              状態:出庫/入庫の状況を設定。
              0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了
              ※0:未出庫、1:未入庫のみ指定可能
              ※1:未入庫、2:入庫検品中、3:入庫完了を0:未出庫に変更不可
              ※2:入庫検品中、3:入庫完了の場合、変更不可

              details
              Array of objects (出庫明細)

              出庫明細
              ※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

              Responses

              200

              取得成功

              400
              • 商品IDが重複している場合
              • 商品IDが存在しない場合
              • スタッフIDが存在しない場合
              • 出庫明細IDが存在しない場合
              • 状態を1:未入庫から0:未出庫に変更しようとした場合
              • 状態が2:入庫検品中、3:入庫完了の場合
              • 承認状態が2:承認拒否の場合
              • 出庫明細件数が1000件を超過した場合
              404
              • リソースが存在しない場合
              patch /shipping/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/{id}

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingExpectedDateFrom": "2023-12-01",
              • "receivingExpectedDateTo": "2023-12-01",
              • "shippingDate": "2023-12-01",
              • "staffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": 0,
              • "details":
                [
                ]
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "shippingDate": "string",
              • "staffId": "string",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "approvalStatus": "string",
              • "approvalDateTime": "string",
              • "modificationRequestStatus": "string",
              • "modificationRequestDateTime": "string",
              • "modificationRequestCheckedDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string",
              • "details":
                [
                ]
              }

              出庫削除

              出庫情報を削除します。

              Plans:
              プレミアムプラス・フードビジネス・リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出庫ID

              Responses

              200

              削除成功

              400

              状態が2:入庫検品中、3:入庫完了のデータの場合

              404

              指定した出庫データが存在しない場合

              delete /shipping/{id}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/{id}

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/{id}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "type": "about:blank",
              • "title": "Bad Request",
              • "detail": "入庫作業中のデータは削除できません",
              • "status": 400
              }

              出庫承認

              出庫承認ステータスを更新します。
              未承認となっている出庫情報/出庫依頼情報に対し、出庫を承認/拒否する場合に本APIを実行します。
              承認済にすると、承認ステータスが承認済、ステータスが未入庫(出庫済)の状態に更新します。
              承認拒否にすると、承認ステータスが承認拒否の状態に更新します。

              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.transfers:write)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出庫ID

              Request Body schema: application/json
              receivingExpectedDateFrom
              string <date> (入庫予定日From)

              入庫予定日From:[YYYY-MM-DD]
              出庫情報の承認ステータスが3:依頼未承認時に必須

              receivingExpectedDateTo
              string <date> (入庫予定日To)

              入庫予定日To:[YYYY-MM-DD]
              出庫情報の承認ステータスが3:依頼未承認時に必須

              shippingDate
              string <date> (出庫日)

              出庫日:[YYYY-MM-DD]
              出庫情報の承認ステータスが3:依頼未承認時に必須

              memo
              string (メモ) <= 1000 characters

              メモ

              approvalStatus
              required
              string (承認ステータス)
              Default: 0
              Enum: 0 1 2

              承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認
              3:依頼未承認 → 0:未承認、1:承認済に変更可
              0:未承認 → 1:承認済、2:承認拒否に変更可
              2:承認拒否 → 0:未承認に変更可

              Responses

              200

              取得成功

              400
              • 承認ステータスが1:承認済の場合
              • 承認ステータスが2:承認拒否のものを1:承認済に変更しようとした場合
              • 出庫の承認設定を利用しない設定で1:承認済以外を設定した場合
              • 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済以外に更新しようとした場合
              • 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫予定日Fromが未設定の場合
              • 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫予定日Toが未設定の場合
              • 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫日が未設定の場合
              404
              • リソースがない場合
              patch /shipping/{id}/approval

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/{id}/approval

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/{id}/approval

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "receivingExpectedDateFrom": "2023-12-01",
              • "receivingExpectedDateTo": "2023-12-01",
              • "shippingDate": "2023-12-01",
              • "memo": "string",
              • "approvalStatus": 0
              }

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "shippingId": "string",
              • "receivingStoreId": "string",
              • "shippingStoreId": "string",
              • "receivingDesiredDate": "string",
              • "receivingExpectedDateFrom": "string",
              • "receivingExpectedDateTo": "string",
              • "shippingDate": "string",
              • "staffId": "string",
              • "requestStaffId": "string",
              • "memo": "string",
              • "identificationNo": "string",
              • "status": "string",
              • "approvalStatus": "string",
              • "approvalDateTime": "string",
              • "modificationRequestStatus": "string",
              • "modificationRequestDateTime": "string",
              • "modificationRequestCheckedDateTime": "string",
              • "insDateTime": "string",
              • "updDateTime": "string"
              }

              出庫明細取得

              出庫明細情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■shippingDetailId:出庫明細ID
              ■productId:商品ID
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.transfers:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              出庫ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              Responses

              200

              取得成功

              404
              • リソースが存在しない場合
              get /shipping/{id}/details

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/shipping/{id}/details

              本番

              https://api.smaregi.jp/{契約ID}/pos/shipping/{id}/details

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              棚卸

              棚卸一覧取得

              棚卸情報一覧を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■stocktakingInfoId:棚卸情報ID
              ■storeId:店舗ID
              ■targetDate:棚卸日:[YYYY-MM-DD]
              ■status:ステータス:(0:棚卸途中、1:調整中、2:完了)
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.stocktaking:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              store_id
              string

              店舗ID

              target_date
              string

              棚卸日:[YYYY-MM-DD]

              status
              string
              Enum: 0 1 2 3

              ステータス: 0:棚卸途中、1:調整中、2:完了

              Responses

              200

              取得成功

              get /stocktaking

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/stocktaking

              本番

              https://api.smaregi.jp/{契約ID}/pos/stocktaking

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              棚卸対象部門取得

              棚卸対象部門情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■categoryId:部門ID一覧:棚卸対象部門の部門ID。対象が全部門の場合は"0"固定。

              Authorizations:
              AppAccessToken (pos.stocktaking:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              棚卸情報ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              Responses

              200

              取得成功

              get /stocktaking/{id}/categories

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/stocktaking/{id}/categories

              本番

              https://api.smaregi.jp/{契約ID}/pos/stocktaking/{id}/categories

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              棚卸対象商品取得

              棚卸対象商品情報を取得します。

              Plans:
              リテールビジネス
              sortで使用可能なパラメータ ■productId:商品ID
              ■categoryId:部門ID:現在の商品マスタの部門ID。
              ■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

              Authorizations:
              AppAccessToken (pos.stocktaking:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              id
              required
              string

              棚卸情報ID

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              category_id
              string

              部門ID:現在の商品マスタの部門ID

              Responses

              200

              取得成功

              get /stocktaking/{id}/products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/stocktaking/{id}/products

              本番

              https://api.smaregi.jp/{契約ID}/pos/stocktaking/{id}/products

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              棚卸在庫一覧取得

              棚卸在庫一覧を取得します。棚卸在庫一覧とは、指定した棚卸の棚卸在庫数をもとに、指定日時点の在庫数量の計算結果を取得する機能です。


              sortで使用可能なパラメータ
              ■商品ID:棚卸対象の商品IDを設定。
              ■部門ID:棚卸対象の商品の部門IDを設定。
              Plans:
              リテールビジネス

              Authorizations:
              AppAccessToken (pos.stocktaking:read)
              path Parameters
              contract_id
              required
              string

              契約ID

              stocktaking_info_id
              required
              string

              棚卸情報ID

              base_date
              required
              string

              基準日(YYYY-MM-DD)

              query Parameters
              fields
              array

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

              sort
              string

              並び順(カンマ区切りで指定可)
              指定可能な項目については上記参照

              limit
              integer

              上限数

              page
              integer

              ページ

              product_id
              string

              商品ID

              category_id
              string

              部門ID

              Responses

              200

              取得成功

              get /stocktaking/{id}/details/{baseDate}

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/stocktaking/{id}/details/{baseDate}

              本番

              https://api.smaregi.jp/{契約ID}/pos/stocktaking/{id}/details/{baseDate}

              Response samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              [
              • {
                }
              ]

              Webhook

              部門

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:categories

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              • bulk-deleted: 一括削除
              categoryIds
              array (部門IDリスト)
              post /webhook-categories

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-categories

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-categories

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "categoryIds":
                [
                ]
              }

              部門グループ

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:category-groups

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              categoryGroupIds
              array (部門グループIDリスト)
              post /webhook-category-groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-category-groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-category-groups

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "categoryGroupIds":
                [
                ]
              }

              商品

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:products

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              • bulk-deleted: 一括削除
              productIds
              array (商品IDリスト)
              post /webhook-products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-products

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "productIds":
                [
                ]
              }

              商品画像

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:product-images

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • deleted: 削除
              • bulk-deleted: 一括削除
              productIds
              array (商品IDリスト)
              post /webhook-product-images

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-product-images

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-product-images

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "productIds":
                [
                ]
              }

              セール

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:bargain

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              bargainIds
              array (セールIDリスト)
              post /webhook-bargain

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-bargain

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-bargain

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "bargainIds":
                [
                ]
              }

              オプショングループ

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:option-groups

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              productOptionGroupIds
              array (オプショングループIDリスト)
              post /webhook-product-option-groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-product-option-groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-product-option-groups

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "productOptionGroupIds":
                [
                ]
              }

              オプショングループ商品

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:product-options

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • deleted: 削除
              • bulk-update: 一括更新
              ids
              Array of objects
              post /webhook-product-option-group-products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-product-option-group-products

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-product-option-group-products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ids":
                [
                ]
              }

              バンドル販売

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:bundles

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              productBundleGroupIds
              array (商品バンドルグループID)
              post /webhook-bundles

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-bundles

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-bundles

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "productBundleGroupIds":
                [
                ]
              }

              バンドル販売商品

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:bundle-products

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • deleted: 削除
              ids
              Array of objects
              post /webhook-bundle-products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-bundle-products

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-bundle-products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ids":
                [
                ]
              }

              仕入先

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:suppliers

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              supplierIds
              array (仕入先IDリスト)
              post /webhook-suppliers

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-suppliers

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-suppliers

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "executed",
              • "supplierIds":
                [
                ]
              }

              仕入先商品

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:supplier-products

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • deleted: 削除
              • bulk-update: 一括更新
              • bulk-deleted: 一括削除
              ids
              Array of objects
              post /webhook-supplier-products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-supplier-products

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-supplier-products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "executed",
              • "ids":
                [
                ]
              }

              仕入先区分

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:supplier-divisions

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              supplierDivisionIds
              array (仕入先区分IDリスト)
              post /webhook-supplier-divisions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-supplier-divisions

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-supplier-divisions

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "executed",
              • "supplierDivisionIds":
                [
                ]
              }

              店舗

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:stores

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              storeIds
              array (店舗IDリスト)
              post /webhook-stores

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-stores

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-stores

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "storeIds":
                [
                ]
              }

              レジ端末

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:terminals

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              terminalIds
              array (レジ端末IDリスト)
              post /webhook-terminals

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-terminals

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-terminals

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "terminalIds":
                [
                ]
              }

              スタッフ

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:staffs

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              staffIds
              array (スタッフIDリスト)
              post /webhook-staffs

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-staffs

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-staffs

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "staffIds":
                [
                ]
              }

              役割・役職

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:roles

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              roleIds
              array (役割・役職ID)
              post /webhook-roles

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-roles

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-roles

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "roleIds":
                [
                ]
              }

              日別予算

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:daily-budget

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              ids
              Array of objects
              post /webhook-daily-budget

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-daily-budget

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-daily-budget

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ids":
                [
                ]
              }

              会員

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:customers

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              • bulk-deleted: 一括削除
              customerIds
              array (会員IDリスト)
              post /webhook-customers

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-customers

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-customers

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "customerIds":
                [
                ]
              }

              会員ポイント

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:customer-points

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • edited: 更新
              • bulk-update: 一括更新
              transactionHeadIds
              array (取引IDリスト)
              post /webhook-customers-points

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-customers-points

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-customers-points

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "edited",
              • "transactionHeadIds":
                [
                ]
              }

              会員ランク

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:customer-ranks

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              ranks
              array (会員ランクリスト)
              post /webhook-customers-ranks

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-customers-ranks

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-customers-ranks

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ranks":
                [
                ]
              }

              社員ランク

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:staff-ranks

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              staffRanks
              array (社員ランクリスト)
              post /webhook-staff-ranks

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-staff-ranks

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-staff-ranks

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "staffRanks":
                [
                ]
              }

              取引

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:transactions

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • canceled: 取消
              • disposed: 打消取消
              • bulk-update: 一括更新
              • bulk-deleted: 一括削除
              transactionHeadIds
              array (取引IDリスト)
              post /webhook-transactions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-transactions

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-transactions

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "transactionHeadIds":
                [
                ]
              }

              クーポン取引

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:transaction-coupons

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • canceled: 取消
              • disposed: 打消取消
              transactionHeadIds
              array (取引IDリスト)
              post /webhook-transactions-coupon

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-transactions-coupon

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-transactions-coupon

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "transactionHeadIds":
                [
                ]
              }

              取置き

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:layaway

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • canceled: 取消
              • bulk-deleted: 一括削除
              transactionHeadIds
              array (取引IDリスト)
              post /webhook-transactions-layaway

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-transactions-layaway

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-transactions-layaway

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "transactionHeadIds":
                [
                ]
              }

              仮販売

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:temporary-transactions

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-deleted: 一括削除
              transactionHeadIds
              array (仮販売取引IDリスト)
              post /webhook-transactions-temporary

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-transactions-temporary

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-transactions-temporary

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "transactionHeadIds":
                [
                ]
              }

              精算処理

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:adjustments

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • executed: 精算実施
              • canceled: 現金精算情報の取消
              ids
              Array of objects
              cashAdjustment
              boolean (現金精算情報の有無)

              現金精算情報がある場合: true、ない場合: false
              ※ 現金精算情報の取消のときは、常にfalseになります

              post /webhook-adjustments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-adjustments

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-adjustments

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "executed",
              • "ids":
                [
                ],
              • "cashAdjustment": true
              }

              締め処理

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:daily-summaries

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • executed: 締め実施
              • edited: 更新
              • canceled: 締め解除
              • bulk-update: 一括更新
              ids
              Array of objects
              post /webhook-daily-summaries

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-daily-summaries

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-daily-summaries

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "executed",
              • "ids":
                [
                ]
              }

              客層

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:customer-groups

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-update: 一括更新
              customerGroupIds
              array (客層IDリスト)
              post /webhook-customer-groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-customer-groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-customer-groups

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "customerGroupIds":
                [
                ]
              }

              在庫

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:stock

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • edited: 更新
              • bulk-update: 一括更新
              ids
              Array of objects
              post /webhook-stock

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-stock

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-stock

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ids":
                [
                ]
              }

              支払方法

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:payment-methods

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              paymentMethodIds
              array (支払方法IDリスト)
              post /webhook-payment-methods

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-payment-methods

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-payment-methods

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "paymentMethodIds":
                [
                ]
              }

              支払方法分類

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:payment-method-groups

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              paymentMethodGroupIds
              array (支払方法分類IDリスト)
              post /webhook-payment-method-groups

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-payment-method-groups

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-payment-method-groups

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "paymentMethodGroupIds":
                [
                ]
              }

              クーポン

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:coupons

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              couponIds
              array (クーポンID)
              post /webhook-coupons

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-coupons

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-coupons

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "couponIds":
                [
                ]
              }

              クーポン商品

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:coupon-products

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              • bulk-deleted: 一括削除
              ids
              Array of objects
              post /webhook-coupon-products

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-coupon-products

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-coupon-products

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "ids":
                [
                ]
              }

              ロス

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:losses

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              lossIds
              array (ロスIDリスト)
              post /webhook-losses

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-losses

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-losses

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "lossIds":
                [
                ]
              }

              ロス区分

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:loss-divisions

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              codes
              array (ロス区分コードリスト)
              post /webhook-loss-divisions

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-loss-divisions

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-loss-divisions

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "codes":
                [
                ]
              }

              発注

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:purchase-orders

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              storageInfoIds
              array (発注IDリスト)
              post /webhook-purchase-orders

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-purchase-orders

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-purchase-orders

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "storageInfoIds":
                [
                ]
              }

              入荷

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:storage

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              storageIds
              array (入荷IDリスト)
              post /webhook-storage

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-storage

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-storage

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "storageIds":
                [
                ]
              }

              出荷

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:shipments

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              shipmentIds
              array (出荷IDリスト)
              post /webhook-shipments

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-shipments

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-shipments

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "shipmentIds":
                [
                ]
              }

              入庫

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:receiving

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              receivingIds
              array (入庫IDリスト)
              post /webhook-receiving

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-receiving

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-receiving

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "receivingIds":
                [
                ]
              }

              出庫

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:shipping

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              shippingIds
              array (出庫IDリスト)
              post /webhook-shipping

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-shipping

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-shipping

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "shippingIds":
                [
                ]
              }

              棚卸

              header Parameters
              Smaregi-Event
              string

              イベント名 pos:stocktaking

              Request Body schema: application/json
              contractId
              string (契約ID)
              event
              string (イベント)
              action
              string (アクション)
              • created: 登録
              • edited: 更新
              • deleted: 削除
              stocktakingInfoIds
              array (棚卸IDリスト)
              post /webhook-stocktaking

              サンドボックス

              https://api.smaregi.dev/{契約ID}/pos/webhook-stocktaking

              本番

              https://api.smaregi.jp/{契約ID}/pos/webhook-stocktaking

              Request samples

              Content type
              application/json
              Copy
              Expand all Collapse all
              {
              • "contractId": "string",
              • "event": "string",
              • "action": "created",
              • "stocktakingInfoIds":
                [
                ]
              }
              Copyright (C) 2020 Smaregi, Inc. All rights reserved.