日付チェック API
日付チェック ( app=dateCheck )の点検結果を参照する API の仕様です。
保存済みの点検結果を参照します。この API からの登録はできません。
共通の認証・ベースURLは 基本情報・認証仕様 を参照してください。
1. 🗺️ エンドポイント一覧
| メソッド | エンドポイント(クエリパラメータ) | 処理概要 |
|---|---|---|
| GET | ?app=dateCheck&docId={id} | 点検結果の単一取得 |
| GET | ?app=dateCheck&docId={id}&image={imageIndex} | 点検画像を 1 枚取得 |
| GET | ?app=dateCheck&date=YYYY-MM | 月次一覧取得(登録日基準) |
| GET | ?app=dateCheck&date=YYYY-MM-DD | 日次一覧取得(登録日基準) |
⚠️ 非対応スコープ(制限事項)
以下の操作およびデータ連携には対応していません。
- 点検結果の登録(POST)・修正・削除
- 確認・承認フローの実行
- 点検画像 URL(
imgFileURL)の返却。画像本体は、下記「画像の取り方」の手順で JPEG として取得できます。- NG 時のメール通知
- 製品マスタ・端末マスタの取得・更新
💡 画像の取り方
1件の点検結果に画像は複数枚あります。JSON には番号だけが入り、JPEG は番号ごとに別リクエストです。
imgFileURLは返しません。
GET {baseUrl}?app=dateCheck&docId={id}で点検結果を取得する。checkItemsのうちimageIndexがある項目だけ画像がある。- その番号ごとに
GET {baseUrl}?app=dateCheck&docId={id}&image={imageIndex}を呼ぶ。応答は JSON ではなくimage/jpegの 1 枚。認証はこれまで通りヘッダーのx-api-key。例:
imageIndexが0と1なら、画像の取得は 2 回です。
2. 📤 GET: 点検結果の取得
取得系APIにおいて、レスポンスに含まれるすべての日付・時刻フィールドは、 YYYY/MM/DD HH:mm の文字列形式に統一されて返却されます。 画像がある点検項目には imageIndex が付きます。画像本体の取得は上記「画像の取り方」と 2.5 を参照してください。
2.1 単一取得(docId 指定)
- Request:
GET {baseUrl}?app=dateCheck&docId=label_check_doc_id_11111
{
"data": [
{
"id": "label_check_doc_id_11111",
"userUID": "user_uid_example",
"shopUID": "xxxxxxxxxxxxxxxxxxxx",
"productName": "黒蜜かわらけ80g",
"allowableDays": 10,
"deviceName": "端末A",
"sender": "山田太郎",
"checkItems": [
{
"title": "ラベル",
"checkType": "label",
"readType": "barcode",
"value": "4901234567890",
"readLine": 1,
"datePatterns": [],
"dateSeparators": [],
"passOnly": false,
"isPassed": true,
"checkResult": "OK",
"imageIndex": 0
},
{
"title": "賞味期限",
"checkType": "date",
"readType": "",
"value": "",
"readLine": 1,
"datePatterns": ["YYYYMMDD", "YYMMDD"],
"dateSeparators": ["/", "-", ".", "年月日"],
"passOnly": true,
"isPassed": true,
"checkResult": "2026/08/20",
"imageIndex": 1
}
],
"isNormalForReport": true,
"registeredAt": "2026/08/20 00:00",
"sentAt": "2026/08/20 09:16",
"confirmedAt": "",
"confirmerName": "",
"approvedAt": "",
"approverName": "",
"createdAt": "2026/08/20 09:16",
"updatedAt": "2026/08/20 09:16"
}
]
}2.2 一覧取得(date 指定)
GET {baseUrl}?app=dateCheck&date=2026-08(月次一覧取得)GET {baseUrl}?app=dateCheck&date=2026-08-20(日次一覧取得)
date は YYYY/MM 、 YYYY/MM/DD 、ハイフン区切りのいずれも受け付けます。 範囲は管理画面の点検結果一覧と同じく、 registeredAt (端末送信時の当日 00:00)です。
💡 サーバー側での自動フィルタリング・ソート規則
- 認証されたAPIキーに紐づく
shopUIDのデータのみに自動制限されます。- データは 登録日順(
registeredAtの昇順) 、同じ登録日内においては 製品名順(productNameの昇順) 、さらに同じ製品名内では 送信日時順(sentAtの昇順) でソートして返却されます。
2.3 🗂️ 点検結果オブジェクト詳細定義(GETレスポンス)
| フィールドキー | 論理名 | データ型 | 概要・返却値のルール |
|---|---|---|---|
id | ドキュメントID | string | データベース上で一意に割り振られたドキュメントID。 |
productName | 製品名 | string | 点検対象の製品名。一覧の「製品名」に相当します。 |
allowableDays | 賞味期限許容日数 | number | 製品マスタの賞味期限許容日数。 |
deviceName | 端末名 | string | 送信した端末の名称。未設定のときは空文字です。 |
sender | 送信者名 | string | 点検を送信した担当者の氏名。 |
userUID | ユーザーID | string | 送信した端末ユーザーのID。 |
shopUID | 店舗ID | string | 点検結果が属する店舗ID。 |
checkItems | 点検項目 | array | 点検項目の配列。詳細は 2.4 を参照。 |
isNormalForReport | 点検結果 | boolean | 全点検項目が合格なら true (画面の OK)、1件でも不合格なら false (画面の NG)。 |
registeredAt | 登録日 | string | 端末送信時の当日 00:00。一覧の日付・月の絞り込みに使います。 |
sentAt | 送信日時 | string | 端末が点検結果を保存した日時。 |
createdAt | 作成日時 | string | ドキュメントの初回作成日時。 |
updatedAt | 更新日時 | string | ドキュメントの最終更新日時。 |
confirmedAt | 確認日時 | string | 管理画面で確認された日時。未確認時は ""。 |
confirmerName | 確認者氏名 | string | 確認を行ったユーザーの氏名。未確認時は ""。 |
approvedAt | 承認日時 | string | 管理画面で承認された日時。未承認時は ""。 |
approverName | 承認者氏名 | string | 承認を行ったユーザーの氏名。未承認時は ""。 |
2.4 点検項目(checkItems)
詳細画面の「点検画像」に並ぶ各項目です。 画面の点検値は、 checkType が label のとき value 、 date のとき checkResult です。
| フィールドキー | 論理名 | データ型 | 概要・返却値のルール |
|---|---|---|---|
title | 項目名 | string | 製品マスタの点検項目名。 |
checkType | 点検種別 | string | "label" (ラベル)または "date" (賞味期限)。 |
readType | 読み取り形式 | string | ラベルのとき "text" または "barcode" 。賞味期限のときは空文字。 |
value | 期待値 | string | ラベルの照合値。賞味期限のときは空文字。 |
readLine | 読み取り行数 | number | ラベル文字列の読み取り行数(1 / 2 / 3)。 |
datePatterns | 日付形式 | array | 賞味期限の日付形式( YYYYMMDD / YYMMDD )。 |
dateSeparators | 区切り文字 | array | 賞味期限の区切り文字。 |
passOnly | OKのみ送信 | boolean | 賞味期限で、合格時のみ送信できる設定か。 |
isPassed | 項目の合否 | boolean | 合格なら true (画面の OK)、不合格なら false (画面の NG)。 |
checkResult | 点検値 | string | ラベルは "OK" / "NG" 。賞味期限は読み取った日付文字列。 |
imageIndex | 画像番号 | number | 画像がある項目だけに付きます。 checkItems の番号で、2.5 の image に指定します。 |
2.5 点検画像の取得
点検結果の imageIndex を image に指定します。応答は JSON ではなく、その番号の JPEG 1 枚です。
- Request:
GET {baseUrl}?app=dateCheck&docId=label_check_doc_id_11111&image=0 - Response:
Content-Type: image/jpeg(JPEG ファイル本体)
2.1 の例には画像が 2 枚あります。ラベルは image=0 、賞味期限は image=1 で、上と同じ形の取得を 2 回します。
失敗したときの応答は次のとおりです。
| 条件 | HTTPステータス | レスポンスボディ |
|---|---|---|
docId が無い | 400 | docId query parameter is required for image |
image が 0 以上の整数でない | 400 | image must be a non-negative integer |
他店舗の docId | 403 | Forbidden |
| 結果が無い、またはその番号に画像が無い | 404 | Not Found |