API・管理画面更新のお知らせ

日頃よりDIAq APIをご利用いただき、誠にありがとうございます。
下記日程にて、APIの更新を実施いたしますので、お知らせいたします。

[適用予定日]
2020年8月31日　8:00～8:30

プロパティ名	内容	型
pickup_driver_comments	集荷時アンカーメモ	string
destination_driver_comments	お届時アンカーメモ	string

　レスポンスサンプル

　　{
　　　”id”: “0168e780-4918-4f36-9a3f-f06cbdfd8cee”,
　　　”object”: “delivery”,
　　　”tracking_code”: “031024680361”,
　　　”status”: “delivered”,
　　　”ready_by”: “2020-07-28T19:53:00+09:00”,
　　　”driver”: {
　　　　”name”: “佐藤 孝”
　　　},
　　　”delivered_at”: “2020-07-28T14:56:01+09:00”,
　　　”delivery_window”: {
　　　　”id”: “b1a9012a-913d-41c7-9d81-8f1e9aaaed06”,
　　　　”starts_at”: “2020-07-28T22:00:00+09:00”,
　　　　”ends_at”: “2020-07-28T23:00:00+09:00”,
　　　　”expires_at”: “2020-07-28T15:24:28+09:00”
　　　},
　　　”customer”: {
　　　　”last_name”: “田中”,
　　　　”first_name”: “徹”,
　　　　”business_name”: “”,
　　　　”phone”: “03-4444-8888”,
　　　　”email”: “”,
　　　　”address_zipcode”: “”,
　　　　”address_prefecture”: “東京都”,
　　　　”address_line_1″: “新宿区西新宿”,
　　　　”address_line_2″: “”
　　},
　　”store”: {
　　　”store_id”: “c974655e-075c-4add-b243-cd8614b8a990”,
　　　”store_name”: “高田馬場支店”,
　　　”store_address_prefecture”: “東京都”,
　　　”store_address_line_1″: “新宿区高田馬場１－３１－１８”,
　　　”store_address_line_2″: “高田馬場センタービル２階”,
　　　”store_phone”: “03-5000-4000”,
　　　”store_type”: “standalone_store”
　　},
　　”pickup_comments”: “”,
　　”destination_comments”: “”,
　　”pickup_driver_comments”: “集荷時アンカーメモ”,
　　”destination_driver_comments”: “お届時アンカーメモ”,
　　”store_signature”: “signature”,
　　”customer_signature”: “signature”,
　　”packages”: [
　　　{
　　　　”service_brand”: “100サイズ”,
　　　　”order_reference”: “1234”,
　　　　”name”: “洋服”,
　　　　”price”: “554”,
　　　　”number”: 1,
　　　　”boxes”: 1,
　　　　”height”: 0.0,
　　　　”width”: 0.0,
　　　　”depth”: 0.0,
　　　　”weight”: 0.0,
　　　　”attention”: “”
　　　}
　　],
　　”distance”: 3387,
　　”etc_price”: “0”,
　　”etc_price_reason”: “”,
　　”exception”: null,
　　”update”: “2020-07-28T14:56:01.334+09:00”
　}

---

　■APIリクエストの変更

　　・時間指定なし（AnytimeWindow）をご利用いただく際に、deliveriesは
　　　「until」、fetchesは「after」をご指定いただけるように変更いたし
　　　ます。
　　　until・afterの追加により、時間指定なしの配送・回収の依頼でも
　　　「〇〇:〇〇～●●：●●の間に配送」というご依頼を行って頂くことが
　　　出来るようになります。

　　　deliveriesに追加

プロパティ名	内容	型
until	配送完了の目安時刻「まで」	timestamp

　　　アンカーアプリでは以下のように表示されます。　　　

untilを指定した場合	ready_by　～　until
untilを指定しなかった場合	ready_by　～

　　　fetchesに追加

プロパティ名	内容	型
after	配送開始の目安時刻「から」	timestamp

　　　アンカーアプリでは以下のように表示されます。

afterを指定した場合	after　～　deliver_by
afterを指定しなかった場合	～　deliver_by

---

　■Store APIの機能追加
　　・Store APIに、以下の機能を追加いたします。

メソッド	用途
POST	ストアの追加
PUT	ストアの更新
DELETE	ストアの削除

---

　■Webhookの変更
　　・配送ステータスが「collecting」以降の通知に、アンカーの連絡先、
　　　車両タイプを追加いたします。

プロパティ名	内容	型	備考
phone	電話番号	string
vehicle_type	車両タイプ	string	未選択、自転車、原付、 小型二輪、バイク、軽四輪のいずれか

　　・集荷時・お届時にアンカーが入力したメモの内容を追加いたします。

プロパティ名	内容	型
pickup_driver_comments	集荷時アンカーメモ	string
destination_driver_comments	お届時アンカーメモ	string

　Webhookサンプル

　　{
　　　”id”: “0168e780-4918-4f36-9a3f-f06cbdfd8cee”,
　　　”object”: “delivery”,
　　　”tracking_code”: “031024680361”,
　　　”status”: “delivered”,
　　　”ready_by”: “2020-07-28T19:53:00+09:00”,
　　　”driver”: {
　　　　”id”: 5150,
　　　　”name”: “佐藤 孝”,
　　　　”phone”: “090-0000-1111”,
　　　　”vehicle_type”: “軽四輪”,
　　　　　”location”: {
　　　　　　”longitude”: 139.70327440406476,
　　　　　　”latitude”: 35.7093505859375,
　　　　　　”update”: “2020-07-28T12:19:07+09:00”
　　　　}
　　　},
　　　”delivered_at”: “2020-07-28T14:56:01+09:00”,
　　　”delivery_window”: {
　　　　”id”: “b1a9012a-913d-41c7-9d81-8f1e9aaaed06”,
　　　　”starts_at”: “2020-07-28T22:00:00+09:00”,
　　　　”ends_at”: “2020-07-28T23:00:00+09:00”,
　　　　”expires_at”: “2020-07-28T15:24:28+09:00”
　　　},
　　　”customer”: {
　　　　”last_name”: “小林”,
　　　　”first_name”: “武志”,
　　　　”business_name”: “”,
　　　　”phone”: “03-4444-8888”,
　　　　”email”: “”,
　　　　”address_zipcode”: “”,
　　　　”address_prefecture”: “東京都”,
　　　　”address_line_1″: “新宿区西早稲田”,
　　　　”address_line_2″: “”
　　　},
　　　”store”: {
　　　　”store_id”: “c974655e-075c-4add-b243-cd8614b8a990”,
　　　　”store_name”: “高田馬場支店”,
　　　　”store_address_prefecture”: “東京都”,
　　　　”store_address_line_1″: “新宿区高田馬場１－３１－１８”,
　　　　”store_address_line_2″: “高田馬場センタービル２階”,
　　　　”store_phone”: “03-5000-4000”,
　　　　”store_type”: “standalone_store”
　　　},
　　　”pickup_comments”: “”,
　　　”destination_comments”: “”,
　　　”pickup_driver_comments”: “集荷時アンカーメモ”,
　　　”destination_driver_comments”: “お届時アンカーメモ”,
　　　”store_signature”: “signature”,
　　　”customer_signature”: “signature”,
　　　”packages”: [
　　　　{
　　　　　”service_brand”: “100サイズ”,
　　　　　”name”: “12333”,
　　　　　”price”: “554”,
　　　　　”number”: 1,
　　　　　”boxes”: 1,
　　　　　”height”: 0,
　　　　　”width”: 0,
　　　　　”depth”: 0,
　　　　　”weight”: 0,
　　　　　”attention”: “”
　　　　}
　　　],
　　　”distance”: 3387,
　　　”etc_price”: “0”,
　　　”etc_price_reason”: “”,
　　　”exception”: null,
　　　”update”: “2020-07-28T14:56:01.334+09:00”
　　}

---

　■管理画面の変更
　　管理画面の注文詳細⇒荷物情報に記載していた、サイン種別・サイン画像
　　を注文詳細⇒基本情報に変更いたします。
　　また、注文詳細にて集荷時・お届時にアンカーが入力したメモの内容を
　　確認していただけるようにいたします。
　　

---

　■CSV項目の追加
　　管理画面からダウンロードできる、請求管理CSVに集荷時・お届時に
　　アンカーが入力したメモの内容を追加いたします。

項目名	追加列番号
集荷時アンカーメモ	30列目
配送時アンカーメモ	31列目

[サービスへの影響]
　メンテナンスのタイミングで瞬断が発生する可能性がございます。
　APIリクエストでエラーとなった場合、お手数ですが再リクエストを
　実施いただきますようお願い申し上げます。