Back to top

ZAICO API Document

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

認証

認証について

GET

概要

ZAICO APIは認証にBearerトークン認証を採用しています。 リクエストを送る際、HTTPヘッダにAuthorization: Bearerをつけてください。

Authorization: Bearer YOUR_TOKEN_HERE

在庫データ

在庫データ一覧取得

GET/api/v1/inventories

処理概要

  • 自分のアカウントに登録されている在庫データのすべてを返します

  • 在庫データが1件も無い場合は、空の配列を返します

  • 棚卸し日は設定されている場合のみ表示されます

  • 発注点は設定されている場合のみ表示されます

  • 在庫データが1000件以上ある場合はページネーションで分割され、1000件ごと在庫データを返します

  • 任意のページを取得するにはURLにクエリ「page=」をつけることで取得できます。サンプルプログラムなど詳しくはこちらのページをご覧ください( https://www.zaico.co.jp/2019/03/29/zaico-api-update-get-inventories/ )

  • ページ情報はHTTPヘッダ"Link"に最初のページ、前のページ、次のページ、最後のページそれぞれ,(カンマ)で区切られ返されます。最初のページでは「前のページ」、最後のページでは「次のページ」項目は表示されません

  • Link, Total-Countヘッダは在庫一覧でのみ返されます

Example URI

GET https://web.zaico.co.jp/api/v1/inventories
Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Link: <https://web.zaico.co.jp/api/v1/inventories?page=1>; rel="first", <https://web.zaico.co.jp/api/v1/inventories?page=前のページ>; rel="prev", <https://web.zaico.co.jp/api/v1/inventories?page=次のページ>; rel="next", <https://web.zaico.co.jp/api/v1/inventories?page=最後のページ>; rel="last"
Total-Count: 在庫データ件数
Body
{
  "id": 1,
  "title": "在庫データ",
  "quantity": 10,
  "unit": "個",
  "category": "製品",
  "state": "新品",
  "place": "ZAICO倉庫",
  "etc": "備考",
  "code": "tw201800000000",
  "item_image": {
    "url": "itemimageurl"
  },
  "stocktake_attributes": {
    "checked_at": "2018-03-27T09:38:19+09:00"
  },
  "optional_attributes": [
    {
      "name": "追加項目名",
      "value": "追加項目値"
    }
  ],
  "quantity_management_attributes": [
    {
      "order_point_quantity": 5
    }
  ],
  "created_at": "2018-03-27T09:38:19+09:00",
  "updated_at `2018-03-27T09:38:19+09:00`": "",
  "create_user_name": "田村 太郎",
  "update_user_name": "田村 次郎",
  "user_group": "基本グループ"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID"
    },
    "title": {
      "type": "string",
      "description": "在庫データタイトル"
    },
    "quantity": {
      "type": "number",
      "description": "数量"
    },
    "unit": {
      "type": "string",
      "description": "単位"
    },
    "category": {
      "type": "string",
      "description": "カテゴリ"
    },
    "state": {
      "type": "string",
      "description": "状態"
    },
    "place": {
      "type": "string",
      "description": "保管場所"
    },
    "etc": {
      "type": "string",
      "description": "備考"
    },
    "code": {
      "type": "string",
      "description": "バーコードの値"
    },
    "item_image": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "画像URL"
        }
      }
    },
    "stocktake_attributes": {
      "type": "object",
      "properties": {
        "checked_at": {
          "type": "string",
          "description": "棚卸し日"
        }
      }
    },
    "optional_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "追加項目名"
          },
          "value": {
            "type": "string",
            "description": "追加項目値"
          }
        }
      }
    },
    "quantity_management_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_point_quantity": {
            "type": "number",
            "description": "発注点"
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "description": "作成日"
    },
    "updated_at `2018-03-27T09:38:19+09:00`": {
      "type": "string",
      "description": "更新日"
    },
    "create_user_name": {
      "type": "string",
      "description": "作成者"
    },
    "update_user_name": {
      "type": "string",
      "description": "更新者"
    },
    "user_group": {
      "type": "string",
      "description": "ユーザーグループ"
    }
  }
}

在庫データ作成

POST/api/v1/inventories

処理概要

  • 在庫データを作成します

注意事項

  • タイトルのみあれば作成可能です

  • 画像もつけてデータを作成する場合は、画像をbase64エンコードして送ってください

  • 送られたパラメータにタイトルが無い場合やデータが無い場合はエラーを返します

  • パースできないJSONを送るとエラーを返します

  • 存在しないユーザーグループを送るとエラーを返します

  • 変更履歴のメモも一緒に保存することが可能です。詳しくは下記Bodyをご覧ください

  • 棚卸し日はstocktake_attributes: { checked_at: 日付 }で登録・変更が可能です

  • 発注点を設定することも可能です

Example URI

POST https://web.zaico.co.jp/api/v1/inventories
Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Body
{
  "title": "在庫データ",
  "quantity": 10,
  "unit": "個",
  "category": "製品",
  "state": "新品",
  "place": "ZAICO倉庫",
  "etc": "備考",
  "code": "tw201800000000",
  "item_image": "base64-encoded-image",
  "stocktake_attributes": {
    "checked_at": "2018-03-27T09:38:19+09:00"
  },
  "optional_attributes": [
    {
      "name": "追加項目名",
      "value": "追加項目値"
    }
  ],
  "quantity_management_attributes": [
    {
      "order_point_quantity": 5
    }
  ],
  "inventory_history": {
    "memo": "変更履歴メモ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "在庫データタイトル"
    },
    "quantity": {
      "type": "number",
      "description": "数量"
    },
    "unit": {
      "type": "string",
      "description": "単位"
    },
    "category": {
      "type": "string",
      "description": "カテゴリ"
    },
    "state": {
      "type": "string",
      "description": "状態"
    },
    "place": {
      "type": "string",
      "description": "保管場所"
    },
    "etc": {
      "type": "string",
      "description": "備考"
    },
    "code": {
      "type": "string",
      "description": "バーコードの値"
    },
    "item_image": {
      "type": "string"
    },
    "stocktake_attributes": {
      "type": "object",
      "properties": {
        "checked_at": {
          "type": "string",
          "description": "棚卸し日"
        }
      }
    },
    "optional_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "追加項目名"
          },
          "value": {
            "type": "string",
            "description": "追加項目値"
          }
        }
      }
    },
    "quantity_management_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_point_quantity": {
            "type": "number",
            "description": "発注点"
          }
        }
      }
    },
    "inventory_history": {
      "type": "object",
      "properties": {
        "": {
          "type": "object",
          "properties": {}
        },
        "memo": {
          "type": "string",
          "description": "変更履歴のメモ"
        }
      }
    }
  },
  "required": [
    "title"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully created.",
  "data_id": 123456
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    },
    "data_id": {
      "type": "number",
      "description": "作成した在庫データのID"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "status": "error",
  "message": "error message"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 406,
  "status": "error",
  "message": "UserGroup is NOT exist"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}

在庫データ個別取得

GET/api/v1/inventories/{id}

処理概要

  • 在庫データを1件のみ取得します

  • 棚卸し日は設定されている場合のみ表示されます

  • 発注点は設定されている場合のみ表示されます

  • 在庫データが1000件以上ある場合はページネーションで分割され、1000件ごと在庫データを返します

注意事項

  • 在庫データが無い場合は404を返します

Example URI

GET https://web.zaico.co.jp/api/v1/inventories/1
URI Parameters
HideShow
id
number (required) Example: 1

在庫データのID

Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "title": "在庫データ",
  "quantity": 10,
  "unit": "個",
  "category": "製品",
  "state": "新品",
  "place": "ZAICO倉庫",
  "etc": "備考",
  "code": "tw201800000000",
  "item_image": {
    "url": "itemimageurl"
  },
  "stocktake_attributes": {
    "checked_at": "2018-03-27T09:38:19+09:00"
  },
  "optional_attributes": [
    {
      "name": "追加項目名",
      "value": "追加項目値"
    }
  ],
  "quantity_management_attributes": [
    {
      "order_point_quantity": 5
    }
  ],
  "created_at": "2018-03-27T09:38:19+09:00",
  "updated_at `2018-03-27T09:38:19+09:00`": "",
  "create_user_name": "田村 太郎",
  "update_user_name": "田村 次郎",
  "user_group": "基本グループ"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID"
    },
    "title": {
      "type": "string",
      "description": "在庫データタイトル"
    },
    "quantity": {
      "type": "number",
      "description": "数量"
    },
    "unit": {
      "type": "string",
      "description": "単位"
    },
    "category": {
      "type": "string",
      "description": "カテゴリ"
    },
    "state": {
      "type": "string",
      "description": "状態"
    },
    "place": {
      "type": "string",
      "description": "保管場所"
    },
    "etc": {
      "type": "string",
      "description": "備考"
    },
    "code": {
      "type": "string",
      "description": "バーコードの値"
    },
    "item_image": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "画像URL"
        }
      }
    },
    "stocktake_attributes": {
      "type": "object",
      "properties": {
        "checked_at": {
          "type": "string",
          "description": "棚卸し日"
        }
      }
    },
    "optional_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "追加項目名"
          },
          "value": {
            "type": "string",
            "description": "追加項目値"
          }
        }
      }
    },
    "quantity_management_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_point_quantity": {
            "type": "number",
            "description": "発注点"
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "description": "作成日"
    },
    "updated_at `2018-03-27T09:38:19+09:00`": {
      "type": "string",
      "description": "更新日"
    },
    "create_user_name": {
      "type": "string",
      "description": "作成者"
    },
    "update_user_name": {
      "type": "string",
      "description": "更新者"
    },
    "user_group": {
      "type": "string",
      "description": "ユーザーグループ"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 404,
  "status": "error",
  "message": "Inventory not found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}

在庫データ更新

PUT/api/v1/inventories/{id}

処理概要

  • 特定の在庫データを更新します

注意事項

  • タイトルのみあれば作成可能です

  • 画像もつけてデータを作成する場合は、画像をbase64エンコードして送ってください

  • 該当する在庫データが無い場合はエラーを返します

  • パースできないJSONを送るとエラーを返します

  • 存在しないユーザーグループを送るとエラーを返します

  • 変更履歴のメモも一緒に保存することが可能です。詳しくは下記Bodyをご覧ください

  • 棚卸し日はstocktake_attributes: { checked_at: 日付 }で登録・変更が可能です

  • 発注点を設定することも可能です

Example URI

PUT https://web.zaico.co.jp/api/v1/inventories/1
URI Parameters
HideShow
id
number (required) Example: 1

在庫データのID

Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Body
{
  "title": "在庫データ",
  "quantity": 10,
  "unit": "個",
  "category": "製品",
  "state": "新品",
  "place": "ZAICO倉庫",
  "etc": "備考",
  "code": "tw201800000000",
  "item_image": "base64-encoded-image",
  "stocktake_attributes": {
    "checked_at": "2018-03-27T09:38:19+09:00"
  },
  "optional_attributes": [
    {
      "name": "追加項目名",
      "value": "追加項目値"
    }
  ],
  "quantity_management_attributes": [
    {
      "order_point_quantity": 5
    }
  ],
  "inventory_history": {
    "memo": "変更履歴メモ"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "在庫データタイトル"
    },
    "quantity": {
      "type": "number",
      "description": "数量"
    },
    "unit": {
      "type": "string",
      "description": "単位"
    },
    "category": {
      "type": "string",
      "description": "カテゴリ"
    },
    "state": {
      "type": "string",
      "description": "状態"
    },
    "place": {
      "type": "string",
      "description": "保管場所"
    },
    "etc": {
      "type": "string",
      "description": "備考"
    },
    "code": {
      "type": "string",
      "description": "バーコードの値"
    },
    "item_image": {
      "type": "string"
    },
    "stocktake_attributes": {
      "type": "object",
      "properties": {
        "checked_at": {
          "type": "string",
          "description": "棚卸し日"
        }
      }
    },
    "optional_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "追加項目名"
          },
          "value": {
            "type": "string",
            "description": "追加項目値"
          }
        }
      }
    },
    "quantity_management_attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_point_quantity": {
            "type": "number",
            "description": "発注点"
          }
        }
      }
    },
    "inventory_history": {
      "type": "object",
      "properties": {
        "": {
          "type": "object",
          "properties": {}
        },
        "memo": {
          "type": "string",
          "description": "変更履歴のメモ"
        }
      }
    }
  },
  "required": [
    "title"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully updated."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 400,
  "status": "error",
  "message": "error message"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 404,
  "status": "error",
  "message": "Inventory not found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 406,
  "status": "error",
  "message": "UserGroup is NOT exist"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}

在庫データ削除

DELETE/api/v1/inventories/{id}

処理概要

  • 特定の在庫データを削除します

注意事項

  • 該当する在庫データが無い場合はエラーを返します

Example URI

DELETE https://web.zaico.co.jp/api/v1/inventories/1
URI Parameters
HideShow
id
number (required) Example: 1

在庫データのID

Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully deleted."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 404,
  "status": "error",
  "message": "Inventory not found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "ステータス"
    },
    "message": {
      "type": "string",
      "description": "エラー内容"
    }
  }
}

納品データ

納品データ一覧取得

納品データ一覧取得
GET/api/v1/packing_slips/

処理概要

  • 自分のアカウントに登録されている納品データのすべてを返します

  • 納品データが1件も無い場合は、空の配列を返します

  • 各納品データの項目について以下のようになります

    • id : 納品データID
    • num : 納品データ番号(ユーザーが任意に設定できる番号)
    • customer_name : 取引先名
    • status : 納品データの状態
      • 以下の2つのどちらかが設定されています
      • before_delivery : 納品前
      • completed_delivery : 納品済み
    • total_amount : 納品データの合計金額
    • delivery_date : 納品日
    • estimated_delivery_date : 納品予定日
      • この納品予定日は納品データの物品のうち、最も早い納品予定日を表示します
    • created_at : 納品データ作成日
    • updated_at : 納品データ更新日
    • deliveries : 納品データに登録している在庫データ一覧
      • inventory_id : 在庫データID
      • title : 物品名
      • quantity : 納品数量
      • unit : 単位
      • unit_price : 納品単価
      • status : 状態
        • 以下の2つのどちらかが設定されています
        • before_delivery : 納品前
        • completed_delivery : 納品済み
      • delivery_date : 納品日
      • estimated_delivery_date : 納品予定日
      • etc : 摘要・備考

Example URI

GET https://web.zaico.co.jp/api/v1/packing_slips/
Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 10,
    "num": "100",
    "customer_name": "株式会社ZAICO",
    "status": "completed_delivery",
    "total_amount": 1000,
    "delivery_date": "2019-09-01",
    "estimated_delivery_date": null,
    "created_at": "2018-03-27T09:38:19+09:00",
    "updated_at": "2018-03-27T09:38:19+09:00",
    "deliveries": [
      {
        "inventory_id": 1,
        "title": "掃除機",
        "quantity": 3,
        "unit": "台",
        "unit_price": 100,
        "status": "completed_delivery",
        "delivery_date": "2019-09-01",
        "estimated_delivery_date": null,
        "etc": "黒色"
      },
      {
        "inventory_id": 2,
        "title": "テレビ",
        "quantity": 3,
        "unit": "台",
        "unit_price": 100,
        "status": "completed_delivery",
        "delivery_date": "2019-09-01",
        "estimated_delivery_date": null,
        "etc": ""
      }
    ]
  },
  {
    "id": 11,
    "num": "1001",
    "customer_name": "株式会社ZAICO",
    "status": "before_delivery",
    "total_amount": 1000,
    "delivery_date": "2019-09-01",
    "estimated_delivery_date": "2019-09-01",
    "created_at": "2018-03-27T09:38:19+09:00",
    "updated_at": "2018-03-27T09:38:19+09:00",
    "deliveries": [
      {
        "inventory_id": 5,
        "title": "掃除機",
        "quantity": 3,
        "unit": "台",
        "unit_price": 100,
        "status": "completed_delivery",
        "delivery_date": "2019-09-01",
        "estimated_delivery_date": "2019-09-01",
        "etc": ""
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

納品データ作成

納品データ作成
POST/api/v1/packing_slips/

処理概要

  • 納品データを作成します

  • パースできないJSONを送るとエラーを返します

  • 登録できる項目について

    • num : 納品データ番号(ユーザーが任意に設定できる番号)
    • customer_name : 取引先名
    • status : 納品データの状態
      • 以下の2つのどちらかを指定してください
      • 納品前の場合は before_delivery
      • 納品済みの場合は completed_delivery
      • 納品済みを指定した場合は、対象の在庫データの数量を減少します
    • delivery_date : 納品日
      • statusによって必須かどうか変わります
      • status=completed_delivery
        • delivery_dateが必須
      • status=before_delivery
        • delivery_dateは不要
    • deliveries : 対象となる在庫データの配列
      • 以下のパラメータを含むオブジェクトを配列の要素とします
        • inventory_id : 在庫データID
        • quantity : 納品数量
        • unit_price : 納品単価
        • estimated_delivery_date : 納品予定日
        • etc : 摘要・備考

Example URI

POST https://web.zaico.co.jp/api/v1/packing_slips/
Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Body
{
  "num": "100",
  "customer_name": "株式会社ZAICO",
  "status": "completed_delivery",
  "delivery_date": "2019-09-01",
  "deliveries": [
    {
      "inventory_id": 1,
      "quantity": 3,
      "unit_price": 100,
      "estimated_delivery_date": "2019-09-01"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "num": {
      "type": "string",
      "description": "納品データ番号(ユーザーが任意に設定できる番号)"
    },
    "customer_name": {
      "type": "string",
      "description": "取引先名"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "delivery_date": {
      "type": "string",
      "description": "納品日"
    },
    "deliveries": {
      "type": "array"
    }
  },
  "required": [
    "status",
    "deliveries"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully created.",
  "data_id": 12345
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    },
    "data_id": {
      "type": "number",
      "description": "作成した納品データID"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 422,
  "status": "error",
  "message": "Invalid data."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}

納品データ個別取得

納品データ個別取得
GET/api/v1/packing_slips/{id}

処理概要

  • 納品データを1件のみ取得します

  • 納品データの項目について以下のようになります

    • id : 納品データID
    • num : 納品データ番号(ユーザーが任意に設定できる番号)
    • customer_name : 取引先名
    • status : 納品データの状態
      • 以下の2つのどちらかが設定されています
      • before_delivery : 納品前
      • completed_delivery : 納品済み
    • total_amount : 納品データの合計金額
    • delivery_date : 納品日
    • estimated_delivery_date : 納品予定日
      • この納品予定日は納品データの物品のうち、最も早い納品予定日を表示します
    • created_at : 納品データ作成日
    • updated_at : 納品データ更新日
    • deliveries : 納品データに登録している在庫データ一覧
      • inventory_id : 在庫データID
      • title : 物品名
      • quantity : 納品数量
      • unit : 単位
      • unit_price : 納品単価
      • status : 状態
        • 以下の2つのどちらかが設定されています
        • before_delivery : 納品前
        • completed_delivery : 納品済み
      • delivery_date : 納品日
      • estimated_delivery_date : 納品予定日
      • etc: 摘要・備考

Example URI

GET https://web.zaico.co.jp/api/v1/packing_slips/1
URI Parameters
HideShow
id
number (required) Example: 1

納品データのID

Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 10,
  "num": "100",
  "customer_name": "株式会社ZAICO",
  "status": "completed_delivery",
  "total_amount": 1000,
  "delivery_date": "2019-09-01",
  "estimated_delivery_date": "2019-09-01",
  "created_at": "2018-03-27T09:38:19+09:00",
  "updated_at": {
    "deliveries": [
      {
        "inventory_id": 1,
        "title": "掃除機",
        "quantity": 3,
        "unit": "台",
        "unit_price": 100,
        "status": "completed_delivery",
        "delivery_date": "2019-09-01",
        "estimated_delivery_date": null,
        "etc": "白色"
      },
      {
        "inventory_id": 2,
        "title": "テレビ",
        "quantity": 3,
        "unit": "台",
        "unit_price": 100,
        "status": "completed_delivery",
        "delivery_date": "2019-09-01",
        "estimated_delivery_date": "2019-09-01",
        "etc": ""
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "num": {
      "type": "string"
    },
    "customer_name": {
      "type": "string",
      "description": "取引先名"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "total_amount": {
      "type": "number"
    },
    "delivery_date": {
      "type": "string",
      "description": "納品日"
    },
    "estimated_delivery_date": {
      "type": "string",
      "description": "納品日"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "object",
      "properties": {
        "deliveries": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "inventory_id": {
                  "type": "number"
                },
                "title": {
                  "type": "string",
                  "description": "物品名"
                },
                "quantity": {
                  "type": "number",
                  "description": "納品数量"
                },
                "unit": {
                  "type": "string",
                  "description": "単位"
                },
                "unit_price": {
                  "type": "number",
                  "description": "納品単価"
                },
                "status": {
                  "type": "string"
                },
                "delivery_date": {
                  "type": "string"
                },
                "estimated_delivery_date": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "etc": {
                  "type": "string",
                  "description": "摘要・備考"
                }
              }
            },
            {
              "type": "object",
              "properties": {
                "inventory_id": {
                  "type": "number"
                },
                "title": {
                  "type": "string",
                  "description": "物品名"
                },
                "quantity": {
                  "type": "number",
                  "description": "納品数量"
                },
                "unit": {
                  "type": "string",
                  "description": "単位"
                },
                "unit_price": {
                  "type": "number",
                  "description": "納品単価"
                },
                "status": {
                  "type": "string"
                },
                "delivery_date": {
                  "type": "string"
                },
                "estimated_delivery_date": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "etc": {
                  "type": "string",
                  "description": "摘要・備考"
                }
              }
            }
          ]
        }
      }
    }
  }
}

納品データ更新

納品データ更新
PUT/api/v1/packing_slips/

処理概要

  • 納品データを更新します

  • パースできないJSONを送るとエラーを返します

  • 項目について

    • num : 納品データ番号(ユーザーが任意に設定できる番号)
    • customer_name : 取引先名
    • deliveries : 対象となる在庫データの配列
      • 以下のパラメータを含むオブジェクトを配列の要素とします
        • inventory_id : 在庫データID
          • 在庫データIDは対象の物品を特定するために指定するため、これを更新することはできません
        • quantity : 納品数量
        • unit_price : 納品単価
        • status : 状態
          • 納品前在庫を更新するときは before_delivery または completed_delivery を指定できます
            納品前在庫を納品済みに更新すると 対象の在庫データの数量を減少します
          • 納品済み在庫の状態を更新することはできません
        • delivery_date : 納品日
        • estimated_delivery_date : 納品予定日
        • etc : 摘要・備考

Example URI

PUT https://web.zaico.co.jp/api/v1/packing_slips/
Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Body
{
  "num": "100",
  "customer_name": "株式会社ZAICO",
  "deliveries": [
    {
      "inventory_id": 1,
      "quantity": 3,
      "unit_price": 100,
      "status": "completed_delivery",
      "delivery_date": "2019-11-11",
      "estimated_delivery_date": "2019-11-11"
    },
    {
      "inventory_id": 2,
      "quantity": 5,
      "unit_price": 100,
      "status": "before_delivery",
      "estimated_delivery_date": "2019-11-11"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "num": {
      "type": "string",
      "description": "納品データ番号(ユーザーが任意に設定できる番号)"
    },
    "customer_name": {
      "type": "string",
      "description": "取引先名"
    },
    "deliveries": {
      "type": "array"
    }
  },
  "required": [
    "deliveries"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully created.",
  "data_id": 12345
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    },
    "data_id": {
      "type": "number",
      "description": "作成した納品データID"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 422,
  "status": "error",
  "message": "Invalid data."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}

納品データ削除

納品データ削除
DELETE/api/v1/packing_slips/{id}

処理概要

  • 特定の納品データを削除します

  • 納品データの各物品の状態によって在庫データの取り扱いが変わります

    • 納品前:変化なし
    • 納品済み:在庫データの数量を納品数量分だけ戻します

Example URI

DELETE https://web.zaico.co.jp/api/v1/packing_slips/1
URI Parameters
HideShow
id
number (required) Example: 1

納品データのID

Request
HideShow
Headers
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 200,
  "status": "success",
  "message": "Data was successfully deleted"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 404,
  "status": "error",
  "message": "Packing slip not found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "ステータスコード"
    },
    "status": {
      "type": "string",
      "description": "状態"
    },
    "message": {
      "type": "string",
      "description": "メッセージ"
    }
  }
}

Generated by aglio on 25 Mar 2020