Preparing search index...
The search index is not available
@salesforce/commerce-sdk-react
@salesforce/commerce-sdk-react
ApiQueryOptions
Type alias ApiQueryOptions<Method>
Api
Query
Options
<
Method
>
:
Prettify
<
Omit
<
UseQueryOptions
<
DataType
<
Method
>
,
unknown
,
DataType
<
Method
>
,
ApiQueryKey
>
,
"queryFn"
|
"queryKey"
>
>
Query options for endpoint hooks.
Type Parameters
Method
extends
ApiMethod
<
any
,
unknown
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
@salesforce/commerce-
sdk-
react
Components
Commerce
Api
Provider
Helpers
Other
use
Commerce
Api
Shopper Authentication
Auth
Helpers
Auth
Helper
use
Access
Token
use
Auth
Helper
use
Customer
Id
use
Customer
Type
use
Enc
User
Id
use
Usid
ShopperBaskets
Mutation
Shopper
Baskets
Mutations
Shopper
Baskets
Mutation
use
Shopper
Baskets
Mutation
Query
use
Basket
use
Payment
Methods
For
Basket
use
Price
Books
For
Basket
use
Shipping
Methods
For
Shipment
use
Taxes
From
Basket
ShopperContexts
Mutation
Shopper
Contexts
Mutations
Shopper
Contexts
Mutation
use
Shopper
Contexts
Mutation
Query
use
Shopper
Context
ShopperCustomers
Mutation
Shopper
Customers
Mutations
Shopper
Customers
Mutation
use
Shopper
Customers
Mutation
Query
use
Customer
use
Customer
Address
use
Customer
Baskets
use
Customer
Orders
use
Customer
Payment
Instrument
use
Customer
Product
List
use
Customer
Product
List
Item
use
Customer
Product
Lists
use
Product
List
Item
use
Public
Product
List
use
Public
Product
Lists
By
Search
Term
ShopperExperience
Query
use
Page
use
Pages
ShopperGiftCertificates
Query
use
Gift
Certificate
ShopperLogin
Mutation
Shopper
Login
Mutations
Shopper
Login
Mutation
use
Shopper
Login
Mutation
Query
use
Cred
Quality
User
Info
use
Jwks
Uri
use
User
Info
use
Wellknown
Openid
Configuration
ShopperOrders
Mutation
Shopper
Orders
Mutations
Shopper
Orders
Mutation
use
Shopper
Orders
Mutation
Query
use
Order
use
Payment
Methods
For
Order
use
Taxes
From
Order
ShopperProducts
Query
use
Categories
use
Category
use
Product
use
Products
ShopperPromotions
Query
use
Promotions
use
Promotions
For
Campaign
ShopperSearch
Query
use
Product
Search
use
Search
Suggestions
Interfaces
Api
Clients
Modules
<internal>
Classes
Auth
Base
Storage
Client
Config
Component
Mutation
Mutation
Cache
Mutation
Observer
Query
Query
Cache
Query
Client
Query
Observer
Removable
Shopper
Baskets
Shopper
Contexts
Shopper
Customers
Shopper
Experience
Shopper
Gift
Certificates
Shopper
Login
Shopper
Orders
Shopper
Products
Shopper
Promotions
Shopper
Search
Subscribable
Functions
Error
Object
Interfaces
Array
Buffer
View
Auth
Config
Base
Storage
Options
Base
Uri
Parameters
Blob
Blob
Property
Bag
Body
Cancel
Options
Client
Config
Init
Commerce
Api
Provider
Props
Component
Lifecycle
Consumer
Props
Context
Context
Options
Continue
Action
Continue
Action
DO_
NOT_
USE_
OR_
YOU_
WILL_
BE_
FIRED_
EXPERIMENTAL_
REACT_
NODES
Default
Options
Deprecated
Lifecycle
Error
Error
Action
Error
Action
Error
Info
Exotic
Component
Failed
Action
Failed
Action
Fetch
Action
Fetch
Context
Fetch
Infinite
Query
Options
Fetch
Options
Fetch
Query
Options
Headers
Infinite
Data
Invalidate
Action
Invalidate
Options
Invalidate
Query
Filters
Iterable
Iterator
Iterator
Return
Result
Iterator
Yield
Result
Loading
Action
Logger
Mutate
Options
Mutation
Cache
Config
Mutation
Config
Mutation
Filters
Mutation
Meta
Mutation
Observer
Base
Result
Mutation
Observer
Error
Result
Mutation
Observer
Idle
Result
Mutation
Observer
Loading
Result
Mutation
Observer
Options
Mutation
Observer
Success
Result
Mutation
Options
Mutation
State
New
Lifecycle
Notify
Event
Notify
Event
Mutation
Added
Notify
Event
Mutation
Observer
Added
Notify
Event
Mutation
Observer
Options
Updated
Notify
Event
Mutation
Observer
Removed
Notify
Event
Mutation
Removed
Notify
Event
Mutation
Updated
Notify
Event
Query
Added
Notify
Event
Query
Observer
Added
Notify
Event
Query
Observer
Options
Updated
Notify
Event
Query
Observer
Removed
Notify
Event
Query
Observer
Results
Updated
Notify
Event
Query
Removed
Notify
Event
Query
Updated
Notify
Options
Object
Observer
Fetch
Options
Pause
Action
Pause
Action
Promise
Like
Provider
Exotic
Component
Provider
Props
Query
Behavior
Query
Cache
Config
Query
Client
Config
Query
Config
Query
Filters
Query
Function
Context
Query
Meta
Query
Observer
Base
Result
Query
Observer
Loading
Error
Result
Query
Observer
Loading
Result
Query
Observer
Options
Query
Observer
Refetch
Error
Result
Query
Observer
Success
Result
Query
Options
Query
State
Queuing
Strategy
Queuing
Strategy
Size
React
Element
React
Portal
Readable
Stream
Readable
Stream
Default
Controller
Readable
Stream
Default
Reader
Readable
Stream
Generic
Reader
Readable
Stream
Read
Done
Result
Readable
Stream
Read
Value
Result
Readable
Writable
Pair
Refetch
Options
Refetch
Page
Filters
Refetch
Query
Filters
Reset
Options
Reset
Query
Filters
Response
Response
Init
Result
Options
Set
Data
Options
Set
State
Action
Set
State
Action
Set
State
Options
Stream
Pipe
Options
Success
Action
Success
Action
Underlying
Sink
Underlying
Sink
Abort
Callback
Underlying
Sink
Close
Callback
Underlying
Sink
Start
Callback
Underlying
Sink
Write
Callback
Underlying
Source
Underlying
Source
Cancel
Callback
Underlying
Source
Pull
Callback
Underlying
Source
Start
Callback
Use
Base
Query
Options
Use
Query
Options
Validator
Writable
Stream
Writable
Stream
Default
Controller
Writable
Stream
Default
Writer
Shopper Authentication helpers
Access
Token
Type Aliases
Action
Action
Allow
Null
Array
Buffer
Like
Auth
Data
Auth
Data
Keys
Auth
Request
Basket
Basket$1
Basket
Payment
Instrument
Request
Baskets
Result$0
Blob
Part
Body
Init
Bonus
Discount
Line
Item
Bonus
Discount
Line
Item$1
Brand
Suggestions
Buffer
Source
Bundled
Product
Category
Category
Result
Category
Suggestions
Client
Client
Client
Client
Client
Component
Consumer
Coupon
Item
Coupon
Item$1
Cred
Quality
User
Response
Custom
Suggestions
Customer
Customer
Customer
Address
Customer
Address
Customer
Address
Info
Customer
Ext
Profile
Request
Customer
External
Profile
Customer
Info
Customer
Info$1
Customer
Order
Result
Customer
Payment
Card
Request
Customer
Payment
Instrument
Customer
Payment
Instrument
Customer
Payment
Instrument
Request
Customer
Product
List
Customer
Product
List
Item
Customer
Product
List
Registrant
Customer
Product
List
Result
Customer
Registration
Customer
Registration
Customer
Type
Data
Update
Function
Defaulted
Query
Observer
Options
Defined
Query
Observer
Result
Discount
Discount$0
Discount$1
Discount
Request
Ending
Type
Exclude
Fetch
Status
Get
Next
Page
Param
Function
Get
Previous
Page
Param
Function
Gift
Certificate
Gift
Certificate
Item
Gift
Certificate
Item$0
Gift
Certificate
Item$1
Gift
Certificate
Request
Headers
Init
Image
Image$0
Image
Group
Image
Group$0
Initial
Data
Function
Inventory
Inventory$0
Iterator
Result
JSXElement
Constructor
Key
Listener
Log
Function
Login
Request
Master
Master$0
Mutate
Function
Mutation
Cache
Listener
Mutation
Cache
Notify
Event
Mutation
Function
Mutation
Key
Mutation
Observer
Listener
Mutation
Observer
Result
Mutation
Status
Network
Mode
Non
Nullable
Notify
Event
Type
Null
Keys
Omit
Option
Option$0
Option
Item
Option
Item$0
Option
Value
Option
Value$0
Order
Order$1
Order
Address
Order
Address$1
Order
Payment
Card
Request
Order
Payment
Instrument
Order
Payment
Instrument$1
Order
Payment
Instrument
Request$0
Override
Page
Page
Result
Parameters
Partial
Password
Action
Request
Password
Action
Verify
Request
Password
Change
Request
Password
Less
Login
Token
Request
Passwordless
Login
Request
Path
Record
Payment
Bank
Account
Payment
Bank
Account
Payment
Bank
Account
Request
Payment
Card
Payment
Card
Payment
Card$0
Payment
Card$1
Payment
Card
Spec
Payment
Method
Payment
Method
Result
Payment
Method
Result$0
Pick
Placeholder
Data
Function
Prettify
Price
Adjustment
Price
Adjustment$0
Price
Adjustment$1
Price
Adjustment
Request
Price
Book
Ids
Price
Range
Product
Product$0
Product
Details
Link
Product
Details
Link$0
Product
Item
Product
Item$0
Product
Item$1
Product
Link
Product
Link$0
Product
List
Event
Product
List
Item
Reference
Product
List
Item
Reference$0
Product
List
Link
Product
List
Link$0
Product
List
Registrant
Product
List
Shipping
Address
Product
Price
Table
Product
Promotion
Product
Ref
Product
Result
Product
Search
Hit
Product
Search
Refinement
Product
Search
Refinement
Value
Product
Search
Result
Product
Search
Sorting
Option
Product
Suggestions
Product
Type
Product
Type$0
Product
Type$1
Promotion
Promotion
Result
Property
Key
Provider
Public
Product
List
Public
Product
List
Info
Public
Product
List
Item
Public
Product
List
Result
Query
Cache
Listener
Query
Cache
Notify
Event
Query
Function
Query
Key
Query
Key
Hash
Function
Query
Observer
Listener
Query
Observer
Result
Query
Status
Query
Type
Filter
React
Fragment
React
Instance
React
Node
Readable
Stream
Controller
Readable
Stream
Read
Result
Readonly
Recommendation
Recommendation$0
Recommendation
Type
Recommendation
Type$0
Record
Region
Remove
Never
Values
Require
Parameters
Unless
All
Are
Optional
Required
Reset
Password
Request
Reset
Password
Token
Reset
Password
Token
Request
Response
Type
Retry
Delay
Function
Retry
Delay
Value
Retry
Value
Return
Type
Session
Bridge
Token
Request
Shipment
Shipment$1
Shipping
Item
Shipping
Item$1
Shipping
Method
Shipping
Method$0
Shipping
Method
Result
Shipping
Promotion
Shipping
Promotion$0
Shopper
Baskets
Parameters
Shopper
Baskets
Path
Parameters
Shopper
Baskets
Query
Parameters
Shopper
Context
Shopper
Contexts
Parameters
Shopper
Contexts
Path
Parameters
Shopper
Contexts
Query
Parameters
Shopper
Customers
Parameters
Shopper
Customers
Path
Parameters
Shopper
Customers
Query
Parameters
Shopper
Experience
Parameters
Shopper
Experience
Path
Parameters
Shopper
Experience
Query
Parameters
Shopper
Gift
Certificates
Parameters
Shopper
Gift
Certificates
Path
Parameters
Shopper
Gift
Certificates
Query
Parameters
Shopper
Login
Parameters
Shopper
Login
Path
Parameters
Shopper
Login
Query
Parameters
Shopper
Orders
Parameters
Shopper
Orders
Path
Parameters
Shopper
Orders
Query
Parameters
Shopper
Products
Parameters
Shopper
Products
Path
Parameters
Shopper
Products
Query
Parameters
Shopper
Promotions
Parameters
Shopper
Promotions
Path
Parameters
Shopper
Promotions
Query
Parameters
Shopper
Search
Parameters
Shopper
Search
Path
Parameters
Shopper
Search
Query
Parameters
Should
Retry
Function
Simple
Link
Simple
Link$1
Status
Status$0
Storage
Type
String
Index
To
Never
Suggested
Category
Suggested
Phrase
Suggested
Product
Suggested
Term
Suggested
Terms
Suggestion
Suggestion
Result
Tax
Item
Tax
Items
Taxes
Taxes$0
Token
Action
Request
Token
Request
Token
Response
Token
Response
Token
Response
Token
Response
Trusted
Agent
Token
Request
Trusted
System
Auth
Request
Trusted
System
Token
Request
Updater
Use
Base
Mutation
Result
Use
Base
Query
Result
Use
Error
Boundary
Use
Mutate
Async
Function
Use
Mutate
Function
Use
Mutation
Result
Use
Query
Result
Validator
Variant
Variant$0
Variation
Attribute
Variation
Attribute$0
Variation
Attribute$1
Variation
Attribute
Value
Variation
Attribute
Value$0
Variation
Group
Variation
Group$0
Weak
Validation
Map
With
Required
XMLHttp
Request
Body
Init
Variables
Blob
Headers
Readable
Stream
Readable
Stream
Default
Controller
Readable
Stream
Default
Reader
Response
Writable
Stream
Writable
Stream
Default
Controller
Writable
Stream
Default
Writer
Type Aliases
Api
Client
Api
Client
Config
Params
Api
Method
Api
Options
Api
Query
Key
Api
Query
Options
Argument
Cache
Update
Cache
Update
Getter
Cache
Update
Invalidate
Cache
Update
Matrix
Cache
Update
Remove
Cache
Update
Update
Data
Type
Exclude
Tail
Merged
Options
Null
To
Optional
Nullable
Parameters
Omit
Nullable
Parameters
Prettify
Remove
String
Index
Require
Keys
Tail
use
Customer
Type
Query options for endpoint hooks.