一度に返すアイテム数は 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
APIを利用するシステムのユーザーがご利用中のプランにより、実行できるAPIや、取得・登録・更新できるパラメータの種類が異なります。
APIを利用可能なプランについては各APIのページをご確認ください。
プランの種類は以下の通りです。
ユーザー権限による実行制御は「役割・役職による制御」、「所属店舗による制御」の2種類があります。
ユーザーがスタッフとして属している役割・役職によりAPIの実行を制御します。
また、各APIの項目に「UserAccessToken」と記載があるものはスコープに対応する機能による制御も行います。
例)
役割・役職の取引履歴機能が「閲覧」の場合、取引取得APIは実行可能、取引登録APIはエラーになります。
スタッフの役割・役職は管理画面で設定可能です。
役割・役職の各機能の権限は管理画面、APIで設定可能です。
スマレジ・ヘルプ:スタッフの権限を設定する(役割・役職)
ユーザーがスタッフとして所属している店舗の情報のみ取得・登録・更新・削除が可能です。
制御の詳細は各APIのページをご確認ください。
アプリアクセストークン。
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:
|
ユーザーアクセストークン。
管理画面における制御と同等の、ユーザー(=スタッフ)の所属店舗による制御や、属する役割・役職に設定された各種権限に基づく実行制御が適用されます。
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
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
category_code | string 部門コード |
level | string Enum: 1 2 3 階層レベル |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
部門情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
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 端末で表示するか判定 |
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 |
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のものを指定した場合エラー)。 |
tag | string (タグ) <= 85 characters タグ |
更新成功
サンドボックス
本番
{- "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"
}
{- "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"
}
部門情報を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 部門ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
取得成功
サンドボックス
本番
{- "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"
}
部門情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 部門ID |
categoryCode | string (部門コード) <= 20 characters ^[ -~]+$ ユニーク値 部門コード |
categoryName | string (部門名) <= 85 characters 部門名 |
categoryAbbr | string (部門名略称) <= 85 characters 部門名略称 |
displaySequence | string <int> (表示番号) [ 0 .. 999999999 ] 表示順序 |
displayFlag | string (表示フラグ) Default: 1 Enum: 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 |
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のものを指定した場合エラー)。 |
tag | string (タグ) <= 85 characters タグ |
更新成功
部門IDが存在しない場合
サンドボックス
本番
{- "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"
}
{- "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"
}
部門情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 部門ID |
削除成功
指定された部門IDが削除不可の場合
指定した部門データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "関連商品が存在するため削除できません",
- "status": 400
}
部門グループの一覧を取得します。
sortで使用可能なパラメータ
■categoryGroupId:部門グループID
■displaySequence:表示順
■updDateTime:更新日時:登録時・更新時の日時
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
category_group_id | string 部門グループID |
category_group_code | string 部門グループコード |
取得成功
サンドボックス
本番
[- {
- "categoryGroupId": "string",
- "categoryGroupCode": "string",
- "categoryGroupName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
部門グループを登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
categoryGroupCode | string (部門グループコード) <= 10 characters ^[ -~]+$ 部門グループコード |
categoryGroupName required | string (部門グループ名) <= 85 characters 部門グループ名 |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] 表示順 |
更新成功
サンドボックス
本番
{- "categoryGroupCode": "string",
- "categoryGroupName": "string",
- "displaySequence": "string"
}
{- "categoryGroupId": "string",
- "categoryGroupCode": "string",
- "categoryGroupName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
指定された部門グループを更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 部門グループID |
categoryGroupCode | string (部門グループコード) <= 10 characters ^[ -~]+$ 部門グループコード |
categoryGroupName | string (部門グループ名) <= 85 characters 部門グループ名 |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] 表示順 |
更新成功
サンドボックス
本番
{- "categoryGroupCode": "string",
- "categoryGroupName": "string",
- "displaySequence": "string"
}
{- "categoryGroupId": "string",
- "categoryGroupCode": "string",
- "categoryGroupName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
指定された部門グループを削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 部門グループID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "指定された部門グループに紐付いている部門が存在するため、削除できません。",
- "status": 400
}
商品情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
upd_date_time-to | string 更新日時(To):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
商品情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
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 商品をオープン価格販売するかどうかの設定 |
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 端末で表示するか判定 |
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 小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを識別する。 |
staffDiscountRate | string <int> (社員販売割引率) [ 0 .. 100 ] 社員販売時の割引率 |
useCategoryReduceTax | string (部門税設定参照フラグ) Default: 1 Enum: 0 1 軽減税率個別設定フラグ(0:reduceTaxIdを使用、1:部門の税設定を使用) |
reduceTaxId | string <int> (軽減税率ID) [ 0 .. 999999999 ] 軽減税率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値で登録されます。 |
更新成功
サンドボックス
本番
{- "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": [
- {
- "no": "string",
- "value": "string"
}
], - "prices": [
- {
- "storeId": "string",
- "priceDivision": 1,
- "startDate": "2023-12-01",
- "endDate": "2023-12-01",
- "price": "string"
}
], - "stores": [
- {
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": "0"
}
], - "inventoryReservations": [
- {
- "reservationProductId": "string",
- "reservationAmount": "string"
}
], - "attributeItems": [
- {
- "code": "string",
- "no": "string"
}
], - "orderSetting": {
- "continuationDivision": null,
- "orderStatusDivision": 1,
- "orderNoReasonDivision": "string",
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 1,
- "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": -1,
- "displayFlag": -1
}
]
}
}
{- "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": [
- {
- "productId": "string",
- "storeId": null,
- "priceDivision": "string",
- "startDate": null,
- "endDate": null,
- "price": null
}
], - "reserveItems": [
- {
- "productId": "string",
- "no": null,
- "value": "string"
}
], - "stores": [
- {
- "productId": "string",
- "storeId": null,
- "productOptionGroupId": "string",
- "assignDivision": "string"
}
], - "inventoryReservations": [
- {
- "productId": "string",
- "reservationProductId": null,
- "reservationAmount": null
}
], - "attributeItems": [
- {
- "productId": "string",
- "code": "string",
- "no": "string",
- "name": "string"
}
], - "orderSetting": {
- "productId": "string",
- "continuationDivision": "string",
- "orderStatusDivision": 0,
- "orderNoReasonDivision": "string",
- "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 0,
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": "string",
- "displayFlag": -1
}
]
}
}
商品情報を一括登録します。
※ 商品の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 商品は1リクエストにつき100件まで登録できます。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
products required | Array of objects (商品情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "products": [
- {
- "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": [
- {
- "no": "string",
- "value": "string"
}
], - "prices": [
- {
- "storeId": "string",
- "priceDivision": 1,
- "startDate": "2023-12-01",
- "endDate": "2023-12-01",
- "price": "string"
}
], - "stores": [
- {
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": 0
}
], - "inventoryReservations": [
- {
- "reservationProductId": "string",
- "reservationAmount": "string"
}
], - "attributeItems": [
- {
- "code": "string",
- "no": "string"
}
], - "orderSetting": {
- "continuationDivision": null,
- "orderStatusDivision": 1,
- "orderNoReasonDivision": "string",
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 1,
- "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": -1,
- "displayFlag": -1
}
]
}
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
商品情報を一括更新します。
※ 商品の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 商品は1リクエストにつき100件まで更新できます。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
products required | Array of objects (商品情報) |
callbackUrl required | string (商品更新完了通知URL) <= 511 characters 商品の更新が完了した際に、更新結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "products": [
- {
- "productId": "string",
- "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": [
- {
- "storeId": "string",
- "priceDivision": 1,
- "startDate": "2023-12-01",
- "endDate": "2023-12-01",
- "price": "string"
}
], - "reserveItems": [
- {
- "no": "string",
- "value": "string"
}
], - "stores": [
- {
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": 0
}
], - "inventoryReservations": [
- {
- "reservationProductId": "string",
- "reservationAmount": "string"
}
], - "attributeItems": [
- {
- "code": "string",
- "no": "string"
}
], - "orderSetting": {
- "continuationDivision": null,
- "orderStatusDivision": 1,
- "orderNoReasonDivision": "string",
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 1,
- "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": -1,
- "displayFlag": -1
}
]
}
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
商品情報を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "productId": "string",
- "no": "string",
- "value": "string"
}
], - "prices": [
- {
- "productId": "string",
- "storeId": "string",
- "priceDivision": "string",
- "startDate": "string",
- "endDate": "string",
- "price": "string"
}
], - "stores": [
- {
- "productId": "string",
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": "string"
}
], - "inventoryReservations": [
- {
- "productId": "string",
- "reservationProductId": "string",
- "reservationAmount": "string"
}
], - "attributeItems": [
- {
- "productId": "string",
- "code": "string",
- "no": "string",
- "name": "string"
}
], - "orderSetting": {
- "productId": "string",
- "continuationDivision": "string",
- "orderStatusDivision": 0,
- "orderNoReasonDivision": "string",
- "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 0,
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": "string",
- "displayFlag": -1
}
]
}
}
商品情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
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 商品をオープン価格販売するかどうかの設定 |
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 端末で表示するか判定 |
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 小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを識別する。 |
staffDiscountRate | string <int> (社員販売割引率) [ 0 .. 100 ] 社員販売時の割引率 |
useCategoryReduceTax | string (部門税設定参照フラグ) Default: 1 Enum: 0 1 軽減税率個別設定フラグ(0:reduceTaxIdを使用、1:部門の税設定を使用) |
reduceTaxId | string <int> (軽減税率ID) [ 0 .. 999999999 ] 軽減税率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値で登録されます。 |
更新成功
指定した商品データが存在しない場合
サンドボックス
本番
{- "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": [
- {
- "storeId": "string",
- "priceDivision": 1,
- "startDate": "2023-12-01",
- "endDate": "2023-12-01",
- "price": "string"
}
], - "reserveItems": [
- {
- "no": "string",
- "value": "string"
}
], - "stores": [
- {
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": 0
}
], - "inventoryReservations": [
- {
- "reservationProductId": "string",
- "reservationAmount": "string"
}
], - "attributeItems": [
- {
- "code": "string",
- "no": "string"
}
], - "orderSetting": {
- "continuationDivision": null,
- "orderStatusDivision": 1,
- "orderNoReasonDivision": "string",
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 1,
- "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": -1,
- "displayFlag": -1
}
]
}
}
{- "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": [
- {
- "productId": "string",
- "storeId": null,
- "priceDivision": "string",
- "startDate": null,
- "endDate": null,
- "price": null
}
], - "reserveItems": [
- {
- "productId": "string",
- "no": null,
- "value": "string"
}
], - "stores": [
- {
- "productId": "string",
- "storeId": null,
- "productOptionGroupId": "string",
- "assignDivision": "string"
}
], - "inventoryReservations": [
- {
- "productId": "string",
- "reservationProductId": null,
- "reservationAmount": null
}
], - "attributeItems": [
- {
- "productId": "string",
- "code": "string",
- "no": "string",
- "name": "string"
}
], - "orderSetting": {
- "productId": "string",
- "continuationDivision": "string",
- "orderStatusDivision": 0,
- "orderNoReasonDivision": "string",
- "orderLimitAmount": "string",
- "orderSupplierEditable": 0,
- "pbDivision": 1,
- "displayFlag": 0,
- "orderUnit": {
- "division": 0,
- "num": "string",
- "name": "string"
}, - "stores": [
- {
- "storeId": "string",
- "orderLimitAmount": "string",
- "displayFlag": -1
}
]
}
}
商品情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
削除成功
指定した商品データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
商品価格情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
store_id | integer 店舗ID (全店を指定する場合 -1) |
price_division | string Enum: 1 2 価格区分 (1:商品単価、2:会員単価) |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "storeId": "string",
- "priceDivision": "string",
- "startDate": "string",
- "endDate": "string",
- "price": "string"
}
]
商品価格を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
product_id required | string 商品毎に付与するID |
price_division required | string 価格区分(1:商品単価、2:会員価格) |
store_id required | string 店舗ID (全店の場合、-1を設定) |
start_date required | string 適用開始日:[YYYY-MM-DD] |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "適用開始日は\"YYYY-MM-DD\"形式を指定してください",
- "status": 400
}
商品価格変更履歴の一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
price_division | string 価格区分:(1:商品単価、2:会員価格、3:原価、4:商品単価詳細、5:会員価格詳細) |
取得成功
価格区分が[1, 2, 3, 4, 5]の何れかの値ではない場合
指定した商品IDが存在しない場合
サンドボックス
本番
[- {
- "id": "string",
- "productId": "string",
- "beforeTaxDivision": "string",
- "beforePrice": "string",
- "afterTaxDivision": "string",
- "afterPrice": "string",
- "priceDivision": "string",
- "procDivision": "string",
- "procDetailDivision": "string",
- "updDateTime": "string"
}
]
商品自由項目情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "no": "string",
- "value": "string"
}
]
商品自由項目情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
product_id required | string 商品ID |
no required | string 商品自由項目番号 |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
商品属性一覧を取得します。
sortで使用可能なパラメータ
■項目番号:商品属性に付与されている連番
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "no": "string",
- "name": "string"
}
]
商品属性を更新します。
URI指定した項目番号が存在しなければ登録処理、存在すれば更新処理を行います。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
no required | string [ 1 .. 3 ] 項目番号 |
name required | string <string> (属性名) <= 15 characters 商品属性の名称 |
取得成功
サンドボックス
本番
{- "name": "string"
}
{- "no": "string",
- "name": "string"
}
商品属性を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
no required | string [ 1 .. 3 ] 項目番号 |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "指定された商品属性に紐づく商品属性項目が存在するため削除できません",
- "status": 400
}
商品属性項目一覧を取得します。
sortで使用可能なパラメータ
■項目番号:商品属性に付与されている連番
■コード:商品属性項目を一意にする項目
■表示順:表示順序
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
code | string コード:商品属性項目を一意にする項目 |
no | integer [ 1 .. 3 ] 項目番号:商品属性に付与されている連番 |
取得成功
サンドボックス
本番
[- {
- "code": "string",
- "no": "string",
- "name": "string",
- "displaySequence": "string"
}
]
商品属性項目を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
no required | string <int> (項目番号) [ 1 .. 3 ] 商品属性に付与されている連番 |
name required | string <string> (選択肢名) <= 30 characters 商品属性項目の名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順序 |
取得成功
サンドボックス
本番
{- "no": "string",
- "name": "string",
- "displaySequence": "string"
}
{- "code": "string",
- "no": "string",
- "name": "string",
- "displaySequence": "string"
}
商品属性項目を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
code required | string コード |
name required | string <string> (選択肢名) <= 30 characters 商品属性項目の名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順序 |
取得成功
サンドボックス
本番
{- "name": "string",
- "displaySequence": "string"
}
{- "code": "string",
- "no": "string",
- "name": "string",
- "displaySequence": "string"
}
商品属性項目を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
code required | string コード |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
商品取扱店舗情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
store_id | integer 店舗ID |
assign_division | string Enum: 0 1 取扱区分 (0:販売する、1:販売しない) |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "storeId": "string",
- "assignDivision": "string"
}
]
指定した店舗が取り扱っている商品一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
[- {
- "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",
- "appStartDateTime": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "stores": [
- {
- "productId": "string",
- "storeId": "string",
- "productOptionGroupId": "string",
- "assignDivision": "string"
}
]
}
]
在庫引当商品情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "reservationProductId": "string",
- "reservationAmount": "string"
}
]
在庫引当商品を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
reservation_product_id required | string 在庫引当商品ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定された商品IDのリソースが見つかりません",
- "status": 404
}
商品自由項目ラベル情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "no": "string",
- "label": "string"
}
]
商品自由項目ラベル情報を登録または更新します。
URI指定した商品自由項目番号が存在しなければ登録処理、存在すれば更新処理を行います。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
no required | string 商品自由項目番号 |
label required | string (ラベル) <= 85 characters |
取得成功
サンドボックス
本番
{- "label": "string"
}
{- "no": "string",
- "label": "string"
}
商品自由項目ラベル情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
no required | string 商品自由項目番号 |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "指定された項目番号は使用中です",
- "status": 400
}
商品の画像URLを一覧を取得します。
sortで使用可能なパラメータ
■productId:商品ID
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "url": "string"
}
]
商品画像を登録を受付します。すでに商品画像が存在しているときは上書きします。
※ 商品画像の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
imageUrl required | string (商品画像URL) <= 511 characters 設定したい商品画像のURL |
callbackUrl | string (画像登録完了通知URL) <= 511 characters 画像の登録が完了した際に、登録結果をWebhook通知するURL |
state | string (完了通知ステートメント) <= 20 characters 画像登録完了通知URLに完了通知する際に設定できる任意の文字列 |
取得成功
サンドボックス
本番
{- "imageUrl": "string",
- "callbackUrl": "string",
- "state": "string"
}
{- "productId": "string",
- "callbackUrl": "string",
- "state": "string"
}
商品画像を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定された商品IDのリソースが見つかりません",
- "status": 404
}
商品アイコン画像の登録を受付します。すでに商品アイコン画像が存在しているときは上書きします。
※ 商品アイコン画像の登録処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
imageUrl required | string (商品アイコン画像URL) <= 511 characters 設定したい商品アイコン画像のURL |
callbackUrl | string (画像登録完了通知URL) <= 511 characters 画像の登録が完了した際に、登録結果をWebhook通知するURL |
state | string (完了通知ステートメント) <= 20 characters 画像登録完了通知URLに完了通知する際に設定できる任意の文字列 |
取得成功
サンドボックス
本番
{- "imageUrl": "string",
- "callbackUrl": "string",
- "state": "string"
}
{- "productId": "string",
- "callbackUrl": "string",
- "state": "string"
}
商品アイコン画像を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
セール情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
bargain_id | string セールID |
bargain_product_id | string セール商品ID: |
term_start | string 適用開始日時:[YYYY-MM-DD] |
term_end | string 適用終了日時:[YYYY-MM-DD] |
取得成功
サンドボックス
本番
[- {
- "bargainId": "string",
- "bargainName": "string",
- "termStart": "string",
- "termEnd": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
セール情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
bargainName required | string (セール名) <= 85 characters セール名称 |
termStart required | string <date> (セール開始日) [YYYY-MM-DD] セールの開始日 |
termEnd required | string <date> (セール終了日) [YYYY-MM-DD] セールの終了日 |
取得成功
サンドボックス
本番
{- "bargainName": "string",
- "termStart": "2023-12-01",
- "termEnd": "2023-12-01"
}
{- "bargainId": "string",
- "bargainName": "string",
- "termStart": "string",
- "termEnd": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
bargainName | string (セール名) <= 85 characters セール名称 |
termStart | string <date> (セール開始日) [YYYY-MM-DD] セールの開始日 |
termEnd | string <date> (セール終了日) [YYYY-MM-DD] セールの終了日 |
取得成功
サンドボックス
本番
{- "bargainName": "string",
- "termStart": "2023-12-01",
- "termEnd": "2023-12-01"
}
{- "bargainId": "string",
- "bargainName": "string",
- "termStart": "string",
- "termEnd": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
削除成功
指定したセールデータが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
セール店舗情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string セールID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
store_id | string 店舗ID: |
取得成功
サンドボックス
本番
[- {
- "bargainStoreId": "string",
- "bargainId": "string",
- "storeId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
セール店舗情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
storeId required | string <int> (店舗ID) [ 1 .. 999999999 ] 対象の店舗ID |
取得成功
サンドボックス
本番
{- "storeId": "string"
}
{- "bargainStoreId": "string",
- "bargainId": "string",
- "storeId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール店舗情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
bargainStoreId required | string セール店舗ID |
storeId | string <int> (店舗ID) [ 1 .. 999999999 ] 対象の店舗ID |
取得成功
サンドボックス
本番
{- "storeId": "string"
}
{- "bargainStoreId": "string",
- "bargainId": "string",
- "storeId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール店舗情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
bargainStoreId required | string セール店舗ID |
削除成功
指定したセール店舗データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
セール商品情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string セールID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
target_division | string Enum: 1 2 3 対象区分:(1:部門、2:商品、3:グループコード) |
target_id | string 対象ID:部門ID, 商品ID, グループコードのいずれかを設定 |
取得成功
サンドボックス
本番
[- {
- "bargainProductId": "string",
- "bargainId": "string",
- "targetDivision": 1,
- "targetId": "string",
- "division": 1,
- "value": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
セール商品情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
targetDivision required | string (対象区分) Enum: 1 2 3 1:カテゴリー, 2:商品, 3:グループコード |
targetId required | string (対象ID) <= 255 characters カテゴリーID, 商品ID, グループコードのいずれか |
division required | string (割引区分) Enum: 1 2 3 1:割引 2:値引 3:価格指定 |
value required | string <int> (値) <= 9999999999 割引、値引き、価格指定の値 |
取得成功
サンドボックス
本番
{- "targetDivision": 1,
- "targetId": "string",
- "division": 1,
- "value": "string"
}
{- "bargainProductId": "string",
- "bargainId": "string",
- "targetDivision": "string",
- "targetId": "string",
- "division": "string",
- "value": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール商品情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
bargainProductId required | string セール商品ID:セールID、対象区分、対象ID の3つの値によって定まる一意なID |
targetDivision | string (対象区分) Enum: 1 2 3 1:カテゴリー, 2:商品, 3:グループコード |
targetId | string (対象ID) <= 255 characters カテゴリーID, 商品ID, グループコードのいずれか |
division | string (割引区分) Enum: 1 2 3 1:割引 2:値引 3:価格指定 |
value | string <int> (値) <= 9999999999 割引、値引き、価格指定の値 |
取得成功
サンドボックス
本番
{- "targetDivision": 1,
- "targetId": "string",
- "division": 1,
- "value": "string"
}
{- "bargainProductId": "string",
- "bargainId": "string",
- "targetDivision": "string",
- "targetId": "string",
- "division": "string",
- "value": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
セール商品情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string セールID |
bargainProductId required | string セール商品ID:セールID、対象区分、対象ID の3つの値によって定まる一意なID |
削除成功
指定したセール商品データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
オプショングループの一覧を取得します。
sortで使用可能なパラメータ
■productOptionGroupId:商品オプショングループID
■conditionId:条件ID
■updDateTime:更新日時
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_option_group_name | string オプショングループ名 |
condition_id | string 条件ID:(0:条件なし、1:全体、2:部門毎) |
取得成功
サンドボックス
本番
[- {
- "productOptionGroupId": "string",
- "productOptionGroupName": "string",
- "conditionId": "string",
- "max": "string",
- "min": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
オプショングループを登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
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件以上の登録必須。 |
更新成功
サンドボックス
本番
{- "productOptionGroupName": "string",
- "conditionId": 0,
- "max": "string",
- "min": "string",
- "products": [
- {
- "productId": "string"
}
]
}
{- "productOptionGroupId": "string",
- "productOptionGroupName": "string",
- "conditionId": "string",
- "max": "string",
- "min": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "products": {
- "productOptionGroupId": "string",
- "productId": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
}
指定されたオプショングループを取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string オプショングループID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_products | string Default: "none" Enum: "all" "none" オプショングループ商品情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
[- {
- "productOptionGroupId": "string",
- "productOptionGroupName": "string",
- "conditionId": "string",
- "max": "string",
- "min": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "products": {
- "productOptionGroupId": "string",
- "productId": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
}
]
オプショングループを更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string オプショングループID |
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 (オプショングループ商品) オプショングループ商品:指定した商品をオプショングループに追加します。 |
更新成功
サンドボックス
本番
{- "productOptionGroupName": "string",
- "conditionId": 0,
- "max": "string",
- "min": "string",
- "products": [
- {
- "productId": "string"
}
]
}
{- "productOptionGroupId": "string",
- "productOptionGroupName": "string",
- "conditionId": "string",
- "max": "string",
- "min": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "products": {
- "productOptionGroupId": "string",
- "productId": "string",
- "syncDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
}
オプショングループを削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string オプショングループID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "指定されたオプショングループは使用中のため、削除できません。",
- "status": 400
}
指定されたオプショングループ商品を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string オプショングループID |
product_id required | string 商品ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "オプション商品が0件になるため削除できません。",
- "status": 400
}
バンドル販売情報一覧を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_bundle_group_id | string 商品バンドルグループID |
term_from | string 適用開始日:[YYYY-MM-DD] |
term_to | string 適用終了日:[YYYY-MM-DD] |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
バンドル販売情報を登録します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
productBundleGroupName required | string (商品バンドルグループ名) <= 85 characters 商品バンドルグループの名称。 |
type required | string (種類) Enum: 1 2 3 4 種類:バンドル販売の種類。 |
taxDivision | string (税区分) Enum: 0 1 2 税区分 (0:税込、1:税抜、2:非課税) |
reduceTaxId | string <int> (軽減税率ID) 軽減税率ID |
quantity | string <int> (数量) [ 1 .. 999 ] バンドル販売の条件となる数量。 |
value required | string <int> (値) [ -99999999 .. 999999999 ] 種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。 |
reduceTaxValue | string <int> (軽減税率適用時の値) [ -99999999 .. 999999999 ] 種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。 |
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:ポイント対象外) |
taxFreeDivision | string (免税区分) Enum: 0 1 2 免税区分 (0:対象外、1:一般品、2:消耗品) |
calcDiscount | string (値引割引計算対象区分) Enum: 0 1 値引割引計算対象区分 (0:対象外、1:対象) |
products required | Array of objects (対象商品) 対象商品:バンドル販売の対象商品 |
更新成功
サンドボックス
本番
{- "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": [
- {
- "categoryId": "string",
- "productId": "string",
- "productGroupCode": "string"
}
]
}
{- "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": [
- {
- "productBundleId": "string",
- "productBundleGroupId": "string",
- "categoryId": "string",
- "productId": "string",
- "productGroupCode": "string"
}
]
}
バンドル販売情報を取得します。
pos.products:read
) UserAccessToken (pos.products:read
) contract_id required | string 契約ID |
id required | string 商品バンドルグループID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_products | string Default: "none" Enum: "all" "none" バンドル販売対象商品情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "productBundleId": "string",
- "productBundleGroupId": "string",
- "categoryId": "string",
- "productId": "string",
- "productGroupCode": "string"
}
]
}
バンドル販売情報を更新します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品バンドルグループID |
productBundleGroupName | string (商品バンドルグループ名) <= 85 characters 商品バンドルグループの名称。 |
type | string (種類) Enum: 1 2 3 4 種類:バンドル販売の種類。 |
taxDivision | string (税区分) Enum: 0 1 2 税区分 (0:税込、1:税抜、2:非課税) |
reduceTaxId | string <int> (軽減税率ID) 軽減税率ID |
quantity | string <int> (数量) [ 1 .. 999 ] バンドル販売の条件となる数量。 |
value | string <int> (値) [ -99999999 .. 999999999 ] 種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。 |
reduceTaxValue | string <int> (軽減税率適用時の値) [ -99999999 .. 999999999 ] 種類=1,4の時は販売金額、種類=2の時は値引金額、種類=3の時は割引率。 |
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 (対象商品) 対象商品:バンドル販売の対象商品 |
更新成功
サンドボックス
本番
{- "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": [
- {
- "productBundleId": "string",
- "categoryId": "string",
- "productId": "string",
- "productGroupCode": "string"
}
]
}
{- "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": [
- {
- "productBundleId": "string",
- "productBundleGroupId": "string",
- "categoryId": "string",
- "productId": "string",
- "productGroupCode": "string"
}
]
}
バンドル販売情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
id required | string 商品バンドルグループID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": "404"
}
バンドル販売商品情報を削除します。
pos.products:write
) UserAccessToken (pos.products:write
) contract_id required | string 契約ID |
productBundleGroupId required | string 商品バンドルグループID |
productBundleId required | string 商品バンドル明細ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "バンドル販売商品が0件になるため削除できません。",
- "status": 400
}
会員情報一覧を取得します。
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
会員情報を登録します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
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) |
更新成功
サンドボックス
本番
{- "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"
}
{- "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件まで登録できます。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
customers required | Array of objects (会員情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "customers": [
- {
- "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"
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
会員情報を一括更新します。
※ 会員の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 会員は1リクエストにつき100件まで更新できます。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
customers required | Array of objects (会員情報) |
callbackUrl required | string (会員更新完了通知URL) <= 511 characters 会員の更新が完了した際に、更新結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "customers": [
- {
- "customerId": "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",
- "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"
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
会員情報を取得します。
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
id required | string 会員ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
取得成功
サンドボックス
本番
{- "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"
}
会員情報を更新します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
id required | string 会員ID |
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) |
更新成功
サンドボックス
本番
{- "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"
}
{- "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"
}
会員情報を削除します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
id required | string 会員ID |
削除成功
指定した会員データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
会員ポイント情報一覧を取得します。
参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから返します。
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
customer_id | string 会員ID |
mile | string マイル |
point | string ポイント |
point_expire_date | string ポイント失効予定日 |
customerId | string (非推奨)会員ID |
pointExpireDate | string (非推奨)ポイント失効予定日 |
取得成功
サンドボックス
本番
[- {
- "customerId": "string",
- "mile": "string",
- "point": "string",
- "pointExpireDate": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
会員ポイント情報を更新します。
ポイントおよびマイルは、入力された値と同じになるよう更新します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
id required | string 会員ID |
mile | string <int> (マイル) <= 999999999 マイル |
point | string <int> (ポイント) <= 999999999 ポイント |
pointExpireDate | string <date> (ポイント失効予定日) ポイント失効予定日:指定しない場合ポイント失効日は更新されません。 |
取得成功
サンドボックス
本番
{- "mile": "string",
- "point": "string",
- "pointExpireDate": "2023-12-01"
}
{- "customerId": "string",
- "mile": "string",
- "point": "string",
- "pointExpireDate": "string",
- "updDateTime": "string",
- "transactionHeadIds": [
- "10",
- "11"
]
}
会員ポイント情報を更新します。
ポイントおよびマイルは、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
現在値参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから加算を行います(失効で0になっているので減算はエラー)。
pos.customers:read
pos.customers:write
) UserAccessToken (pos.customers:read
pos.customers:write
) contract_id required | string 契約ID |
id required | string 会員ID |
mile | string <int> (マイル) [ -999999999 .. 999999999 ] マイル |
point | string <int> (ポイント) [ -999999999 .. 999999999 ] ポイント |
pointExpireDate | string <date> (ポイント失効予定日) ポイント失効予定日:指定しない場合ポイント失効日は更新されません。 |
取得成功
サンドボックス
本番
{- "mile": "string",
- "point": "string",
- "pointExpireDate": "2023-12-01"
}
{- "customerId": "string",
- "mile": "string",
- "point": "string",
- "pointExpireDate": "string",
- "updDateTime": "string",
- "transactionHeadIds": [
- "10",
- "11"
]
}
会員ポイント情報を一括更新します。
ポイントおよびマイルは、入力された値と同じになるよう更新します。
※ 会員ポイント情報の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 会員ポイント情報は1リクエストにつき100件まで更新できます。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
customerPoints required | Array of objects (会員ポイント情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "customerPoints": [
- {
- "customerId": "string",
- "mile": "string",
- "point": "string",
- "pointExpireDate": "2023-12-01"
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
会員ポイント情報を一括更新します。
ポイントおよびマイルは、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
現在値参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから加算を行います(失効で0になっているので減算はエラー)。
※ 会員ポイント情報の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 会員ポイント情報は1リクエストにつき100件まで更新できます。
pos.customers:read
pos.customers:write
) UserAccessToken (pos.customers:read
pos.customers:write
) contract_id required | string 契約ID |
customerPoints required | Array of objects (会員ポイント情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "customerPoints": [
- {
- "customerId": "string",
- "mile": "string",
- "point": "string",
- "pointExpireDate": "2023-12-01"
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
会員必須項目設定を取得します。
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
column_name | string カラム名 |
value | string Enum: 0 1 設定値:会員登録・更新時に必須項目とするかどうかの設定値。 (0:任意、1:必須) |
取得成功
サンドボックス
本番
[- {
- "columnName": "string",
- "initialValue": "string",
- "value": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
会員ランクの一覧を取得します。
sortで使用可能なパラメータ
■rank:会員ランク
■displaySequence:表示順
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
rank | string 会員ランク |
display_flag | string Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
取得成功
サンドボックス
本番
[- {
- "rank": "string",
- "name": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
会員ランクを登録します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
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:有効) |
更新成功
サンドボックス
本番
{- "name": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "rank": "string",
- "name": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
会員ランクを更新します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
rank required | string 会員ランク |
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:有効) |
更新成功
サンドボックス
本番
{- "name": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "rank": "string",
- "name": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
会員ランクを削除します。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
rank required | string 会員ランク |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定された会員ランクのリソースが見つかりません",
- "status": 404
}
社員ランクの一覧を取得します。
※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。
sortで使用可能なパラメータ
■staffRank:社員ランク。社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。
■displaySequence:表示順。一覧表示時の並び順の優先順位です。
■updDateTime:更新日時。登録時・更新時の日時
pos.customers:read
) UserAccessToken (pos.customers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
staff_rank | string 社員ランク:社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。 |
display_flag | string 有効/無効:表示区分。(0:無効、1:有効) |
取得成功
サンドボックス
本番
[- {
- "staffRank": "string",
- "staffRankFullName": "string",
- "staffRankDisplayName": "string",
- "displayFlag": "string",
- "displaySequence": "string",
- "staffDiscountRate": "string",
- "useProductStaffDiscountRateDivision": "string",
- "staffApplicationSellingPriceDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
社員ランクを登録します。
※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
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:セール価格と社員販売価格を比較して高い方を適用) |
取得成功
サンドボックス
本番
{- "staffRankFullName": "string",
- "staffRankDisplayName": "string",
- "displayFlag": 1,
- "displaySequence": "string",
- "staffDiscountRate": "string",
- "useProductStaffDiscountRateDivision": 1,
- "staffApplicationSellingPriceDivision": 2
}
{- "staffRank": "string",
- "staffRankFullName": "string",
- "staffRankDisplayName": "string",
- "displayFlag": "string",
- "displaySequence": "string",
- "staffDiscountRate": "string",
- "useProductStaffDiscountRateDIvision": "string",
- "staffApplicationSellingPriceDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
社員ランクを更新します。
※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
staff_rank required | string 社員ランク |
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:セール価格と社員販売価格を比較して高い方を適用) |
取得成功
サンドボックス
本番
{- "staffRankFullName": "string",
- "staffRankDisplayName": "string",
- "displayFlag": 0,
- "displaySequence": "string",
- "staffDiscountRate": "string",
- "useProductStaffDiscountRateDivision": 0,
- "staffApplicationSellingPriceDivision": 0
}
{- "staffRank": "string",
- "staffRankFullName": "string",
- "staffRankDisplayName": "string",
- "displayFlag": "string",
- "displaySequence": "string",
- "staffDiscountRate": "string",
- "useProductStaffDiscountRateDIvision": "string",
- "staffApplicationSellingPriceDivision": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
社員ランクを削除します。
※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。
pos.customers:write
) UserAccessToken (pos.customers:write
) contract_id required | string 契約ID |
staff_rank required | string 社員ランク |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "会員本部連携が有効な契約では社員ランクはご利用できないため、本APIもご利用できません。",
- "status": 400
}
在庫情報一覧を取得します。
※ 商品の在庫情報はその商品の在庫数が変動してはじめて取得できます。
(在庫数の変動例: 販売・入出荷・店間移動・棚卸・在庫調整・ロス登録など)
pos.stock:read
) UserAccessToken (pos.stock:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
upd_date_time-to | string 更新日時(to):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "productId": "string",
- "stockAmount": "string",
- "layawayStockAmount": "string",
- "updDateTime": "string"
}
]
在庫情報を更新します。
在庫数は、入力された値と同じになるよう更新します。
pos.stock:write
) UserAccessToken (pos.stock:write
) contract_id required | string 契約ID |
product_id required | string 商品ID |
storeId required | string <int> (店舗ID) <= 15 characters |
stockAmount required | string <int> (在庫数) [ -999999999 .. 999999999 ] |
stockHistory | object (在庫変動履歴) |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "stockAmount": "string",
- "stockHistory": {
- "memo": "string"
}
}
{- "productId": "string",
- "storeId": "string",
- "stockAmount": "string",
- "updDateTime": "string",
- "stockHistory": {
- "id": "string",
- "memo": "string"
}
}
在庫情報を更新します。
在庫数は、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
pos.stock:read
pos.stock:write
) UserAccessToken (pos.stock:read
pos.stock:write
) contract_id required | string 契約ID |
product_id required | string 商品ID |
storeId required | string <int> (店舗ID) <= 15 characters |
stockAmount required | string <int> (在庫数) [ -1999999998 .. 1999999998 ] |
stockHistory | object (在庫変動履歴) |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "stockAmount": "string",
- "stockHistory": {
- "memo": "string"
}
}
{- "productId": "string",
- "storeId": "string",
- "stockAmount": "string",
- "updDateTime": "string",
- "stockHistory": {
- "id": "string",
- "memo": "string"
}
}
在庫情報を一括更新します。
在庫数は、入力された値と同じになるよう更新します。
※ 在庫の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 在庫は1リクエストにつき100件(店舗)まで登録できます。
pos.stock:write
) UserAccessToken (pos.stock:write
) contract_id required | string 契約ID |
stock required | Array of objects (在庫情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "stock": [
- {
- "productId": "string",
- "storeId": "string",
- "stockAmount": "string",
- "stockHistory": {
- "memo": "string"
}
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
在庫情報を一括更新します。
在庫数は、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。
※ 在庫の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。
※ 在庫は1リクエストにつき100件(店舗)まで登録できます。
pos.stock:read
pos.stock:write
) UserAccessToken (pos.stock:read
pos.stock:write
) contract_id required | string 契約ID |
stock required | Array of objects (在庫情報) |
callbackUrl required | string <string> (処理完了通知URL) <= 511 characters ^https?://\S+$ 処理が完了した際にその結果をWebhook通知するURL |
処理受付完了
サンドボックス
本番
{- "stock": [
- {
- "productId": "string",
- "storeId": "string",
- "stockAmount": "string",
- "stockHistory": {
- "memo": "string"
}
}
], - "callbackUrl": "string"
}
{- "requestId": "string",
- "callbackUrl": "string"
}
在庫変動履歴情報を取得します。
pos.stock-changes:read
) UserAccessToken (pos.stock-changes:read
) contract_id required | string 契約ID |
product_id required | string 商品ID |
store_id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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 |
取得成功
サンドボックス
本番
[- {
- "id": "string",
- "updDateTime": "string",
- "targetDateTime": "string",
- "productId": "string",
- "storeId": "string",
- "amount": "string",
- "stockAmount": "string",
- "layawayStockAmount": "string",
- "stockDivision": "string",
- "fromStoreId": "string",
- "toStoreId": "string",
- "taxDivision": "string",
- "price": "string",
- "cost": "string",
- "memo": "string",
- "staffId": "string",
- "staffName": "string"
}
]
取引情報一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
transaction_date_time-to | string 取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
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] |
terminal_tran_date_time-to | string 端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
adjustment_date_time | string 精算日時 [YYYY-MM-DDThh:mm:ssTZD] |
sum_date | string 締め日 [YYYY-MM-DD] |
sum_date-from | string 締め日(From)[YYYY-MM-DD] |
sum_date-to | string 締め日(To)[YYYY-MM-DD] |
customer_code | string 会員コード |
transaction_uuid | string レシート番号:指定した値を完全一致で検索します |
barcode | string バーコード:指定したバーコードの仮販売データに紐づく、取引データを取得します。 |
upd_date_time-from | string 更新日時(From):登録時・更新時の日時。締め日(From)[YYYY-MM-DD] |
upd_date_time-to | string 更新日時(To):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
with_details | string Default: "none" Enum: "all" "summary" "none" 取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone) |
with_deposit_others | string Default: "none" Enum: "all" "none" その他支払い情報を付加するか(付加する場合はall, しない場合はnone) |
with_layaway | string Default: "none" Enum: "all" "none" (非推奨)取置き情報を付加するか(付加する場合はall, しない場合はnone) |
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 | 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) |
取得成功
サンドボックス
本番
[- {
- "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",
- "storeCode": "string",
- "terminalId": "string",
- "customerId": "string",
- "customerCode": "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",
- "staffCode": "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string",
- "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
], - "rfidTags": [
- "string"
]
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": 0,
- "paymentDivision": "string",
- "paymentSecuritiesFlag": 0,
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "cancelSlipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layaways": [
- {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}
], - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}, - "layawayPickUps": [
- {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}
], - "moneyControl": {
- "transactionHeadId": "string",
- "attributeDivision": "string",
- "attributeDivisionName": "string"
}
}
]
取引を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
transactionHeadDivision required | string (取引区分) Enum: 1 2 3 4 5 6 7 13 14 取引を識別する区分。 | ||||||||||||||||||||||||||||||||||||||||||||
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 ] 小計値引き/割引時に指定された区分を設定。 | ||||||||||||||||||||||||||||||||||||||||||||
pointDiscount | string <int> (ポイント値引き) [ -999999999 .. 999999999 ] 使用ポイント * ポイント還元率。 | ||||||||||||||||||||||||||||||||||||||||||||
total required | string <int> (合計) [ -999999999 .. 999999999 ] 小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 | ||||||||||||||||||||||||||||||||||||||||||||
taxInclude | string <int> (内税額) [ -999999999 .. 999999999 ] 内税商品計 / 110 * 10。 | ||||||||||||||||||||||||||||||||||||||||||||
taxExclude | string <int> (外税額) [ -999999999 .. 999999999 ] 外税商品計 * 10 / 100。 | ||||||||||||||||||||||||||||||||||||||||||||
roundingDivision | string (端数値引区分) Enum: "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 取引で付与されるポイント。 合計 * ポイント付与率 1. スマレジのポイント算出方式について
2. カード会社・支払方法にポイント付与単位と付与ポイント数の設定がある場合のポイント計算例支払い方法毎のポイント付与率
取引(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取引におけるポイント付与状況各支払方法に対するポイントを計算します。また、付与ポイント計算時に生じた端数金額については合算し、 その取引で最も高いポイント付与率を使用して再付与を行います。
合計ポイントの計算合計付与ポイント: 10 + 100 + 0 + 10 = 120ポイント注意事項
| ||||||||||||||||||||||||||||||||||||||||||||
spendPoint | string <int> (使用ポイント) [ -999999999 .. 999999999 ] 取引で使用したポイント。 | ||||||||||||||||||||||||||||||||||||||||||||
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 調整マイルの区分 | ||||||||||||||||||||||||||||||||||||||||||||
adjustmentMileValue | string <int> (調整マイル区分値) [ 1 .. 99999999 ] 調整マイルの入力値 | ||||||||||||||||||||||||||||||||||||||||||||
storeId required | string <int> (店舗ID) [ 1 .. 999999999 ] 店舗毎に付与するID。 | ||||||||||||||||||||||||||||||||||||||||||||
terminalId required | string <int> (端末ID) [ 1 .. 999999999 ] 店舗の端末毎に付与するID。 | ||||||||||||||||||||||||||||||||||||||||||||
customerId | string <int> (会員ID) [ 1 .. 9999999999 ] 会員毎に付与するID。 | ||||||||||||||||||||||||||||||||||||||||||||
customerCode | string (会員コード) <= 20 characters /^[ -~]+$/ 会員毎に付与する一意のコード。 | ||||||||||||||||||||||||||||||||||||||||||||
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:締め処理済み) | ||||||||||||||||||||||||||||||||||||||||||||
sumDate | string <date> (締め日) 締めをしたら年月日が入る。 [YYYY-MM-DD] | ||||||||||||||||||||||||||||||||||||||||||||
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) | ||||||||||||||||||||||||||||||||||||||||||||
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:免税販売(自動計算・合算)) | ||||||||||||||||||||||||||||||||||||||||||||
netTaxFreeGeneralTaxInclude | string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ] 内税商品の一般品免税額。 | ||||||||||||||||||||||||||||||||||||||||||||
netTaxFreeGeneralTaxExclude | string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ] 外税商品の一般品免税額。 | ||||||||||||||||||||||||||||||||||||||||||||
netTaxFreeConsumableTaxInclude | string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ] 内税商品の消耗品免税額。 | ||||||||||||||||||||||||||||||||||||||||||||
netTaxFreeConsumableTaxExclude | string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ] 外税商品の消耗品免税額。 | ||||||||||||||||||||||||||||||||||||||||||||
tags | string (取引タグ) <= 255 characters レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。 | ||||||||||||||||||||||||||||||||||||||||||||
pointGivingDivision | string (ポイント付与税区分) Enum: 1 2 3 4 1:税額を含める + 利用ポイント分を含める、 | ||||||||||||||||||||||||||||||||||||||||||||
pointGivingUnitPrice | string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ] ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円) | ||||||||||||||||||||||||||||||||||||||||||||
pointGivingUnit | string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ] ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント) | ||||||||||||||||||||||||||||||||||||||||||||
pointSpendDivision | string (ポイント利用区分) Default: 1 Enum: 1 2 ポイント利用時の税を含む/含まないを判定。 | ||||||||||||||||||||||||||||||||||||||||||||
mileageDivision | string (マイレージ利用区分) Default: 0 Enum: 0 1 2 マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める) | ||||||||||||||||||||||||||||||||||||||||||||
mileageLabel | string (マイレージラベル) <= 32 characters マイレージの名称。未設定の場合は「マイル」 | ||||||||||||||||||||||||||||||||||||||||||||
customerPinCode | string (PINコード) <= 32 characters 自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 | ||||||||||||||||||||||||||||||||||||||||||||
sellDivision | string (販売区分) Enum: 0 1 取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売) | ||||||||||||||||||||||||||||||||||||||||||||
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 レシートに印字する番号。ユニークな値を設定してください。 | ||||||||||||||||||||||||||||||||||||||||||||
exchangeTicketNo | string (引換券番号) <= 20 characters | ||||||||||||||||||||||||||||||||||||||||||||
giftReceiptValidDays | string <int> (ギフトレシート引換有効日数) [ 0 .. 999999999 ] 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 | ||||||||||||||||||||||||||||||||||||||||||||
discountCalculateDivision | string (割引額計算対象) Default: 0 Enum: 0 1 小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。 | ||||||||||||||||||||||||||||||||||||||||||||
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 (クーポン商品付与明細) 対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス |
更新成功
サンドボックス
本番
{- "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": [
- {
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": 1,
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "taxDivision": 0,
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "quantity": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": 0,
- "productDivision": 0,
- "calcDiscount": 0,
- "taxFreeDivision": 0,
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "reduceTaxId": "string",
- "memo": "string"
}
], - "depositOthers": [
- {
- "no": 1,
- "paymentMethodId": "string",
- "depositOthers": "string",
- "denominationCode": "CREDIT",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "serialNumber": "string",
- "awardType": 1,
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
]
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string",
- "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
]
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": "string",
- "paymentDivision": "string",
- "paymentSecuritiesFlag": "string",
- "denomination": "string",
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}
}
取引情報を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 取引ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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" 対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス |
with_coupon_items | string Default: "none" Enum: "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 | string Default: "none" Enum: "all" "none" 取置き情報を付加するか(付加する場合はall, しない場合はnone) |
with_layaway_pick_up | string Default: "none" Enum: "all" "none" (非推奨)取置き引取情報を付加するか(付加する場合はall, しない場合はnone) |
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) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string",
- "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
], - "rfidTags": [
- "string"
]
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": 0,
- "paymentDivision": "string",
- "paymentSecuritiesFlag": 0,
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "cancelSlipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
], - "discounts": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "transactionDiscountDivision": "string",
- "discountDivision": "string",
- "discountDivisionName": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "store": {
- "storeId": "string",
- "storeCode": "string",
- "storeName": "string",
- "storeAbbr": "string",
- "printReceiptStoreName": "string",
- "displaySequence": "string"
}, - "customer": {
- "customerId": "string",
- "customerCode": "string",
- "customerNo": "string",
- "rank": "string",
- "staffRank": "string",
- "firstName": "string",
- "lastName": "string",
- "firstKana": "string",
- "lastKana": "string",
- "sex": "string",
- "birthDate": "string",
- "pointExpireDate": "string",
- "lastComeDateTime": "string",
- "entryDate": "string",
- "leaveDate": "string"
}, - "customerGroups": [
- {
- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string"
}
], - "staff": {
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string",
- "rank": "string"
}, - "recordedStaff": [
- {
- "staffDivision": "string",
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layaways": [
- {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}
], - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}, - "layawayPickUps": [
- {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}
], - "moneyControl": {
- "transactionHeadId": "string",
- "attributeDivision": "string",
- "attributeDivisionName": "string"
}
}
取引情報を更新します。
※ 会員情報の更新は、取引会員更新をご利用ください。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 取引ID |
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) |
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 レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。 |
更新成功
サンドボックス
本番
{- "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"
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": "string",
- "paymentDivision": "string",
- "paymentSecuritiesFlag": "string",
- "denomination": "string",
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layaways": [
- {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}
], - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}, - "layawayPickUps": [
- {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}
]
}
取引を取消します。
※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 取引ID |
cancelDateTime | string <date-time> (取消日時) 取消/打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD] |
depositOthers | Array of objects (その他支払方法) 個別アプリ専用支払方法IDを指定した決済で取消伝票番号を登録するのに利用します |
更新成功
サンドボックス
本番
{- "cancelDateTime": "2023-12-01T10:09:41Z",
- "depositOthers": [
- {
- "no": 1,
- "cancelSlipNumber": "string"
}
]
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": "string",
- "paymentDivision": "string",
- "paymentSecuritiesFlag": "string",
- "denomination": "string",
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "cancelSlipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
], - "recordedStaff": [
- {
- "staffDivision": "string",
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string"
}
]
}
取引を打消取消します。指定された取引に対して、返品する取引情報を作成します。
※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 取引ID |
terminalTranDateTime | string <date-time> (端末取引日時) 端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
depositOthers | Array of objects (その他支払方法) 個別アプリ専用支払方法IDを指定した取引を打消取消する際に、取消伝票番号を設定するのに利用します。 |
更新成功
サンドボックス
本番
{- "terminalTranDateTime": "2023-12-01T10:09:41Z",
- "depositOthers": [
- {
- "no": 1,
- "cancelSlipNumber": "string"
}
]
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": "string",
- "paymentDivision": "string",
- "paymentSecuritiesFlag": "string",
- "denomination": "string",
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "cancelSlipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
], - "recordedStaff": [
- {
- "staffDivision": "string",
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string"
}
]
}
取引の会員情報を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 取引ID |
customerId | string <int> (会員ID) 会員コードとどちらかが必須です。(会員を解除する場合はnullを指定) |
customerCode | string (会員コード) <= 20 characters /^[ -~]+$/ 会員IDとどちらかが必須です。(会員を解除する場合はnullを指定) |
pointUpdateDivision | string (会員ポイント更新区分) Default: 0 Enum: "0" "1" "2" 会員ポイントの更新フラグ。 |
更新成功
サンドボックス
本番
{- "customerId": "string",
- "customerCode": "string",
- "pointUpdateDivision": 0
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
], - "depositOthers": [
- {
- "transactionHeadId": "string",
- "no": "string",
- "paymentMethodId": "string",
- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "depositOthers": "string",
- "paymentUnitPrice": "string",
- "paymentChangeFlag": "string",
- "paymentDivision": "string",
- "paymentSecuritiesFlag": "string",
- "denomination": "string",
- "denominationCode": "string",
- "denominationName": "string",
- "cardCompanyName": "string",
- "slipNumber": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string"
}
], - "coupons": [
- {
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "couponId": "string",
- "couponName": "string",
- "couponDivision": "string",
- "serialNumber": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "couponItems": [
- {
- "transactionCouponDetailId": "string",
- "transactionCouponId": "string",
- "terminalTranCouponId": "string",
- "transactionDetailId": "string",
- "couponItemId": "string"
}
]
}
取引明細情報一覧CSVファイルを作成します。
※ 取引明細CSVの作成処理は非同期で実行されます。処理完了後、指定されたコールバックURLに取得結果のCSVファイル(圧縮済み)をダウンロードするURLがWebhook通知されます。
※ Webhookで通知されるCSVダウンロードURLの期限は1時間です。
※ 取得件数の上限はありませんが、検索条件の取引日時(From)〜取引日時(To)の範囲を31日以内にする必要があります。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | string <string> (検索パラメータ) 検索パラメータ(カンマ区切りで指定可) | ||||||||||||||||||||
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] | ||||||||||||||||||||
transactionDateTimeTo required | string <string> (取引日時(To)) 取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] | ||||||||||||||||||||
transactionHeadDivision | string (取引区分) Enum: 1 10 取引区分(1:通常,2:入金,3:出金,4:預かり金,5:預かり金返金,6:ポイント加算,7:ポイント減算,8:ポイント失効,9:回数券,10:取置き,11:チップ,13:マイル加算,14:マイル減算,15:バリューカード入金,16:領収証) | ||||||||||||||||||||
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に完了通知する際に設定できる任意の文字列 |
取得成功
サンドボックス
本番
{- "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"
}
{- "callbackUrl": "string",
- "state": "string",
- "requestCode": "string"
}
取引明細情報を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 取引ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
[- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "discountCouponProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string",
- "discounts": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "transactionDiscountDivision": "string",
- "discountDivision": "string",
- "discountDivisionName": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
], - "rfidTags": [
- "string"
]
}
]
取置き一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
transaction_date_time-to | string 取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
store_id | string 店舗ID:店舗毎に付与するID。 |
terminal_tran_date_time-from | string 端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
terminal_tran_date_time-to | string 端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
adjustment_date_time | string 精算日時 [YYYY-MM-DDThh:mm:ssTZD] |
sum_date | string 締め日:締めをしたら年月日が入る。 [YYYY-MM-DD] |
sum_date-from | string 締め日(From) :[YYYY-MM-DD] |
sum_date-to | string 締め日(To) :[YYYY-MM-DD] |
customer_code | string 会員コード |
transaction_uuid | string レシート番号:指定した値を完全一致で検索します |
upd_date_time-from | string 更新日時(From):登録時・更新時の日時。締め日(From)[YYYY-MM-DD] |
upd_date_time-to | string 更新日時(To):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
with_layaway | string Default: "none" Enum: "all" "none" 取置き情報を付加するか(付加する場合はall, しない場合はnone) |
with_layaway_pick_up | string Default: "none" Enum: "all" "none" 取置き引取情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
[- {
- "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",
- "storeCode": "string",
- "terminalId": "string",
- "customerId": "string",
- "customerCode": "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",
- "staffCode": "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",
- "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}
}
]
取置き取引を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
transactionHeadDivision required | string (取引区分) Value: 10 取引を識別する区分。 |
subtotal required | string <int> (小計) [ -999999999 .. 999999999 ] 取引明細の値引き後小計の合計。 |
subtotalDiscountPrice | string <int> (小計値引き) [ -999999999 .. 999999999 ] 小計の値引き金額を設定。 |
subtotalDiscountRate | string <int> (小計割引率) [ -999 .. 999 ] 小計の割引を設定 (単位%) デフォルトは未設定。 |
subtotalDiscountDivision | string <int> (小計値引き/割引区分) [ 1 .. 999999999 ] 小計値引き/割引時に指定された区分を設定。 |
pointDiscount | string <int> (ポイント値引き) [ -999999999 .. 999999999 ] 使用ポイント * ポイント還元率。 |
total required | string <int> (合計) [ -999999999 .. 999999999 ] 小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 |
taxInclude | string <int> (内税額) [ -999999999 .. 999999999 ] 内税商品計 / 110 * 10。 |
taxExclude | string <int> (外税額) [ -999999999 .. 999999999 ] 外税商品計 * 10 / 100。 |
roundingDivision | string (端数値引区分) Enum: "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。 |
terminalId required | string <int> (端末ID) [ 1 .. 999999999 ] 店舗の端末毎に付与するID。 |
customerId | string <int> (会員ID) [ 1 .. 9999999999 ] 会員毎に付与するID。 |
customerCode | string (会員コード) <= 20 characters /^[ -~]+$/ 会員毎に付与する一意のコード。 |
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:締め処理済み) |
sumDate | string <date> (締め日) 締めをしたら年月日が入る。 [YYYY-MM-DD] |
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) |
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:免税販売(自動計算・合算)) |
netTaxFreeGeneralTaxInclude | string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ] 内税商品の一般品免税額。 |
netTaxFreeGeneralTaxExclude | string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ] 外税商品の一般品免税額。 |
netTaxFreeConsumableTaxInclude | string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ] 内税商品の消耗品免税額。 |
netTaxFreeConsumableTaxExclude | string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ] 外税商品の消耗品免税額。 |
tags | string (取引タグ) <= 255 characters レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。 |
pointGivingDivision | string (ポイント付与税区分) Enum: 1 2 3 4 1:税額を含める + 利用ポイント分を含める、 |
pointGivingUnitPrice | string <int> (ポイント付与単位(金額)) [ 1 .. 99999 ] ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円) |
pointGivingUnit | string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ] ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント) |
pointSpendDivision | string (ポイント利用区分) Default: 1 Enum: 1 2 ポイント利用時の税を含む/含まないを判定。 |
mileageDivision | string (マイレージ利用区分) Default: 0 Enum: 0 1 2 マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める) |
mileageLabel | string (マイレージラベル) <= 32 characters マイレージの名称。未設定の場合は「マイル」 |
customerPinCode | string (PINコード) <= 32 characters 自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 |
sellDivision | string (販売区分) Enum: 0 1 取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売) |
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 レシートに印字する番号。ユニークな値を設定してください。 |
exchangeTicketNo | string (引換券番号) <= 20 characters |
giftReceiptValidDays | string <int> (ギフトレシート引換有効日数) [ 0 .. 999999999 ] 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 |
discountCalculateDivision | string (割引額計算対象) Default: 0 Enum: 0 1 小計に対する値引または割引の上にさらに割引を行う際の、割引額の算出方法を指定する区分。 |
details | Array of objects (取引明細) |
layaway | object (取置き情報) 取置き時の情報 |
更新成功
サンドボックス
本番
{- "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": [
- {
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": 1,
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "taxDivision": 0,
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "quantity": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": 0,
- "productDivision": 0,
- "calcDiscount": 0,
- "taxFreeDivision": 0,
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "reduceTaxId": "string"
}
], - "layaway": {
- "pickUpDate": "2023-12-01",
- "partPayment": "string",
- "partPaymentClass": 1,
- "disabledEdit": 0
}
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
]
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}
}
取置き情報を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 取引ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "remainingCount": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "barcode1": "string",
- "barcode2": "string",
- "nonPluBarcode": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "couponIds": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "netTaxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "priceTaxExcluded": "string",
- "memberPriceTaxExcluded": "string",
- "printReceiptDivision": "string",
- "pbDivision": "string",
- "ecpProductDivision": "string"
}
], - "discounts": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "transactionDiscountDivision": "string",
- "discountDivision": "string",
- "discountDivisionName": "string",
- "awardType": "string",
- "awardValue": "string",
- "discountPrice": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}, - "layawayPickUp": {
- "transactionHeadId": "string",
- "layawayServerTransactionHeadId": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string"
}, - "store": {
- "storeId": "string",
- "storeCode": "string",
- "storeName": "string",
- "storeAbbr": "string",
- "printReceiptStoreName": "string",
- "displaySequence": "string"
}, - "customer": {
- "customerId": "string",
- "customerCode": "string",
- "customerNo": "string",
- "rank": "string",
- "staffRank": "string",
- "firstName": "string",
- "lastName": "string",
- "firstKana": "string",
- "lastKana": "string",
- "sex": "string",
- "birthDate": "string",
- "pointExpireDate": "string",
- "lastComeDateTime": "string",
- "entryDate": "string",
- "leaveDate": "string"
}, - "customerGroups": [
- {
- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string"
}
], - "staff": {
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string",
- "rank": "string"
}
}
取置きを打消取消します。指定された取置きに対して、返品する取置き情報を作成します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 取引ID |
terminalTranDateTime | string <date-time> (端末取引日時) 端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
更新成功
サンドボックス
本番
{- "terminalTranDateTime": "2023-12-01T10:09:41Z"
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "supplierProductNo": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "discriminationNo": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "inventoryReservationDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "discountPriceProportional": "string",
- "discountPointProportional": "string",
- "taxIncludeProportional": "string",
- "taxExcludeProportional": "string",
- "productBundleProportional": "string",
- "staffDiscountProportional": "string",
- "bargainDiscountProportional": "string",
- "roundingPriceProportional": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string"
}
], - "layaway": {
- "transactionHeadId": "string",
- "pickUpDate": "string",
- "status": "string",
- "partPayment": "string",
- "partPaymentClass": "string",
- "pickUpTransactionHeadId": "string",
- "disabledEdit": "string"
}
}
仮販売取引情報一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
transaction_date_time-to | string 取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
store_id | integer 店舗ID |
terminal_tran_date_time-from | string 端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
terminal_tran_date_time-to | string 端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD] |
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) |
取得成功
サンドボックス
本番
[- {
- "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",
- "storeCode": "string",
- "terminalId": "string",
- "customerId": "string",
- "customerCode": "string",
- "terminalTranId": "string",
- "terminalTranDateTime": "string",
- "customerGroupId": "string",
- "customerGroupId2": "string",
- "customerGroupId3": "string",
- "customerGroupId4": "string",
- "customerGroupId5": "string",
- "staffId": "string",
- "staffCode": "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
]
}
]
仮販売取引を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
transactionHeadDivision required | string (取引区分) Value: 1 取引を識別する区分。 |
status required | string (ステータス) Value: 0 仮販売のステータス。(0:通常、1:完了、2:取消) |
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 ] 小計値引き/割引時に指定された区分を設定。 |
pointDiscount | string <int> (ポイント値引き) [ -999999999 .. 999999999 ] 使用ポイント * ポイント還元率。 |
total required | string <int> (合計) [ -999999999 .. 999999999 ] 小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額 を設定 |
taxInclude | string <int> (内税額) [ -999999999 .. 999999999 ] 内税商品計 / 110 * 10。 |
taxExclude | string <int> (外税額) [ -999999999 .. 999999999 ] 外税商品計 * 10 / 100。 |
roundingDivision | string (端数値引区分) Enum: "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 取引で付与されるポイント。 合計 * ポイント付与率 |
spendPoint | string <int> (使用ポイント) [ -999999999 .. 999999999 ] 取引で使用したポイント。 |
point | string <int> (現在ポイント) [ -999999999 .. 999999999 ] 取引前のポイント。 |
totalPoint | string <int> (合計ポイント) [ -999999999 .. 999999999 ] 取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。 |
storeId required | string <int> (店舗ID) [ 1 .. 999999999 ] 店舗毎に付与するID。 |
terminalId required | string <int> (端末ID) [ 1 .. 999999999 ] 店舗の端末毎に付与するID。 |
customerId | string <int> (会員ID) [ 1 .. 9999999999 ] 会員毎に付与するID。 |
customerCode | string (会員コード) <= 20 characters /^[ -~]+$/ 会員毎に付与する一意のコード。 |
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) |
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:免税販売(自動計算・合算)) |
netTaxFreeGeneralTaxInclude | string <int> (内税商品の一般品免税額) [ -999999999 .. 999999999 ] 内税商品の一般品免税額。 |
netTaxFreeGeneralTaxExclude | string <int> (外税商品の一般品免税額) [ -999999999 .. 999999999 ] 外税商品の一般品免税額。 |
netTaxFreeConsumableTaxInclude | string <int> (内税商品の消耗品免税額) [ -999999999 .. 999999999 ] 内税商品の消耗品免税額。 |
netTaxFreeConsumableTaxExclude | string <int> (外税商品の消耗品免税額) [ -999999999 .. 999999999 ] 外税商品の消耗品免税額。 |
tags | string (取引タグ) <= 255 characters レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。 |
mileageDivision | string (マイレージ利用区分) Default: 0 Enum: 0 1 2 マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める) |
mileageLabel | string (マイレージラベル) <= 32 characters マイレージの名称。未設定の場合は「マイル」 |
sellDivision | string (販売区分) Enum: 0 1 取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売) |
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 (取引明細) |
更新成功
サンドボックス
本番
{- "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": [
- {
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": 1,
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "taxDivision": 0,
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "quantity": "string",
- "categoryId": "string",
- "categoryName": "string",
- "salesDivision": 0,
- "productDivision": 0,
- "calcDiscount": 0,
- "taxFreeDivision": 0,
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "reduceTaxId": "string",
- "memo": "string"
}
]
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string",
- "productAttributes": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "code": "string",
- "name": "string"
}
]
}
]
}
仮販売取引情報を取得します。
sortで使用可能なパラメータ
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 仮販売取引ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
], - "store": {
- "storeId": "string",
- "storeCode": "string",
- "storeName": "string",
- "storeAbbr": "string",
- "printReceiptStoreName": "string",
- "displaySequence": "string"
}, - "customer": {
- "customerId": "string",
- "customerCode": "string",
- "customerNo": "string",
- "rank": "string",
- "staffRank": "string",
- "firstName": "string",
- "lastName": "string",
- "firstKana": "string",
- "lastKana": "string",
- "sex": "string",
- "birthDate": "string",
- "pointExpireDate": "string",
- "lastComeDateTime": "string",
- "entryDate": "string",
- "leaveDate": "string"
}, - "customerGroups": [
- {
- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string"
}
], - "staff": {
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string",
- "rank": "string"
}
}
指定された仮販売取引を削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 仮販売取引ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "既に完了済みの為、削除できません。",
- "status": 400
}
仮販売取引の状態を変更します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 仮販売取引ID |
status required | string (ステータス) Enum: 0 1 2 ステータス:仮販売のステータス。(0:通常、1:完了、2:取消) |
更新成功
サンドボックス
本番
{- "status": 0
}
{- "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": [
- {
- "transactionHeadId": "string",
- "transactionDetailId": "string",
- "parentTransactionDetailId": "string",
- "transactionDetailDivision": "string",
- "productId": "string",
- "productCode": "string",
- "productName": "string",
- "printReceiptProductName": "string",
- "color": "string",
- "size": "string",
- "groupCode": "string",
- "taxDivision": "string",
- "price": "string",
- "salesPrice": "string",
- "unitDiscountPrice": "string",
- "unitDiscountRate": "string",
- "unitDiscountDivision": "string",
- "cost": "string",
- "quantity": "string",
- "unitNonDiscountSum": "string",
- "unitDiscountSum": "string",
- "unitDiscountedSum": "string",
- "costSum": "string",
- "categoryId": "string",
- "categoryName": "string",
- "salesDivision": "string",
- "productDivision": "string",
- "pointNotApplicable": "string",
- "calcDiscount": "string",
- "taxFreeDivision": "string",
- "taxFreeCommodityPrice": "string",
- "taxFree": "string",
- "productBundleGroupId": "string",
- "productStaffDiscountRate": "string",
- "staffRank": "string",
- "staffRankName": "string",
- "staffDiscountRate": "string",
- "staffDiscountDivision": "string",
- "applyStaffDiscountRate": "string",
- "applyStaffDiscountPrice": "string",
- "bargainId": "string",
- "bargainName": "string",
- "bargainDivision": "string",
- "bargainValue": "string",
- "applyBargainValue": "string",
- "applyBargainDiscountPrice": "string",
- "taxRate": "string",
- "standardTaxRate": "string",
- "modifiedTaxRate": "string",
- "reduceTaxId": "string",
- "reduceTaxName": "string",
- "reduceTaxRate": "string",
- "reduceTaxPrice": "string",
- "reduceTaxMemberPrice": "string",
- "memo": "string"
}
]
}
月別予算を取得します。
sortで使用可能なパラメータ
■予算年月(YYYYMM形式)
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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] |
upd_date_time-to | string 更新日時(to):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "ym": "string",
- "salesTargetMonthly": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
日別予算情報を月単位で取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 店舗ID |
year required | string 年:予算年月の年。(YYYY形式) |
month required | string 月:予算年月の月。(MM形式) |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
day | string 日:予算年月の日。(DD形式) |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "ym": "string",
- "day": "string",
- "salesTargetDaily": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
日別予算情報を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
day required | string (日) ^(0[1-9]|[12]\d|3[01])$ 予算年月の日。(DD形式) |
salesTargetDaily required | string <int> (売上金額予算額) [ 1 .. 999999999999999 ] 売上金額の目標額。(最大15桁) |
取得成功
サンドボックス
本番
{- "day": "string",
- "salesTargetDaily": "string"
}
{- "storeId": "string",
- "ym": "string",
- "day": "string",
- "salesTargetDaily": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
日別予算情報を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
day required | string (日) ^(0[1-9]|[12]\d|3[01])$ 予算年月の日。(DD形式) |
salesTargetDaily required | string <int> (売上金額予算額) [ 1 .. 999999999999999 ] 売上金額の目標額。(最大15桁) |
取得成功
サンドボックス
本番
{- "day": "string",
- "salesTargetDaily": "string"
}
{- "storeId": "string",
- "ym": "string",
- "day": "string",
- "salesTargetDaily": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
日別予算情報を削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
削除成功
指定した部門データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "2011年1月より前のデータは登録できません。",
- "status": 400
}
スタッフ別予算の一覧を取得します。
sortで使用可能なパラメータ
■スタッフID
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "ym": "string",
- "staffId": "string",
- "salesTargetStaff": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
スタッフ別予算情報を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
staffId required | string (スタッフID) 予算登録するスタッフID |
salesTargetStaff required | string <int> (スタッフ別の予算金額) [ 0 .. 999999999999999 ] スタッフ別の予算金額。(最大15桁) |
更新成功
サンドボックス
本番
{- "staffId": "string",
- "salesTargetStaff": "string"
}
{- "storeId": "string",
- "ym": "string",
- "staffId": "string",
- "salesTargetStaff": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
スタッフ別予算情報を削除します。
指定された店舗における指定された年月のスタッフ別予算がすべて削除されます。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDと年月のリソースが見つかりません",
- "status": "404"
}
スタッフ別予算情報を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
year required | string 予算年(YYYY) |
month required | string 予算月(MM) |
staff_id required | string スタッフID |
salesTargetStaff required | string <int> (スタッフ別の予算金額) [ 0 .. 999999999999999 ] スタッフ別の予算金額。(最大15桁) |
更新成功
サンドボックス
本番
{- "salesTargetStaff": "string"
}
{- "storeId": "string",
- "ym": "string",
- "staffId": "string",
- "salesTargetStaff": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
客層セクション情報一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "customerGroupSectionId": "string",
- "customerGroupSectionLabel": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
客層セクション情報を更新します。
指定した客層セクションが存在しない場合、登録処理となります。
客層セクションラベルが空文字の場合、削除処理となります。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 客層セクションID |
customerGroupSectionLabel required | string (客層セクションラベル) <= 85 characters 客層セクションラベル |
更新成功
サンドボックス
本番
{- "customerGroupSectionLabel": "string"
}
{- "customerGroupSectionId": "string",
- "customerGroupSectionLabel": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
客層情報一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
customer_group_section_id | string 客層セクションID |
display_flag | string Enum: 0 1 表示フラグ:端末で表示するか判定 (0:表示しない、1:表示する) |
取得成功
サンドボックス
本番
[- {
- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string",
- "displayFlag": 0,
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
客層情報を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
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 ] |
更新成功
サンドボックス
本番
{- "customerGroupSectionId": "string",
- "label": "string",
- "displayFlag": 1,
- "displaySequence": "string"
}
{- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string",
- "displayFlag": 0,
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
客層情報を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 客層ID |
customerGroupSectionId | string <int> (客層セクションID) [ 1 .. 99999 ] |
label | string (ラベル) <= 85 characters |
displayFlag | string (表示フラグ) Enum: 0 1 端末で表示するか判定 (0:表示しない、1:表示する) |
displaySequence | string <int> (表示順) [ 0 .. 99999 ] |
更新成功
指定された客層IDのリソースが見つからない場合
サンドボックス
本番
{- "customerGroupSectionId": "string",
- "label": "string",
- "displayFlag": 0,
- "displaySequence": "string"
}
{- "customerGroupId": "string",
- "customerGroupSectionId": "string",
- "label": "string",
- "displayFlag": 0,
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
客層情報を削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 客層ID |
削除成功
指定された客層IDのリソースが見つからない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
仕入先情報一覧を取得します。
pos.suppliers:read
) UserAccessToken (pos.suppliers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
supplier_id | any 仕入先ID |
supplier_code | any 仕入先コード |
supplier_division_id | any 仕入先区分ID |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
仕入先情報を登録します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
supplierCode required | string (仕入先コード) <= 10 characters ^[ -~]+$ ユニーク値 仕入先コード |
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 ] 発注先優先度 |
更新成功
サンドボックス
本番
{- "supplierCode": "string",
- "supplierDivisionId": "string",
- "supplierName": "string",
- "supplierAbbr": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "mailAddress": "user@example.com",
- "staffName": "string",
- "orderPriority": "string"
}
{- "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"
}
仕入先情報を更新します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
id required | string 仕入先ID |
supplierCode | string (仕入先コード) <= 10 characters ^[ -~]+$ ユニーク値 仕入先コード |
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 ] 発注先優先度 |
更新成功
サンドボックス
本番
{- "supplierCode": "string",
- "supplierDivisionId": "string",
- "supplierName": "string",
- "supplierAbbr": "string",
- "address": "string",
- "phoneNumber": "string",
- "faxNumber": "string",
- "mailAddress": "user@example.com",
- "staffName": "string",
- "orderPriority": "string"
}
{- "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"
}
仕入先情報を削除します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
id required | string 仕入先ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": "404"
}
仕入先商品の一覧を取得します。
sortで使用可能なパラメータ
■categoryId:部門ID
■productId:商品ID
pos.suppliers:read
) UserAccessToken (pos.suppliers:read
) contract_id required | string 契約ID |
supplier_id required | string 仕入先ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
category_id | string 部門ID |
product_id | string 商品ID |
取得成功
サンドボックス
本番
[- {
- "supplierId": "string",
- "categoryId": "string",
- "productId": "string",
- "insDateTime": "string"
}
]
仕入先商品を登録します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
supplier_id required | string 仕入先ID |
categoryId | string <int> (部門ID) [ 1 .. 999999999 ] 部門ID:仕入先で取り扱っている部門のID |
productId | string <int> (商品ID) [ 1 .. 999999999999999 ] 商品ID:仕入先で取り扱っている商品のID |
更新成功
サンドボックス
本番
{- "categoryId": "string",
- "productId": "string"
}
{- "supplierId": "string",
- "categoryId": "string",
- "productId": "string",
- "insDateTime": "string"
}
仕入先商品を削除します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) 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を指定します。 |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定された仕入先IDのリソースが見つかりません。",
- "status": 404
}
仕入先区分の一覧を取得します。
sortで使用可能なパラメータ
■supplierDivisionId:仕入先区分ID
■displaySequence:表示順
pos.suppliers:read
) UserAccessToken (pos.suppliers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
supplier_division_id | string 仕入先区分ID |
display_flag | string Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
取得成功
サンドボックス
本番
[- {
- "supplierDivisionId": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
仕入先区分を登録します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
name required | string (名称) <= 85 characters 名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順 |
displayFlag | string (有効/無効) Default: 1 Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
更新成功
サンドボックス
本番
{- "name": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "supplierDivisionId": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
指定された仕入先区分を更新します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
id required | string 仕入先区分ID |
name | string (名称) <= 85 characters 名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順 |
displayFlag | string (有効/無効) Default: 1 Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
更新成功
サンドボックス
本番
{- "name": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "supplierDivisionId": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
指定された仕入先区分を削除します。
pos.suppliers:write
) UserAccessToken (pos.suppliers:write
) contract_id required | string 契約ID |
id required | string 仕入先区分ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
店舗情報一覧を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
[- {
- "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": {
- "storeId": "string",
- "pointUseDivision": 0,
- "spendRate": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "pointGivingDivision": 1,
- "pointUseUnit": "string",
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": "string",
- "mileageDivision": 0
}, - "receiptPrintInfo": {
- "storeId": "string",
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "taxOfficeName": "string",
- "airPrintLogo": "string",
- "advertisementImage": "string",
- "giftReceiptImage": "string",
- "giftReceiptNote": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
]
店舗情報を登録します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
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] |
sumRefColumn | string (締め参照時間項目) Default: 0 Enum: 0 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 簡易バンドル販売画面の最大商品登録数を設定する。 |
maxDiscountRate | string <int> (最大値引率) [ 0 .. 100 ] 端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%) |
carriageDisplayFlag | string (送料・手数料表示フラグ) Default: 0 Enum: 0 1 送料・手数料を表示するフラグ。 |
terminalAdjustmentCashFlag | string (端末精算時の現金管理フラグ) Default: 1 Enum: 0 1 端末精算時に現金管理入力画面を表示するか否か |
terminalCheckCashFlag | string (端末検査時の現金管理フラグ) Default: 1 Enum: 0 1 端末精算時に現金管理入力画面を表示するか否か |
waiterAdjustmentDivision | string (ウェイター精算可能チェック区分) Default: 0 Enum: 0 1 未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ) |
savingAutoDivision | string (銀行預入金自動入力区分) Default: 0 Enum: 0 1 締め処理画面の銀行預入金を自動で設定するか否か |
savingAutoPrice | string <int> (銀行預入金自動入力金額) [ 0 .. 999999999 ] 銀行預入金が自動の場合、繰越準備金の金額を設定する。 |
cancelSettingDivision | string (取消設定区分) Default: 3 Enum: 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" 販売時の合計金額の端数を丸めるか否かを設定する |
discountRoundingDivision | string (割引丸め区分) Default: 0 Enum: 0 1 2 3 0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め |
cardCompanySelectDivision | string (カード会社選択区分) Default: 0 Enum: 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 (レシート印刷情報) |
更新成功
サンドボックス
本番
{- "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": {
- "pointUseDivision": 1,
- "spendRate": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "pointGivingDivision": 1,
- "pointUseUnit": "string",
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": "string",
- "mileageDivision": 0,
- "mileageLimit": "string"
}, - "receiptPrintInfo": {
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "taxOfficeName": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
{- "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": {
- "storeId": "string",
- "pointUseDivision": 0,
- "spendRate": "string",
- "pointGivingUnitPrice": null,
- "pointGivingUnit": null,
- "pointGivingDivision": 1,
- "pointUseUnit": null,
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": null,
- "mileageDivision": 0,
- "mileageLimit": null
}, - "receiptPrintInfo": {
- "storeId": "string",
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "airPrintLogo": "string",
- "advertisementImage": "string",
- "giftReceiptImage": "string",
- "giftReceiptNote": "string",
- "taxOfficeName": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
店舗情報を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_point_condition | string Default: "none" Enum: "all" "none" ポイント情報を付加するか(付加する場合はall, しない場合はnone) |
with_receipt_print_info | string Default: "none" Enum: "all" "none" レシート印刷情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": {
- "storeId": "string",
- "pointUseDivision": 0,
- "spendRate": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "pointGivingDivision": 1,
- "pointUseUnit": "string",
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": "string",
- "mileageDivision": 0
}, - "receiptPrintInfo": {
- "storeId": "string",
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "taxOfficeName": "string",
- "airPrintLogo": "string",
- "advertisementImage": "string",
- "giftReceiptImage": "string",
- "giftReceiptNote": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
店舗情報を更新します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 店舗ID |
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] |
sumRefColumn | string (締め参照時間項目) Default: 0 Enum: 0 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 簡易バンドル販売画面の最大商品登録数を設定する。 |
maxDiscountRate | string <int> (最大値引率) [ 0 .. 100 ] 端末で値引きができる率。下記の率を超える金額になると値引き出来なくなる。(単位:%) |
carriageDisplayFlag | string (送料・手数料表示フラグ) Default: 0 Enum: 0 1 送料・手数料を表示するフラグ。 |
terminalAdjustmentCashFlag | string (端末精算時の現金管理フラグ) Default: 1 Enum: 0 1 端末精算時に現金管理入力画面を表示するか否か |
terminalCheckCashFlag | string (端末検査時の現金管理フラグ) Default: 1 Enum: 0 1 端末精算時に現金管理入力画面を表示するか否か |
waiterAdjustmentDivision | string (ウェイター精算可能チェック区分) Default: 0 Enum: 0 1 未会計伝票が残った状態での精算を許可するか許可しないかを判定(ウェイター利用者のみ) |
savingAutoDivision | string (銀行預入金自動入力区分) Default: 0 Enum: 0 1 締め処理画面の銀行預入金を自動で設定するか否か |
savingAutoPrice | string <int> (銀行預入金自動入力金額) [ 0 .. 999999999 ] 銀行預入金が自動の場合、繰越準備金の金額を設定する。 |
cancelSettingDivision | string (取消設定区分) Default: 3 Enum: 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" 販売時の合計金額の端数を丸めるか否かを設定する |
discountRoundingDivision | string (割引丸め区分) Default: 0 Enum: 0 1 2 3 0:四捨五入、1:切り捨て、2:切り上げ、3:銀行丸め |
cardCompanySelectDivision | string (カード会社選択区分) Default: 0 Enum: 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 (レシート印刷情報) |
更新成功
サンドボックス
本番
{- "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": {
- "pointUseDivision": 1,
- "spendRate": "string",
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "pointGivingDivision": 1,
- "pointUseUnit": "string",
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": "string",
- "mileageDivision": 0,
- "mileageLimit": "string"
}, - "receiptPrintInfo": {
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "taxOfficeName": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
{- "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": {
- "storeId": "string",
- "pointUseDivision": 0,
- "spendRate": "string",
- "pointGivingUnitPrice": null,
- "pointGivingUnit": null,
- "pointGivingDivision": 1,
- "pointUseUnit": null,
- "pointSpendDivision": 1,
- "pointSpendLimitDivision": 0,
- "expireDivision": 0,
- "expireLimit": null,
- "mileageDivision": 0,
- "mileageLimit": null
}, - "receiptPrintInfo": {
- "storeId": "string",
- "header": "string",
- "footer": "string",
- "receiptTaxOfficeStampComment": "string",
- "airPrintLogo": "string",
- "advertisementImage": "string",
- "giftReceiptImage": "string",
- "giftReceiptNote": "string",
- "taxOfficeName": "string",
- "discountReceiptHeader": "string",
- "discountReceiptFooter": "string"
}
}
店舗情報を削除します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 店舗ID |
削除成功
指定した店舗データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
店舗と店舗分類項目との関連付け情報一覧を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "storeClassId": "string",
- "storeClassItemId": "string"
}
]
店舗と店舗分類項目との関連付けを削除します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
store_class_id required | string 店舗分類ID |
削除成功
店舗IDと店舗分類IDの組み合わせが店舗分類項目関連テーブルに存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
店舗分類情報一覧を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "storeClassId": "string",
- "storeClassName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
店舗分類情報を登録します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
storeClassName required | string (分類ラベル) <= 85 characters |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] |
更新成功
サンドボックス
本番
{- "storeClassName": "string",
- "displaySequence": "string"
}
{- "storeClassId": "string",
- "storeClassName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
店舗分類情報を更新します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
store_class_id required | string 店舗分類ID |
storeClassName | string (分類ラベル) <= 85 characters |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] |
更新成功
入力チェックエラーの場合
店舗分類IDが存在しない場合
サンドボックス
本番
{- "storeClassName": "string",
- "displaySequence": "string"
}
{- "storeClassId": "string",
- "storeClassName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
店舗分類情報を削除します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
store_class_id required | string 店舗分類ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定された店舗分類IDのリソースが見つかりません",
- "status": 404
}
店舗分類項目情報一覧を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
id required | string 店舗分類ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "storeClassItemId": "string",
- "storeClassId": "string",
- "storeClassItemName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
店舗分類項目情報を登録します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 店舗分類ID |
storeClassItemName required | string (店舗分類項目名) <= 85 characters |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] |
更新成功
サンドボックス
本番
{- "storeClassItemName": "string",
- "displaySequence": "string"
}
{- "storeClassItemId": "string",
- "storeClassId": "string",
- "storeClassItemName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
店舗分類項目情報を更新します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 店舗分類ID |
item_id required | string 店舗分類項目ID |
storeClassItemName | string (店舗分類項目名) <= 85 characters |
displaySequence | string <int> (表示順) [ 0 .. 999999999 ] |
更新成功
入力チェックエラーの場合
店舗分類項目IDが存在しない場合
サンドボックス
本番
{- "storeClassItemName": "string",
- "displaySequence": "string"
}
{- "storeClassItemId": "string",
- "storeClassId": "string",
- "storeClassItemName": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
店舗分類項目情報を削除します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 店舗分類ID |
item_id required | string 店舗分類項目ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "店舗分類項目が0件になるため削除できません",
- "status": 400
}
レジ端末の一覧を取得します。
pos.stores:read
) UserAccessToken (pos.stores:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:利用する) |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "terminalId": "string",
- "terminalName": "string",
- "cashDrawerId": "string",
- "uuid": "string",
- "selfCheckoutAvailableFlag": "string",
- "useStopDivision": "string",
- "transactionEditableFlag": "string",
- "smartIdEngineAvailableFlag": "string",
- "creditTerminalId": "string",
- "parentTerminalId": "string",
- "appVersion": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
レジ端末を登録します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
storeId required | string <int> (店舗ID) [ 1 .. 999999999 ] 店舗毎に付与する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 対象プラン プレミアムプラス/フードビジネス/リテールビジネス |
smartIdEngineAvailableFlag | string (Smart ID Engine利用フラグ) Default: 0 Enum: 0 1 対象プラン リテールビジネス |
creditTerminalId | string <int> (CAT/CCT端末ID) [ 1 .. 999999999 ] レジ端末に紐付けるCAT/CCT端末のID |
cashDrawerId | string <int> (キャッシュドロアID) [ 1 .. 999999999 ] レジ端末を登録するキャッシュドロアのID |
parentTerminalId | string <int> (親端末ID) [ 1 .. 999999999 ] 親端末として登録するレジ端末の端末ID |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "terminalName": "string",
- "uuid": "string",
- "useStopDivision": 0,
- "transactionEditableFlag": 0,
- "selfCheckoutAvailableFlag": 0,
- "smartIdEngineAvailableFlag": 0,
- "creditTerminalId": "string",
- "cashDrawerId": "string",
- "parentTerminalId": "string"
}
[- {
- "terminalId": "string",
- "storeId": "string",
- "terminalName": "string",
- "uuid": "string",
- "useStopDivision": 0,
- "transactionEditableFlag": 0,
- "selfCheckoutAvailableFlag": 0,
- "smartIdEngineAvailableFlag": 0,
- "creditTerminalId": "string",
- "cashDrawerId": "string",
- "parentTerminalId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
レジ端末を更新します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 端末ID |
storeId | string <int> (店舗ID) [ 1 .. 999999999 ] 店舗毎に付与する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 対象プラン プレミアムプラス/フードビジネス/リテールビジネス |
smartIdEngineAvailableFlag | string (Smart ID Engine利用フラグ) Enum: 0 1 対象プラン リテールビジネス |
creditTerminalId | string <int> (CAT/CCT端末ID) [ 1 .. 999999999 ] レジ端末に紐付けるCAT/CCT端末のID |
cashDrawerId | string <int> (キャッシュドロアID) [ 1 .. 999999999 ] レジ端末を登録するキャッシュドロアのID |
parentTerminalId | string <int> (親端末ID) [ 1 .. 999999999 ] 親端末として登録するレジ端末の端末ID |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "terminalName": "string",
- "uuid": "string",
- "useStopDivision": 0,
- "transactionEditableFlag": 0,
- "selfCheckoutAvailableFlag": 0,
- "smartIdEngineAvailableFlag": 0,
- "creditTerminalId": "string",
- "cashDrawerId": "string",
- "parentTerminalId": "string"
}
[- {
- "terminalId": "string",
- "storeId": "string",
- "terminalName": "string",
- "uuid": "string",
- "useStopDivision": 0,
- "transactionEditableFlag": 0,
- "selfCheckoutAvailableFlag": 0,
- "smartIdEngineAvailableFlag": 0,
- "creditTerminalId": "string",
- "cashDrawerId": "string",
- "parentTerminalId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
レジ端末を削除します。
pos.stores:write
) UserAccessToken (pos.stores:write
) contract_id required | string 契約ID |
id required | string 端末ID |
削除成功
親端末のIDを指定した場合
指定されたIDが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "親端末として設定されているため、削除できません。",
- "status": 400
}
スタッフ情報一覧を取得します。
pos.staffs:read
) UserAccessToken (pos.staffs:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:表示する) |
取得成功
サンドボックス
本番
[- {
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string",
- "staffNameKana": "string",
- "rank": "string",
- "displayFlag": "string",
- "displaySequence": "string",
- "loginStaffFlag": "string",
- "email": "user@example.com",
- "loginIpAddress": "string",
- "roleId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
スタッフ情報を取得します。
pos.staffs:read
) UserAccessToken (pos.staffs:read
) contract_id required | string 契約ID |
id required | string スタッフID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_stores | string Default: "none" Enum: "all" "none" 店舗情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
[- {
- "staffId": "string",
- "staffCode": "string",
- "staffName": "string",
- "staffNameKana": "string",
- "rank": "string",
- "displayFlag": "string",
- "displaySequence": "string",
- "loginStaffFlag": "string",
- "email": "user@example.com",
- "loginIpAddress": "string",
- "roleId": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "stores": [
- {
- "staffId": "string",
- "storeId": "string",
- "controlDivision": "string"
}
]
}
]
役割・役職の一覧を取得します。
sortで使用可能なパラメータ
■roleId:役割・役職ID
■updDateTime:更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
pos.staffs:read
) UserAccessToken (pos.staffs:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "roleId": "string",
- "roleName": "string",
- "note": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
役割・役職を登録します。
pos.staffs:write
) UserAccessToken (pos.staffs:write
) contract_id required | string 契約ID |
roleName required | string (役割名・役職名) <= 30 characters 役割名・役職名 |
note | string (説明) <= 255 characters 説明 |
functionControls | Array of objects (機能制限) 機能制限:POS機能における役割・役職に対する機能制限の一覧です。 |
inventoryFunctionControls | Array of objects (在庫機能制限) 対象プラン リテールビジネス |
alertFunctionControls | Array of objects (アラート機能制限) 対象プラン リテールビジネス |
更新成功
サンドボックス
本番
{- "roleName": "string",
- "note": "string",
- "functionControls": [
- {
- "functionId": 1,
- "controlDivision": 1
}
], - "inventoryFunctionControls": [
- {
- "functionId": 1,
- "controlDivision": 1
}
], - "alertFunctionControls": [
- {
- "alertType": 1,
- "controlDivision": 0
}
]
}
{- "roleId": "string",
- "roleName": "string",
- "note": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "functionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "inventoryFunctionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "alertFunctionControls": [
- {
- "alertType": "string",
- "controlDivision": "string"
}
]
}
役割・役職の一覧を取得します。
pos.staffs:read
) UserAccessToken (pos.staffs:read
) contract_id required | string 契約ID |
id required | string 役割・役職ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_function_controls | string Default: "none" Enum: "all" "none" 機能制限情報を付加するか(付加する場合はall, しない場合はnone) |
with_inventory_function_controls | string Default: "none" Enum: "all" "none" 対象プラン リテールビジネス |
with_alert_function_controls | string Default: "none" Enum: "all" "none" 対象プラン リテールビジネス |
取得成功
サンドボックス
本番
[- {
- "roleId": "string",
- "roleName": "string",
- "note": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "functionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "inventoryFunctionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "alertFunctionControls": [
- {
- "alertType": "string",
- "controlDivision": "string"
}
]
}
]
役割・役職を更新します。
pos.staffs:write
) UserAccessToken (pos.staffs:write
) contract_id required | string 契約ID |
id required | string 役割・役職ID |
roleName | string (役割名・役職名) <= 30 characters 対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス |
note | string (説明) <= 255 characters 対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス |
functionControls | Array of objects (機能制限) 機能制限:POS機能における役割・役職に対する機能制限の一覧です。 |
inventoryFunctionControls | Array of objects (在庫機能制限) 対象プラン リテールビジネス |
alertFunctionControls | Array of objects (アラート機能制限) 対象プラン リテールビジネス |
更新成功
サンドボックス
本番
{- "roleName": "string",
- "note": "string",
- "functionControls": [
- {
- "functionId": 1,
- "controlDivision": 1
}
], - "inventoryFunctionControls": [
- {
- "functionId": 1,
- "controlDivision": 1
}
], - "alertFunctionControls": [
- {
- "alertType": 1,
- "controlDivision": 0
}
]
}
{- "roleId": "string",
- "roleName": "string",
- "note": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "functionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "inventoryFunctionControls": [
- {
- "functionId": "string",
- "controlDivision": "string"
}
], - "alertFunctionControls": [
- {
- "alertType": "string",
- "controlDivision": "string"
}
]
}
役割・役職を削除します。
pos.staffs:write
) UserAccessToken (pos.staffs:write
) contract_id required | string 契約ID |
id required | string 役割・役職ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "役割・役職IDが 1:管理者 の役割・役職は削除できません。",
- "status": 400
}
指定された店舗の精算情報を取得します。
※ 精算日、精算日時、精算日時(from)・精算日時(to)のいずれかの指定が必須です
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
store_id required | integer 店舗ID |
terminal_id | integer 端末ID |
adjustment_date | string 精算日:精算を実施した日。 [YYYY-MM-DD] |
adjustment_date_time | string 精算日時:精算を実施した日時。 [YYYY-MM-DDThh:mm:ssTZD] |
adjustment_date_time-from | string 精算日時(From):[YYYY-MM-DDThh:mm:ssTZD] |
adjustment_date_time-to | string 精算日時(To):[YYYY-MM-DDThh:mm:ssTZD] |
取得成功
サンドボックス
本番
[- {
- "storeId": "string",
- "terminalId": "string",
- "adjustmentDateTime": "string",
- "childTerminals": [
- {
- "terminalId": "string"
}
], - "transactionCount": "string",
- "preparationCash": "string",
- "cashSales": "string",
- "creditSales": "string",
- "otherSalesList": [
- {
- "id": "string",
- "name": "string",
- "paymentMethodDivision": "string",
- "paymentMethodDivisionName": "string",
- "sales": "string"
}
], - "partPayment": "string",
- "partPaymentCash": "string",
- "partPaymentCredit": "string",
- "receivedDeposit": "string",
- "receivedDepositCash": "string",
- "receivedDepositCredit": "string",
- "partPaymentCancel": "string",
- "partPaymentCashCancel": "string",
- "partPaymentCreditCancel": "string",
- "tip": "string",
- "tipCash": "string",
- "tipCredit": "string",
- "deposit": "string",
- "returnDeposit": "string",
- "receipt": "string",
- "payment": "string",
- "nonSalesCashTotal": "string",
- "nonSalesCreditTotal": "string",
- "nonSalesOtherTotal": "string",
- "calculateBalance": "string",
- "cashAdjustment": {
- "realBalance": "string",
- "difference": "string",
- "saving": "string",
- "carryOver": "string",
- "tenThousandYen": "string",
- "fiveThousandYen": "string",
- "twoThousandYen": "string",
- "oneThousandYen": "string",
- "fiveHundredYen": "string",
- "oneHundredYen": "string",
- "fiftyYen": "string",
- "tenYen": "string",
- "fiveYen": "string",
- "oneYen": "string"
}
}
]
精算を実行します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
storeId required | string <int> (店舗ID) 店舗ID |
terminalId | string <int> (端末ID) 端末IDと端末UUIDのどちらかが必須。 |
uuid | string (端末UUID) 端末IDと端末UUIDのどちらかが必須。 |
cashAdjustment | object (現金精算情報) 現金精算を行う際のレジ内の現金状況を保持する。 |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "terminalId": "string",
- "uuid": "string",
- "cashAdjustment": {
- "preparationCash": "string",
- "saving": "string",
- "tenThousandYen": "string",
- "fiveThousandYen": "string",
- "twoThousandYen": "string",
- "oneThousandYen": "string",
- "fiveHundredYen": "string",
- "oneHundredYen": "string",
- "fiftyYen": "string",
- "tenYen": "string",
- "fiveYen": "string",
- "oneYen": "string"
}
}
{- "adjustmentDateTime": "string",
- "storeId": "string",
- "terminalId": "string"
}
日次締め情報一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 (1 〜 100) |
page | integer ページ |
sum_date | string 締め日 [YYYY-MM-DD] |
store_id | integer 店舗ID |
cash_drawer_id | integer ドロアID |
取得成功
サンドボックス
本番
[- {
- "sumDate": "string",
- "storeId": "string",
- "cashDrawerId": "string",
- "status": "string",
- "salesTotal": "string",
- "discount": "string",
- "pointDiscount": "string",
- "taxExcludeReceive": "string",
- "nonSalesTargetTotal": "string",
- "total": "string",
- "totalExcludeTax": "string",
- "totalExcludTax": "string",
- "inTaxSalesTotal": "string",
- "taxInclude": "string",
- "outTaxSalesTotal": "string",
- "taxExclude": "string",
- "taxTotal": "string",
- "taxDetailList": [
- {
- "taxRate": "string",
- "taxTotal": "string",
- "taxTargetTotal": "string",
- "taxFreeTotal": "string",
- "taxFreeTargetTotal": "string"
}
], - "nonTaxSalesTotal": "string",
- "taxFreeTotal": "string",
- "nonSalesTargetTaxFreeTotal": "string",
- "costTotal": "string",
- "grossMargin": "string",
- "amount": "string",
- "transactionCount": "string",
- "returnAmount": "string",
- "carriage": "string",
- "commission": "string",
- "preparationCash": "string",
- "cashSales": "string",
- "creditSales": "string",
- "otherSalesList": [
- {
- "id": "string",
- "name": "string",
- "paymentMethodDivision": "string",
- "paymentMethodDivisionName": "string",
- "sales": "string"
}
], - "otherSalseList": [
- {
- "id": "string",
- "name": "string",
- "paymentMethodDivision": "string",
- "paymentMethodDivisionName": "string",
- "sales": "string"
}
], - "partPayment": "string",
- "partPaymentCash": "string",
- "partPaymentCredit": "string",
- "receivedDepositCash": "string",
- "receivedDepositCashTotal": "string",
- "receivedDepositCreditTotal": "string",
- "partPaymentCancel": "string",
- "partPaymentCashCancel": "string",
- "partPaymentCreditCancel": "string",
- "deposit": "string",
- "returnDeposit": "string",
- "receipt": "string",
- "payment": "string",
- "nonSalesCashTotal": "string",
- "nonSalesCreditTotal": "string",
- "nonSalesOtherTotal": "string",
- "nonSalesTaxFreeTotal": "string",
- "changeDifference": "string",
- "calculateBalance": "string",
- "realBalance": "string",
- "difference": "string",
- "saving": "string",
- "carryOver": "string",
- "tenThousandYen": "string",
- "fiveThousandYen": "string",
- "twoThousandYen": "string",
- "oneThousandYen": "string",
- "fiveHundredYen": "string",
- "oneHundredYen": "string",
- "fiftyYen": "string",
- "tenYen": "string",
- "fiveYen": "string",
- "oneYen": "string",
- "comment": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "salesTotalNonSalesTargetDivision": "string",
- "totalTaxFreeDivision": "string"
}
]
締め処理を実行します。
※ 本処理は、スマレジ・アプリにおける手動締め処理に相当する処理です
※ 精算を実施した取引が締めの対象となります
※ キャッシュドロアを設定した店舗で締め処理を実施したい場合は管理画面から実施してください
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
sumDate required | string <date> 締め日:締め処理を実施する対象日。[YYYY-MM-DD] |
storeId required | string <int> (店舗ID) 店舗ID |
cashInfo | object (現金管理情報) 現金管理情報:「管理画面 > 日次締め画面 > 現金残高・現金管理」の入力可能項目に対応する値を設定します。 |
取得成功
サンドボックス
本番
{- "sumDate": "2023-12-01",
- "storeId": "string",
- "cashInfo": {
- "preparationCash": "string",
- "saving": "string",
- "tenThousandYen": "string",
- "fiveThousandYen": "string",
- "twoThousandYen": "string",
- "oneThousandYen": "string",
- "fiveHundredYen": "string",
- "oneHundredYen": "string",
- "fiftyYen": "string",
- "tenYen": "string",
- "fiveYen": "string",
- "oneYen": "string"
}
}
{- "sumDate": "string",
- "storeId": "string",
- "cashDrawerId": "string",
- "terminalIdList": "string"
}
消費税率一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
target_date | string 対象日:指定した場合、対象日時点で有効な消費税率を1件取得 [YYYY-MM-DD] |
取得成功
サンドボックス
本番
[- {
- "applyStartDate": "string",
- "taxRate": "string",
- "taxRounding": "string"
}
]
軽減税率一覧を取得します。
契約共通で固定のID値で設定されている軽減税率に加え、カスタム軽減税率として契約ごとに設定された軽減税率が取得できます。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
reduce_tax_id | string 軽減税率ID |
division | string 軽減税率区分:軽減税率の適用時、部門や商品にこの軽減税率が設定されている場合にこれをそのまま適用して販売するか、それとも状態(提供方法など)によって標準税率と軽減税率で適用税率を切り替えて販売するかの区分値が設定されます。 |
target_date | string 対象日:指定した場合、対象日時点で有効な軽減税率を取得します。 [YYYY-MM-DD] |
取得成功
サンドボックス
本番
[- {
- "reduceTaxId": "string",
- "name": "string",
- "division": "string",
- "rate": "string",
- "termStart": "string",
- "termEnd": "string",
- "condition": "string",
- "advancedCondition": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
但し書き(領収証)の一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:有効) |
取得成功
サンドボックス
本番
[- {
- "receiptProvisoCode": "string",
- "receiptProvisoName": "string",
- "initialValueFlag": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
支払方法の一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:有価証券である) |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
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円) |
pointGivingUnit | string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ] ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント) |
stores | Array of objects (支払方法取扱店舗) |
更新成功
サンドボックス
本番
{- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "unitPrice": "string",
- "displayFlag": 1,
- "displaySequence": "string",
- "changeFlag": 1,
- "paymentMethodGroupId": "string",
- "securitiesFlag": 1,
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "stores": [
- {
- "storeId": "string",
- "assignDivision": 0
}
]
}
{- "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": {
- "paymentMethodId": "string",
- "storeId": "string",
- "assignDivision": "string"
}
}
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string 支払方法ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_stores | string Default: "none" Enum: "all" "none" 支払方法取扱店舗を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
[- {
- "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": {
- "paymentMethodId": "string",
- "storeId": "string",
- "assignDivision": "string"
}
}
]
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 支払方法ID |
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円) |
pointGivingUnit | string <decimal> (ポイント付与単位(ポイント)) [ 0 .. 99999.99 ] ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント) |
stores | Array of objects (支払方法取扱店舗) |
更新成功
サンドボックス
本番
{- "paymentMethodCode": "string",
- "paymentMethodName": "string",
- "unitPrice": "string",
- "displayFlag": 1,
- "displaySequence": "string",
- "changeFlag": 1,
- "paymentMethodGroupId": "string",
- "securitiesFlag": 1,
- "pointGivingUnitPrice": "string",
- "pointGivingUnit": "string",
- "stores": [
- {
- "storeId": "string",
- "assignDivision": 0
}
]
}
{- "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": {
- "paymentMethodId": "string",
- "storeId": "string",
- "assignDivision": "string"
}
}
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 支払方法ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
指定した店舗が取扱っている支払方法の一覧を取得します。
sortで使用可能なパラメータ
■paymentMethodId : 支払方法ID
■paymentMethodCode : 支払方法コード
■unitPrice : 単価
■displaySequence : 表示番号
■updDateTime : 更新日時
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
store_id required | string 店舗ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:有価証券である) |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
支払方法分類の一覧を取得します。
sortで使用可能なパラメータ
■paymentMethodGroupId:支払方法分類ID
■code:コード
■displaySequence:表示順
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
payment_method_group_id required | integer 支払方法分類ID |
code | string コード:一意にするための値 |
display_flag | string Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
取得成功
サンドボックス
本番
[- {
- "paymentMethodGroupId": "string",
- "code": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
支払方法分類を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
name required | string (名称) <= 85 characters 名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順 |
displayFlag | string (有効/無効) Default: 1 Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
取得成功
サンドボックス
本番
{- "name": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "paymentMethodGroupId": "string",
- "code": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
支払方法分類を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 支払方法分類ID |
name | string (名称) <= 85 characters 名称 |
displaySequence | string <int> (表示順) [ 1 .. 999 ] 表示順 |
displayFlag | string (有効/無効) Default: 1 Enum: 0 1 有効/無効:端末で表示するかを設定。(0:無効、1:有効) |
取得成功
サンドボックス
本番
{- "name": "string",
- "displaySequence": "string",
- "displayFlag": 1
}
{- "paymentMethodGroupId": "string",
- "code": "string",
- "name": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
支払方法分類を削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string 支払方法分類ID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
クライアントIDに紐づく個別アプリ専用支払方法の一覧を取得します。
※現状、返却される支払方法は最大1つです。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
payment_method_id | string 個別アプリ専用支払方法ID:クライアントIDに紐づく、契約毎に一意な支払方法ID |
取得成功
サンドボックス
本番
[- {
- "paymentMethodId": "string",
- "paymentMethodName": "string"
}
]
個別アプリ専用支払方法を登録します。
クライアントIDに基づいて、契約毎に一意な支払方法IDを発行します。
※ 本APIで発行される支払方法IDは、取引登録APIでキャッシュレス決済時の伝票番号・金種・クレジットカード会社のデータを登録する場合に使用します。
※ 非有価証券・釣銭なしの支払方法として登録されます。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
paymentMethodName required | string (個別アプリ専用支払方法名) <= 20 characters |
更新成功
サンドボックス
本番
{- "paymentMethodName": "string"
}
{- "paymentMethodId": "string",
- "paymentMethodName": "string"
}
値引/割引区分の一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:有効) |
取得成功
サンドボックス
本番
[- {
- "discountDivision": "string",
- "awardType": "string",
- "discountDivisionName": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
クーポンの一覧を取得します。
sortで使用可能なパラメータ
■couponId:クーポンID
■updDateTime:更新日時
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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) |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
クーポンを登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
couponName required | string (クーポン名) <= 85 characters クーポン名 | ||||||||||||||||||||||||
couponDivision | string (クーポン区分) Default: 0 Enum: 0 1 クーポン区分:クーポン区分(0:通常、1:giftee) | ||||||||||||||||||||||||
serialNumber required | string (シリアル番号) <= 20 characters シリアル番号:端末側でのクーポンの入力に用いられます。 | ||||||||||||||||||||||||
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> (特典値) 特典値: 特典タイプに応じた値を設定。
| ||||||||||||||||||||||||
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:併用可能) |
更新成功
サンドボックス
本番
{- "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
}
{- "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"
}
指定されたクーポンを取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
id required | string クーポンID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_items | string Default: "none" Enum: "all" "none" クーポンアイテム情報を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
[- {
- "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",
- "items": {
- "couponItemId": "string",
- "couponId": "string",
- "division": "string",
- "itemId": "string",
- "type": "string",
- "salesPrice": "string"
}
}
]
指定されたクーポンを更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string クーポンID |
couponName | string (クーポン名) <= 85 characters クーポン名 | ||||||||||||||||||||||||
serialNumber | string (シリアル番号) <= 20 characters シリアル番号:端末側でのクーポンの入力に用いられます。 | ||||||||||||||||||||||||
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> (特典値) 特典値: 特典タイプに応じた値を設定。
| ||||||||||||||||||||||||
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:併用可能) |
更新成功
サンドボックス
本番
{- "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
}
{- "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"
}
指定されたクーポンを削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
id required | string クーポンID |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
クーポン商品を登録します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
coupon_id required | string クーポンID |
division required | string (クーポンアイテム区分) Enum: 1 2 3 クーポンアイテム区分:itemId の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード) |
itemId required | string <int> (アイテムID) <= 85 characters アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。 |
type required | string (クーポンアイテムタイプ) Enum: 1 2 クーポンアイテムタイプ(1:適用条件、2:商品付与) |
salesPrice | string <int> (販売価格) [ -9999999999 .. 9999999999 ] 販売価格:商品付与する際の価格を指定します。 |
更新成功
サンドボックス
本番
{- "division": 1,
- "itemId": "string",
- "type": 1,
- "salesPrice": "string"
}
{- "couponId": "string",
- "division": "string",
- "itemId": "string",
- "type": "string",
- "salesPrice": "string"
}
指定されたクーポン商品を更新します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
coupon_id required | string クーポンID |
type required | string Value: 2 クーポンアイテムタイプ(1:適用条件、2:商品付与) |
division required | string Value: 2 クーポンアイテム区分:item_id の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード) |
item_id required | string <= 85 characters アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。 |
salesPrice required | string <int> (販売価格) [ -9999999999 .. 9999999999 ] 販売価格:商品付与する際の価格を指定します。 |
更新成功
サンドボックス
本番
{- "salesPrice": "string"
}
{- "couponId": "string",
- "division": "string",
- "itemId": "string",
- "type": "string",
- "salesPrice": "string"
}
指定されたクーポン商品を削除します。
pos.transactions:write
) UserAccessToken (pos.transactions:write
) contract_id required | string 契約ID |
coupon_id required | string クーポンID |
type required | string Enum: 1 2 クーポンアイテムタイプ(1:適用条件、2:商品付与) |
division required | string Enum: 1 2 3 クーポンアイテム区分:item_id の値が何を示すものかを指定します。(1:部門ID、2:商品ID、3:グループコード) |
item_id required | string <= 85 characters アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。 |
削除成功
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたクーポンIDのリソースが見つかりません。",
- "status": 404
}
CAT/CCTカード会社の一覧を取得します。
pos.transactions:read
) UserAccessToken (pos.transactions:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "catCardCompanyCode": "string",
- "catCardCompanyName": "string",
- "kid": "string",
- "displaySequence": "string",
- "displayFlag": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
ロス情報一覧を取得します。
pos.losses:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
store_id | string 店舗ID |
division | string ロス区分:ロス区分一覧より設定可能。 |
取得成功
サンドボックス
本番
[- {
- "lossId": "string",
- "storeId": "string",
- "division": "string",
- "memo": "string",
- "lossDateTime": "string",
- "identificationNo": "string",
- "staffId": "string",
- "staffName": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
ロス情報を登録します。
pos.losses:write
) contract_id required | string 契約ID |
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) 登録時は明細は必須 |
取得成功
サンドボックス
本番
{- "storeId": "string",
- "division": "string",
- "memo": "string",
- "lossDateTime": "2023-12-01T10:09:42Z",
- "identificationNo": "string",
- "staffId": "string",
- "details": [
- {
- "productId": "string",
- "taxRate": "string",
- "quantity": "string"
}
]
}
{- "lossId": "string",
- "storeId": "string",
- "division": "string",
- "memo": "string",
- "lossDateTime": "string",
- "identificationNo": "string",
- "staffId": "string",
- "staffName": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "details": [
- {
- "lossDetailId": "string",
- "lossId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
ロス情報を取得します。
sortで使用可能なパラメータ
pos.losses:read
) contract_id required | string 契約ID |
id required | string ロスID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_details | string Default: "none" Enum: "all" "none" ロス明細を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "lossId": "string",
- "storeId": "string",
- "division": "string",
- "memo": "string",
- "lossDateTime": "string",
- "identificationNo": "string",
- "staffId": "string",
- "staffName": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "details": [
- {
- "lossDetailId": "string",
- "lossId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
}
ロスを更新します。
pos.losses:write
) contract_id required | string 契約ID |
id required | string ロスID |
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) ロス更新時にロス明細を追加登録できます |
取得成功
サンドボックス
本番
{- "division": "string",
- "memo": "string",
- "identificationNo": "string",
- "staffId": "string",
- "details": [
- {
- "lossDetailId": "string",
- "productId": "string",
- "taxRate": "string",
- "quantity": "string"
}
]
}
{- "lossId": "string",
- "division": "string",
- "memo": "string",
- "identificationNo": "string",
- "staffId": "string",
- "staffName": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "details": [
- {
- "lossDetailId": "string",
- "lossId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
ロス情報を削除します。
pos.losses:write
) contract_id required | string 契約ID |
id required | string ロスID |
削除成功
指定したロスデータが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
ロス明細情報を取得します。
pos.losses:read
) contract_id required | string 契約ID |
id required | string ロスID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
取得成功
サンドボックス
本番
[- {
- "lossDetailId": "string",
- "lossId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
ロス区分情報一覧を取得します。
pos.losses:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
active_flag | string Enum: 0 1 有効フラグ:0:無効 1:有効 |
取得成功
サンドボックス
本番
[- {
- "code": "string",
- "name": "string",
- "color": "string",
- "activeFlag": 0,
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
ロス区分を登録します。
pos.losses:write
) contract_id required | string 契約ID |
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 ] 表示順 |
取得成功
サンドボックス
本番
{- "name": "string",
- "color": "string",
- "activeFlag": 1,
- "displaySequence": "string"
}
{- "code": "string",
- "name": "string",
- "color": "string",
- "activeFlag": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
ロス区分を更新します。
pos.losses:write
) contract_id required | string 契約ID |
code required | string コード |
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 ] 表示順 |
取得成功
指定したロス区分データが存在しない場合
サンドボックス
本番
{- "name": "string",
- "color": "string",
- "activeFlag": 0,
- "displaySequence": "string"
}
{- "code": "string",
- "name": "string",
- "color": "string",
- "activeFlag": "string",
- "displaySequence": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
ロス区分情報を削除します。
pos.losses:write
) contract_id required | string 契約ID |
code required | string コード |
削除成功
指定したロス区分データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "NotFound",
- "detail": "指定されたIDのリソースが見つかりません",
- "status": 404
}
発注情報一覧を取得します。
pos.orders:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:仮発注) |
取得成功
サンドボックス
本番
[- {
- "storageInfoId": "string",
- "recipientOrderId": "string",
- "divisionUnit": 0,
- "categoryGroupId": "string",
- "orderedDate": "string",
- "memo": "string",
- "identificationNo": "string",
- "roundingDivision": 0,
- "status": 2,
- "staffId": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
発注を登録します。
pos.orders:write
) contract_id required | string 契約ID |
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:仮発注。 |
staffId | string <int> (スタッフID) 発注処理時のスタッフID |
products required | Array of objects (発注対象商品) 発注対象商品 |
stores required | Array of objects (発注対象店舗) 発注対象店舗 |
取得成功
サンドボックス
本番
{- "recipientOrderId": "string",
- "orderedDate": "2023-12-01",
- "memo": "string",
- "identificationNo": "string",
- "roundingDivision": 0,
- "status": 2,
- "staffId": "string",
- "products": [
- {
- "productId": "string",
- "taxRate": 0,
- "cost": "string",
- "deliveryStore": [
- {
- "storeId": "string",
- "quantity": "string"
}
]
}
], - "stores": [
- {
- "storageStoreId": "string",
- "storageExpectedDateFrom": "2023-12-01",
- "storageExpectedDateTo": "2023-12-01"
}
]
}
{- "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": [
- {
- "storageInfoProductId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "taxDivision": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "deliveryStore": [
- {
- "storageInfoDeliveryProductId": "string",
- "storeId": "string",
- "quantity": "string"
}
]
}
], - "stores": [
- {
- "storageInfoDeliveryId": "string",
- "storageInfoId": "string",
- "storageStoreId": "string",
- "storageExpectedDateFrom": "string",
- "storageExpectedDateTo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
発注情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 発注ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_products | string Default: "none" Enum: "all" "none" 発注対象商品、発注配送商品を付加するか(付加する場合はall, しない場合はnone) |
with_stores | string Default: "none" Enum: "all" "none" 発注対象店舗を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "storageInfoProductId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "taxDivision": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "deliveryStore": [
- {
- "storageInfoDeliveryProductId": "string",
- "storeId": "string",
- "quantity": "string"
}
]
}
], - "stores": [
- {
- "storageInfoDeliveryId": "string",
- "storageInfoId": "string",
- "storageStoreId": "string",
- "storageExpectedDateFrom": "string",
- "storageExpectedDateTo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
発注を更新します。
pos.orders:write
) contract_id required | string 契約ID |
id required | string 発注ID |
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:仮発注) |
staffId | string <int> (スタッフID) 発注処理時のスタッフID |
products | Array of objects (発注対象商品) 発注対象商品 |
stores | Array of objects (発注対象店舗) 発注対象店舗 |
取得成功
指定した発注データが存在しない場合
サンドボックス
本番
{- "recipientOrderId": "string",
- "orderedDate": "2023-12-01",
- "memo": "string",
- "identificationNo": "string",
- "roundingDivision": 0,
- "status": 2,
- "staffId": "string",
- "products": [
- {
- "storageInfoProductId": "string",
- "productId": "string",
- "taxRate": 0,
- "cost": "string",
- "deliveryStore": [
- {
- "storageInfoDeliveryProductId": "string",
- "storeId": "string",
- "quantity": "string"
}
]
}
], - "stores": [
- {
- "storageInfoDeliveryId": "string",
- "storageStoreId": "string",
- "storageExpectedDateFrom": "2023-12-01",
- "storageExpectedDateTo": "2023-12-01"
}
]
}
{- "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": [
- {
- "storageInfoProductId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "taxDivision": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "deliveryStore": [
- {
- "storageInfoDeliveryProductId": "string",
- "storeId": "string",
- "quantity": "string"
}
]
}
], - "stores": [
- {
- "storageInfoDeliveryId": "string",
- "storageInfoId": "string",
- "storageStoreId": "string",
- "storageExpectedDateFrom": "string",
- "storageExpectedDateTo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
発注情報を削除します。
pos.orders:write
) contract_id required | string 契約ID |
id required | string 発注ID |
削除成功
指定した発注データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "status:3 入荷検品中または入荷完了しているため発注情報を削除できません。",
- "status": 400
}
発注対象商品情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 発注ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
with_deliveries | string Default: "none" Enum: "all" "none" 配送先店舗付加フラグ:(none:付加しない、all:付加する) |
取得成功
指定した発注データが存在しない場合
サンドボックス
本番
[- {
- "storageInfoProductId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "taxDivision": 0,
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string",
- "deliveryStore": [
- {
- "storageInfoDeliveryProductId": "string",
- "storeId": "string",
- "quantity": "string"
}
]
}
]
発注対象店舗情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 発注ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
storage_store_id | string 配送店舗ID |
取得成功
指定した発注データが存在しない場合
サンドボックス
本番
[- {
- "storageInfoDeliveryId": "string",
- "storageInfoId": "string",
- "storageStoreId": "string",
- "storageExpectedDateFrom": "string",
- "storageExpectedDateTo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
入荷情報一覧を取得します。
pos.orders:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
storage_info_id | string 発注ID:発注登録から作成された入荷の場合のみ、発注IDを設定。 |
supplier_id | string 仕入先ID |
storage_store_id | string 入荷店舗ID |
storage_date | string 入荷日: |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
入荷を登録します。
pos.orders:write
) contract_id required | string 契約ID |
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:切り上げ) |
details required | Array of objects (入荷明細) 入荷明細 |
取得成功
サンドボックス
本番
{- "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": [
- {
- "productId": "string",
- "taxRate": 0,
- "cost": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "2023-12-01",
- "numberMemo": "string",
- "dateMemo": "2023-12-01",
- "compulsoryCompleteFlag": 0
}
]
}
{- "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": [
- {
- "storageDetailId": "string",
- "storageId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "numberMemo": "string",
- "dateMemo": "string",
- "status": 0,
- "compulsoryCompleteFlag": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
入荷情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 入荷ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_details | string Default: "none" Enum: "all" "none" 入荷明細を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "storageDetailId": "string",
- "storageId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "cost": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "rfidTags": [
- "string"
], - "numberMemo": "string",
- "dateMemo": "string",
- "status": 0,
- "compulsoryCompleteFlag": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
入荷を更新します。
pos.orders:write
) contract_id required | string 契約ID |
id required | string 入荷ID |
storageDate | string <date> (入荷日) 入荷日:対象データに入荷日が設定されていない場合必ず設定してください。設定済みの場合は設定不要。 |
identificationNo | string (識別番号) <= 32 characters 識別番号 入荷情報を管理するための任意の文字列を設定出来る項目。 |
details | Array of objects (入荷明細) 入荷明細 |
取得成功
サンドボックス
本番
{- "storageDate": "2023-12-01",
- "identificationNo": "string",
- "details": [
- {
- "storageDetailId": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "2023-12-01",
- "numberMemo": "string",
- "dateMemo": "2023-12-01",
- "compulsoryCompleteFlag": 0
}
]
}
{- "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": [
- {
- "storageDetailId": "string",
- "storageId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "numberMemo": "string",
- "dateMemo": "string",
- "status": 0,
- "compulsoryCompleteFlag": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
入荷明細情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 入荷ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
status | string Enum: 0 1 ステータス:0:未検品、1:検品完了 |
取得成功
サンドボックス
本番
[- {
- "storageDetailId": "string",
- "storageId": "string",
- "storageInfoId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "rfidTags": [
- "string"
], - "numberMemo": "string",
- "dateMemo": "string",
- "status": 0,
- "compulsoryCompleteFlag": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
出荷情報一覧を取得します。
pos.orders:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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での指定のみ |
取得成功
サンドボックス
本番
[- {
- "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"
}
]
出荷を登録します。
pos.orders:write
) contract_id required | string 契約ID |
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 ] 税率:出荷時の税率 |
identificationNo | string (識別番号) <= 32 characters 出荷情報を管理するための任意の文字列を設定出来る項目。 |
roundingDivision | string (税丸め) Enum: 0 1 2 税丸め(0:四捨五入、1:切り捨て、2:切り上げ) |
status required | string (出荷ステータス) Enum: 0 2 3 出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中) |
approvalStatus | string (承認ステータス) Enum: 0 1 2 承認ステータス:0:未承認, 1:承認済, 2:承認拒否 |
details required | Array of objects (出荷明細) 出荷明細 |
取得成功
サンドボックス
本番
{- "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": [
- {
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "memo": "string"
}
]
}
{- "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": [
- {
- "shipmentDetailId": "string",
- "shipmentId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "price": "string",
- "quantity": "string",
- "memo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出荷を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 出荷ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_details | string Default: "none" Enum: "all" "none" 出荷明細を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "shipmentDetailId": "string",
- "shipmentId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "price": "string",
- "quantity": "string",
- "memo": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出荷を更新します。
pos.orders:write
) contract_id required | string 契約ID |
id required | string 出荷ID |
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 ] 税率:出荷時の税率 |
identificationNo | string (識別番号) <= 32 characters 出荷情報を管理するための任意の文字列を設定出来る項目。 |
roundingDivision | string (税丸め) Enum: 0 1 2 税丸め(0:四捨五入、1:切り捨て、2:切り上げ) |
status | string (出荷ステータス) Enum: 0 2 3 出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中) |
approvalStatus | string (承認ステータス) Enum: 0 1 2 承認ステータス:0:未承認, 1:承認済, 2:承認拒否 |
details | Array of objects (出荷明細) 出荷明細 |
取得成功
サンドボックス
本番
{- "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": [
- {
- "shipmentDetailId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "quantity": "string",
- "memo": "string"
}
]
}
{- "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": [
- {
- "shipmentDetailId": "string",
- "shipmentId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "price": "string",
- "quantity": "string",
- "memo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出荷情報を削除します。
pos.orders:write
) contract_id required | string 契約ID |
id required | string 出荷ID |
削除成功
指定した出荷データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "在庫管理設定の出荷完了後の編集可否で編集不可が設定されているため、削除できません",
- "status": 400
}
出荷明細情報を取得します。
pos.orders:read
) contract_id required | string 契約ID |
id required | string 出荷ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
取得成功
サンドボックス
本番
[- {
- "shipmentDetailId": "string",
- "shipmentId": "string",
- "productId": "string",
- "taxRate": "string",
- "cost": "string",
- "price": "string",
- "quantity": "string",
- "memo": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
入庫情報一覧を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:入庫完了 |
取得成功
サンドボックス
本番
[- {
- "receivingId": "string",
- "shippingId": "string",
- "receivingStoreId": "string",
- "shippingStoreId": "string",
- "receivingExpectedDateFrom": "string",
- "receivingExpectedDateTo": "string",
- "receivingDate": "string",
- "memo": "string",
- "staffId": "string",
- "status": 0,
- "identificationNo": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
指定した入庫情報を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
id required | string 入庫ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_details | string 明細取得フラグ:入庫明細を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "receivingDetailId": "string",
- "receivingId": "string",
- "productId": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "rfidTags": [
- "string"
], - "status": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
入庫を更新します。
入庫情報は出庫情報を登録後、status=1:未入庫 に設定されたときに自動生成されます。
入庫明細を本APIで新規追加した場合、status=1:検品中 のままとなり、検品完了しません。
スマレジ管理画面上で出庫修正依頼を実施して下さい。
pos.transfers:write
) contract_id required | string 契約ID |
id required | string 入庫ID |
receivingDate required | string <date> (入庫日) 入庫日:[YYYY-MM-DD] |
memo | string (メモ) <= 1000 characters メモ:(出庫情報のメモと共有される) |
staffId | string <int> (スタッフID) [ 1 .. 999999999999999 ] スタッフID |
details | Array of objects (入庫明細) 入庫明細 |
取得成功
サンドボックス
本番
{- "receivingDate": "2023-12-01",
- "memo": "string",
- "staffId": "string",
- "details": [
- {
- "receivingDetailId": "string",
- "productId": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "2023-12-01"
}
]
}
{- "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": [
- {
- "receivingDetailId": "string",
- "receivingId": "string",
- "productId": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "status": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
入庫明細情報を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
id required | string 入庫ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
status | string Enum: 0 1 状態:商品の検品状況を設定。 0:未検品、1:検品完了 |
取得成功
サンドボックス
本番
[- {
- "receivingDetailId": "string",
- "receivingId": "string",
- "productId": "string",
- "scheduledQuantity": "string",
- "inspectionQuantity": "string",
- "stockoutQuantity": "string",
- "stockoutReason": "string",
- "inspectionDate": "string",
- "rfidTags": [
- "string"
], - "status": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
出庫情報一覧を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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 識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 |
取得成功
サンドボックス
本番
[- {
- "shippingId": "string",
- "receivingStoreId": "string",
- "shippingStoreId": "string",
- "receivingDesiredDate": "string",
- "receivingExpectedDateFrom": "string",
- "receivingExpectedDateTo": "string",
- "shippingDate": "string",
- "staffId": "string",
- "requestStaffId": "string",
- "memo": "string",
- "identificationNo": "string",
- "status": 0,
- "approvalStatus": 0,
- "approvalDateTime": "string",
- "modificationRequestStatus": 0,
- "modificationRequestDateTime": "string",
- "modificationRequestCheckedDateTime": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
出庫を登録します。
pos.transfers:write
) contract_id required | string 契約ID |
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 (出庫明細) 出庫明細 |
取得成功
サンドボックス
本番
{- "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": [
- {
- "productId": "string",
- "quantity": "string"
}
]
}
{- "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": [
- {
- "shippingDetailId": "string",
- "shippingId": "string",
- "productId": "string",
- "requestQuantity": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出庫依頼を登録します。
pos.transfers:write
) contract_id required | string 契約ID |
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 (出庫明細) 出庫明細 |
取得成功
サンドボックス
本番
{- "receivingStoreId": "string",
- "shippingStoreId": "string",
- "receivingDesiredDate": "2023-12-01",
- "requestStaffId": "string",
- "memo": "string",
- "identificationNo": "string",
- "details": [
- {
- "productId": "string",
- "requestQuantity": "string"
}
]
}
{- "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": [
- {
- "shippingDetailId": "string",
- "shippingId": "string",
- "productId": "string",
- "requestQuantity": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出庫情報を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
id required | string 出庫ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
with_details | string Default: "none" Enum: "all" "none" 明細取得フラグ:出庫明細を付加するか(付加する場合はall, しない場合はnone) |
取得成功
サンドボックス
本番
{- "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": [
- {
- "shippingDetailId": "string",
- "shippingId": "string",
- "productId": "string",
- "requestQuantity": "string",
- "quantity": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出庫を更新します。
承認ステータスの更新については出庫承認APIを実行して下さい。
出庫修正依頼については管理画面で操作して下さい。
pos.transfers:write
) contract_id required | string 契約ID |
id required | string 出庫ID |
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 状態:出庫/入庫の状況を設定。 |
details | Array of objects (出庫明細) 出庫明細 |
取得成功
サンドボックス
本番
{- "receivingExpectedDateFrom": "2023-12-01",
- "receivingExpectedDateTo": "2023-12-01",
- "shippingDate": "2023-12-01",
- "staffId": "string",
- "memo": "string",
- "identificationNo": "string",
- "status": 0,
- "details": [
- {
- "shippingDetailId": "string",
- "productId": "string",
- "quantity": "string"
}
]
}
{- "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": [
- {
- "shippingDetailId": "string",
- "shippingId": "string",
- "productId": "string",
- "requestQuantity": "string",
- "quantity": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
}
出庫情報を削除します。
pos.transfers:write
) contract_id required | string 契約ID |
id required | string 出庫ID |
削除成功
状態が2:入庫検品中、3:入庫完了のデータの場合
指定した出庫データが存在しない場合
サンドボックス
本番
{- "type": "about:blank",
- "title": "Bad Request",
- "detail": "入庫作業中のデータは削除できません",
- "status": 400
}
出庫承認ステータスを更新します。
未承認となっている出庫情報/出庫依頼情報に対し、出庫を承認/拒否する場合に本APIを実行します。
承認済にすると、承認ステータスが承認済、ステータスが未入庫(出庫済)の状態に更新します。
承認拒否にすると、承認ステータスが承認拒否の状態に更新します。
pos.transfers:write
) contract_id required | string 契約ID |
id required | string 出庫ID |
receivingExpectedDateFrom | string <date> (入庫予定日From) 入庫予定日From:[YYYY-MM-DD] |
receivingExpectedDateTo | string <date> (入庫予定日To) 入庫予定日To:[YYYY-MM-DD] |
shippingDate | string <date> (出庫日) 出庫日:[YYYY-MM-DD] |
memo | string (メモ) <= 1000 characters メモ |
approvalStatus required | string (承認ステータス) Default: 0 Enum: 0 1 2 承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認 |
取得成功
サンドボックス
本番
{- "receivingExpectedDateFrom": "2023-12-01",
- "receivingExpectedDateTo": "2023-12-01",
- "shippingDate": "2023-12-01",
- "memo": "string",
- "approvalStatus": 0
}
{- "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"
}
出庫明細情報を取得します。
pos.transfers:read
) contract_id required | string 契約ID |
id required | string 出庫ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
取得成功
サンドボックス
本番
[- {
- "shippingDetailId": "string",
- "shippingId": "string",
- "productId": "string",
- "requestQuantity": "string",
- "quantity": "string",
- "rfidTags": [
- "string"
], - "insDateTime": "string",
- "updDateTime": "string"
}
]
棚卸情報一覧を取得します。
pos.stocktaking:read
) contract_id required | string 契約ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
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:完了 |
取得成功
サンドボックス
本番
[- {
- "stocktakingInfoId": "string",
- "storeId": "string",
- "divisionUnit": 0,
- "stockCountDivision": 1,
- "targetDate": "string",
- "adjustmentDateTime": "string",
- "stocktakingInputCompleteDate": "string",
- "stocktakingCompleteDateTime": "string",
- "status": 0,
- "autoFollowingFlag": 0,
- "layawayStockIncludeFlag": 0,
- "insDateTime": "string",
- "updDateTime": "string"
}
]
棚卸対象部門情報を取得します。
pos.stocktaking:read
) contract_id required | string 契約ID |
id required | string 棚卸情報ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
取得成功
サンドボックス
本番
[- {
- "stocktakingInfoId": "string",
- "categoryId": "string"
}
]
棚卸対象商品情報を取得します。
pos.stocktaking:read
) contract_id required | string 契約ID |
id required | string 棚卸情報ID |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
category_id | string 部門ID:現在の商品マスタの部門ID |
取得成功
サンドボックス
本番
[- {
- "productId": "string",
- "categoryId": "string",
- "stocktakingQuantity": "string",
- "inputStocktakingQuantity": "string",
- "rfidTags": [
- "string"
], - "transportationStockQuantity": "string",
- "layawayStockQuantity": "string",
- "stockQuantityBeforeAdjustment": "string",
- "cost": "string",
- "memo": "string",
- "quantityModifiedDatetime": "string",
- "insDateTime": "string",
- "updDateTime": "string"
}
]
棚卸在庫一覧を取得します。棚卸在庫一覧とは、指定した棚卸の棚卸在庫数をもとに、指定日時点の在庫数量の計算結果を取得する機能です。
sortで使用可能なパラメータ
■商品ID:棚卸対象の商品IDを設定。
■部門ID:棚卸対象の商品の部門IDを設定。
pos.stocktaking:read
) contract_id required | string 契約ID |
stocktaking_info_id required | string 棚卸情報ID |
base_date required | string 基準日(YYYY-MM-DD) |
fields | array 検索パラメータ(カンマ区切りで指定可) |
sort | string 並び順(カンマ区切りで指定可) |
limit | integer 上限数 |
page | integer ページ |
product_id | string 商品ID |
category_id | string 部門ID |
取得成功
サンドボックス
本番
[- {
- "stocktakingInfoId": "string",
- "productId": "string",
- "categoryId": "string",
- "stockQuantity": "string",
- "stockMoney": "string",
- "transportationQuantity": "string",
- "transportationMoney": "string",
- "layawayQuantity": "string",
- "layawayMoney": "string",
- "storeId": "string"
}
]
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
categoryIds | array (部門IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "categoryIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
categoryGroupIds | array (部門グループIDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "categoryGroupIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
productIds | array (商品IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "productIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
productIds | array (商品IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "productIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
bargainIds | array (セールIDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "bargainIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
productOptionGroupIds | array (オプショングループIDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "productOptionGroupIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ids": [
- {
- "productOptionGroupId": "1",
- "productId": "1"
}, - {
- "productOptionGroupId": "1",
- "productId": "10"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
productBundleGroupIds | array (商品バンドルグループID) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "productBundleGroupIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ids": [
- {
- "productBundleGroupId": "1",
- "productBundleId": "10"
}, - {
- "productBundleGroupId": "1",
- "productBundleId": "11"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
supplierIds | array (仕入先IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "executed",
- "supplierIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "executed",
- "ids": [
- {
- "supplierId": "1",
- "division": "1",
- "targetId": "1"
}, - {
- "supplierId": "1",
- "division": "2",
- "targetId": "10"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
supplierDivisionIds | array (仕入先区分IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "executed",
- "supplierDivisionIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
storeIds | array (店舗IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "storeIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
terminalIds | array (レジ端末IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "terminalIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
staffIds | array (スタッフIDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "staffIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
roleIds | array (役割・役職ID) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "roleIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ids": [
- {
- "storeId": "1",
- "year": "2020",
- "month": "1"
}, - {
- "storeId": "1",
- "year": "2020",
- "month": "2"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
customerIds | array (会員IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "customerIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
transactionHeadIds | array (取引IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "edited",
- "transactionHeadIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ranks | array (会員ランクリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ranks": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
staffRanks | array (社員ランクリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "staffRanks": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
transactionHeadIds | array (取引IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "transactionHeadIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
transactionHeadIds | array (取引IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "transactionHeadIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
transactionHeadIds | array (取引IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "transactionHeadIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
transactionHeadIds | array (仮販売取引IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "transactionHeadIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
cashAdjustment | boolean (現金精算情報の有無) 現金精算情報がある場合: true、ない場合: false |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "executed",
- "ids": [
- {
- "storeId": "1",
- "terminalId": "5",
- "adjustmentDateTime": "2022-10-26T15:22:35+09:00"
}
], - "cashAdjustment": true
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "executed",
- "ids": [
- {
- "sumDate": "2020/09/01",
- "storeId": "1",
- "cashDrawerId": "0"
}, - {
- "sumDate": "2020/09/02",
- "storeId": "1",
- "cashDrawerId": "0"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
customerGroupIds | array (客層IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "customerGroupIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ids": [
- {
- "id": "1",
- "productId": "1",
- "storeId": "0"
}, - {
- "id": "10",
- "productId": "1",
- "storeId": "0"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
paymentMethodIds | array (支払方法IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "paymentMethodIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
paymentMethodGroupIds | array (支払方法分類IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "paymentMethodGroupIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
couponIds | array (クーポンID) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "couponIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
ids | Array of objects |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "ids": [
- {
- "couponId": "1",
- "type": "1",
- "division": "2",
- "itemId": "1"
}, - {
- "couponId": "1",
- "type": "2",
- "division": "2",
- "itemId": "10"
}
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
lossIds | array (ロスIDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "lossIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
codes | array (ロス区分コードリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "codes": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
storageInfoIds | array (発注IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "storageInfoIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
storageIds | array (入荷IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "storageIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
shipmentIds | array (出荷IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "shipmentIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
receivingIds | array (入庫IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "receivingIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
shippingIds | array (出庫IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "shippingIds": [
- "1",
- "10",
- "12"
]
}
Smaregi-Event | string イベント名 |
contractId | string (契約ID) |
event | string (イベント) |
action | string (アクション)
|
stocktakingInfoIds | array (棚卸IDリスト) |
サンドボックス
本番
{- "contractId": "string",
- "event": "string",
- "action": "created",
- "stocktakingInfoIds": [
- "1",
- "10",
- "12"
]
}