Rakuten RMS WEB API client for .NET

RakutenPayOrderService

Namespace: Rakuten.RMS.Api.RakutenPayOrderAPI

楽天ペイ受注API（RakutenPayOrderAPI）

public class RakutenPayOrderService : Rakuten.RMS.Api.JSON.RakutenApiJsonClientBase

Inheritance Object → RakutenApiClientBaseCommon → RakutenApiJsonClientBase → RakutenPayOrderService

Methods

CancelOrder(String, Int32, Int32)

次のステータスの注文にのみ有効
・100: 注文確認待ち
・200: 楽天処理中
・300: 発送待ち

public IEnumerable<OrderMessageModel> CancelOrder(string orderNumber, int inventoryRestoreType, int changeReasonDetailApply)

Parameters

orderNumber String
注文番号キャンセル申請対象の受注番号。

inventoryRestoreType Int32
在庫連動区分
0: 商品設定に合わせる
1: 在庫連動する
2: 在庫連動しない

changeReasonDetailApply Int32
キャンセル理由
(お客様都合による)
1: キャンセル
2: 受取後の返品
3: 長期不在による受取拒否
4: 未入金
5: 代引決済の受取拒否
6: その他
(店舗都合による)
8: 欠品
10: その他
13: 発送遅延
14: 顧客・配送対応注意表示
15: 返品（破損・品間違い）

Returns

IEnumerable<OrderMessageModel>

CancelOrderAfterShipping(String, Int32, Int32)

注文キャンセル（発送後）発送完了報告後の受注に対してキャンセルを要求する。次のステータスの注文にのみ有効・500: 発送済・600: 支払手続き中・700: 支払手続き済・800: キャンセル確定待ち ※キャンセル確定までを一括で行いますので、商品が返品されたことを確認後に実施してください。

public IList<OrderMessageModel> CancelOrderAfterShipping(string orderNumber, int inventoryRestoreType, int changeReasonDetailApply)

Parameters

orderNumber String
注文番号キャンセル申請対象の受注番号。

inventoryRestoreType Int32
在庫連動区分以下のいずれか 0: 商品設定に合わせる 1: 在庫連動する 2: 在庫連動しない

changeReasonDetailApply Int32
キャンセル理由以下のいずれか (お客様都合による) 1: キャンセル 2: 受取後の返品 3: 長期不在による受取拒否 4: 未入金 5: 代引決済の受取拒否 6: その他 (店舗都合による) 8: 欠品 10: その他 13: 発送遅延 14: 顧客・配送対応注意表示 15: 返品（破損・品間違い）

Returns

IList<OrderMessageModel>

ConfirmOrder(IList<String>)

楽天ペイ注文の「注文確認」を行うことができます。こちらは同期処理となります。

public IEnumerable<OrderMessageModel> ConfirmOrder(IList<String> orderNumberList)

Parameters

orderNumberList IList<String>
注文番号リスト最大 100 件まで指定可能

Returns

IEnumerable<OrderMessageModel>

GetOrder(IEnumerable<String>, Int32)

複数の注文番号を指定して注文の詳細を取得する。

public GetOrderResponse GetOrder(IEnumerable<String> orderNumberList, int version)

Parameters

orderNumberList IEnumerable<String>
注文番号

version Int32
3: 消費税増税対応 4: 共通の送料込みライン対応 5: 領収書、前払い期限版 6: 顧客・配送対応注意表示詳細対応 7: SKU対応

Returns

GetOrderResponse

GetOrder(String, Int32)

１つの注文詳細を取得。

public OrderModel GetOrder(string orderNumber, int version)

Parameters

orderNumber String
注文番号

version Int32
3: 消費税増税対応
4: 共通の送料込みライン対応
5: 領収書、前払い期限版
6: 顧客・配送対応注意表示詳細対応
7: SKU対応

Returns

OrderModel

Exceptions

RakutenRMSApiException

GetPayment(String, Int32)

注文番号を指定して、支払明細情報を取得する。

public GetPaymentResponse GetPayment(string orderNumber, int version)

Parameters

orderNumber String
注文番号

version Int32

Returns

GetPaymentResponse

GetResultUpdateOrderShippingAsync(String)

public UpdateOrderShippingResultResponse GetResultUpdateOrderShippingAsync(string requestId)

Parameters

requestId String

Returns

UpdateOrderShippingResultResponse

GetSubStatusList()

public GetSubStatusListResponse GetSubStatusList()

Returns

GetSubStatusListResponse

SearchOrder(SearchOrderRequest)

public SearchOrderResponse SearchOrder(SearchOrderRequest request)

Parameters

request SearchOrderRequest

Returns

SearchOrderResponse

UpdateOrderDelivery(String, String)

・配送方法（宅急便・国際配送・ゆうパック・自社配送・バイク便・その他配送方法１・その他配送方法２・その他配送方法３

public IList<OrderMessageModel> UpdateOrderDelivery(string orderNumber, string deliveryName)

Parameters

orderNumber String
注文番号

deliveryName String
店舗設定で設定した配送方法を指定

Returns

IList<OrderMessageModel>

UpdateOrderMemo(UpdateOrderMemoRequest)

以下の情報を更新可能・ひとことメモ・担当者・利用サービス名（配送区分）・お客様へのメッセージ・お届け日指定・お届け時間帯・サブステータスID

public IList<Message> UpdateOrderMemo(UpdateOrderMemoRequest request)

Parameters

request UpdateOrderMemoRequest

Returns

IList<Message>

UpdateOrderOrderer(String, OrdererModel, Nullable<Int32>)

・注文者 - 名前・注文者 - フリガナ・注文者 - 住所・注文者 - 電話番号・注文者 - メールアドレス・注文者 - 性別・注文者 - 誕生日

public IList<OrderMessageModel> UpdateOrderOrderer(string orderNumber, OrdererModel ordererModel, Nullable<Int32> reductionReason)

Parameters

orderNumber String
注文番号

ordererModel OrdererModel

reductionReason Nullable<Int32>
以下のいずれか (お客様都合による) 1: キャンセル 2: 受取後の返品 3: 長期不在による受取拒否 4: 未入金 5: 代引決済の受取拒否 6: その他 (店舗都合による) 8: 欠品 10: その他 13: 発送遅延 14: 顧客・配送対応注意表示 15: 返品（破損・品間違い） ※以下の条件で必須。

減額変更時
楽天市場共通の後払い決済かつ発送完了報告後の変更時

Returns

IList<OrderMessageModel>

UpdateOrderRemarks(String, String, Nullable<Int32>)

以下の情報を更新可能・備考・ギフト配送（希望する・希望しない）

public IList<Message> UpdateOrderRemarks(string orderNumber, string remarks, Nullable<Int32> giftCheck)

Parameters

orderNumber String
注文番号

remarks String
コメント

giftCheck Nullable<Int32>
ギフト配送 0: 希望しない 1: 希望する

Returns

IList<Message>

UpdateOrderSender(OrderSenderRequest)

public IList<OrderMessageModel> UpdateOrderSender(OrderSenderRequest request)

Parameters

request OrderSenderRequest

Returns

IList<OrderMessageModel>

UpdateOrderSenderAfterShipping(OrderSenderRequest)

public IList<OrderMessageModel> UpdateOrderSenderAfterShipping(OrderSenderRequest request)

Parameters

request OrderSenderRequest

Returns

IList<OrderMessageModel>

UpdateOrderShipping(String, IEnumerable<BasketidModel>)

１注文の配送情報の更新が可能。発送が完了した注文の、伝票番号、出荷日を登録して、注文を締める。

public IEnumerable<OrderShippingMessageModel> UpdateOrderShipping(string orderNumber, IEnumerable<BasketidModel> BasketidModelList)

Parameters

orderNumber String
注文番号

BasketidModelList IEnumerable<BasketidModel>

Returns

IEnumerable<OrderShippingMessageModel>

UpdateOrderShippingAsync(IEnumerable<OrderMessageModel>)

発送完了報告（非同期）「発送完了報告」処理を複数件一括で非同期更新する。機能呼び出しの返却値としてrequestId が発行され、この値を元に発送完了報告（非同期結果確認）を実行し、処理結果を確認する。

public UpdateOrderShippingAsyncResponse UpdateOrderShippingAsync(IEnumerable<OrderMessageModel> messageModelList)

Parameters

messageModelList IEnumerable<OrderMessageModel>

Returns

UpdateOrderShippingAsyncResponse

UpdateOrderSubStatus(Int32, IEnumerable<String>)

public IEnumerable<OrderMessageModel> UpdateOrderSubStatus(int subStatusId, IEnumerable<String> orderNumberList)

Parameters

subStatusId Int32

orderNumberList IEnumerable<String>

Returns

IEnumerable<OrderMessageModel>

< クラス一覧