• Preparing search index...
  • The search index is not available
@salesforce/commerce-sdk-react
  • @salesforce/commerce-sdk-react
  • useCustomerProductList

Function useCustomerProductList

  • useCustomerProductList(apiOptions, queryOptions?): UseQueryResult<CustomerProductList, unknown>
  • Returns a customer product list of the given customer and the items in the list.

    Parameter

    apiOptions - Options to pass through to commerce-sdk-isomorphic, with null accepted for unset API parameters.

    Parameter

    queryOptions - TanStack Query query options, with enabled by default set to check that all required API parameters have been set.

    See

    • Salesforce Developer Center for more information about the API endpoint.
    • commerce-sdk-isomorphic documentation for more information on the parameters and returned data type.
    • TanStack Query useQuery reference for more information about the return value.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters: { customerId: string; listId: string; organizationId?: string | undefined; siteId?: string | undefined; };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<CustomerProductList>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : CustomerProductList>;
      }> = {}

    Returns UseQueryResult<CustomerProductList, unknown>

    A TanStack Query query hook with data from the Shopper Customers getCustomerProductList endpoint.

    • Defined in src/hooks/ShopperCustomers/query.ts:292

Settings

Member Visibility

Theme

@salesforce/commerce-sdk-react
  • Components
    • CommerceApiProvider
  • Helpers
    • Other
      • useCommerceApi
    • Shopper Authentication
      • AuthHelpers
      • AuthHelper
      • useAccessToken
      • useAuthHelper
      • useCustomerId
      • useCustomerType
      • useEncUserId
      • useUsid
  • ShopperBaskets
    • Mutation
      • ShopperBasketsMutations
      • ShopperBasketsMutation
      • useShopperBasketsMutation
    • Query
      • useBasket
      • usePaymentMethodsForBasket
      • usePriceBooksForBasket
      • useShippingMethodsForShipment
      • useTaxesFromBasket
  • ShopperContexts
    • Mutation
      • ShopperContextsMutations
      • ShopperContextsMutation
      • useShopperContextsMutation
    • Query
      • useShopperContext
  • ShopperCustomers
    • Mutation
      • ShopperCustomersMutations
      • ShopperCustomersMutation
      • useShopperCustomersMutation
    • Query
      • useCustomer
      • useCustomerAddress
      • useCustomerBaskets
      • useCustomerOrders
      • useCustomerPaymentInstrument
      • useCustomerProductList
      • useCustomerProductListItem
      • useCustomerProductLists
      • useProductListItem
      • usePublicProductList
      • usePublicProductListsBySearchTerm
  • ShopperExperience
    • Query
      • usePage
      • usePages
  • ShopperGiftCertificates
    • Query
      • useGiftCertificate
  • ShopperLogin
    • Mutation
      • ShopperLoginMutations
      • ShopperLoginMutation
      • useShopperLoginMutation
    • Query
      • useCredQualityUserInfo
      • useJwksUri
      • useUserInfo
      • useWellknownOpenidConfiguration
  • ShopperOrders
    • Mutation
      • ShopperOrdersMutations
      • ShopperOrdersMutation
      • useShopperOrdersMutation
    • Query
      • useOrder
      • usePaymentMethodsForOrder
      • useTaxesFromOrder
  • ShopperProducts
    • Query
      • useCategories
      • useCategory
      • useProduct
      • useProducts
  • ShopperPromotions
    • Query
      • usePromotions
      • usePromotionsForCampaign
  • ShopperSearch
    • Query
      • useProductSearch
      • useSearchSuggestions
  • Interfaces
    • ApiClients
  • Modules
    • <internal>
      • Classes
        • Auth
        • BaseStorage
        • ClientConfig
        • Component
        • Mutation
        • MutationCache
        • MutationObserver
        • Query
        • QueryCache
        • QueryClient
        • QueryObserver
        • Removable
        • ShopperBaskets
        • ShopperContexts
        • ShopperCustomers
        • ShopperExperience
        • ShopperGiftCertificates
        • ShopperLogin
        • ShopperOrders
        • ShopperProducts
        • ShopperPromotions
        • ShopperSearch
        • Subscribable
      • Functions
        • Error
        • Object
      • Interfaces
        • ArrayBufferView
        • AuthConfig
        • BaseStorageOptions
        • BaseUriParameters
        • Blob
        • BlobPropertyBag
        • Body
        • CancelOptions
        • ClientConfigInit
        • CommerceApiProviderProps
        • ComponentLifecycle
        • ConsumerProps
        • Context
        • ContextOptions
        • ContinueAction
        • ContinueAction
        • DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES
        • DefaultOptions
        • DeprecatedLifecycle
        • Error
        • ErrorAction
        • ErrorAction
        • ErrorInfo
        • ExoticComponent
        • FailedAction
        • FailedAction
        • FetchAction
        • FetchContext
        • FetchInfiniteQueryOptions
        • FetchOptions
        • FetchQueryOptions
        • Headers
        • InfiniteData
        • InvalidateAction
        • InvalidateOptions
        • InvalidateQueryFilters
        • Iterable
        • Iterator
        • IteratorReturnResult
        • IteratorYieldResult
        • LoadingAction
        • Logger
        • MutateOptions
        • MutationCacheConfig
        • MutationConfig
        • MutationFilters
        • MutationMeta
        • MutationObserverBaseResult
        • MutationObserverErrorResult
        • MutationObserverIdleResult
        • MutationObserverLoadingResult
        • MutationObserverOptions
        • MutationObserverSuccessResult
        • MutationOptions
        • MutationState
        • NewLifecycle
        • NotifyEvent
        • NotifyEventMutationAdded
        • NotifyEventMutationObserverAdded
        • NotifyEventMutationObserverOptionsUpdated
        • NotifyEventMutationObserverRemoved
        • NotifyEventMutationRemoved
        • NotifyEventMutationUpdated
        • NotifyEventQueryAdded
        • NotifyEventQueryObserverAdded
        • NotifyEventQueryObserverOptionsUpdated
        • NotifyEventQueryObserverRemoved
        • NotifyEventQueryObserverResultsUpdated
        • NotifyEventQueryRemoved
        • NotifyEventQueryUpdated
        • NotifyOptions
        • Object
        • ObserverFetchOptions
        • PauseAction
        • PauseAction
        • PromiseLike
        • ProviderExoticComponent
        • ProviderProps
        • QueryBehavior
        • QueryCacheConfig
        • QueryClientConfig
        • QueryConfig
        • QueryFilters
        • QueryFunctionContext
        • QueryMeta
        • QueryObserverBaseResult
        • QueryObserverLoadingErrorResult
        • QueryObserverLoadingResult
        • QueryObserverOptions
        • QueryObserverRefetchErrorResult
        • QueryObserverSuccessResult
        • QueryOptions
        • QueryState
        • QueuingStrategy
        • QueuingStrategySize
        • ReactElement
        • ReactPortal
        • ReadableStream
        • ReadableStreamDefaultController
        • ReadableStreamDefaultReader
        • ReadableStreamGenericReader
        • ReadableStreamReadDoneResult
        • ReadableStreamReadValueResult
        • ReadableWritablePair
        • RefetchOptions
        • RefetchPageFilters
        • RefetchQueryFilters
        • ResetOptions
        • ResetQueryFilters
        • Response
        • ResponseInit
        • ResultOptions
        • SetDataOptions
        • SetStateAction
        • SetStateAction
        • SetStateOptions
        • StreamPipeOptions
        • SuccessAction
        • SuccessAction
        • UnderlyingSink
        • UnderlyingSinkAbortCallback
        • UnderlyingSinkCloseCallback
        • UnderlyingSinkStartCallback
        • UnderlyingSinkWriteCallback
        • UnderlyingSource
        • UnderlyingSourceCancelCallback
        • UnderlyingSourcePullCallback
        • UnderlyingSourceStartCallback
        • UseBaseQueryOptions
        • UseQueryOptions
        • Validator
        • WritableStream
        • WritableStreamDefaultController
        • WritableStreamDefaultWriter
      • Shopper Authentication helpers
        • AccessToken
      • Type Aliases
        • Action
        • Action
        • AllowNull
        • ArrayBufferLike
        • AuthData
        • AuthDataKeys
        • AuthRequest
        • Basket
        • Basket$1
        • BasketPaymentInstrumentRequest
        • BasketsResult$0
        • BlobPart
        • BodyInit
        • BonusDiscountLineItem
        • BonusDiscountLineItem$1
        • BrandSuggestions
        • BufferSource
        • BundledProduct
        • Category
        • CategoryResult
        • CategorySuggestions
        • Client
        • Client
        • Client
        • Client
        • Client
        • Component
        • Consumer
        • CouponItem
        • CouponItem$1
        • CredQualityUserResponse
        • CustomSuggestions
        • Customer
        • Customer
        • CustomerAddress
        • CustomerAddress
        • CustomerAddressInfo
        • CustomerExtProfileRequest
        • CustomerExternalProfile
        • CustomerInfo
        • CustomerInfo$1
        • CustomerOrderResult
        • CustomerPaymentCardRequest
        • CustomerPaymentInstrument
        • CustomerPaymentInstrument
        • CustomerPaymentInstrumentRequest
        • CustomerProductList
        • CustomerProductListItem
        • CustomerProductListRegistrant
        • CustomerProductListResult
        • CustomerRegistration
        • CustomerRegistration
        • CustomerType
        • DataUpdateFunction
        • DefaultedQueryObserverOptions
        • DefinedQueryObserverResult
        • Discount
        • Discount$0
        • Discount$1
        • DiscountRequest
        • EndingType
        • Exclude
        • FetchStatus
        • GetNextPageParamFunction
        • GetPreviousPageParamFunction
        • GiftCertificate
        • GiftCertificateItem
        • GiftCertificateItem$0
        • GiftCertificateItem$1
        • GiftCertificateRequest
        • HeadersInit
        • Image
        • Image$0
        • ImageGroup
        • ImageGroup$0
        • InitialDataFunction
        • Inventory
        • Inventory$0
        • IteratorResult
        • JSXElementConstructor
        • Key
        • Listener
        • LogFunction
        • LoginRequest
        • Master
        • Master$0
        • MutateFunction
        • MutationCacheListener
        • MutationCacheNotifyEvent
        • MutationFunction
        • MutationKey
        • MutationObserverListener
        • MutationObserverResult
        • MutationStatus
        • NetworkMode
        • NonNullable
        • NotifyEventType
        • NullKeys
        • Omit
        • Option
        • Option$0
        • OptionItem
        • OptionItem$0
        • OptionValue
        • OptionValue$0
        • Order
        • Order$1
        • OrderAddress
        • OrderAddress$1
        • OrderPaymentCardRequest
        • OrderPaymentInstrument
        • OrderPaymentInstrument$1
        • OrderPaymentInstrumentRequest$0
        • Override
        • Page
        • PageResult
        • Parameters
        • Partial
        • PasswordActionRequest
        • PasswordActionVerifyRequest
        • PasswordChangeRequest
        • PasswordLessLoginTokenRequest
        • PasswordlessLoginRequest
        • PathRecord
        • PaymentBankAccount
        • PaymentBankAccount
        • PaymentBankAccountRequest
        • PaymentCard
        • PaymentCard
        • PaymentCard$0
        • PaymentCard$1
        • PaymentCardSpec
        • PaymentMethod
        • PaymentMethodResult
        • PaymentMethodResult$0
        • Pick
        • PlaceholderDataFunction
        • Prettify
        • PriceAdjustment
        • PriceAdjustment$0
        • PriceAdjustment$1
        • PriceAdjustmentRequest
        • PriceBookIds
        • PriceRange
        • Product
        • Product$0
        • ProductDetailsLink
        • ProductDetailsLink$0
        • ProductItem
        • ProductItem$0
        • ProductItem$1
        • ProductLink
        • ProductLink$0
        • ProductListEvent
        • ProductListItemReference
        • ProductListItemReference$0
        • ProductListLink
        • ProductListLink$0
        • ProductListRegistrant
        • ProductListShippingAddress
        • ProductPriceTable
        • ProductPromotion
        • ProductRef
        • ProductResult
        • ProductSearchHit
        • ProductSearchRefinement
        • ProductSearchRefinementValue
        • ProductSearchResult
        • ProductSearchSortingOption
        • ProductSuggestions
        • ProductType
        • ProductType$0
        • ProductType$1
        • Promotion
        • PromotionResult
        • PropertyKey
        • Provider
        • PublicProductList
        • PublicProductListInfo
        • PublicProductListItem
        • PublicProductListResult
        • QueryCacheListener
        • QueryCacheNotifyEvent
        • QueryFunction
        • QueryKey
        • QueryKeyHashFunction
        • QueryObserverListener
        • QueryObserverResult
        • QueryStatus
        • QueryTypeFilter
        • ReactFragment
        • ReactInstance
        • ReactNode
        • ReadableStreamController
        • ReadableStreamReadResult
        • Readonly
        • Recommendation
        • Recommendation$0
        • RecommendationType
        • RecommendationType$0
        • Record
        • Region
        • RemoveNeverValues
        • RequireParametersUnlessAllAreOptional
        • Required
        • ResetPasswordRequest
        • ResetPasswordToken
        • ResetPasswordTokenRequest
        • ResponseType
        • RetryDelayFunction
        • RetryDelayValue
        • RetryValue
        • ReturnType
        • SessionBridgeTokenRequest
        • Shipment
        • Shipment$1
        • ShippingItem
        • ShippingItem$1
        • ShippingMethod
        • ShippingMethod$0
        • ShippingMethodResult
        • ShippingPromotion
        • ShippingPromotion$0
        • ShopperBasketsParameters
        • ShopperBasketsPathParameters
        • ShopperBasketsQueryParameters
        • ShopperContext
        • ShopperContextsParameters
        • ShopperContextsPathParameters
        • ShopperContextsQueryParameters
        • ShopperCustomersParameters
        • ShopperCustomersPathParameters
        • ShopperCustomersQueryParameters
        • ShopperExperienceParameters
        • ShopperExperiencePathParameters
        • ShopperExperienceQueryParameters
        • ShopperGiftCertificatesParameters
        • ShopperGiftCertificatesPathParameters
        • ShopperGiftCertificatesQueryParameters
        • ShopperLoginParameters
        • ShopperLoginPathParameters
        • ShopperLoginQueryParameters
        • ShopperOrdersParameters
        • ShopperOrdersPathParameters
        • ShopperOrdersQueryParameters
        • ShopperProductsParameters
        • ShopperProductsPathParameters
        • ShopperProductsQueryParameters
        • ShopperPromotionsParameters
        • ShopperPromotionsPathParameters
        • ShopperPromotionsQueryParameters
        • ShopperSearchParameters
        • ShopperSearchPathParameters
        • ShopperSearchQueryParameters
        • ShouldRetryFunction
        • SimpleLink
        • SimpleLink$1
        • Status
        • Status$0
        • StorageType
        • StringIndexToNever
        • SuggestedCategory
        • SuggestedPhrase
        • SuggestedProduct
        • SuggestedTerm
        • SuggestedTerms
        • Suggestion
        • SuggestionResult
        • TaxItem
        • TaxItems
        • Taxes
        • Taxes$0
        • TokenActionRequest
        • TokenRequest
        • TokenResponse
        • TokenResponse
        • TokenResponse
        • TokenResponse
        • TrustedAgentTokenRequest
        • TrustedSystemAuthRequest
        • TrustedSystemTokenRequest
        • Updater
        • UseBaseMutationResult
        • UseBaseQueryResult
        • UseErrorBoundary
        • UseMutateAsyncFunction
        • UseMutateFunction
        • UseMutationResult
        • UseQueryResult
        • Validator
        • Variant
        • Variant$0
        • VariationAttribute
        • VariationAttribute$0
        • VariationAttribute$1
        • VariationAttributeValue
        • VariationAttributeValue$0
        • VariationGroup
        • VariationGroup$0
        • WeakValidationMap
        • WithRequired
        • XMLHttpRequestBodyInit
      • Variables
        • Blob
        • Headers
        • ReadableStream
        • ReadableStreamDefaultController
        • ReadableStreamDefaultReader
        • Response
        • WritableStream
        • WritableStreamDefaultController
        • WritableStreamDefaultWriter
  • Type Aliases
    • ApiClient
    • ApiClientConfigParams
    • ApiMethod
    • ApiOptions
    • ApiQueryKey
    • ApiQueryOptions
    • Argument
    • CacheUpdate
    • CacheUpdateGetter
    • CacheUpdateInvalidate
    • CacheUpdateMatrix
    • CacheUpdateRemove
    • CacheUpdateUpdate
    • DataType
    • ExcludeTail
    • MergedOptions
    • NullToOptional
    • NullableParameters
    • OmitNullableParameters
    • Prettify
    • RemoveStringIndex
    • RequireKeys
    • Tail
    • useCustomerType