Skip to main content

Interface: UseQuickOrderOptions

Defined in: composables/react/useQuickOrder.ts:79

Options for useQuickOrder.

Properties​

afterAddToCart?​

optional afterAddToCart?: (cart) => void

Defined in: composables/react/useQuickOrder.ts:109

Fires after a successful bulk add — receives the resulting cart.

Parameters​

cart​

Cart

Returns​

void

applyOrderlists?​

optional applyOrderlists?: boolean

Defined in: composables/react/useQuickOrder.ts:95

Set false to ignore orderlistIds. Defaults to true when ids are given.

companyId?​

optional companyId?: number

Defined in: composables/react/useQuickOrder.ts:85

Active company id — scopes cart + pricing for B2B users.

configuration?​

optional configuration?: object

Defined in: composables/react/useQuickOrder.ts:97

Image filters + the base category the search is scoped to.

anonymousUserId?​

optional anonymousUserId?: number

The channel's anonymous user, seeded by the host. Scopes logged-out listings exactly like the SSR seed does.

baseCategoryId?​

optional baseCategoryId?: number

Catalog root. Without it the search returns nothing — see searchProducts.

imageSearchFiltersGrid?​

optional imageSearchFiltersGrid?: MediaImageProductSearchInput

imageVariantFiltersSmall?​

optional imageVariantFiltersSmall?: TransformationsInput

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: composables/react/useQuickOrder.ts:81

GraphQL client the hook derives its Services bundle from. Resolved from PropellerProvider when omitted.

language?​

optional language?: string

Defined in: composables/react/useQuickOrder.ts:87

Language for search + cart queries. Defaults to 'NL'.

onCartCreated?​

optional onCartCreated?: (cart) => void

Defined in: composables/react/useQuickOrder.ts:107

Fires when submit creates a fresh cart — persist the cart id.

Parameters​

cart​

Cart

Returns​

void

orderlistIds?​

optional orderlistIds?: number[]

Defined in: composables/react/useQuickOrder.ts:93

Orderlist (contract) ids to scope the catalogue by.

searchLimit?​

optional searchLimit?: number

Defined in: composables/react/useQuickOrder.ts:89

Max typeahead results per row. Defaults to 8.

taxZone?​

optional taxZone?: string

Defined in: composables/react/useQuickOrder.ts:91

Tax zone for price calculation. Defaults to 'NL'.

user?​

optional user?: AnyUser

Defined in: composables/react/useQuickOrder.ts:83

The signed-in user (quick order is an authenticated feature).