Onboarding_Api
- Full name:
\BigCommerce\Merchant\Onboarding_Api
Constants
| Constant | Visibility | Type | Value |
|---|---|---|---|
AUTH_KEY | public | ’bigcommerce_oauth_broker_secret’ | |
ACCOUNT_ID | public | ’bigcommerce_account_id’ | |
STORE_ID | public | ’bigcommerce_store_id’ |
Methods
__construct
public __construct(string $base_url): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$base_url | string |
create_account
public create_account(\BigCommerce\Merchant\Models\Create_Account_Request $request): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$request | \BigCommerce\Merchant\Models\Create_Account_Request |
connect_account
public connect_account(mixed $store_id, \BigCommerce\Merchant\Models\Connect_Account_Request $request): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$store_id | mixed | |
$request | \BigCommerce\Merchant\Models\Connect_Account_Request |
status
public status(mixed $store_id): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$store_id | mixed |
installation_url
Get the URL to launch the app installation process with BigCommerce
public installation_url(string $store_id): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$store_id | string |
customer_login_token
public customer_login_token(string $store_id, string $customer_id, \BigCommerce\Merchant\Models\Customer_Login_Request $request): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$store_id | string | |
$customer_id | string | |
$request | \BigCommerce\Merchant\Models\Customer_Login_Request |
Throws:
Automatically generated on 2025-01-21