API更新（v1.1.2）のお知らせ

2026年4月1日

いつもDIAq APIをご利用いただき、誠にありがとうございます。

このたび、以下の日程で以下の通りAPIの仕様を一部変更いたします。

　

  1. アンカーには公開されない社内向けコメント「private_comments」の追加
  2. Webhookに「delivery_type」（配達先への受渡方法）を追加

　

新規フィールドの追加になります。既存APIのレスポンスの構造に変更はありません。

なお、リリース作業に伴うサービスの停止はございません。DIAq APIは通常通りご利用いただけます。

変更の詳細は、以下をご確認ください。

　　

[更新日]

2026年4月23日（木）

　

[更新内容]

■APIの変更

アンカーには公開されない貴社社内向けのコメントを入力できるようになります。

プロパティ名内容型必須
private_comments社内コメントstring×

JSONサンプル

{
  "store_id": "store_001",
  "ready_by": "2026-03-10T14:00:00+09:00",
  "delivery_window_id": 42,
  "pickup_comments": "裏口で受け取り",
  "destination_comments": "到着時に電話",
  "private_comments": "社内メモ: ID123-456-789", //新規追加
  "customer": {
    "last_name": "山田",
    "first_name": "太郎",
    "phone": "09000000000",
    "address_zipcode": "150-0001",
    "address_prefecture": "東京都",
    "address_line_1": "渋谷1-1-1",
    "address_line_2": "テストビル101",
    "latitude": 35.6595,
    "longitude": 139.7005
  },
  "packages": [
    {
      "service_brand": "80サイズ",
      "order_reference": "order-1001",
      "name": "書類",
      "number": 1,
      "boxes": 1
    }
  ]
}

　

■管理画面の変更

注文詳細画面（基本情報）に貴社社内コメントの表示欄を追加いたします。

　

■Webhookの変更

1. Private commentの追加

以下のフィールドを追加いたします。

フィールド名内容型
private_comments社内コメントstring

2. 配送方法の追加

以下のフィールドを追加いたします。

フィールド名内容型
delivery_kindお届け方法の分類配達完了（status = delivered）の場合のみ値が設定されます  。それ以外のステータスではnullになりますinteger 又は null
delivery_method具体的なお届け方法配達完了（status = delivered）の場合のみ値が設定されます  。それ以外のステータスではnullになりますinteger 又は null

【配送方法の定義】

delivery_kind内容delivery_method内容
1対面1ご本人または同居人
1対面2守衛・受付・コンシェルジュ
1対面3ご本人の指示で代理の方へお渡し
2非対面4宅配ボックス
2非対面5集合ポスト
2非対面6指定場所への置き配
2非対面7ガスメーターボックス
2非対面8車庫
2非対面9自転車のかご

webhookサンプル

{
  "id": "f4e6b439-b183-4219-add3-17f7ff2c1115",
  "object": "delivery",
  "tracking_code": "031012345678",
  "status": "delivered",
  "ready_by": "2026-03-28T12:00:00+09:00",
  "driver": {
    "id": 20123,
    "name": "田中 太郎",
    "phone": "080-1234-5678",
    "vehicle_type": "軽四輪",
    "location": {
      "longitude": 139.70315468497574,
      "latitude": 35.70969424210489,
      "update": "2026-03-28T13:24:29+09:00"
    }
  },
  "delivered_at": "2026-03-28T14:58:53+09:00",
  "delivery_window": {
    "id": "8a5d2283-98e4-4eb9-a9bb-121e55b01230",
    "starts_at": null,
    "ends_at": "2026-03-28T00:00:00+09:00",
    "expires_at": "2026-03-28T13:00:11+09:00"
  },
  "customer": {
    "last_name": "delivery_type",
    "first_name": "鈴木 花子",
    "business_name": "",
    "phone": "00-0000-0000",
    "email": "",
    "address_zipcode": "",
    "address_prefecture": "東京都",
    "address_line_1": "新宿区大久保1-1-1",
    "address_line_2": ""
  },
  "store": {
    "store_id": "1694b4fd-e246-4ca4-bc84-94c5d8e953b0",
    "store_name": "ストア　高田馬場店",
    "store_address_prefecture": "東京都",
    "store_address_line_1": "新宿区高田馬場1-31-18",
    "store_address_line_2": "高田馬場センタービル2階",
    "store_phone": "03-5678-1234",
    "store_type": "consolidation_store"
  },
  "pickup_comments": "",
  "destination_comments": "",
  "private_comment": "",
  "pickup_driver_comments": "",
  "destination_driver_comments": "",
  "delivery_kind": 2,  //新規追加
  "delivery_method": 4,//新規追加
  "store_signature": "signature",
  "customer_signature": "signature",
  "packages": [
    {
      "service_brand": "ポスト投函サイズ",
      "name": "医薬品",
      "price": "1100",
      "number": 1,
      "boxes": 1,
      "height": 0,
      "width": 0,
      "depth": 0,
      "weight": 0,
      "attention": ""
    }
  ],
  "distance": 1945,
  "etc_price": "0",
  "etc_price_reason": "",
  "exception": null,
  "update": "2026-03-28T14:58:53.994+09:00"
}

　

　

今回の機能追加は、DIAqスターターアプリには影響ありません。

本件についてご不明点等がございましたら、お気軽にお問い合わせください。

引き続きDIAq APIをどうぞよろしくお願いいたします。