Skip to content

CustomerAccountManagementV1Api.md

Latest commit

 

History

History
868 lines (594 loc) · 32.6 KB

CustomerAccountManagementV1Api.md

File metadata and controls

868 lines (594 loc) · 32.6 KB
Raw

Krak\MagentoApiClient\CustomerAccountManagementV1Api

All URIs are relative to http://ce22.vg/index.php/rest/default

Method HTTP request Description
customerAccountManagementV1ActivateByIdPut PUT /V1/customers/me/activate
customerAccountManagementV1ActivatePut PUT /V1/customers/{email}/activate
customerAccountManagementV1ChangePasswordByIdPut PUT /V1/customers/me/password
customerAccountManagementV1CreateAccountPost POST /V1/customers
customerAccountManagementV1GetConfirmationStatusGet GET /V1/customers/{customerId}/confirm
customerAccountManagementV1GetDefaultBillingAddressGet GET /V1/customers/me/billingAddress
customerAccountManagementV1GetDefaultBillingAddressGet_0 GET /V1/customers/{customerId}/billingAddress
customerAccountManagementV1GetDefaultShippingAddressGet GET /V1/customers/me/shippingAddress
customerAccountManagementV1GetDefaultShippingAddressGet_0 GET /V1/customers/{customerId}/shippingAddress
customerAccountManagementV1InitiatePasswordResetPut PUT /V1/customers/password
customerAccountManagementV1IsEmailAvailablePost POST /V1/customers/isEmailAvailable
customerAccountManagementV1IsReadonlyGet GET /V1/customers/{customerId}/permissions/readonly
customerAccountManagementV1ResendConfirmationPost POST /V1/customers/confirm
customerAccountManagementV1ResetPasswordPost POST /V1/customers/resetPassword
customerAccountManagementV1ValidatePut PUT /V1/customers/validate
customerAccountManagementV1ValidateResetPasswordLinkTokenGet GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}

customerAccountManagementV1ActivateByIdPut

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface customerAccountManagementV1ActivateByIdPut($customerAccountManagementV1ActivateByIdPutBody)

Activate a customer account using a key that was sent in a confirmation email.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1ActivateByIdPutBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivateByIdPutBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivateByIdPutBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ActivateByIdPut($customerAccountManagementV1ActivateByIdPutBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ActivateByIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1ActivateByIdPutBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivateByIdPutBody [optional]

Return type

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ActivatePut

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface customerAccountManagementV1ActivatePut($email, $customerAccountManagementV1ActivatePutBody)

Activate a customer account using a key that was sent in a confirmation email.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$email = "email_example"; // string | 
$customerAccountManagementV1ActivatePutBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivatePutBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivatePutBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ActivatePut($email, $customerAccountManagementV1ActivatePutBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ActivatePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
email string
customerAccountManagementV1ActivatePutBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ActivatePutBody [optional]

Return type

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ChangePasswordByIdPut

bool customerAccountManagementV1ChangePasswordByIdPut($customerAccountManagementV1ChangePasswordByIdPutBody)

Change customer password.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1ChangePasswordByIdPutBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ChangePasswordByIdPutBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ChangePasswordByIdPutBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ChangePasswordByIdPut($customerAccountManagementV1ChangePasswordByIdPutBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ChangePasswordByIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1ChangePasswordByIdPutBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ChangePasswordByIdPutBody [optional]

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1CreateAccountPost

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface customerAccountManagementV1CreateAccountPost($customerAccountManagementV1CreateAccountPostBody)

Create customer account. Perform necessary business operations like sending email.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1CreateAccountPostBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1CreateAccountPostBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1CreateAccountPostBody | 

try {
    $result = $apiInstance->customerAccountManagementV1CreateAccountPost($customerAccountManagementV1CreateAccountPostBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1CreateAccountPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1CreateAccountPostBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1CreateAccountPostBody [optional]

Return type

\Krak\MagentoApiClient\Model\CustomerDataCustomerInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1GetConfirmationStatusGet

string customerAccountManagementV1GetConfirmationStatusGet($customerId)

Gets the account confirmation status.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 56; // int | 

try {
    $result = $apiInstance->customerAccountManagementV1GetConfirmationStatusGet($customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1GetConfirmationStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerId int

Return type

string

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1GetDefaultBillingAddressGet

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface customerAccountManagementV1GetDefaultBillingAddressGet()

Retrieve default billing address for the given customerId.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->customerAccountManagementV1GetDefaultBillingAddressGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1GetDefaultBillingAddressGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1GetDefaultBillingAddressGet_0

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface customerAccountManagementV1GetDefaultBillingAddressGet_0($customerId)

Retrieve default billing address for the given customerId.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 56; // int | 

try {
    $result = $apiInstance->customerAccountManagementV1GetDefaultBillingAddressGet_0($customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1GetDefaultBillingAddressGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerId int

Return type

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1GetDefaultShippingAddressGet

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface customerAccountManagementV1GetDefaultShippingAddressGet()

Retrieve default shipping address for the given customerId.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->customerAccountManagementV1GetDefaultShippingAddressGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1GetDefaultShippingAddressGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1GetDefaultShippingAddressGet_0

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface customerAccountManagementV1GetDefaultShippingAddressGet_0($customerId)

Retrieve default shipping address for the given customerId.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 56; // int | 

try {
    $result = $apiInstance->customerAccountManagementV1GetDefaultShippingAddressGet_0($customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1GetDefaultShippingAddressGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerId int

Return type

\Krak\MagentoApiClient\Model\CustomerDataAddressInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1InitiatePasswordResetPut

bool customerAccountManagementV1InitiatePasswordResetPut($customerAccountManagementV1InitiatePasswordResetPutBody)

Send an email to the customer with a password reset link.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1InitiatePasswordResetPutBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1InitiatePasswordResetPutBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1InitiatePasswordResetPutBody | 

try {
    $result = $apiInstance->customerAccountManagementV1InitiatePasswordResetPut($customerAccountManagementV1InitiatePasswordResetPutBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1InitiatePasswordResetPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1InitiatePasswordResetPutBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1InitiatePasswordResetPutBody [optional]

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1IsEmailAvailablePost

bool customerAccountManagementV1IsEmailAvailablePost($customerAccountManagementV1IsEmailAvailablePostBody)

Check if given email is associated with a customer account in given website.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1IsEmailAvailablePostBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1IsEmailAvailablePostBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1IsEmailAvailablePostBody | 

try {
    $result = $apiInstance->customerAccountManagementV1IsEmailAvailablePost($customerAccountManagementV1IsEmailAvailablePostBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1IsEmailAvailablePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1IsEmailAvailablePostBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1IsEmailAvailablePostBody [optional]

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1IsReadonlyGet

bool customerAccountManagementV1IsReadonlyGet($customerId)

Check if customer can be deleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 56; // int | 

try {
    $result = $apiInstance->customerAccountManagementV1IsReadonlyGet($customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1IsReadonlyGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerId int

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ResendConfirmationPost

bool customerAccountManagementV1ResendConfirmationPost($customerAccountManagementV1ResendConfirmationPostBody)

Resend confirmation email.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1ResendConfirmationPostBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResendConfirmationPostBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResendConfirmationPostBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ResendConfirmationPost($customerAccountManagementV1ResendConfirmationPostBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ResendConfirmationPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1ResendConfirmationPostBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResendConfirmationPostBody [optional]

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ResetPasswordPost

bool customerAccountManagementV1ResetPasswordPost($customerAccountManagementV1ResetPasswordPostBody)

Reset customer password.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1ResetPasswordPostBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResetPasswordPostBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResetPasswordPostBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ResetPasswordPost($customerAccountManagementV1ResetPasswordPostBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ResetPasswordPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1ResetPasswordPostBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ResetPasswordPostBody [optional]

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ValidatePut

\Krak\MagentoApiClient\Model\CustomerDataValidationResultsInterface customerAccountManagementV1ValidatePut($customerAccountManagementV1ValidatePutBody)

Validate customer data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerAccountManagementV1ValidatePutBody = new \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ValidatePutBody(); // \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ValidatePutBody | 

try {
    $result = $apiInstance->customerAccountManagementV1ValidatePut($customerAccountManagementV1ValidatePutBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ValidatePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerAccountManagementV1ValidatePutBody \Krak\MagentoApiClient\Model\CustomerAccountManagementV1ValidatePutBody [optional]

Return type

\Krak\MagentoApiClient\Model\CustomerDataValidationResultsInterface

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customerAccountManagementV1ValidateResetPasswordLinkTokenGet

bool customerAccountManagementV1ValidateResetPasswordLinkTokenGet($customerId, $resetPasswordLinkToken)

Check if password reset token is valid.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = Krak\MagentoApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Krak\MagentoApiClient\Api\CustomerAccountManagementV1Api(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 56; // int | 
$resetPasswordLinkToken = "resetPasswordLinkToken_example"; // string | 

try {
    $result = $apiInstance->customerAccountManagementV1ValidateResetPasswordLinkTokenGet($customerId, $resetPasswordLinkToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerAccountManagementV1Api->customerAccountManagementV1ValidateResetPasswordLinkTokenGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
customerId int
resetPasswordLinkToken string

Return type

bool

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]