ショッピング

注文分割API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderSplit


本番環境用APIを利用したい場合は、こちらをご確認ください。

テスト用APIはどなたでもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderSplit
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

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

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

【分割不可なもの】

  • お支払い方法が「ドコモ ケータイ支払い」「auかんたん決済」「ソフトバンクまとめて支払い」の注文
  • ストア発行の値引きクーポンが利用されている注文
  • リクエストパラメータ

    RESTリクエストの構築(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 ストアアカウント

    ※こちらのAPIはYahoo! ID連携に対応したAPIです。
    Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
    Yahoo! ID連携
    Yahoo! ID連携によるAPIアクセス実装方法


    サンプルリクエスト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



    サンプルレスポンス

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



    エラー

    注文分割APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

    ・エラーコード

    コード HTTPステータスコード 説明
    od90101 400 リクエストパラメータエラーです。
    od90135 400 決済上限金額を超えたエラーです。
    od90201 400 分割不可エラーです。
    od91008 500 システムエラーです。連続して発生する場合はお問い合わせください。
    od91009 500 システムエラーです。連続して発生する場合はお問い合わせください。
    od91101 500 システムエラーです。連続して発生する場合はお問い合わせください。
    od91110 500 決済におけるメンテナンスエラーです。連続して発生する場合はお問い合わせください。
    od91111 500 決済におけるタイムアウトエラーです。連続して発生する場合はお問い合わせください。
    od91121 500 決済処理エラーです。連続して発生する場合はお問い合わせください。
    od91132 500 システムエラーです。連続して発生する場合はお問い合わせください。
    od91601 405 リクエストメソッドエラーです。
    od91801 404 該当注文なしエラーです。
    od91012 500 システムエラーです。連続して発生する場合はお問い合わせください。
    od91120 500 決済連携エラーです。連続して発生する場合はお問い合わせください。
    od91139 500 エラー回数の上限に達したため、本日中は注文情報の操作が行えません。この注文者のクレジットカードは、現在使用できない状態です。
    od91902 404 メンテナンスエラー
    od91201 500 決済エラーです。連続して発生する場合はお問い合わせください。




    利用制限

    ※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
    ※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
    まずはヘルプページのお問い合わせフォームからご相談ください。

    利用約款

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