ショッピング

出荷ステータス変更API

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

変更履歴(2019年03月27日)

「配送会社名」を修正します。
 ・「西武運輸(1005)」⇒「セイノースーパーエクスプレス(1005)」へ変更
 ・「日通通運(1021)」⇒「日本通運(1021)」へ変更
リリース日:2019年04月09日(火)



利用申請について

本番環境について

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

テスト環境について

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



リクエストURL

リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderShipStatusChange
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/orderShipStatusChange



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

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

リクエストパラメータ

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

ご注意ください
伝票番号(ShipInvoiceNumber)と伝票番号なし理由(ShipInvoiceNumberEmpryReason)は排他関係です。同時更新、他コードが存在している状況での更新はエラーとなります。

パラメータ 説明
/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 配送方法:postage1-14,16のどれか1つ(postage15は欠番)ストアクリエイターProの配送設定順
/Req/Order/Ship/ShipNotes string 配送メモ(最大半角500文字)
/Req/Order/Ship/ShipCompanyCode string 配送会社コード
1000:その他
1001:ヤマト運輸
1002:佐川急便
1003:日本郵便
1004:西濃運輸
(一覧はこちら
/Req/Order/Ship/ShipInvoiceNumber1 string 配送伝票番号1
/Req/Order/Ship/ShipInvoiceNumber2 string 配送伝票番号2
/Req/Order/Ship/ShipInvoiceNumberEmptyReason string 伝票番号なし理由
NULL:(未登録の状態)
101:メーカ等の在庫元からの直送品のため
102:発送不要の商品のため
103:店頭受け取り商品のため
104:配送会社から直接ご連絡のため
105:伝票番号が発行されない(追跡できない)配送方法のため
/Req/Order/Ship/ShipUrl string 配送会社URL。最大半角100文字。&などが含まれる場合はCDATAとする必要があります。
/Req/Order/Ship/ShipDate date 出荷日(YYYYMMDD)
/Req/Order/Ship/ArrivalDate date 着荷日(YYYYMMDD)
Req/Order/Ship/ShipInstructStatus integer ※ヤマトピック&デリバリー専用項目
出荷指示ステータス

100:出荷指示受付前
101:出荷指示待ち
102:出荷キャンセル
103:出荷指示済み
104:出荷完了
105:着荷完了
106:配送不可

103:出荷指示済み(トータルピック完了)以外は指定不可

トータルピック完了後に連携をお願いします。

毎日23:00~翌7:00までシステムメンテナンスに入ります。
ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。余裕を持った更新をお願いします。

またヤマト運輸内部での出荷指示は1日1回14時となります。
当日中の出荷指示をご要望の場合は13:00までに連携をお願いします。
※連携の件数によっては13:00に行なっても14:00に間に合わないケースがあります。余裕を持った更新をお願いします。
Req/Order/Ship/CollectionDate date ※ヤマトピック&デリバリー専用項目
集荷日(YYYYMMDD)
※ ShipInstructStatus=103:出荷指示済み 指定時は必須、それ以外の時は指定不可
※当日もしくは翌日のみ登録可

毎日23:00~翌7:00までシステムメンテナンスに入ります。

ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。
Req/Order/Ship/CashOnDeliveryTax integer ※ヤマトピック&デリバリー専用項目
代引き用消費税額
税額無しの場合は0を指定
税額未入力の場合は、出荷指示ステータス=出荷指示済み変更時に10%で自動計算された値が入ります。

毎日23:00~翌7:00までシステムメンテナンスに入ります。

ヤマト運輸へのデータ連携は翌7:00から行われますので当日中連携をご希望の場合は22:30ごろまでに更新をお願いします。
※連携の件数によっては22:30に行なっても翌朝になるケースもございます。
/Req/SellerId
(必須)
string ストアアカウント

配送会社コード(ShipCompanyCode) :

配送会社コード配送会社名
1000その他
1001ヤマト運輸
1002佐川急便
1003日本郵便
1004西濃運輸
1005セイノースーパーエクスプレス
1006福山通運
1007名鉄運輸
1008トナミ運輸
1009第一貨物
1010新潟運輸
1011中越運送
1012岡山県貨物運送
1013久留米運送
1014山陽自動車運送
1015日本トラック
1016エコ配
1017EMS
1018DHL
1019FedEx
1020UPS
1021日本通運
1022TNT
1023OCS
1024USPS
1025SFエクスプレス
1026Aramex
1027SGHグローバル・ジャパン

サンプルリクエスト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>postage1</ShipMethod>
  <ShipNotes>2つに分けて届ける</ShipNotes>
  <ShipCompanyCode>1001</ShipCompanyCode>
  <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 システムエラーです。連続して発生する場合はお問い合わせください。
od91149 500 キャンセル受付中のため注文の更新不可のエラーです。
od91902 404 メンテナンスエラー
od90103 400 リクエストと注文の整合性エラーです。
od90152 400 ※ヤマトピック&デリバリー専用項目
出荷指示済み後の注文操作不可エラーです。
od90153 400 ※ヤマトピック&デリバリー専用項目
ヤマトP&D対象ではない注文のヤマト配送専用項目の変更時のエラーです。
od90154 400 ※ヤマトピック&デリバリー専用項目
出荷キャンセル済み注文の注文操作不可エラーです。
od90155 400 ※ヤマトピック&デリバリー専用項目
ヤマトシステムへの連携処理中注文の注文操作不可エラーです。
od90156 400 ※ヤマトピック&デリバリー専用項目
ヤマトP&Dの手数料もしくは、決済金額が上限を超えている場合にエラーとなります。
手数料(pay_charge)が1000,000円以上
決済金額が各配送方法で以下の場合エラーとなります。
宅急便: 30万円超
コンパクト便: 3万円超
ネコポス便: 3000円超
od90157 400 ※ヤマトピック&デリバリー専用項目
必須となる情報が設定されていない、または不正の場合、出荷指示済みへ更新時にエラーとなります。
od90159 400 ※ヤマトピック&デリバリー専用項目
ヤマト配送注文かつ支払方法が商品代引の場合に、代引き契約が許可なし、又は、配送方法がネコポスの注文操作不可エラーです。
od90160 400 ※ヤマトピック&デリバリー専用項目
ヤマト配送注文かつ支払方法が商品代引ではない場合に、代引き用消費税額の更新操作はできません。
od90161 400 ※ヤマトピック&デリバリー専用項目
ヤマト配送注文かつ出荷指示済みへ更新時以外の場合に更新不可項目を指定された場合のエラーです。




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

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