Rakuten RMS WEB API client for .NET
ShopAPI
Namespace: Rakuten.RMS.Api.ShopAPI
GetLastResult()
public class ShopAPI : Rakuten.RMS.Api.XML.RakutenApiXmlClientBase
Inheritance Object → RakutenApiClientBaseCommon → RakutenApiXmlClientBase → ShopAPI
Fields
ModelNamespace
public static string ModelNamespace;
Properties
LastResult
public ShopBizApiResponse LastResult { get; protected set; }
Property Value
Methods
EditGoldTop(GoldTopBizModel)
public ShopBizApiResponse EditGoldTop(GoldTopBizModel model)
Parameters
model GoldTopBizModel
Returns
EditLayoutTextLarge(LayoutTextLargeBizModel)
public ShopBizApiResponse EditLayoutTextLarge(LayoutTextLargeBizModel model)
Parameters
model LayoutTextLargeBizModel
Returns
EditNaviButton(NaviButtonBizModelRequest)
public ShopBizApiResponseWithResult<NaviButtonBizModel> EditNaviButton(NaviButtonBizModelRequest request)
Parameters
request NaviButtonBizModelRequest
Returns
ShopBizApiResponseWithResult<NaviButtonBizModel>
EditNaviButtonInfo(NaviButtonInfoBizModelRequest)
public ShopBizApiResponseWithResult<ShopLayoutCommonBizModel> EditNaviButtonInfo(NaviButtonInfoBizModelRequest request)
Parameters
request NaviButtonInfoBizModelRequest
Returns
ShopBizApiResponseWithResult<ShopLayoutCommonBizModel>
EditShopAreaSoryo(ShopAreaSoryoWrapperBizModel)
public ShopBizApiResponse EditShopAreaSoryo(ShopAreaSoryoWrapperBizModel model)
Parameters
model ShopAreaSoryoWrapperBizModel
Returns
EditShopCalendarAndDesign(ShopCalendarAndDesignBizModel, Nullable<Boolean>)
営業日カレンダー・カレンダーデザイン設定を登録・更新・削除
public ShopBizApiResponse EditShopCalendarAndDesign(ShopCalendarAndDesignBizModel model, Nullable<Boolean> clearCalendar)
Parameters
model ShopCalendarAndDesignBizModel
clearCalendar Nullable<Boolean>
clearCalendar=trueを年中無休フラグ（nonHolidayFlag=1）と合わせて使用します。
Returns
EditShopHoliday(ShopHolidayBizModel)
public ShopBizApiResponse EditShopHoliday(ShopHolidayBizModel model)
Parameters
model ShopHolidayBizModel
Returns
EditShopLayoutCommon(shopLayoutCommonBizModelRequest)
public ShopBizApiResponse<ShopLayoutCommonResultMessage> EditShopLayoutCommon(shopLayoutCommonBizModelRequest request)
Parameters
request shopLayoutCommonBizModelRequest
Returns
ShopBizApiResponse<ShopLayoutCommonResultMessage>
EditShopLayoutImage(ShopLayoutImage)
public ShopBizApiResponse EditShopLayoutImage(ShopLayoutImage model)
Parameters
model ShopLayoutImage
Returns
EditShopStatus(String, ShopStatus)
public ShopBizApiResponse EditShopStatus(string statusKey, ShopStatus status)
Parameters
statusKey String
status ShopStatus
Returns
EditSignboard(String, String)
スマートフォン用小バナー設定の情報を登録・更新・削除・表示順変更
public ShopBizApiResponse EditSignboard(string spSignboardUrl, string pcSignboardUrl)
Parameters
spSignboardUrl String
pcSignboardUrl String
Returns
EditSpBigBanner(SpBigBannerBizModel)
public ShopBizApiResponse EditSpBigBanner(SpBigBannerBizModel model)
Parameters
model SpBigBannerBizModel
Returns
EditSpCategoryPage(SpCategoryPageBizModel)
public void EditSpCategoryPage(SpCategoryPageBizModel model)
Parameters
model SpCategoryPageBizModel
EditSpItemPage(SpItemPageBizModel)
public ShopBizApiResponse EditSpItemPage(SpItemPageBizModel model)
Parameters
model SpItemPageBizModel
Returns
EditSpMedamaCategory(SpMedamaCategoryBizModel)
public ShopBizApiResponse EditSpMedamaCategory(SpMedamaCategoryBizModel model)
Parameters
model SpMedamaCategoryBizModel
Returns
EditSpMedamaItem(SpMedamaItemBizModel)
public ShopBizApiResponse EditSpMedamaItem(SpMedamaItemBizModel model)
Parameters
model SpMedamaItemBizModel
Returns
EditSpSmallBanner(SpSmallBannerBizModel)
public ShopBizApiResponse EditSpSmallBanner(SpSmallBannerBizModel model)
Parameters
model SpSmallBannerBizModel
Returns
EditSpTopPage(SpTopPageBizModel)
public ShopBizApiResponse EditSpTopPage(SpTopPageBizModel model)
Parameters
model SpTopPageBizModel
Returns
EditTopDisplay(TopDisplay)
public ShopBizApiResponse EditTopDisplay(TopDisplay model)
Parameters
model TopDisplay
Returns
GetDeliverySetInfo(Nullable<Int32>)
public IList<DeliverySetInfo> GetDeliverySetInfo(Nullable<Int32> deliverySetId)
Parameters
deliverySetId Nullable<Int32>
Returns
GetDelvAreaMaster(Nullable<Int32>)
public DelvAreaMasterBizModel GetDelvAreaMaster(Nullable<Int32> delvAreaId)
Parameters
delvAreaId Nullable<Int32>
Returns
GetDelvdateMaster(String)
納期情報設定の情報を取得
public IList<DelvdateMaster> GetDelvdateMaster(string delvdateNumber)
Parameters
delvdateNumber String
指定したdelvdateNumberの情報を取得します。指定しない場合はすべての納期情報設定の情報を取得します。
Returns
GetGoldTop()
public GoldTopBizModel GetGoldTop()
Returns
GetLayoutCategoryMap(Nullable<Int32>)
カテゴリページ表示項目並び順の情報を取得
public IList<LayoutCategoryMap> GetLayoutCategoryMap(Nullable<Int32> categoryMapId)
Parameters
categoryMapId Nullable<Int32>
Returns
GetLayoutItemMap(Nullable<Int32>)
商品ページ表示項目並び順の情報を取得
public IList<LayoutItemMap> GetLayoutItemMap(Nullable<Int32> itemMapId)
Parameters
itemMapId Nullable<Int32>
Returns
GetLayoutLossLeader(Nullable<Int32>)
目玉商品（PC）のテンプレート設定情報のみを取得
public IList<LayoutLossLeader> GetLayoutLossLeader(Nullable<Int32> lossLeaderId)
Parameters
lossLeaderId Nullable<Int32>
lossLeaderId
Returns
GetLayoutTextLarge()
public LayoutTextLargeBizModel GetLayoutTextLarge()
Returns
GetLayoutTextSmall(Nullable<Int32>)
共通説明文（小）の情報を取得
public LayoutTextSmallList GetLayoutTextSmall(Nullable<Int32> textSmallId)
Parameters
textSmallId Nullable<Int32>
Returns
GetNaviButton()
public NaviButton GetNaviButton()
Returns
GetNaviButtonInfo(Nullable<Int64>)
public IList<NaviButtonInfo> GetNaviButtonInfo(Nullable<Int64> naviId)
Parameters
naviId Nullable<Int64>
Returns
GetOperationLeadTime(Nullable<Int32>)
この機能を利用すると、出荷リードタイムを取得することができます。※SKU移行後の店舗様向けの機能です。
public IList<OperationLeadTime> GetOperationLeadTime(Nullable<Int32> id)
Parameters
Returns
GetShipFrom(Nullable<Int32>)
出荷元住所を取得
public void GetShipFrom(Nullable<Int32> shipFromId)
Parameters
shipFromId Nullable<Int32>
GetShopAreaSoryo(Nullable<Int32>)
public ShopAreaSoryoWrapper GetShopAreaSoryo(Nullable<Int32> patternId)
Parameters
patternId Nullable<Int32>
Returns
GetShopCalendar(Nullable<DateTime>, Nullable<Int32>)
営業日カレンダー設定・ショップからの重要なお知らせの情報を取得
public ShopCalendar2 GetShopCalendar(Nullable<DateTime> fromDate, Nullable<Int32> period)
Parameters
fromDate Nullable<DateTime>
period Nullable<Int32>
取得する期間を指定します。(fromDate ～ fromDate + period)
デフォルト値は90日。
最大値は180日。
Returns
GetShopCalendarAndDesign()
public ShopCalendarAndDesignBizModel GetShopCalendarAndDesign()
Returns
GetShopHoliday()
public ShopHolidayBizModel GetShopHoliday()
Returns
GetShopLayoutCommon(Nullable<Int64>)
public IList<ShopLayoutCommon> GetShopLayoutCommon(Nullable<Int64> layoutCommonId)
Parameters
layoutCommonId Nullable<Int64>
Returns
GetShopLayoutImage()
public ShopLayoutImage GetShopLayoutImage()
Returns
GetShopMaster()
public ShopMaster GetShopMaster()
Returns
GetShopStatus(String)
skuMigration：SKU移行 pcTopMigration：PC用トップページの移行
public ShopStatusBizModel GetShopStatus(string statusKey)
Parameters
statusKey String
Returns
GetSignboard()
スマートフォン用・PC用新店舗トップページの看板画像URLを取
public ShopBizApiResponseWithResult<SignboardBizModel> GetSignboard()
Returns
ShopBizApiResponseWithResult<SignboardBizModel>
GetSoryoKbn(Nullable<Int32>, Nullable<Int32>)
public SoryoKbnBizModel GetSoryoKbn(Nullable<Int32> kbnId, Nullable<Int32> id)
Parameters
kbnId Nullable<Int32>
Returns
GetSpBigBanner()
public SpBigBannerBizModel GetSpBigBanner()
Returns
GetSpCategoryPage()
public SpCategoryPageBizModel GetSpCategoryPage()
Returns
GetSpItemPage()
public SpItemPageBizModel GetSpItemPage()
Returns
GetSpMedamaCategory()
public SpMedamaCategoryBizModel GetSpMedamaCategory()
Returns
GetSpMedamaItem()
public ShopBizApiResponse GetSpMedamaItem()
Returns
GetSpSmallBanner()
public SpSmallBannerBizModel GetSpSmallBanner()
Returns
GetSpTopPage()
public SpTopPageBizModel GetSpTopPage()
Returns
GetSpTopPageDisplay()
2022年4月18日（月）リリースのスマートフォン用トップページへの切替を行ったかを確認
public int GetSpTopPageDisplay()
Returns
0: 従来版スマートフォン用トップページ 1: 2022年4月18日（月）リリースのスマートフォン用トップページ
GetTopDisplay()
public TopDisplay GetTopDisplay()