zaico API Document
このドキュメントはZAICO APIの機能と使うために必要なパラメータなどを説明するものです。
+
zaico API Document
このドキュメントはZAICO APIの機能と使うために必要なパラメータなどを説明するものです。
2022年12月14日更新
認証 ¶
認証について
GET
@@ -942,6 +942,32 @@Example URI
DELETEetc : 摘要・備考
+shipping_instruction : 発送情報（フルプラン、かつ設定されている場合のみ表示されます）
+
@@ -979,7 +1005,29 @@
-
+
- to_name : 宛名 +
- to_name_postfix : 敬称 +
- to_zip : 郵便番号 +
- to_address : 住所 +
- building_name : 建物名・部屋番号 +
- to_phone_number : 電話番号 +
- shipping_client : 発送元
+
-
+
- id : 発送元ID +
- name : 名前/会社名 +
- zip : 郵便番号 +
- address : 住所 +
- building_name : 建物名・部屋番号 +
- phone_number : 電話番号 +
+ - invoice_type_name : 便指定 +
- product_name_on_invoice : 品名 +
- freight_handling : 荷扱い +
- freight_handling2 : 荷扱い +
- arrival_date : 希望お届け日 +
- arrival_hour : 希望お届け時間帯 +
Example URI
GET&
"estimated_delivery_date": null,
"etc": ""
}
- ]
+ ],
+ "shipping_instruction": {
+ "to_name": "在庫商会",
+ "to_name_postfix": "御中",
+ "to_zip": "1000101",
+ "to_address": "東京都大島町元町",
+ "building_name": "ザイコ工場",
+ "to_phone_number": "0312341234",
+ "shipping_client": {
+ "id": 1,
+ "name": "発送元A",
+ "zip": "1234567",
+ "address": "東京都港区",
+ "building_name": "港ビル",
+ "phone_number": "08012345678"
+ },
+ "invoice_type_name": "ヤマト 発払い",
+ "product_name_on_invoice": "化学薬品",
+ "freight_handling": "ワレ物注意",
+ "freight_handling2": "下載厳禁",
+ "arrival_date": "2023-10-31",
+ "arrival_hour": "14〜16時"
+ }
},
{
"id": 11,
@@ -1057,6 +1105,39 @@
Example URI
GET&
+shipping_instruction : 発送情報（フルプランのみ設定できます）
+
@@ -1072,7 +1153,22 @@
-
+
- to_name : 宛名 +
- to_name_postfix : 敬称 +
- to_zip : 郵便番号 +
- to_address : 住所 +
- building_name : 建物名・部屋番号 +
- to_phone_number : 電話番号 +
- shipping_client_id : 発送元ID +
- invoice_type_name : 便指定
+
-
+
- 指定可能な値 :
ヤマト 発払いヤマト DM便ヤマト 着払いヤマト ネコポス佐川 元払佐川 着払ゆうパケットクリックポストその他
+
+ - 指定可能な値 :
- product_name_on_invoice : 品名 +
- freight_handling : 荷扱い
+
-
+
- 指定可能な値 :
指定なしワレ物注意下載厳禁天地無用精密機器ナマモノ水濡厳禁取扱注意（※「取扱注意」は佐川のみ）
+
+ - 指定可能な値 :
- freight_handling2 : 荷扱い
+
-
+
- 指定可能な値 :
指定なしワレ物注意下載厳禁天地無用精密機器ナマモノ水濡厳禁取扱注意（※「取扱注意」は佐川のみ）
+
+ - 指定可能な値 :
- arrival_date : 希望お届け日 +
- arrival_hour : 希望お届け時間帯
+
-
+
- 指定可能な値 :
指定なし午前中14〜16時16〜18時18〜20時19〜21時
+
+ - 指定可能な値 :
Example URI
POSTunit_price": 100,
"estimated_delivery_date": "2019-09-01"
}
- ]
+ ],
+ "shipping_instruction": {
+ "to_name": "在庫商会",
+ "to_name_postfix": "御中",
+ "to_zip": "1000101",
+ "to_address": "東京都大島町元町",
+ "building_name": "ザイコ工場",
+ "to_phone_number": "0312341234",
+ "shipping_client_id": 123,
+ "invoice_type_name": "ヤマト 発払い",
+ "product_name_on_invoice": "化学薬品",
+ "freight_handling": "ワレ物注意",
+ "freight_handling2": "下載厳禁",
+ "arrival_date": "2023-10-31",
+ "arrival_hour": "14〜16時"
+ }
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -1095,6 +1191,63 @@ Example URI
POST},
"deliveries": {
"type": "array"
+ },
+ "shipping_instruction": {
+ "type": "object",
+ "properties": {
+ "to_name": {
+ "type": "string",
+ "description": "宛名"
+ },
+ "to_name_postfix": {
+ "type": "string",
+ "description": "敬称"
+ },
+ "to_zip": {
+ "type": "string",
+ "description": "郵便番号"
+ },
+ "to_address": {
+ "type": "string",
+ "description": "住所"
+ },
+ "building_name": {
+ "type": "string",
+ "description": "建物名・部屋番号"
+ },
+ "to_phone_number": {
+ "type": "string",
+ "description": "電話番号"
+ },
+ "shipping_client_id": {
+ "type": "number",
+ "description": "発送元ID"
+ },
+ "invoice_type_name": {
+ "type": "string",
+ "description": "便指定"
+ },
+ "product_name_on_invoice": {
+ "type": "string",
+ "description": "品名"
+ },
+ "freight_handling": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "freight_handling2": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "arrival_date": {
+ "type": "string",
+ "description": "希望お届け日"
+ },
+ "arrival_hour": {
+ "type": "string",
+ "description": "希望お届け時間帯"
+ }
+ }
}
},
"required": [
@@ -1194,6 +1347,32 @@ Example URI
POSTetc: 摘要・備考
+shipping_instruction : 発送情報（フルプラン、かつ設定されている場合のみ表示されます）
+
+- to_name : 宛名
+- to_name_postfix : 敬称
+- to_zip : 郵便番号
+- to_address : 住所
+- building_name : 建物名・部屋番号
+- to_phone_number : 電話番号
+- shipping_client : 発送元
+
+- id : 発送元ID
+- name : 名前/会社名
+- zip : 郵便番号
+- address : 住所
+- building_name : 建物名・部屋番号
+- phone_number : 電話番号
+
+
+- invoice_type_name : 便指定
+- product_name_on_invoice : 品名
+- freight_handling : 荷扱い
+- freight_handling2 : 荷扱い
+- arrival_date : 希望お届け日
+- arrival_hour : 希望お届け時間帯
+
+
@@ -1207,31 +1386,52 @@ Example URI
GET&
"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": ""
- }
- ]
+ "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": "2019-09-01",
+ "etc": ""
+ }
+ ],
+ "shipping_instruction": {
+ "to_name": "在庫商会",
+ "to_name_postfix": "御中",
+ "to_zip": "1000101",
+ "to_address": "東京都大島町元町",
+ "building_name": "ザイコ工場",
+ "to_phone_number": "0312341234",
+ "shipping_client": {
+ "id": 1,
+ "name": "発送元A",
+ "zip": "1234567",
+ "address": "東京都港区",
+ "building_name": "港ビル",
+ "phone_number": "08012345678"
+ },
+ "invoice_type_name": "ヤマト 発払い",
+ "product_name_on_invoice": "化学薬品",
+ "freight_handling": "ワレ物注意",
+ "freight_handling2": "下載厳禁",
+ "arrival_date": "2023-10-31",
+ "arrival_hour": "14〜16時"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
@@ -1266,92 +1466,173 @@ Example URI
GET&
"type": "string"
},
"updated_at": {
+ "type": "string"
+ },
+ "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": "摘要・備考"
+ }
+ }
+ }
+ ]
+ },
+ "shipping_instruction": {
"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": "摘要・備考"
- }
- }
+ "to_name": {
+ "type": "string",
+ "description": "宛名"
+ },
+ "to_name_postfix": {
+ "type": "string",
+ "description": "敬称"
+ },
+ "to_zip": {
+ "type": "string",
+ "description": "郵便番号"
+ },
+ "to_address": {
+ "type": "string",
+ "description": "住所"
+ },
+ "building_name": {
+ "type": "string",
+ "description": "建物名・部屋番号"
+ },
+ "to_phone_number": {
+ "type": "string",
+ "description": "電話番号"
+ },
+ "shipping_client": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "number",
+ "description": "レコードID"
+ },
+ "name": {
+ "type": "string",
+ "description": "名前/会社名"
+ },
+ "zip": {
+ "type": "string",
+ "description": "郵便番号"
+ },
+ "address": {
+ "type": "string",
+ "description": "住所"
+ },
+ "building_name": {
+ "type": "string",
+ "description": "建物名・部屋番号"
+ },
+ "phone_number": {
+ "type": "string",
+ "description": "電話番号"
}
- ]
+ },
+ "description": "発送元"
+ },
+ "invoice_type_name": {
+ "type": "string",
+ "description": "便指定"
+ },
+ "product_name_on_invoice": {
+ "type": "string",
+ "description": "品名"
+ },
+ "freight_handling": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "freight_handling2": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "arrival_date": {
+ "type": "string",
+ "description": "希望お届け日"
+ },
+ "arrival_hour": {
+ "type": "string",
+ "description": "希望お届け時間帯"
}
}
}
@@ -1394,6 +1675,39 @@ Example URI
GET&
+shipping_instruction : 発送情報（フルプランのみ設定できます）
+
+- to_name : 宛名
+- to_name_postfix : 敬称
+- to_zip : 郵便番号
+- to_address : 住所
+- building_name : 建物名・部屋番号
+- to_phone_number : 電話番号
+- shipping_client_id : 発送元ID
+- invoice_type_name : 便指定
+
+- 指定可能な値 :
ヤマト 発払い ヤマト DM便 ヤマト 着払い ヤマト ネコポス 佐川 元払 佐川 着払 ゆうパケット クリックポスト その他
+
+
+- product_name_on_invoice : 品名
+- freight_handling : 荷扱い
+
+- 指定可能な値 :
指定なし ワレ物注意 下載厳禁 天地無用 精密機器 ナマモノ 水濡厳禁 取扱注意 （※「取扱注意」は佐川のみ）
+
+
+- freight_handling2 : 荷扱い
+
+- 指定可能な値 :
指定なし ワレ物注意 下載厳禁 天地無用 精密機器 ナマモノ 水濡厳禁 取扱注意 （※「取扱注意」は佐川のみ）
+
+
+- arrival_date : 希望お届け日
+- arrival_hour : 希望お届け時間帯
+
+- 指定可能な値 :
指定なし 午前中 14〜16時 16〜18時 18〜20時 19〜21時
+
+
+
+
@@ -1417,7 +1731,22 @@ Example URI
PUT&
"status": "before_delivery",
"estimated_delivery_date": "2019-11-11"
}
- ]
+ ],
+ "shipping_instruction": {
+ "to_name": "在庫商会",
+ "to_name_postfix": "御中",
+ "to_zip": "1000101",
+ "to_address": "東京都大島町元町",
+ "building_name": "ザイコ工場",
+ "to_phone_number": "0312341234",
+ "shipping_client_id": 123,
+ "invoice_type_name": "ヤマト 発払い",
+ "product_name_on_invoice": "化学薬品",
+ "freight_handling": "ワレ物注意",
+ "freight_handling2": "下載厳禁",
+ "arrival_date": "2023-10-31",
+ "arrival_hour": "14〜16時"
+ }
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -1432,6 +1761,63 @@ Example URI
PUT&
},
"deliveries": {
"type": "array"
+ },
+ "shipping_instruction": {
+ "type": "object",
+ "properties": {
+ "to_name": {
+ "type": "string",
+ "description": "宛名"
+ },
+ "to_name_postfix": {
+ "type": "string",
+ "description": "敬称"
+ },
+ "to_zip": {
+ "type": "string",
+ "description": "郵便番号"
+ },
+ "to_address": {
+ "type": "string",
+ "description": "住所"
+ },
+ "building_name": {
+ "type": "string",
+ "description": "建物名・部屋番号"
+ },
+ "to_phone_number": {
+ "type": "string",
+ "description": "電話番号"
+ },
+ "shipping_client_id": {
+ "type": "number",
+ "description": "発送元ID"
+ },
+ "invoice_type_name": {
+ "type": "string",
+ "description": "便指定"
+ },
+ "product_name_on_invoice": {
+ "type": "string",
+ "description": "品名"
+ },
+ "freight_handling": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "freight_handling2": {
+ "type": "string",
+ "description": "荷扱い"
+ },
+ "arrival_date": {
+ "type": "string",
+ "description": "希望お届け日"
+ },
+ "arrival_hour": {
+ "type": "string",
+ "description": "希望お届け時間帯"
+ }
+ }
}
},
"required": [
@@ -2520,7 +2906,45 @@ Example URI
DELETEdescription": "メッセージ"
}
}
-}
Generated by aglio on 30 May 2023