ヤマト運輸株式会社「ピック＆デリバリー」導入に伴う仕様変更について

ヤマト運輸株式会社より提供される「ピック＆デリバリー」導入に伴う仕様変更についてお知らせします。

リクエストパラメータの追加等が発生するAPIは以下の通りです。

注文詳細API（orderInfo）

リクエストフィールドへの追加

分類キー名項目型最大長内容
注文 YamatoCoopStatus ヤマト連携ステータス null or 0 ：対象外、未連携
1：連携受付
2：連携処理中
3：連携済
4：連携キャンセル		 1byte ヤマト運輸への連携がいまどのような状態かを示すステータスです。
「3:連携済」のみが連携が済んでいるステータスとなります。
配送 CollectionDate 集荷日 YYYYMMDD 8byte ヤマト運輸に集荷してもらう日
出店者様側で設定
CashOnDeliveryTax 代引き用消費税額 (数値) 15byte(最大) 代引き支払い専用項目で、代引き支払いの総合計金額の内消費税額
NumberUnitsShipped 出荷個口数 (数値) 5byte(最大) ヤマト運輸側から更新
ピック&デリバリーで送られた荷物が何個口で送られたか
ShipRequestTimeZoneCode 配送希望時間帯番号 指定無しの場合は空白
101：午前中（8時～12時）
102：14時～16時
103：16時～18時
104：18時～20時
105：19時～21時		 3byte(最大) ※配送サービス利用ストア専用項目
配送希望時間帯番号
ShipInstructType 出荷指示区分 101：ヤマト P&D 3byte(最大) ※配送サービス利用ストア専用項目
どの配送サービスを使用しているか
ShipInstructStatus 出荷指示ステータス 0：対象外
100：出荷指示受付前
101：出荷指示待ち
102：出荷キャンセル
103：出荷指示済み
104：出荷完了
105：着荷完了
106：配送不可		 3byte(最大) ヤマトピック&デリバリーにおける注文のステータスを表示

0：対象外
→配送サービス対象外
100：出荷指示受付前
→バイヤーキャンセル受付中（受注後10分間）の状態。更新不可
101：出荷指示待ち
→バイヤーキャンセル受付終了（受注後10分以上経過）の状態。「103：出荷指示済み」への更新可
102：出荷キャンセル
→ヤマトピック&デリバリーキャンセル状態
注文自体のキャンセル、配送方法を変更した際に遷移します。
103：出荷指示済み
→トータルピック完了を示す状態。変更契機はストアの更新
104：出荷完了
→倉庫から荷物が出た状態。変更契機はヤマト運輸からの更新
105：着荷完了
→着荷が完了した状態。変更契機はヤマト運輸からの更新
106：配送不可
→何らかの理由で倉庫からの出荷ができなかった状態。「YamatoUndeliverableReason」と必ずセットとなる。変更契機はヤマト運輸からの更新
商品 PickAndDeliveryCode 梱包バーコード情報 (文字列) 20byte(最大) 納品に必要なバーコード情報です。
商品で編集したものがそのまま連携される
PickAndDeliveryTransportRuleType 荷扱い情報 0：なし
1：ナマモノ
2：ワレモノ
3：精密機械
4：下積厳禁
5：天地無用		 2byte(最大) 荷扱いに関する情報です。
商品で編集したものがそのまま連携される
YamatoUndeliverableReason 配送不可理由 （文字列） 80byte(最大) ヤマトから連携される配送不可理由です。
・商品不足：商品が足りなかった場合
・商品不良：商品が破損、汚損等で不良だった場合
・規格外商品：160サイズ以上、冷蔵・冷凍、こわれもの・びんもの、コンパクト・ネコポスに入りきらない商品だった場合
・お客様指示：ストア様からのキャンセル依頼があった場合
・注文者都合：受け取り拒否、保管期限切れ等ユーザー側での都合での返品

エラーコードの追加対応

コードHTTPステータスコード説明
od90103 400 リクエストと注文の整合性エラーです。
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90154 400 出荷キャンセル済み注文の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od90158 400 該当キー更新時の注文操作不可エラーです。
od90160 400 ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。

詳細はこちら
注文詳細API（orderInfo）

注文検索API（orderList）

リクエストフィールドへの追加

検索条件（Condition）

キー名型最大長項目内容
ShipInstructType （数値） 3byte 出荷指示区分 101：ヤマト P&D
102：ヤマト フルフィル
ShipInstructStatus （数値） 3byte 出荷指示ステータス 100：出荷指示受付前
101：出荷指示待ち
102：出荷キャンセル
103：出荷指示済み
104：出荷完了
105：着荷完了
106：配送不可
YamatoCoopStatus （数値） 1byte ヤマト連携ステータス 0 ：対象外、未連携
1：連携受付
2：連携処理中
3：連携済
4：連携キャンセル

取得情報（Field）

キー名型最大長項目内容
ShipInstructType （数値） 3byte 出荷指示区分 101：ヤマト P&D
102：ヤマト フルフィル
ShipInstructStatus （数値） 3byte 出荷指示ステータス 100：出荷指示受付前
101：出荷指示待ち
102：出荷キャンセル
103：出荷指示済み
104：出荷完了
105：着荷完了
106：配送不可
YamatoCoopStatus （数値） 1byte ヤマト連携ステータス null or 0 ：対象外、未連携
1：連携受付
2：連携処理中
3：連携済
4：連携キャンセル

詳細はこちら
注文検索API（orderList）

注文内容変更API（orderChange）

リクエストフィールドへの追加

分類パラメータ項目型デフォルト値説明
配送 Req/Order/Ship/CashOnDeliveryTax 代引き用消費税額 integer 15byte(最大) 税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に
10%で自動計算された値が入ります。

エラーコードの追加対応

コードHTTPステータスコード説明
od90103 400 リクエストと注文の整合性エラーです。
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90154 400 出荷キャンセル済み注文の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od90158 400 該当キー更新時の注文操作不可エラーです。
od90160 400 ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。

詳細はこちら
注文内容変更API（orderChange）

注文ステータス更新API（OrdeStatusChange）

エラーコードの追加対応

コードHTTPステータスコード説明
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od91165 500 出荷指示ステータスが「着荷完了」ではないため、注文ステータスを完了にできません。

詳細はこちら
注文ステータス更新API（orderStatusChange）

出荷ステータス更新API（OrdeShipStatusChange）

リクエストフィールドへの追加

パラメータ型説明
Req/Order/Ship/ShipInstructStatus integer 出荷指示ステータス

100：出荷指示受付前
101：出荷指示待ち
102：出荷キャンセル
103：出荷指示済み
104：出荷完了
105：着荷完了
106：配送不可
※103：出荷指示済み（トータルピック完了）以外は指定不可

トータルピック完了後に連携をお願いします。

毎日23:00～翌7:00までシステムメンテナンスに入ります。
ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。余裕を持った更新をお願いします。
またヤマト運輸内部での出荷指示は1日1回14時となります。
当日中の出荷指示をご要望の場合は13:00までに連携をお願いします。
※連携の件数によっては13:00に行なっても14:00に間に合わないケースがあります。余裕を持った更新をお願いします。
Req/Order/Ship/CollectionDate date 集荷日（YYYYMMDD）

※ShipInstructStatus=103：出荷指示済み 指定時は必須、それ以外の時は指定不可
※当日もしくは翌日のみ登録可
毎日23:00～翌7:00までシステムメンテナンスに入ります。
ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。
Req/Order/Ship/CashOnDeliveryTax integer 代引き用消費税額

税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に10%で自動計算された値が入ります。
毎日23:00～翌7:00までシステムメンテナンスに入ります。
ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。

エラーコードの追加対応

コードHTTPステータスコード説明
od90103 400 リクエストと注文の整合性エラーです。
od90152 400 出荷指示済み後の注文操作不可エラーです。
od90153 400 ヤマトP＆D対象ではない注文のヤマト配送専用項目の変更時のエラーです。
od90154 400 出荷キャンセル済み注文の注文操作不可エラーです。
od90155 400 ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od90156 400 ヤマトP＆Dの手数料もしくは、決済金額が上限を超えている場合にエラーとなります。
手数料（pay_charge）が1000,000円以上
決済金額が各配送方法で以下の場合エラーとなります。
宅急便: 30万円超
コンパクト便: 3万円超
ネコポス便: 3000円超
od90157 400 必須となる情報が設定されていない、または不正の場合、出荷指示済みへ更新時にエラーとなります。
od90159 400 ヤマト配送注文かつ支払方法が商品代引の場合に、代引き契約が許可なし、又は、配送方法がネコポスの注文操作不可エラーです。
od90160 400 ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。
od90161 400 ヤマト配送注文かつ出荷指示済みへ更新時以外の場合に更新不可項目を指定された場合のエラーです。

詳細はこちら
出荷ステータス更新API（orderShipStatusChange）

商品参照API（GetItem）

レスポンスフィールドへの追加への追加

フィールド説明
/ResultSet/Result/PickAndDeliveryCode バーコード情報
/ResultSet/Result/PickAndDeliveryTransportRuleType 荷扱い情報
0：なし
1：ナマモノ
2：ワレモノ
3：精密機械
4：下積厳禁
5：天地無用

詳細はこちら
商品参照API（getItem）

商品登録API（EditItem）

リクエストフィールドへの追加

パラメータ値説明
pick_and_delivery_code string バーコード情報
ヤマトピック&デリバリー対象商品は必須です
20文字以内
半角数字、半角英字（小文字、大文字）、半角記号
（ - . $ / + % ＊アスタリスク）が使用可能です。
pick_and_delivery_transport_rule_type integer 荷扱い情報
0：なし
1：ナマモノ
2：ワレモノ
3：精密機械
4：下積厳禁
5：天地無用

詳細はこちら
商品登録API（editItem）

アプリケーションの管理

利用のルール

開発のヒント