• 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.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              customerId?: string;
              listId?: string;
              organizationId?: string;
              siteId?: string;
          };
      }>
    • 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.

    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.
    • Defined in src/hooks/ShopperCustomers/query.ts:337

Settings

Member Visibility

Theme

@salesforce/commerce-sdk-react
  • Components
    • CommerceApiProvider
  • Helpers
    • DNT
      • useDNT
    • Other
      • useCommerceApi
    • Shopper Authentication
      • AuthHelpers
      • AuthHelper
      • useAccessToken
      • useAuthHelper
      • useCustomerId
      • useCustomerType
      • useEncUserId
      • useTrustedAgent
      • 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
      • 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
  • Functions
    • useConfig
    • useCustomMutation
    • useCustomQuery
    • useShopperBasketsMutationHelper
  • Interfaces
    • ApiClients
    • SDKClientTransformConfig
  • Modules
    • <internal>
  • SearchStores
    • Query
      • useSearchStores
      • useStores
  • ShopperSEO
    • Query
      • useUrlMapping
  • Type Aliases
    • ApiClient
    • ApiClientConfigParams
    • ApiMethod
    • ApiOptions
    • ApiQueryKey
    • ApiQueryOptions
    • Argument
    • CacheUpdate
    • CacheUpdateGetter
    • CacheUpdateInvalidate
    • CacheUpdateMatrix
    • CacheUpdateRemove
    • CacheUpdateUpdate
    • DataType
    • ErrorCallback
    • ExcludeTail
    • MergedOptions
    • NullToOptional
    • NullableParameters
    • OmitNullableParameters
    • OptionalCustomEndpointClientConfig
    • Prettify
    • RemoveStringIndex
    • RequireKeys
    • SDKClientTransformer
    • TMutationVariables
    • Tail
    • useCustomerType