AIに聞くお問い合わせ
AIに聞くお問い合わせ
workrun ヘルプサイト/取引の登録

取引の登録

このピースでできること

  • スマレジに取引情報を新規登録します。
  • 販売した商品の明細（複数商品対応）と支払情報を合わせて登録できます。
  • 店舗・端末・会員・スタッフをドロップダウンから選択して紐付けられます。

スマレジ の接続方法

workrun と スマレジ を接続するには、スマレジ の OAuth クライアント（クライアントID・クライアントシークレット） および 契約ID が必要です。

ステップ 1：workrun のリダイレクト URL を確認する

  1. workrun で スマレジ のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
  1. 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。

ステップ 2：スマレジ・デベロップスで OAuth クライアントを作成する

  1. デベロッパーズアカウント を作成します。
  1. スマレジ・デベロップス にログインし、アプリを新規登録します。
      • リダイレクトURI: ステップ 1 でコピーした URL を登録してください。
      • スコープ: 以下をすべて有効化してください。
        • pos.transactions:read
        • pos.transactions:write
        • pos.stores:read
        • pos.staffs:read
        • pos.customers:read
        • pos.products:read
        • 「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに応じたスコープも追加してください。
  1. 本番環境のスマレジで利用する場合、スマレジ管理画面の「利用状況」から契約IDを入力し、登録したアプリをアクティベートしてください。
      • 契約IDはスマレジ管理画面の左上に表示されています。
  1. アプリの環境設定ページから クライアントID と クライアントシークレット をコピーします。
      • 本番環境で利用する場合は、開発環境ではなく本番環境の値を使用してください。

ステップ 3：workrun に接続を追加する

  1. ステップ 1 の接続画面に戻り、以下の項目を入力します。
      • 環境: 本番の場合は「本番」、サンドボックスの場合は「サンドボックス」を選択します。
      • 契約ID: スマレジ管理画面の左上に表示されている契約IDを入力します。サンドボックスの場合は 形式です。
      • スコープ: 利用するAPIのスコープをスペース区切りで入力します。初期値は標準スコープが設定されています。
      • クライアントID と クライアントシークレット: ステップ 2 でコピーした値を入力します。
  1. 「接続」 をクリックするとスマレジの認証画面が開きます。
  1. スマレジにログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。

ピースの設定項目

1. 取引区分（必須）

  • 登録する取引の種類をドロップダウンから選択します。通常の販売は「通常」を選択してください。ポイント加算・マイル加算などにも対応しています。

2. 取消区分（任意）

  • 取消取引の場合は「取消」を選択します。通常の取引では未選択（「通常」が適用）のままにしてください。

3. 小計（必須）

  • 取引の小計金額を数値で入力します。取引明細の合計と一致しない場合はエラーになります。

4. 合計（必須）

  • 税込の合計金額を数値で入力します。

5. 店舗（必須）

  • 取引を登録する店舗をドロップダウンから選択します。スマレジの店舗情報が動的に取得されます（休止中の店舗は除外されます）。

6. 端末（必須）

  • 取引を登録する端末をドロップダウンから選択します。店舗を選択すると、その店舗の端末のみ表示されます。

7. 端末取引 ID（必須）

  • 連携元システムで管理する取引の識別子を10文字以内で入力します。連番などを設定してください。

8. 端末取引日時（必須）

  • 取引が発生した日時をISO 8601形式で入力します。

9. 会員（任意）

  • 取引に紐付ける会員をドロップダウンから選択します。スマレジの会員情報が動的に取得されます。

10. スタッフ（任意）

  • 担当スタッフをドロップダウンから選択します。スマレジのスタッフ情報が動的に取得されます。

11. 取引明細（任意）

  • 販売した商品の明細を配列形式で入力します。各明細に「取引明細ID」「取引明細区分」「販売単価」「数量」が必須です。商品IDまたは商品コードで商品を指定します。

12. 支払情報（任意）

  • 支払方法と金額を配列形式で入力します。最大5件まで指定できます。各支払情報に「支払方法ID」「支払金額」が必須です。

13. その他の項目（任意）

  • 小計の値引き金額・メモ・レシートメモ・送料・手数料など、取引ヘッダの任意項目を「項目名」と「値」のペアで追加できます。