Class Categories

Hierarchy

Categories

Index

Properties

Methods

As Create Delete DeleteAssignment DeleteBundleAssignment DeleteProductAssignment Get List ListAssignments ListBundleAssignments ListProductAssignments Patch Save SaveAssignment SaveBundleAssignment SaveProductAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): Categories
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Categories.As().List() // lists Categories using the impersonated users' token
```
Returns Categories
- Defined in api/Categories.ts:406

Create

Create<TCategory>(catalogID: string, category: Category<any>, listOptions?: {
adjustListOrders?: boolean;
}, requestOptions?: RequestOptions): Promise<RequiredDeep<TCategory>>
Create a new category. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder. Check out the docs for more info
Type Parameters
- TCategory extends Category<any, TCategory>
Parameters
- catalogID: string
  
  ID of the catalog.
- category: Category<any>
  
  Required fields: Name
- listOptions: {
  adjustListOrders?: boolean;
  } = {}
  - Optional adjustListOrders?: boolean
    
    Adjust list orders of the category.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCategory>>
- Defined in api/Categories.ts:80

Delete

Delete(catalogID: string, categoryID: string, requestOptions?: RequestOptions): Promise<void>
Delete a category. Deleting a parent category will also delete all of that category's children. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:148

DeleteAssignment

DeleteAssignment(catalogID: string, categoryID: string, listOptions?: {
    buyerID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a category assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- listOptions: {
      buyerID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:197

DeleteBundleAssignment

DeleteBundleAssignment(catalogID: string, categoryID: string, bundleID: string, requestOptions?: RequestOptions): Promise<void>
Delete a category bundle assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- bundleID: string
  
  ID of the bundle.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:220

DeleteProductAssignment

DeleteProductAssignment(catalogID: string, categoryID: string, productID: string, requestOptions?: RequestOptions): Promise<void>
Delete a category product assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- productID: string
  
  ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:243

Get

Get<TCategory>(catalogID: string, categoryID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TCategory>>
Get a single category. Check out the docs for more info
Type Parameters
- TCategory extends Category<any, TCategory>
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCategory>>
- Defined in api/Categories.ts:102

List

List<TCategory>(catalogID: string, listOptions?: {
    depth?: string;
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description")[];
    sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCategory>>>
Get a list of categories. Check out the docs for more info
Type Parameters
- TCategory extends Category<any, TCategory>
Parameters
- catalogID: string
  
  ID of the catalog.
- listOptions: {
      depth?: string;
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description")[];
      sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
  } = {}
  - Optional depth?: string
    
    Depth of the category.
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "Description")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCategory>>>
- Defined in api/Categories.ts:57

ListAssignments

ListAssignments<TCategoryAssignment>(catalogID: string, listOptions?: {
    buyerID?: string;
    categoryID?: string;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCategoryAssignment>>>
Get a list of category assignments. Check out the docs for more info
Type Parameters
- TCategoryAssignment extends CategoryAssignment
Parameters
- catalogID: string
  
  ID of the catalog.
- listOptions: {
      buyerID?: string;
      categoryID?: string;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional categoryID?: string
    
    ID of the category.
  - Optional level?: PartyType
    
    Level of the category assignment. Possible values: User, Group, Company.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCategoryAssignment>>>
- Defined in api/Categories.ts:271

ListBundleAssignments

ListBundleAssignments<TCategoryBundleAssignment>(catalogID: string, listOptions?: {
    bundleID?: string;
    categoryID?: string;
    page?: number;
    pageSize?: number;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCategoryBundleAssignment>>>
Get a list of category bundle assignments. Check out the docs for more info
Type Parameters
- TCategoryBundleAssignment extends CategoryBundleAssignment
Parameters
- catalogID: string
  
  ID of the catalog.
- listOptions: {
      bundleID?: string;
      categoryID?: string;
      page?: number;
      pageSize?: number;
  } = {}
  - Optional bundleID?: string
    
    ID of the bundle.
  - Optional categoryID?: string
    
    ID of the category.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCategoryBundleAssignment>>>
- Defined in api/Categories.ts:318

ListProductAssignments

ListProductAssignments<TCategoryProductAssignment>(catalogID: string, listOptions?: {
    categoryID?: string;
    page?: number;
    pageSize?: number;
    productID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCategoryProductAssignment>>>
Get a list of category product assignments. Check out the docs for more info
Type Parameters
- TCategoryProductAssignment extends CategoryProductAssignment
Parameters
- catalogID: string
  
  ID of the catalog.
- listOptions: {
      categoryID?: string;
      page?: number;
      pageSize?: number;
      productID?: string;
  } = {}
  - Optional categoryID?: string
    
    ID of the category.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional productID?: string
    
    ID of the product.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCategoryProductAssignment>>>
- Defined in api/Categories.ts:365

Patch

Patch<TCategory>(catalogID: string, categoryID: string, category: PartialObjectDeep<Category<any>>, listOptions?: {
adjustListOrders?: boolean;
}, requestOptions?: RequestOptions): Promise<RequiredDeep<TCategory>>
Partially update a category. Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder. Check out the docs for more info
Type Parameters
- TCategory extends Category<any, TCategory>
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- category: PartialObjectDeep<Category<any>>
- listOptions: {
  adjustListOrders?: boolean;
  } = {}
  - Optional adjustListOrders?: boolean
    
    Adjust list orders of the partial 1.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCategory>>
- Defined in api/Categories.ts:172

Save

Save<TCategory>(catalogID: string, categoryID: string, category: Category<any>, listOptions?: {
adjustListOrders?: boolean;
}, requestOptions?: RequestOptions): Promise<RequiredDeep<TCategory>>
Create or update a category. If an object with the same ID already exists, it will be overwritten.

Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder. Check out the docs for more info
Type Parameters
- TCategory extends Category<any, TCategory>
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryID: string
  
  ID of the category.
- category: Category<any>
  
  Required fields: Name
- listOptions: {
  adjustListOrders?: boolean;
  } = {}
  - Optional adjustListOrders?: boolean
    
    Adjust list orders of the category.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCategory>>
- Defined in api/Categories.ts:126

SaveAssignment

SaveAssignment(catalogID: string, categoryAssignment: CategoryAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a category assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryAssignment: CategoryAssignment
  
  Required fields: CategoryID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:293

SaveBundleAssignment

SaveBundleAssignment(catalogID: string, categoryBundleAssignment: CategoryBundleAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a category bundle assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryBundleAssignment: CategoryBundleAssignment
  
  Required fields: CategoryID, BundleID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:340

SaveProductAssignment

SaveProductAssignment(catalogID: string, categoryProductAssignment: CategoryProductAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a category product assignment. Check out the docs for more info
Parameters
- catalogID: string
  
  ID of the catalog.
- categoryProductAssignment: CategoryProductAssignment
  
  Required fields: CategoryID, ProductID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Categories.ts:387

Class Categories

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Categories

Create

Type Parameters

TCategory extends Category<any, TCategory>

Parameters

catalogID: string

category: Category<any>

listOptions: { adjustListOrders?: boolean; } = {}

Optional adjustListOrders?: boolean

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCategory>>

Delete

Parameters

catalogID: string

categoryID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

catalogID: string

categoryID: string

listOptions: { buyerID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteBundleAssignment

Parameters

catalogID: string

categoryID: string

bundleID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteProductAssignment

Parameters

catalogID: string

categoryID: string

productID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TCategory extends Category<any, TCategory>

Parameters

catalogID: string

categoryID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCategory>>

List

Type Parameters

TCategory extends Category<any, TCategory>

Parameters

catalogID: string

listOptions: { depth?: string; filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name" | "Description")[]; sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]; } = {}

Optional depth?: string

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "Description")[]

Optional sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TCategory>>>

ListAssignments

Type Parameters

TCategoryAssignment extends CategoryAssignment

Parameters

catalogID: string

`Private` impersonating

listOptions: {
adjustListOrders?: boolean;
} = {}

`Optional` adjustListOrders?: boolean

listOptions: {
buyerID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
depth?: string;
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name" | "Description")[];
sortBy?: ("ID" | "Name" | "!ID" | "!Name")[];
} = {}

`Optional` depth?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "Description")[]

`Optional` sortBy?: ("ID" | "Name" | "!ID" | "!Name")[]

listOptions: {
buyerID?: string;
categoryID?: string;
level?: PartyType;
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` categoryID?: string

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
bundleID?: string;
categoryID?: string;
page?: number;
pageSize?: number;
} = {}

`Optional` bundleID?: string

`Optional` categoryID?: string

`Optional` page?: number

`Optional` pageSize?: number

listOptions: {
categoryID?: string;
page?: number;
pageSize?: number;
productID?: string;
} = {}

`Optional` categoryID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` productID?: string

listOptions: {
adjustListOrders?: boolean;
} = {}

`Optional` adjustListOrders?: boolean

listOptions: {
adjustListOrders?: boolean;
} = {}

`Optional` adjustListOrders?: boolean