Function useCustomerOrders

  • Returns a pageable list of all customer's orders.

    The default page size is 10.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              crossSites?: boolean;
              customerId?: string;
              from?: string;
              limit?: number;
              offset?: number;
              organizationId?: string;
              siteId?: string;
              status?: string;
              until?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<CustomerOrderResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : CustomerOrderResult>;
      }> = {}

    Returns UseQueryResult<CustomerOrderResult, unknown>

    A TanStack Query query hook with data from the Shopper Customers getCustomerOrders 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

Settings

Member Visibility

Theme