注文分割API

一つの注文を二つの注文に分ける機能を提供します。
　

変更履歴

発売日の違いなどから、出荷を分けたいときなどに利用します。
また、API実行時にシステムが自動で注文が分割された連絡メールを購入者に送信します。

【注文分割について】

注文分割とは複数の商品が購入された注文で配送時期を分けたいときなどに注文を2つに分ける機能です。
分割元の注文は、キャンセル扱いになり新たに2つの新しい注文が作られます。
分割時には2つに分ける注文にどの商品と数量を割り振るか、それぞれの送料、手数料はいくらかポイントの利用がある場合は利用ポイントを割り振ることができます。
商品数や、利用ポイントなどの合計値は分割前と一致する必要があります。

【分割不可なもの】

• お支払い方法が「d払い」「auかんたん決済」「ソフトバンクまとめて支払い」の注文
• ストア発行の値引きクーポン（ストアクーポン）が利用されている注文
• モールクーポンが利用されている注文

利用申請について

本番環境について

注文APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング注文API利用申請フォーム

テスト環境について

テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
新しいアプリケーションを開発
※テスト環境に関しては別途注文APIの利用申請をしていただく必要はありません。

リクエストURL

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

パラメータ	値	説明
/Req
/Req/Target
/Req/Target/OrderId （必須）	string	分割元の注文ID
/Req/Target/OperationUser （必須）	string	更新者名（ビジネスID登録氏名）
/Req/Order		複数指定可
/Req/Order/SplitId （必須）	int	分割ID（1か2です。）
/Req/Order/Detail
/Req/Order/Detail/PayCharge （必須）	int	手数料
/Req/Order/Detail/ShipCharge （必須）	int	送料
/Req/Order/Detail/GiftWrapCharge （必須）	int	ギフト包装料
/Req/Order/Detail/Discount （必須）	int	値引き
/Req/Order/Detail/UsePoint （必須）	int	利用ポイント
/Req/Order/Item		複数指定可
/Req/Order/Item/LineId （必須）	int	商品ラインID
/Req/Order/Item/Quantity （必須）	int	数量
/Req/SellerId （必須）	string	ストアアカウント

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderSplit

サンプルリクエスト

POST /ShoppingWebService/V1/orderSplit HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

<Req>
<Target>
<OrderId>testseller-10000001</OrderId>
<OperationUser>矢風太郎</OperationUser>
</Target>
<Order>
<SplitId>1</SplitId>
<Detail>
 <PayCharge>100</PayCharge>
 <ShipCharge>100</ShipCharge>
 <GiftWrapCharge>100</GiftWrapCharge>
 <Discount>100</Discount>
 <UsePoint>100</UsePoint>
</Detail>
<Item>
   <LineId>100</LineId>
   <Quantity>100</Quantity>
</Item>
</Order>
<Order>
<SplitId>2</SplitId>
<Detail>
 <PayCharge>100</PayCharge>
 <ShipCharge>100</ShipCharge>
 <GiftWrapCharge>100</GiftWrapCharge>
 <Discount>100</Discount>
 <UsePoint>100</UsePoint>
</Detail>
<Item>
   <LineId>200</LineId>
   <Quantity>100</Quantity>
</Item>
</Order>
<SellerId>testseller</SellerId>
</Req>

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。 totalResultsReturned : 返却され、かつマッチした件数です。 ok : 正常終了した件数です。 ng : 異常終了した件数です。
/ResultSet/Result	各個別レスポンスを含みます。
/ResultSet/Result/Status	処理成否（OK/NG）
/ResultSet/Result/OrderInfo	複数
/ResultSet/Result/OrderInfo/SplitId	分割ID
/ResultSet/Result/OrderInfo/OrderId	分割後注文ID

サンプルレスポンス

新しく発番された注文ID（OrderId）を返します。

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
        <OrderInfo>
            <SplitId>1</SplitId>
            <OrderId>storename-10000002</OrderId>
        </OrderInfo>
        <OrderInfo>
            <SplitId>2</SplitId>
            <OrderId>storename-10000003</OrderId>
        </OrderInfo>
    </Result>
</ResultSet>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

注文分割APIで固有に返すエラーコードは以下をご覧ください。

エラーコード

コード	HTTPステータスコード	説明
od90101	400	リクエストパラメータエラーです。
od90135	400	決済上限金額を超えたエラーです。
od90137	400	決済・ポイント処理を行っているため注文操作ができません。
od90166	400	不正注文に対する変更不可エラーです。
od90201	400	分割不可エラーです。
od91008	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91009	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91012	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91101	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91102	500	ポイント残高不足により金額、ステータスの完了に変更をすることが出>来ません
od91110	500	決済におけるメンテナンスエラーです。連続して発生する場合はお問い合わせください。
od91111	500	タイムアウトエラーです。連続して発生する場合はお問い合わせください。
od91120	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91121	500	決済処理エラーです。連続して発生する場合はお問い合わせください。
od91127	500	お客様のPayPay残高が不足している際に発生するエラーです。
od91128	500	PayPay残高決済におけるシステムエラーです。連続して発生する場合はお問い合わせください
od91132	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91139	500	エラー回数の上限に達したため、本日中は注文情報の操作が行えません。この注文者のクレジットカードは、現在使用できない状態です。
od91149	500	キャンセル受付中のため注文の更新不可のエラーです。
od91154	500	ポイント処理中による更新不可エラーです。しばらく（最大約60分）してから、再度お試しください。
od91201	500	決済エラーです。連続して発生する場合はお問い合わせください。
od91601	405	リクエストメソッドエラーです。
od91801	404	該当注文なしエラーです。
od91902	404	メンテナンスエラー
od90152	400	出荷指示済み後の注文操作不可エラーです。
od90155	400	ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od91166	500	決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od90103	400	リクエストと注文の整合性エラーです。
od90149	400	Yahoo Auction Order can not change (OrderSplit) : {注文ID} Yahoo!オークション注文では変更できません。
od90301	400	定期購入注文に対する変更不可エラーです。
od90178	400	LINE注文で変更不可な操作をした場合のエラー
od90195	400	ソーシャルギフト注文に対する変更不可エラーです。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。