ClassesBigCommerceApiCustomer API

Customer_Api

Provides methods for interacting with BigCommerce customers via the v2 API.

Includes functionality for validating customer passwords and retrieving customer information by email address.

Methods

validatePassword

Validate a customer’s password.

public validatePassword(int $customer_id, string $password): bool

Checks if the provided password matches the stored password for the given customer ID. Throws an exception if the customer ID does not exist.

Parameters:

ParameterTypeDescription
$customer_idintThe ID of the customer to validate.
$passwordstringThe password to validate.

Return Value:

True if the password is valid, false otherwise.

Throws:

If the customer ID is not found.


find_customer_id_by_email

Find the customer ID associated with a given email address.

public find_customer_id_by_email(string $email): int

Searches for a customer by email and returns their ID. Returns 0 if no customer is found or if an error occurs during the API request.

Parameters:

ParameterTypeDescription
$emailstringThe email address to search for.

Return Value:

The customer ID if found, or 0 if not found or on failure.


Inherited methods

__construct

Constructor

public __construct(\BigCommerce\Api\Base_Client $apiClient): mixed

Initializes the API client instance to be used in making requests.

Parameters:

ParameterTypeDescription
$apiClient\BigCommerce\Api\Base_ClientThe API client to use.

__call

Magic method to call methods on the client class.

public __call(string $method, array $args): mixed

Dynamically calls methods on the client class if available. Throws an exception if the method does not exist.

Parameters:

ParameterTypeDescription
$methodstringThe method name to call.
$argsarrayThe arguments to pass to the method.

Return Value:

The result of the method call.

Throws:

If the method is not found.


get_store_hash

Retrieve the store hash from the API client configuration.

protected get_store_hash(): string

Extracts the store hash from the API client’s configuration using the host URL.

Return Value:

The store hash.



Automatically generated on 2025-01-21