Rakuten RMS WEB API client for .NET
CategoryAPI20
Namespace: Rakuten.RMS.Api.CategoryAPI20
カテゴリ情報を取得し、更新
public class CategoryAPI20 : Rakuten.RMS.Api.JSON.RakutenApiJsonClientBase
Inheritance Object → RakutenApiClientBaseCommon → RakutenApiJsonClientBase → CategoryAPI20
Methods
CreateCategory(NewCategory)
public string CreateCategory(NewCategory category)
Parameters
category NewCategory
Returns
DeleteItemMappings(String)
指定した商品管理番号を表示先カテゴリから削除
public void DeleteItemMappings(string manageNumber)
Parameters
manageNumber String
Exceptions
GetAllCategorySet()
public IList<CategorySet> GetAllCategorySet()
Returns
GetCategory(String, Boolean)
public Category GetCategory(string categoryId, bool breadcrumb)
Parameters
categoryId String
breadcrumb Boolean
Returns
GetCategorySet(String)
public CategorySet GetCategorySet(string categorySetId)
Parameters
categorySetId String
Returns
GetCategorySetIdList()
すべてのカテゴリセット情報を取得
public IList<String> GetCategorySetIdList()
Returns
GetCategorySetList(params CategorySetField[])
すべてのカテゴリセット情報を取得.取得したいカテゴリセット情報を指定する場合。
public IList<CategorySet> GetCategorySetList(params CategorySetField[] categorysetfields)
Parameters
categorysetfields CategorySetField[]
Returns
Exceptions
GetCategoryTree(String)
public CategoryTree GetCategoryTree(string categorySetId)
Parameters
categorySetId String
Returns
GetCategoryTrees(String, CategorySetField[], CategoryField[])
カテゴリセットIDを指定しカテゴリツリー情報を取得
public CategoryTreeResult GetCategoryTrees(string categorySetId, CategorySetField[] categorysetfields, CategoryField[] categoryfields)
Parameters
categorySetId String
カテゴリセットID カテゴリセットを利用していない場合、「0」を指定。
categorysetfields CategorySetField[]
カテゴリセットフィールド
categoryfields CategoryField[]
カテゴリフィールド
Returns
GetItemMappings(String, CategorySetField[], CategoryField[])
商品管理番号を指定し、カテゴリとの紐付き情報を取得
public GetItemMappingResponse GetItemMappings(string manageNumber, CategorySetField[] categorysetfields, CategoryField[] categoryfields)
Parameters
manageNumber String
商品管理番号
categorysetfields CategorySetField[]
カテゴリセットフィールド
categoryfields CategoryField[]
カテゴリフィールド
Returns
GetItemMappingsWithBreadcrumbs(String, CategorySetField[], CategoryField[])
public GetItemMappingWithBreadcrumbResponse GetItemMappingsWithBreadcrumbs(string manageNumber, CategorySetField[] categorysetfields, CategoryField[] categoryfields)
Parameters
manageNumber String
categorysetfields CategorySetField[]
categoryfields CategoryField[]
Returns
GetItemMappingWithBreadcrumbResponse
GetShopCategories(String, Nullable<Boolean>, CategorySetField[], CategoryField[])
カテゴリ情報を取得し、更新
public CategoryWithBreadcrumbs GetShopCategories(string categoryId, Nullable<Boolean> breadcrumb, CategorySetField[] categorysetfields, CategoryField[] categoryfields)
Parameters
categoryId String
カテゴリID
breadcrumb Nullable<Boolean>
true：指定したカテゴリと、パンくずでつながった全ての上位カテゴリ情報 false：指定したカテゴリ情報のみ（デフォルト）
categorysetfields CategorySetField[]
カテゴリセットフィールド
レスポンスの”breadcrumbs“内の以下のカテゴリセット情報を取得したい場合は指定。
categoryfields CategoryField[]
カテゴリフィールド
レスポンスの”breadcrumbs“内の以下のカテゴリ情報を取得したい場合は指定。
Returns
InsertShopCategory(NewCategory)
カテゴリ情報を登録
public string InsertShopCategory(NewCategory category)
Parameters
category NewCategory
Returns
カテゴリID
UpdateCategory(String, NewCategory)
public void UpdateCategory(string categoryId, NewCategory category)
Parameters
categoryId String
category NewCategory
UpdateCategoryTree(String, IList<CategoryIdWithChildren>)
public void UpdateCategoryTree(string categorySetId, IList<CategoryIdWithChildren> tree)
Parameters
categorySetId String
tree IList<CategoryIdWithChildren>
UpdateShopCategory(String, NewCategory)
カテゴリIDを指定しカテゴリ情報を更新
public ResultBase UpdateShopCategory(string categoryId, NewCategory category)
Parameters
categoryId String
カテゴリID
category NewCategory
Returns
UpsertCategoryTree(String, IList<CategoryIdWithChildren>)
public void UpsertCategoryTree(string categorySetId, IList<CategoryIdWithChildren> tree)
Parameters
categorySetId String
tree IList<CategoryIdWithChildren>
UpsertItemMappings(String, IList<String>, String)
指定した商品管理番号の表示先カテゴリの登録や変更 複数カテゴリへのマッピング時
public void UpsertItemMappings(string manageNumber, IList<String> categoryIds, string mainPluralCategoryId)
Parameters
manageNumber String
categoryIds IList<String>
mainPluralCategoryId String
Exceptions
UpsertItemMappings(String, String)
1カテゴリ - 1商品 モードの時の呼び出し。
public void UpsertItemMappings(string manageNumber, string categoryId)
Parameters
manageNumber String
categoryId String