diff --git a/api.md b/api.md index 030638c..3ccc077 100755 --- a/api.md +++ b/api.md @@ -1,20 +1,21 @@ FORMAT: 1A HOST: https://web.zaico.co.jp + + # zaico API Document このドキュメントはZAICO APIの機能と使うために必要なパラメータなどを説明するものです。 -
-バリエーションについて - -2024年9月4日にリリースしたバリエーション機能については現在公開APIから操作することはできません。 - -対応時期については決まり次第別途お知らせいたします。 - -ご不便をおかけしますが、ご了承のほどよろしくお願いいたします。 -
- -2025年10月14日更新 +2025年12月18日更新 diff --git a/dist/index.html b/dist/index.html index cdd28c0..2d57e7c 100644 --- a/dist/index.html +++ b/dist/index.html @@ -1,11 +1,11 @@ zaico API Document Back to top

zaico API Document

このドキュメントはZAICO APIの機能と使うために必要なパラメータなどを説明するものです。

バリエーションについて -

2024年9月4日にリリースしたバリエーション機能については現在公開APIから操作することはできません。

-

対応時期については決まり次第別途お知らせいたします。

+

2024年9月4日にリリースしたバリエーション機能については、現在一部の公開APIからのみ操作することができます。

+

その他のAPIの対応時期については決まり次第別途お知らせいたします。

ご不便をおかけしますが、ご了承のほどよろしくお願いいたします。

-

2024年11月27日更新

+

2025年12月18日更新

認証

認証について

GET

概要

@@ -50,6 +50,9 @@

概要

POST/api/v1/inventories

処理概要

@@ -264,6 +297,9 @@

注意事項 


 
    
@@ -524,6 +595,87 @@ 
    Example URI
    GET&
     "original_filename": "image.jpg",
     "url": "https://web.zaico.co.jp/files/image.jpg",
     "created_at": "2022-01-01 09:00:00"
+  },
+  "variant_setting_enabled": true,
+  "variant_setting": [
+    {
+      "variant_setting_item_id": 1,
+      "label": "ロット番号",
+      "item_type": "number",
+      "enabled_deadline_alert": false
+    },
+    {
+      "variant_setting_item_id": 2,
+      "label": "拠点",
+      "item_type": "text",
+      "enabled_deadline_alert": false
+    },
+    {
+      "variant_setting_item_id": 3,
+      "label": "利用期限",
+      "item_type": "date",
+      "enabled_deadline_alert": true,
+      "deadline_alert_day": 10
+    }
+  ],
+  "variants": {
+    "data": [
+      {
+        "items": [
+          {
+            "variant_setting_item_id": 1,
+            "label": "ロット番号",
+            "value": "100"
+          },
+          {
+            "variant_setting_item_id": 2,
+            "label": "拠点",
+            "value": "第一倉庫"
+          },
+          {
+            "variant_setting_item_id": 3,
+            "label": "利用期限",
+            "value": "2025/12/31"
+          }
+        ],
+        "quantity": 10,
+        "logical_quantity": 20,
+        "code": "tw202500000001",
+        "purchase_unit_price": 800,
+        "packing_slip_unit_price": 1000,
+        "created_at": "2025-10-10T15:02:01+09:00",
+        "updated_at": "2025-10-10T15:02:40+09:00",
+        "create_user_name": "田村 太郎"
+      },
+      {
+        "items": [
+          {
+            "variant_setting_item_id": 1,
+            "label": "ロット番号",
+            "value": "200"
+          },
+          {
+            "variant_setting_item_id": 2,
+            "label": "拠点",
+            "value": "第二倉庫"
+          },
+          {
+            "variant_setting_item_id": 3,
+            "label": "利用期限",
+            "value": "2026/01/31"
+          }
+        ],
+        "quantity": 15,
+        "logical_quantity": 30,
+        "code": "tw202500000002",
+        "purchase_unit_price": 700,
+        "packing_slip_unit_price": 900,
+        "created_at": "2025-10-10T15:05:06+09:00",
+        "updated_at": "2025-10-10T15:06:12+09:00",
+        "create_user_name": "田村 太郎"
+      }
+    ],
+    "total_count": 2
   }
 }
Schema
{
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -667,6 +819,27 @@ 
Example URI
GET&
           "description": "作成日時"
         }
       }
+    },
+    "variant_setting_enabled": {
+      "type": "boolean",
+      "description": "バリエーション設定が有効かどうか"
+    },
+    "variant_setting": {
+      "type": "array",
+      "description": "バリエーション設定情報"
+    },
+    "variants": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "array"
+        },
+        "total_count": {
+          "type": "number",
+          "description": "バリエーションデータの件数"
+        }
+      },
+      "description": "バリエーション情報"
     }
   }
 }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
@@ -1753,6 +1926,7 @@ 
Example URI
DELETE
 
 
  • memo : 出庫メモ
    • 
+
  • note: 納品書備考
    • 
 
  • created_at : 出庫データ作成日
    • 
 
  • updated_at : 出庫データ更新日
    • 
 
  • deliveries : 出庫データに登録している在庫データ一覧
@@ -1958,6 +2132,7 @@ 
    Example URI
    GET&
 
 
    • 
 
  • memo : 出庫メモ
    • 
+
  • note: 納品書備考
    • 
 
  • deliveries : 対象となる在庫データの配列
 
      
 
    • 以下のパラメータを含むオブジェクトを配列の要素とします
@@ -1967,6 +2142,23 @@ 
      Example URI
      GET&
 
    • unit_price : 納品単価
      • 
 
    • estimated_delivery_date : 出庫予定日
      • 
 
    • etc : 摘要・備考
      • 
+
    • variants : バリエーションデータ（登録済みのデータのみ指定できます）
+
        
+
      • 以下のパラメータを含むオブジェクトを配列の要素とします
+
          
+
        • items : 以下のパラメータを含むオブジェクトを配列の要素とします
+
            
+
          • label : バリエーションの項目名
            • 
+
          • value : バリエーションの値
            • 
+
          
+
          • 
+
        • quantity : バリエーション毎の入庫数量
          • 
+
        • unit_price : バリエーション毎の仕入単価
          • 
+
        • code : バーコードの値
          • 
+
        
+
        • 
+
      
+
      • 
 
    
 
    • 
 
@@ -2015,9 +2207,47 @@ 
    Example URI
    POSTdeliveries": [
     {
       "inventory_id": 1,
-      "quantity": 3,
+      "quantity": 25,
       "unit_price": 100,
-      "estimated_delivery_date": "2019-09-01"
+      "estimated_delivery_date": "2019-09-01",
+      "variants": [
+        {
+          "items": [
+            {
+              "label": "ロット番号",
+              "value": "100"
+            },
+            {
+              "label": "拠点",
+              "value": "第一倉庫"
+            },
+            {
+              "label": "利用期限",
+              "value": "2025/12/31"
+            }
+          ],
+          "quantity": 10,
+          "unit_price": 800
+        },
+        {
+          "items": [
+            {
+              "label": "ロット番号",
+              "value": "200"
+            },
+            {
+              "label": "拠点",
+              "value": "第二倉庫"
+            },
+            {
+              "label": "利用期限",
+              "value": "2026/01/31"
+            }
+          ],
+          "quantity": 15,
+          "unit_price": 700
+        }
+      ]
     }
   ],
   "shipping_instruction": {
@@ -2194,6 +2424,7 @@ 
    Example URI
    POST
 
 
  • memo : 出庫メモ
    • 
+
  • note: 納品書備考
    • 
 
  • created_at : 出庫データ作成日
    • 
 
  • updated_at : 出庫データ更新日
    • 
 
  • deliveries : 出庫データに登録している在庫データ一覧
@@ -2529,6 +2760,7 @@ 
    Example URI
    GET&
 
  • num : 出庫データ番号（ユーザーが任意に設定できる番号）
    • 
 
  • customer_name : 取引先名
    • 
 
  • memo : 出庫メモ
    • 
+
  • note: 納品書備考
    • 
 
  • deliveries : 対象となる在庫データの配列
 
      
 
    • 以下のパラメータを含むオブジェクトを配列の要素とします
@@ -2841,6 +3073,41 @@ 
      Example URI
      DELETEdate_of_issue: 納品書に記載される出庫日,
      • 
 
    • created_at: 登録日時
      • 
 
    • updated_at: 更新日時
      • 
+
    • variants : バリエーションデータ
+
        
+
      • 以下のパラメータを含むオブジェクトを配列の要素とします
+
          
+
        • data_key : 在庫毎にバリエーションデータを一意に識別するキー
          • 
+
        • quantity : バリエーション明細の出庫数量
          • 
+
        • unit_price : バリエーション明細の納品単価
          • 
+
        • amount : バリエーション明細の出庫金額
          • 
+
        • unit_snapshot : 単位情報のスナップショット
+
            
+
          • 以下のパラメータを含むオブジェクトとします
+
              
+
            • factor : まとめ単位の換算係数
              • 
+
            • piece_name : 基本単位の名称
              • 
+
            • box_name : まとめ単位の名称
              • 
+
            
+
            • 
+
          
+
          • 
+
        • box_quantity : まとめ単位での出庫数量
          • 
+
        • box_unit : まとめ単位の名称
          • 
+
        • items : 以下のパラメータを含むオブジェクトとします
+
            
+
          • id : 以下のパラメータを含むオブジェクトとします
+
              
+
            • id : バリエーションの項目ID
              • 
+
            • value : バリエーションの値
              • 
+
            
+
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      • 
 
    
 
    • 
 
@@ -2865,10 +3132,10 @@ 
    Example URI
    GET&
     "unit": "台",
     "unit_price": "100",
     "status": "completed_delivery",
-    "delivery_date": "2021",
+    "delivery_date": "2021-11-17",
     "estimated_delivery_date": "Hello, world!",
     "etc": "Hello, world!",
-    "date_of_issue": "2021",
+    "date_of_issue": "2021-11-17",
     "created_at": "2023-11-16 11:27:24",
     "updated_at": "2023-11-16 11:27:24"
   },
@@ -2880,12 +3147,32 @@ 
    Example URI
    GET&
     "unit": "台",
     "unit_price": "100",
     "status": "completed_delivery",
-    "delivery_date": "2021",
+    "delivery_date": "2021-11-17",
     "estimated_delivery_date": "Hello, world!",
     "etc": "Hello, world!",
-    "date_of_issue": "2021",
+    "date_of_issue": "2021-11-17",
     "created_at": "2023-11-16 11:27:24",
-    "updated_at": "2023-11-16 11:27:24"
+    "updated_at": "2023-11-16 11:27:24",
+    "variants": [
+      {
+        "data_key": "347554bad83fd5dc1624af2c97895e279eef35f8e252231169172d0fd96757df",
+        "quantity": 3,
+        "unit_price": 100,
+        "amount": 300,
+        "box_quantity": 3,
+        "box_unit": "台",
+        "items": {
+          "4": {
+            "id": 4,
+            "value": "20251217-A01-1000"
+          },
+          "5": {
+            "id": 5,
+            "value": "第一倉庫"
+          }
+        }
+      }
+    ]
   }
 ]
    Schema
    {
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -3104,6 +3391,23 @@ 
    Example URI
    GET&
 
  • unit_price : 仕入単価
    • 
 
  • estimated_purchase_date : 入庫予定日
    • 
 
  • etc : 摘要・備考
    • 
+
  • variants : バリエーションデータ
+
      
+
    • 以下のパラメータを含むオブジェクトを配列の要素とします
+
        
+
      • items : 以下のパラメータを含むオブジェクトを配列の要素とします
+
          
+
        • label : バリエーションの項目名
          • 
+
        • value : バリエーションの値
          • 
+
        
+
        • 
+
      • quantity : バリエーション毎の入庫数量
        • 
+
      • unit_price : バリエーション毎の仕入単価
        • 
+
      • code : バーコードの値
        • 
+
      
+
      • 
+
    
+
    • 
 
 
 
@@ -3119,9 +3423,47 @@ 
    Example URI
    POSTpurchase_items": [
     {
       "inventory_id": 1,
-      "quantity": 3,
+      "quantity": 25,
       "unit_price": 100,
-      "estimated_purchase_date": "2019-09-01"
+      "estimated_purchase_date": "2019-09-01",
+      "variants": [
+        {
+          "items": [
+            {
+              "label": "ロット番号",
+              "value": "100"
+            },
+            {
+              "label": "拠点",
+              "value": "第一倉庫"
+            },
+            {
+              "label": "利用期限",
+              "value": "2025/12/31"
+            }
+          ],
+          "quantity": 10,
+          "unit_price": 800
+        },
+        {
+          "items": [
+            {
+              "label": "ロット番号",
+              "value": "200"
+            },
+            {
+              "label": "拠点",
+              "value": "第二倉庫"
+            },
+            {
+              "label": "利用期限",
+              "value": "2026/01/31"
+            }
+          ],
+          "quantity": 15,
+          "unit_price": 700
+        }
+      ]
     }
   ]
 }
    Schema
    {
@@ -3586,6 +3928,41 @@ 
    Example URI
    DELETEetc: 摘要・備考
 
  • created_at: 登録日時
    • 
 
  • updated_at: 更新日時
    • 
+
  • variants : バリエーションデータ
+
      
+
    • 以下のパラメータを含むオブジェクトを配列の要素とします
+
        
+
      • data_key : 在庫毎にバリエーションデータを一意に識別するキー
        • 
+
      • quantity : バリエーション明細の入庫数量
        • 
+
      • unit_price : バリエーション明細の仕入単価
        • 
+
      • amount : バリエーション明細の入庫金額
        • 
+
      • unit_snapshot : 単位情報のスナップショット
+
          
+
        • 以下のパラメータを含むオブジェクトとします
+
            
+
          • factor : まとめ単位の換算係数
            • 
+
          • piece_name : 基本単位の名称
            • 
+
          • box_name : まとめ単位の名称
            • 
+
          
+
          • 
+
        
+
        • 
+
      • box_quantity : まとめ単位での入庫数量
        • 
+
      • box_unit : まとめ単位の名称
        • 
+
      • items : 以下のパラメータを含むオブジェクトとします
+
          
+
        • id : 以下のパラメータを含むオブジェクトとします
+
            
+
          • id : バリエーションの項目ID
            • 
+
          • value : バリエーションの値
            • 
+
          
+
          • 
+
        
+
        • 
+
      
+
      • 
+
    
+
    • 
 
 
 
@@ -3628,7 +4005,27 @@ 
    Example URI
    GET&
     "estimated_purchase_date": "Hello, world!",
     "etc": "Hello, world!",
     "created_at": "2023-11-16 11:27:24",
-    "updated_at": "2023-11-16 11:27:24"
+    "updated_at": "2023-11-16 11:27:24",
+    "variants": [
+      {
+        "data_key": "347554bad83fd5dc1624af2c97895e279eef35f8e252231169172d0fd96757df",
+        "quantity": 10,
+        "unit_price": 200,
+        "amount": 2000,
+        "box_quantity": 10,
+        "box_unit": "個",
+        "items": {
+          "2": {
+            "id": 2,
+            "value": "第一倉庫"
+          },
+          "3": {
+            "id": 3,
+            "value": "2023/11/30"
+          }
+        }
+      }
+    ]
   }
 ]
    Schema
    {
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -4621,7 +5018,7 @@ 
    Example URI
    POSTdescription": "エラー内容"
     }
   }
-}

    Generated by aglio on 25 Apr 2025