注文ライン追加API

注文明細に商品を追加する機能を提供します。
また、API実行時に自動で注文金額変更の連絡メールを購入者に送信します。

変更履歴

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

リクエストパラメータ

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

パラメータ	値	説明
/Req		リクエストパラメータ
/Req/Target （必須）		更新対象指定情報
/Req/Target/OrderId （必須）	string	注文ID
/Req/Target/IsQuotation （必須）	boolean	商品情報の引用 true : 商品情報を商品データベースから引用 / false : 手動登録 /Req/Order/Item/IsQuotation の指定がなければこちらの設定が全商品に適応されます。
/Req/Target/OperationUser	string	更新者名（ビジネスID登録氏名） セラー更新のみです。
/Req/Order		複数指定可
/Req/Order/Item		Itemを複数指定可。 ※LineIdは昇順でなければエラーとなります。
/Req/Order/Item/LineId （必須）	int	ラインIDは1注文に紐づく商品数を連番（初期値1）で振ったものです。追加する商品に対してラインIDの最大数+1を指定してください。
/Req/Order/Item/ItemId （必須）	string	商品ID
/Req/Order/Item/Title （※1）	string	商品名
/Req/Order/Item/IsQuotation	boolean	商品情報の引用 true:商品情報を商品データベースから引用 / false:手動登録 ※こちらの設定がある場合、/Req/Target/IsQuotation よりも優先されます。
/Req/Order/Item/SubCode	string	商品サブコード
/Req/Order/Item/ItemOption		商品オプション （繰り返し可）
/Req/Order/Item/ItemOption/Index （※2）	int	商品オプションの表示順です。
/Req/Order/Item/ItemOption/Name （※2）	string	商品オプションの項目名です。
/Req/Order/Item/ItemOption/Value （※2）	string	商品オプションの値です。
/Req/Order/Item/Inscription		インスクリプション （繰り返し可）
/Req/Order/Item/Inscription/Index （※3）	int	インスクリプションの表示順です。
/Req/Order/Item/Inscription/Name （※3）	string	インスクリプションの項目名です。
/Req/Order/Item/Inscription/Value	string	インスクリプションの値です。
/Req/Order/Item/UnitPrice （※1）	int	商品単価（税込） ※2019年10月1日以降、 IsQuotationがfalse（商品データベースからの引用なし）の場合、一律10％の税込価格で設定してください。
/Req/Order/Item/Quantity （必須）	int	個数
/Req/SellerId （必須）	string	ストアアカウント

※1 IsQuotationがfalse（商品データベースからの引用なし）の場合必須です。
※2 商品オプションを指定する場合必須です。
※3 インスクリプションを指定する場合必須です。

サンプルリクエストURL

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

サンプルリクエスト

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

サンプルリクエスト1（商品データベースからの引用ありの場合）

<Req>
 <Target>
 <OrderId>testseller-10000001</OrderId>
 <IsQuotation>true</IsQuotation>
 </Target>
 <Order>
  <Item>
 <LineId>3</LineId>
 <ItemId>32a950a</ItemId>
 <Quantity>2</Quantity>
 </Item>
 </Order>
 <SellerId>testseller</SellerId>
</Req>

サンプルリクエスト2（手動追加（商品データベースからの引用なし）の場合）

<Req>
 <Target>
 <OrderId>testseller-10000001</OrderId>
 <IsQuotation>false</IsQuotation>
 </Target>
 <Order>
  <Item>
 <LineId>3</LineId>
 <ItemId>32a950b</ItemId>
 <Title>サンプル商品</Title>
 <UnitPrice>3800</UnitPrice>
 <Quantity>2</Quantity>
 </Item>
 </Order>
 <SellerId>testseller</SellerId>
</Req>

サンプルリクエスト3（複数ライン指定の場合）

<Req>
 <Target>
 <OrderId>storename-10000001</OrderId>
 <IsQuotation>true</IsQuotation>
 </Target>
 <Order>
 <Item>
 <LineId>4</LineId>
 <Title>商品名</Title>
 <UnitPrice>1000</UnitPrice>
 <ItemId>pointone</ItemId>
 <Quantity>1</Quantity>
 </Item>
 <Item>
 <LineId>5</LineId>
 <Title>商品名</Title>
 <UnitPrice>1000</UnitPrice>
 <ItemId>pointone</ItemId>
 <Quantity>2</Quantity>
 <IsQuotation>false</IsQuotation>
 </Item>
 <Item>
 <LineId>6</LineId>
 <Title>商品名</Title>
 <UnitPrice>1000</UnitPrice>
 <ItemId>pointone</ItemId>
 <Quantity>3</Quantity>
 </Item>
 </Order>
</Req>

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。（1固定） totalResultsReturned : 返された値の個数です。（1固定） ok : 更新OKになった要素数です。（常に0か1です。） ng : 更新NGになった要素数です。（常に0か1です。）
/ResultSet/Result	各個別レスポンスを含みます。
/ResultSet/Result/Status	処理成否（OK/NG）
/ResultSet/Result/Warning	警告情報（ある場合）
/ResultSet/Result/Warning/Code	警告コード（エラーコードと同じ体系です。）
/ResultSet/Result/Warning/Message	警告メッセージ
/ResultSet/Result/Warning/Detail	警告詳細（ある場合）

※なお、以下の条件で正常終了レスポンスに「警告」コードが付加される場合があります。
　警告が発生した場合でも、注文情報変更は完了します。

警告コード

コード	説明	発生条件
od91703	決済がキャンセル済みの為、金額連動が行われませんでした。	クレジットカード注文の場合のみ発生します。
od91059	決済との連携エラー（対応不要です）	金額変更を行った場合

サンプルレスポンス

<!--・サンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
    </Result>
</ResultSet>


<!--・警告ありのサンプルXML-->

<ResultSet totalResultsAvailable="1" totalResultsReturned="1" ok="1" ng="0">
    <Result>
        <Status>OK</Status>
        <Warning>
            <Code>od91703</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>

エラー

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

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

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

フィールド	値	説明
/Error	-	エラーレスポンスのすべてを含みます。
/Error/Code	string	エラーコード
/Error/Message	string	エラーメッセージ
/Error/Detail	-	エラー詳細（ある場合）
/Error/Detail/SettleCode	string	決済システムのエラーコード（APIエラーコードが「od91112」の場合）

エラーコード

コード	HTTPステータスコード	説明
od90101	400	リクエストパラメータエラーです。
od90103	400	リクエストと注文の整合性エラーです。
od90106	400	指定されたラインIDが既に存在します。
od90107	400	指定されたラインIDが既存ラインIDと連番になっていません。
od90109	400	指定された商品が販売期間外です。
od90110	400	予約中でない注文に予約商品を追加しようとしました。
od90135	400	決済上限金額を超えたエラーです。
od90146	400	第1類医薬品商品の追加はできません。
od90151	500	自宅外配送指定の注文のため商品の追加はできません。
od90166	400	不正注文に対する変更不可エラーです。
od91801	404	該当注文がありません。
od91008	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91009	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91011	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91012	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91013	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91101	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91110	500	決済におけるメンテナンスエラーです。連続して発生する場合はお問い合わせください。
od91111	500	決済におけるシステムエラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91112	500	決済におけるシステムエラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91115	500	決済における有効期限切れエラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91116	500	決済における疎通エラーです。連続して発生する場合はお問い合わせください。
od91117	500	決済における手数料取得エラーです。連続して発生する場合はお問い合わせください。
od91118	500	決済における一時的な操作不可エラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91119	500	決済における操作不可エラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91121	500	決済におけるエラーです。 ※このエラー発生時のリトライ処理は行わなわず決済方法を変更してください。
od91127	500	お客様のPayPay残高が不足している際に発生するエラーです。
od91128	500	PayPay残高決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91131	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91132	500	システムエラーです。連続して発生する場合はお問い合わせください。
od91142	500	支払番号発行待ちによるエラーです。支払番号が更新されるまでお待ち下さい。
od91902	404	メンテナンスエラー
od91201	500	決済エラーです。連続して発生する場合はお問い合わせください。
od90137	500	決済・ポイント処理を行っているため注文操作ができません。
od91102	500	ポイント残高不足により金額、ステータスの完了に変更をすることが出>来ません
od91149	500	キャンセル受付中のため注文の更新不可のエラーです。
od91154	500	ポイント処理中による更新不可エラーです。しばらく（最大約60分）してから、再度お試しください。
od90152	400	出荷指示済み後の注文操作不可エラーです。
od91166	500	決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91013	500	システムエラーです。連続して発生する場合はお問い合わせください。
od90185	400	ヤマトフルフィルギフト注文で、必要な情報が未設定や不正な値が設定されている場合のエラー
od90186	400	商品情報の設定によりヤマトフルフィル注文にできない場合のエラー
od90187	400	セラーの設定によりヤマトフルフィル注文にできない場合のエラー
od90149	400	Yahoo Auction Order can not change (OrderSplit) : {注文ID} Yahoo!オークション注文では変更できません。
od90302	400	「定期購入のみ」と設定されている商品は追加できません。
od90178	400	LINEギフト注文で変更不可な操作をした場合のエラー
od90195	400	ソーシャルギフト注文に対する変更不可エラーです。

利用制限

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

利用約款

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