Coupon_Code_Controller
- Full name:
\BigCommerce\Rest\Coupon_Code_Controller
- Parent class:
\BigCommerce\Rest\Rest_Controller
Methods
__construct
Rest_Controller constructor.
public __construct(string $namespace_base, string $version, string $rest_base, \BigCommerce\Api\v3\Api\CheckoutApi $checkout_api, \BigCommerce\Api\v3\Api\CartApi $cart_api): mixed
Parameters:
Parameter | Type | Description |
---|---|---|
$namespace_base | string | |
$version | string | |
$rest_base | string | |
$checkout_api | \BigCommerce\Api\v3\Api\CheckoutApi | |
$cart_api | \BigCommerce\Api\v3\Api\CartApi |
js_config
Add data to the JS config to support cart ajax
public js_config(array $config): array
Parameters:
Parameter | Type | Description |
---|---|---|
$config | array |
register_routes
public register_routes(): mixed
get_permissions_check
Checks if a given request has access to read the rendered shortcodes.
public get_permissions_check(\WP_REST_Request $request): true|\WP_Error
Parameters:
Parameter | Type | Description |
---|---|---|
$request | \WP_REST_Request | Full details about the request. |
Return Value:
True if the request has read access, WP_Error object otherwise.
apply_coupon_code
public apply_coupon_code(\WP_REST_Request $request): \WP_REST_Response|\WP_Error
Parameters:
Parameter | Type | Description |
---|---|---|
$request | \WP_REST_Request | Full details about the request. |
Return Value:
Response object on success, or WP_Error object on failure.
delete_coupon_code
public delete_coupon_code(\WP_REST_Request $request): \WP_REST_Response|\WP_Error
Parameters:
Parameter | Type | Description |
---|---|---|
$request | \WP_REST_Request | Full details about the request. |
Return Value:
Response object on success, or WP_Error object on failure.
Inherited methods
__construct
Rest_Controller constructor.
public __construct(string $namespace_base, string $version, string $rest_base): mixed
Parameters:
Parameter | Type | Description |
---|---|---|
$namespace_base | string | |
$version | string | |
$rest_base | string |
get_namespace
protected get_namespace(): mixed
get_base_url
public get_base_url(): mixed
parse_result
protected parse_result(mixed $response, mixed $client, mixed $rest_response = true): mixed
Parameters:
Parameter | Type | Description |
---|---|---|
$response | mixed | |
$client | mixed | |
$rest_response | mixed |
Automatically generated on 2025-01-21