ショッピング

出荷ステータス変更API

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


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

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

注文の配送状況を管理するための「出荷ステータス」の更新機能を提供します。

【出荷ステータス遷移表】

変更後
変更前 0 : 出荷不可 1 : 出荷可 2 : 出荷処理中 3 : 出荷完了 4 : 着荷完了
0 : 出荷不可 ×
1 : 出荷可 × ×
2 : 出荷処理中 × ×
3 : 出荷完了 × ×
4 : 着荷完了 × ×

リクエストパラメータ

RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
/Req リクエストパラメータ
/Req/Target 更新対象指定情報
/Req/Target/OrderId
(必須)
string 注文ID
/Req/Target/IsPointFix
(必須)
boolean ポイント確定要否
true : ポイント確定します。
false : ポイント確定しません。
/Req/Target/OperationUser string 更新者名(ビジネスID登録氏名)
/Req/Order 更新情報
/Req/Order/Ship 配送情報
/Req/Order/Ship/ShipStatus
(必須)
integer 出荷ステータス
0 : 出荷不可
1 : 出荷可
2 : 出荷処理中
3 : 出荷完了
4 : 着荷完了
/Req/Order/Ship/ShipMethod string 配送方法(固定文字列)
/Req/Order/Ship/ShipNotes string 配送メモ(最大半角500文字)
/Req/Order/Ship/ShipInvoiceNumber1 string 配送伝票番号1
/Req/Order/Ship/ShipInvoiceNumber2 string 配送伝票番号2
/Req/Order/Ship/ShipUrl string 配送会社URL。最大半角100文字。&などが含まれる場合はCDATAとする必要があります。
/Req/Order/Ship/ShipDate date 出荷日(YYYYMMDD)
/Req/Order/Ship/ArrivalDate date 着荷日(YYYYMMDD)
/Req/SellerId
(必須)
string ストアアカウント

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


サンプルリクエストURL

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

サンプルリクエスト

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

<Req>
 <Target>
  <OrderId>testseller-10000001</OrderId>
  <IsPointFix>true</IsPointFix>
  <OperationUser>家風太郎</OperationUser>
 </Target>
 <Order>
  <Ship>
   <ShipStatus>3</ShipStatus>
   <ShipMethod>ヤマト宅急便</ShipMethod>
   <ShipNotes>2つに分けて届ける</ShipNotes>
   <ShipInvoiceNumber1>123-456789-012345</ShipInvoiceNumber1>
   <ShipInvoiceNumber2>234-567890-123456</ShipInvoiceNumber2>
   <ShipUrl><![CDATA[http://hoge.hogehoge.jp&p=100]]></ShipUrl>
   <ShipDate>20140921</ShipDate>
   <ArrivalDate>20140921</ArrivalDate>
  </Ship>
 </Order>
 <SellerId>testseller</SellerId>
</Req>



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • ok : 更新OKになった要素数です。(常に1です。)
  • ng : 更新NGになった要素数です。(常に0です。)

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 処理成否(OKのみ)
/ResultSet/Result/Warning 警告情報(ある場合)
/ResultSet/Result/Warning/Code 警告コード(エラーコードと同じ体系です。)
/ResultSet/Result/Warning/Message 警告メッセージ
/ResultSet/Result/Warning/Detail 警告詳細(ある場合)

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

・警告コード

コード 説明 発生条件
od91113 決済が既に売上確定済みであった為、新たに売上確定は行いませんでした。 クレジットカード決済注文の出荷完了遷移時のみ発生します。
od91115 決済が売上確定有効期限切れであった為、売上確定を行いませんでした。 クレジットカード決済注文の出荷完了遷移時のみ発生します。




サンプルレスポンス

<!-- •サンプル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>od91113</Code>
            <Message></Message>
            <Detail></Detail>
        </Warning>
    </Result>
</ResultSet>



エラー

出荷ステータス変更APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

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


・エラーコード

コード HTTPステータスコード 説明
od90101 400 リクエストパラメータエラーです。
od90103 400 リクエストと注文の整合性エラーです。
od90105 400 処理できないステータスです。
od90901 403 更新許可がありません。
od91801 404 該当注文がありません。
od91008 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91009 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91011 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91012 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91110 500 決済におけるメンテナンスエラーです。連続して発生する場合はお問い合わせください。
od91112 500 決済におけるシステムエラーです。連続して発生する場合はお問い合わせください。
od91116 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91118 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91119 500 決済エラーです。連続して発生する場合はお問い合わせください。
od91132 500 システムエラーです。連続して発生する場合はお問い合わせください。
od91902 404 メンテナンスエラー




利用制限

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

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。