Skip to main content

Interface: CrossupsellSearchInput

Defined in: type/CrossupsellSearchInput.ts:7

Input object for CrossupsellSearchInput

Properties​

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: type/CrossupsellSearchInput.ts:42

Enable or disable applying orderlists


baseProductUuidsFrom?​

optional baseProductUuidsFrom?: string[]

Defined in: type/CrossupsellSearchInput.ts:34

Filter by source base product UUIDs (STI-based)


baseProductUuidsTo?​

optional baseProductUuidsTo?: string[]

Defined in: type/CrossupsellSearchInput.ts:36

Filter by target base product UUIDs (STI-based)


clusterIdsFrom?​

optional clusterIdsFrom?: number[]

Defined in: type/CrossupsellSearchInput.ts:13

Search by cluster ids from


clusterIdsTo?​

optional clusterIdsTo?: number[]

Defined in: type/CrossupsellSearchInput.ts:17

Search by cluster ids to


companyId?​

optional companyId?: number

Defined in: type/CrossupsellSearchInput.ts:48

Browse catalog as a specific Company. Permissions, orderlists, favorite will be merged with the logged in user.


createdAt?​

optional createdAt?: DateSearchInput

Defined in: type/CrossupsellSearchInput.ts:29

Search by date created


hidden?​

optional hidden?: boolean

Defined in: type/CrossupsellSearchInput.ts:38

Filter by hidden status of related base products. true = only hidden, false = only non-hidden, null = no filter.


ids?​

optional ids?: string[]

Defined in: type/CrossupsellSearchInput.ts:9

Search by ids


lastModifiedAt?​

optional lastModifiedAt?: DateSearchInput

Defined in: type/CrossupsellSearchInput.ts:31

Search by date changed


offset?​

optional offset?: number

Defined in: type/CrossupsellSearchInput.ts:27

Pagination offset number. [Default to 12]


orderlistIds?​

optional orderlistIds?: number[]

Defined in: type/CrossupsellSearchInput.ts:44

List orderlists to apply


page?​

optional page?: number

Defined in: type/CrossupsellSearchInput.ts:25

Pagination page number. [Default to 1]


productIdsFrom?​

optional productIdsFrom?: number[]

Defined in: type/CrossupsellSearchInput.ts:11

Search by product ids from


productIdsTo?​

optional productIdsTo?: number[]

Defined in: type/CrossupsellSearchInput.ts:15

Search by product ids to


sortBy?​

optional sortBy?: CrossupsellSortInput[]

Defined in: type/CrossupsellSearchInput.ts:40

Legacy field name for sorting. Use sortInputs instead. Specify multiple sorting criteria for the recommendation results.


sortInputs?​

optional sortInputs?: CrossupsellSortInput[]

Defined in: type/CrossupsellSearchInput.ts:23

Inputs to sort by


subTypes?​

optional subTypes?: string[]

Defined in: type/CrossupsellSearchInput.ts:21

Search by subtype


types?​

optional types?: CrossupsellType[]

Defined in: type/CrossupsellSearchInput.ts:19

Crossupsell type. One of: [accessories, alternatives, options, parts, related]


userId?​

optional userId?: number

Defined in: type/CrossupsellSearchInput.ts:46

Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user.