回数券取引一覧取得

GET

/transactions/product_sets

サンドボックス
本番

回数券取引の一覧を取得します。

※回数券機能が有効な契約でのみご利用いただけます。

対象プラン

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

Authorizations

AppAccessToken
pos.transactions:read
UserAccessToken
pos.transactions:read

Parameters

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

transactionProductSetId：回数券取引ID
purchaseDateTime：購入日時
expireDate：有効期限日
consumeDateTime：最終使用日時

limit

integer

上限数

page

integer

ページ

product_set_id

string

回数券商品ID：回数券の商品ID

customer_id

string

会員ID：回数券を購入した会員のID

purchase_date_time-from

string format: date-time

購入日時(From)：[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

purchase_date_time-to

string format: date-time

購入日時(To)：[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

consume_date_time-from

string format: date-time

最終使用日時(From)：回数券を最後に使用した日時[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

consume_date_time-to

string format: date-time

最終使用日時(To)：回数券を最後に使用した日時[YYYY-MM-DDThh:mm:ssTZD]
※ From〜Toの期間は最大31日までの指定でご利用ください

status

string

Allowed values: 0 1 2

回数券取引状態区分

0: 使用中
1: 使用完了
2: 期限切れ

with_products

string

default: none

Allowed values: all none

回数券対象商品情報を付加するか

all: 付加する
none: 付加しない

with_option_products

string

default: none

Allowed values: all none

回数券対象オプション商品情報を付加するか

all: 付加する
none: 付加しない

Responses

200

取得成功

Array<object>

object

transactionProductSetId

回数券取引ID：数字12桁以内
回数券取引毎に付与するID

string format: int

<= 12 characters

transactionHeadId

取引ID：数字12桁以内
回数券を購入した取引のID

string format: int

<= 12 characters

transactionDetailId

取引明細ID：数字3桁以内
回数券を購入した取引明細のID

string format: int

<= 3 characters

productSetId

回数券商品ID：数字15桁以内
回数券の商品ID

string format: int

<= 15 characters

productSetCode

回数券商品コード：半角英数記号20文字以内
回数券の商品コード

string

<= 20 characters

productSetName

回数券名：85文字以内
回数券の商品名

string

<= 85 characters

productSetPrice

回数券単価：回数券の商品単価

string format: int

>= -99999999 <= 99999999

productSetCategoryId

回数券部門ID：数字9桁以内
回数券の部門ID

string format: int

<= 9 characters

productSetCategoryName

回数券部門名：85文字以内
回数券の部門名

string

<= 85 characters

customerId

会員ID：数字10桁以内
回数券を購入した会員のID
※ 会員販売でない場合nullが設定されます。

string format: int

nullable <= 10 characters

purchaseDateTime

購入日時：回数券を購入した日時

string format: date-time

expireDate

有効期限日
※ 期限がない場合nullが設定されます。

string format: date

nullable

consumeDateTime

最終使用日時：回数券を最後に使用した日時
※ 未使用の場合nullが設定されます。

string format: date-time

nullable

status

回数券取引状態区分

0: 使用中
1: 使用完了
2: 期限切れ

string

Allowed values: 0 1 2

optionConsumeLimit

オプション使用上限数：オプション商品全体の使用上限数
※ オプションを登録していない場合nullが設定されます。

integer

nullable >= 1 <= 999

products

回数券対象商品

Array<object>

object

transactionProductSetId

回数券取引ID：数字12桁以内
回数券取引毎に付与するID

string format: int

<= 12 characters

transactionProductSetItemId

回数券取引明細ID

string format: int

productId

商品ID：数字15桁以内

string format: int

<= 15 characters

productCode

商品コード：半角英数記号20文字以内

string

<= 20 characters

productName

商品名：85文字以内

string

<= 85 characters

productPrice

商品単価

string format: int

>= -99999999 <= 99999999

categoryId

部門ID：数字9桁以内

string format: int

<= 9 characters

categoryName

部門名：85文字以内

string

<= 85 characters

consumeLimit

使用上限数：回数券使用上限数
※ 残数ではなく、回数券購入時の使用上限数になります。

integer

>= 1 <= 999

consumeCount

使用数：回数券使用済数量

integer

<= 999

optionProducts

回数券対象オプション商品

Array<object>

object

transactionProductSetId

回数券取引ID：数字12桁以内
回数券取引毎に付与するID

string format: int

<= 12 characters

transactionProductSetItemId

回数券取引明細ID

string format: int

productId

商品ID：数字15桁以内

string format: int

<= 15 characters

productCode

商品コード：半角英数記号20文字以内

string

<= 20 characters

productName

商品名：85文字以内

string

<= 85 characters

productPrice

商品単価

string format: int

>= -99999999 <= 99999999

categoryId

部門ID：数字9桁以内

string format: int

<= 9 characters

categoryName

部門名：85文字以内

string

<= 85 characters

consumeCount

使用数：回数券使用済数量

integer

<= 999

Example

[
  {
    "transactionProductSetId": "123456789012",
    "transactionHeadId": "123456789012",
    "transactionDetailId": "123",
    "productSetId": "123456789012345",
    "productSetCode": "string",
    "productSetName": "string",
    "productSetPrice": "12345678",
    "productSetCategoryId": "123456789",
    "productSetCategoryName": "string",
    "customerId": "1234567890",
    "purchaseDateTime": "2000-01-23T01:23:45+09:00",
    "expireDate": "2000-01-23",
    "consumeDateTime": "2000-01-23T01:23:45+09:00",
    "status": "0",
    "optionConsumeLimit": 123,
    "products": [
      {
        "transactionProductSetId": "123456789012",
        "transactionProductSetItemId": "1",
        "productId": "123456789012345",
        "productCode": "string",
        "productName": "string",
        "productPrice": "12345678",
        "categoryId": "123456789",
        "categoryName": "string",
        "consumeLimit": 123,
        "consumeCount": 123
      }
    ],
    "optionProducts": [
      {
        "transactionProductSetId": "123456789012",
        "transactionProductSetItemId": "1",
        "productId": "123456789012345",
        "productCode": "string",
        "productName": "string",
        "productPrice": "12345678",
        "categoryId": "123456789",
        "categoryName": "string",
        "consumeCount": 123
      }
    ]
  }
]

400

範囲指定の検索条件のうちのFrom/To片方しか設定されていない場合
範囲指定の検索条件におけるFrom-Toの範囲が上限を超えている場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "範囲の終了を指定して下さい。(QUERY PARAMETER-{QUERY PARAMETER})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "{範囲}の範囲で入力してください。(QUERY PARAMETER-{QUERY PARAMETER})",
  "status": 400
}