取引の取得
このピースでできることスマレジ の接続方法ステップ 1：workrun のリダイレクト URL を確認するステップ 2：スマレジ・デベロップスで OAuth クライアントを作成するステップ 3：workrun に接続を追加するピースの設定項目1. 上限数（任意）2. 取引日時 From（任意）3. 取引日時 To（任意）4. 取引区分（任意）5. 店舗（任意）6. 端末取引日時 From（任意）7. 端末取引日時 To（任意）8. 締め日 From（任意）9. 締め日 To（任意）10. 更新日時 From（任意）11. 更新日時 To（任意）12. 取引明細を付加（任意）13. 支払情報を付加（任意）14. 取置き情報を付加（任意）15. 取置き引取情報を付加（任意）16. 取引金操作情報を付加（任意）17. 販売時の商品属性情報を付加（任意）18. その他の項目（任意）
このピースでできること
- スマレジで指定した期間や店舗の取引情報一覧を取得します。
- 取引日時・端末取引日時・締め日・更新日時などの条件でフィルタリングできます。
- 取引明細・支払情報・取置き情報など、必要なデータを選択して付加できます。
スマレジ の接続方法
workrun と スマレジ を接続するには、スマレジ の OAuth クライアント（クライアントID・クライアントシークレット） および 契約ID が必要です。
ステップ 1：workrun のリダイレクト URL を確認する
- workrun で スマレジ のアクションをフローに追加します。
- 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
- 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。
ステップ 2：スマレジ・デベロップスで OAuth クライアントを作成する
- デベロッパーズアカウント を作成します。
- スマレジ・デベロップス にログインし、アプリを新規登録します。
- リダイレクトURI: ステップ 1 でコピーした URL を登録してください。
- スコープ: 以下をすべて有効化してください。
- pos.transactions:read
- pos.transactions:write
- pos.stores:read
- pos.staffs:read
- pos.customers:read
- pos.products:read
- 「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに応じたスコープも追加してください。
- 本番環境のスマレジで利用する場合、スマレジ管理画面の「利用状況」から契約IDを入力し、登録したアプリをアクティベートしてください。
- 契約IDはスマレジ管理画面の左上に表示されています。
- アプリの環境設定ページから クライアントID と クライアントシークレット をコピーします。
- 本番環境で利用する場合は、開発環境ではなく本番環境の値を使用してください。
ステップ 3：workrun に接続を追加する
- ステップ 1 の接続画面に戻り、以下の項目を入力します。
- 環境: 本番の場合は「本番」、サンドボックスの場合は「サンドボックス」を選択します。
- 契約ID: スマレジ管理画面の左上に表示されている契約IDを入力します。サンドボックスの場合は 形式です。
- スコープ: 利用するAPIのスコープをスペース区切りで入力します。初期値は標準スコープが設定されています。
- クライアントID と クライアントシークレット: ステップ 2 でコピーした値を入力します。
- 「接続」 をクリックするとスマレジの認証画面が開きます。
- スマレジにログインし、workrun に対するアクセスを 「許可」 します。
- 画面が自動で閉じ、接続が完了します。
ピースの設定項目
1. 上限数（任意）
- 取得する取引件数の上限を1〜300の範囲で指定します。300を超えた場合は300に丸められます。「取引明細を付加」で「全項目付加する」または「一部項目を付加する」を選択した場合は100以下のみ設定できます。
2. 取引日時 From（任意）
- 取得する取引の開始日時をISO 8601形式で入力します。取引日時・端末取引日時・締め日・更新日時のFrom/Toのうち、いずれか1つ以上を必ず指定してください。期間は最大31日間です。
3. 取引日時 To（任意）
- 取得する取引の終了日時をISO 8601形式で入力します。Fromと対でご利用ください。期間は最大31日間です。
4. 取引区分（任意）
- 絞り込む取引の区分をドロップダウンから選択します。通常・入金・出金・預かり金などから選べます。未選択の場合はすべての取引区分が対象です。
5. 店舗（任意）
- 絞り込む店舗をドロップダウンから選択します。スマレジの店舗情報が動的に取得されます。300件を超える場合は一部のみ表示されます。
6. 端末取引日時 From（任意）
- 端末側の取引日時の開始をISO 8601形式で入力します。
7. 端末取引日時 To（任意）
- 端末側の取引日時の終了をISO 8601形式で入力します。
8. 締め日 From（任意）
- 締め日の開始日をYYYY-MM-DD形式で入力します。
9. 締め日 To（任意）
- 締め日の終了日をYYYY-MM-DD形式で入力します。
10. 更新日時 From（任意）
- レコードの更新日時の開始をISO 8601形式で入力します。
11. 更新日時 To（任意）
- レコードの更新日時の終了をISO 8601形式で入力します。
12. 取引明細を付加（任意）
- 取引明細データを付加するかどうかを選択します。「全項目付加する」「一部項目を付加する」「しない」から選べます。「全項目付加する」を選択した場合、上限数は100以下に制限されます。
13. 支払情報を付加（任意）
- 支払情報をレスポンスに付加するかどうかを選択します。
14. 取置き情報を付加（任意）
- 取置き情報をレスポンスに付加するかどうかを選択します。
15. 取置き引取情報を付加（任意）
- 取置き引取情報をレスポンスに付加するかどうかを選択します。
16. 取引金操作情報を付加（任意）
- 取引金操作情報をレスポンスに付加するかどうかを選択します。
17. 販売時の商品属性情報を付加（任意）
- 販売時の商品属性情報をレスポンスに付加するかどうかを選択します。
18. その他の項目（任意）
- ページ番号・取引IDの範囲・会員コード・レシートNo.・バーコードなど、追加の検索パラメータを「項目名」と「値」のペアで指定します。複数指定できます。