注文に関するAPIとは
注文に関するAPIとは、お客様が購入した注文に対して 受注→出荷→対応完了の処理を行うための一連のAPIです。
下の図は標準的な受注対応の流れを示したものです。
Yahoo!ショッピングが提供する決済方法では入金ステータスが自動更新されたり、また、前払いか後払いかの注文により出荷ステータスが自動更新されるため、注文ステータス、入金ステータス、出荷ステータスの遷移については正確に理解する必要があります。
注文検索に関するAPI
| API名 | 機能概要 |
|---|---|
| 注文ステータス別件数参照API | 新規注文、新規予約の件数を出力します。定期的にリクエストすることで新規の注文有無をチェックできます。 |
| 注文検索API | 注文検索条件に一致する注文情報をレスポンスします。 |
| 注文詳細API | 注文番号に一致する注文情報をレスポンスします。 |
各種ステータス変更に関するAPI
| API名 | 機能概要 |
|---|---|
| 注文ステータス変更API | 注文ステータスを変更します。 |
| 入金ステータス変更API | 入金ステータスを変更します。 |
| 出荷ステータス変更API | 出荷ステータスを変更します。 |
注文情報変更に関するAPI
| API名 | 機能概要 |
|---|---|
| 注文内容変更API | 注文内容を変更します。 |
| 注文操作履歴一覧API | 注文情報の変更履歴をレスポンスします。 |
| 注文分割API | １つの注文を2つの注文に分割します。 |
| 注文ライン追加API | 注文情報に新しい商品を追加します。 商品数を増やす場合は注文内容変更APIを使ってください。 |
| クーポンキャンセルAPI | クーポンを利用している場合、クーポン適用をキャンセルします |
その他
| API名 | 機能概要 |
|---|---|
| 支払番号発行API | キャリア決済等の場合の支払い番号を発行します。 |
代表的な注文業務
- 新しい注文が入ってから業務に応じた代表的な処理を次に説明します。
-
受注
画像を拡大する -
注文変更（送料変更）
画像を拡大する 注文変更（注文分割）
画像を拡大する注文変更（商品追加）
画像を拡大する入金処理
画像を拡大する出荷準備
画像を拡大する出荷完了
画像を拡大する注文ステータスの変更
注文ステータスを予約中、処理中、保留、キャンセル、完了にする業務に対応します。
画像を拡大する
FraudHoldStatus（不正保留ステータス）について
FraudHoldStatus（不正保留ステータス）の状態によっては、意図した注文ステータスの更新ができない場合があります。
値ごとの注文ステータスの変更可否は下記の通りです。
| FraudHoldStatus | 注文ステータス変更可否 |
|---|---|
| 0 or null：不正リスク低 | 〇（変更可能） |
| 1：ルール保留審査中 | △（キャンセルへの変更のみ可能） |
| 2：ルール保留解除 | 〇（変更可能） |
| 3：ルール悪用確定 | △（キャンセルへの変更のみ可能） |