【Yahoo!ショッピング】［6月30日頃提供開始］「Yahoo!ショッピングギフト券」導入に伴う仕様変更について
いつもYahoo!ショッピングをご利用いただき、誠にありがとうございます。
Yahoo!ショッピングでは、お客様向けの新たな決済方法として
「Yahoo!ショッピングギフト券」を6月下旬より提供開始予定です。
「Yahoo!ショッピングギフト券」導入に伴い下記の仕様変更を行います。
・注文詳細API
・注文ステータス変更API
・注文分割API
・（その他影響する内容）
ギフト券の注文情報を検索し、該当する複数注文情報を取得する機能を提供します。
ギフト券の注文情報の詳細を取得します。
（一回で取得できるのは1注文のみです）
－ 取得可能項目 : （文字列）、10000byte（最大）
※リクエスト、レスポンスの項目に変更点はありません。
※リクエスト、レスポンスの項目に変更点はありません。
既存のキー一覧は注文詳細APIの「PayMethod（支払い方法）」をご確認ください。
※PayKind（支払い種別）は「7 : その他」です。
ただし、一部利用の場合、クレジットカードは「0：カード」、PayPayは「6：電子マネー」 となります。本番リリース直前の予定です。（詳細は追って連絡いたします。）
2022/8/29（月）更新
テスト環境（sandbox）についてはリリース済みとなっておりますが、
「Yahoo!ショッピングギフト券」の出店者様向けの機能開放は行っておりません。
新たな決済方法の導入で、より多くのお客様のご利用を促進してまいりますので、
多くの出店者様にも「Yahoo!ショッピングギフト券」をご活用いただければと思います。
Yahoo!ショッピングでは、お客様向けの新たな決済方法として
「Yahoo!ショッピングギフト券」を6月下旬より提供開始予定です。
「Yahoo!ショッピングギフト券」導入に伴い下記の仕様変更を行います。
影響があるAPI
・注文検索API・注文詳細API
・注文ステータス変更API
・注文分割API
・（その他影響する内容）
注文検索API
注文検索APIギフト券の注文情報を検索し、該当する複数注文情報を取得する機能を提供します。
取得情報（Field）
－ 取得情報（Field） :| キー名 | 型 | 最大長 | 項目 | 内容 |
|---|---|---|---|---|
| GiftCardDiscount | (数値) | 10byte | ギフト券利用額 | 利用されたギフト券の利用額 |
| TotalPrice | (数値) | 15byte（最大） | 合計金額 | 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料 + 調整額 - モールクーポン値引き額- ギフト券利用額 |
| UsePoint | (数値) | 10byte（最大） | 利用ポイント数 | ギフト券を利用した注文の場合は、その利用額がそれぞれ加算されます。 |
注文詳細API
注文詳細APIギフト券の注文情報の詳細を取得します。
（一回で取得できるのは1注文のみです）
リクエストパラメータ
※OrderIdは必須になりますので、リクエストパラメータに値を設定しなかった場合はエラーになります。取得可能項目
Yahoo!ショッピングギフト券で取得したい項目を取得可能項目に指定してください。－ 取得可能項目 : （文字列）、10000byte（最大）
| 分類 | キー名 | 項目 | 型 | 最大長 | 内容 |
|---|---|---|---|---|---|
| 注文 | UseGiftCardData | 利用ギフト券情報 | 文字列 | 500byte（最大） | 利用されたギフト券情報の詳細を取得します。 例）＜![CDATA[[{"id":"01G3WJA8PCYHPJR","name":"1000円ギフト券","available_start":"2022-06-01 00:00:00","available_end":"2022-07-01 00:00:00","amount":1000,"sub_order_id":""}]]]＞ id：ギフト券のID name：ギフト券の名称 available_start：ギフト券の利用可能開始日 available_end：ギフト券の利用可能終了日 sub_order_id：仮注文IDを示していますが、常に空欄です。 |
明細 | GiftCardDiscount | ギフト券利用額 | (数値) | 10byte（最大） | 利用されたギフト券の利用額 |
| 明細 | TotalPrice | 合計金額 | (数値) | 15byte（最大） | 小計 - 利用ポイント + ギフト包装料 + 手数料 - 値引き + 送料+ 調整額 - モールクーポン値引き額 - ギフト券利用額 |
| 明細 | UsePoint | 利用ポイント数 | (数値) | 10byte（最大） | ギフト券を利用した注文の場合は、その利用額がそれぞれ加算されます。 |
注文ステータス変更API
注文ステータス変更API※リクエスト、レスポンスの項目に変更点はありません。
エラー
| コード | HTTPステータスコード | 説明 |
|---|---|---|
| od91180 | 500 | システムエラーです。連続して発生する場合はお問い合わせください。 |
注文分割API
注文分割API※リクエスト、レスポンスの項目に変更点はありません。
エラー
下記エラーコードが追加されます。| コード | HTTPステータスコード | 説明 |
|---|---|---|
| od90103 | 400 | リクエストと注文の整合性エラーです。 |
決済系APIキー
下記キーを追加します。既存のキー一覧は注文詳細APIの「PayMethod（支払い方法）」をご確認ください。
| キー名 | 用途 |
|---|---|
| payment_z4 | Yahoo!ショッピングギフト券 |
ただし、一部利用の場合、クレジットカードは「0：カード」、PayPayは「6：電子マネー」 となります。
テスト環境（sandbox）のリリースについて
2022/8/29（月）更新
テスト環境（sandbox）についてはリリース済みとなっておりますが、
「Yahoo!ショッピングギフト券」の出店者様向けの機能開放は行っておりません。
新たな決済方法の導入で、より多くのお客様のご利用を促進してまいりますので、
多くの出店者様にも「Yahoo!ショッピングギフト券」をご活用いただければと思います。