Aurigma\BackOffice\StorefrontsManagementApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
storefrontsManagementCreateBigCommerceStorefront()	POST /api/backoffice/v1/storefronts/bigcommerce	Creates new BigCommerce storefront.
storefrontsManagementCreateCustomStorefront()	POST /api/backoffice/v1/storefronts/custom	Creates new custom storefront.
storefrontsManagementCreateMagentoStorefront()	POST /api/backoffice/v1/storefronts/magento	Creates new Magento storefront.
storefrontsManagementCreateNopCommerceStorefront()	POST /api/backoffice/v1/storefronts/nopcommerce	Creates new NopCommerce storefront.
storefrontsManagementCreateWooCommerceStorefront()	POST /api/backoffice/v1/storefronts/woocommerce	Creates new WooCommerce storefront.
storefrontsManagementDelete()	DELETE /api/backoffice/v1/storefronts/{id}	Deletes an existing storefront by its identifier.
storefrontsManagementGet()	GET /api/backoffice/v1/storefronts/{id}	Returns a storefront by identifier.
storefrontsManagementGetAll()	GET /api/backoffice/v1/storefronts	Returns all storefronts, relevant to the specified query parameters.
storefrontsManagementGetBigCommerceStorefront()	GET /api/backoffice/v1/storefronts/bigcommerce/{id}	Returns extended information about BigCommerce storefront.
storefrontsManagementGetCustomStorefront()	GET /api/backoffice/v1/storefronts/custom/{id}	Returns extended information about custom storefront.
storefrontsManagementGetMagentoStorefront()	GET /api/backoffice/v1/storefronts/magento/{id}	Returns extended information about Magento storefront.
storefrontsManagementGetNopCommerceStorefront()	GET /api/backoffice/v1/storefronts/nopcommerce/{id}	Returns extended information about NopCommerce storefront.
storefrontsManagementGetWooCommerceStorefront()	GET /api/backoffice/v1/storefronts/woocommerce/{id}	Returns extended information about WooCommerce storefront.

`storefrontsManagementCreateBigCommerceStorefront()`

storefrontsManagementCreateBigCommerceStorefront($tenant_id, $storefronts_management_create_big_commerce_storefront_request): \Aurigma\BackOffice\Model\BigCommerceStorefrontDto

Creates new BigCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$storefronts_management_create_big_commerce_storefront_request = new \Aurigma\BackOffice\Model\StorefrontsManagementCreateBigCommerceStorefrontRequest(); // \Aurigma\BackOffice\Model\StorefrontsManagementCreateBigCommerceStorefrontRequest | BigCommerce storefront creation model.

try {
    $result = $apiInstance->storefrontsManagementCreateBigCommerceStorefront($tenant_id, $storefronts_management_create_big_commerce_storefront_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementCreateBigCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tenant_id	int	Tenant identifier.	[optional]
storefronts_management_create_big_commerce_storefront_request	\Aurigma\BackOffice\Model\StorefrontsManagementCreateBigCommerceStorefrontRequest	BigCommerce storefront creation model.	[optional]

Return type

\Aurigma\BackOffice\Model\BigCommerceStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`storefrontsManagementCreateCustomStorefront()`

storefrontsManagementCreateCustomStorefront($tenant_id, $storefronts_management_create_custom_storefront_request): \Aurigma\BackOffice\Model\CustomStorefrontDto

Creates new custom storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$storefronts_management_create_custom_storefront_request = new \Aurigma\BackOffice\Model\StorefrontsManagementCreateCustomStorefrontRequest(); // \Aurigma\BackOffice\Model\StorefrontsManagementCreateCustomStorefrontRequest | Custom storefront creation model.

try {
    $result = $apiInstance->storefrontsManagementCreateCustomStorefront($tenant_id, $storefronts_management_create_custom_storefront_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementCreateCustomStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tenant_id	int	Tenant identifier.	[optional]
storefronts_management_create_custom_storefront_request	\Aurigma\BackOffice\Model\StorefrontsManagementCreateCustomStorefrontRequest	Custom storefront creation model.	[optional]

Return type

\Aurigma\BackOffice\Model\CustomStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`storefrontsManagementCreateMagentoStorefront()`

storefrontsManagementCreateMagentoStorefront($tenant_id, $storefronts_management_create_magento_storefront_request): \Aurigma\BackOffice\Model\MagentoStorefrontDto

Creates new Magento storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$storefronts_management_create_magento_storefront_request = new \Aurigma\BackOffice\Model\StorefrontsManagementCreateMagentoStorefrontRequest(); // \Aurigma\BackOffice\Model\StorefrontsManagementCreateMagentoStorefrontRequest | Magento storefront creation model.

try {
    $result = $apiInstance->storefrontsManagementCreateMagentoStorefront($tenant_id, $storefronts_management_create_magento_storefront_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementCreateMagentoStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tenant_id	int	Tenant identifier.	[optional]
storefronts_management_create_magento_storefront_request	\Aurigma\BackOffice\Model\StorefrontsManagementCreateMagentoStorefrontRequest	Magento storefront creation model.	[optional]

Return type

\Aurigma\BackOffice\Model\MagentoStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`storefrontsManagementCreateNopCommerceStorefront()`

storefrontsManagementCreateNopCommerceStorefront($tenant_id, $storefronts_management_create_nop_commerce_storefront_request): \Aurigma\BackOffice\Model\NopCommerceStorefrontDto

Creates new NopCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$storefronts_management_create_nop_commerce_storefront_request = new \Aurigma\BackOffice\Model\StorefrontsManagementCreateNopCommerceStorefrontRequest(); // \Aurigma\BackOffice\Model\StorefrontsManagementCreateNopCommerceStorefrontRequest | NopCommerce storefront creation model.

try {
    $result = $apiInstance->storefrontsManagementCreateNopCommerceStorefront($tenant_id, $storefronts_management_create_nop_commerce_storefront_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementCreateNopCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tenant_id	int	Tenant identifier.	[optional]
storefronts_management_create_nop_commerce_storefront_request	\Aurigma\BackOffice\Model\StorefrontsManagementCreateNopCommerceStorefrontRequest	NopCommerce storefront creation model.	[optional]

Return type

\Aurigma\BackOffice\Model\NopCommerceStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`storefrontsManagementCreateWooCommerceStorefront()`

storefrontsManagementCreateWooCommerceStorefront($tenant_id, $storefronts_management_create_woo_commerce_storefront_request): \Aurigma\BackOffice\Model\WooCommerceStorefrontDto

Creates new WooCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$tenant_id = 56; // int | Tenant identifier.
$storefronts_management_create_woo_commerce_storefront_request = new \Aurigma\BackOffice\Model\StorefrontsManagementCreateWooCommerceStorefrontRequest(); // \Aurigma\BackOffice\Model\StorefrontsManagementCreateWooCommerceStorefrontRequest | WooCommerce storefront creation model.

try {
    $result = $apiInstance->storefrontsManagementCreateWooCommerceStorefront($tenant_id, $storefronts_management_create_woo_commerce_storefront_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementCreateWooCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
tenant_id	int	Tenant identifier.	[optional]
storefronts_management_create_woo_commerce_storefront_request	\Aurigma\BackOffice\Model\StorefrontsManagementCreateWooCommerceStorefrontRequest	WooCommerce storefront creation model.	[optional]

Return type

\Aurigma\BackOffice\Model\WooCommerceStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`storefrontsManagementDelete()`

storefrontsManagementDelete($id, $tenant_id): \Aurigma\BackOffice\Model\StorefrontDto

Deletes an existing storefront by its identifier.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementDelete($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\StorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGet()`

storefrontsManagementGet($id, $tenant_id): \Aurigma\BackOffice\Model\StorefrontDto

Returns a storefront by identifier.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGet($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\StorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetAll()`

storefrontsManagementGetAll($types, $skip, $take, $sorting, $search, $tenant_id): \Aurigma\BackOffice\Model\PagedOfStorefrontDto

Returns all storefronts, relevant to the specified query parameters.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$types = array(new \Aurigma\BackOffice\Model\\Aurigma\BackOffice\Model\StorefrontType()); // \Aurigma\BackOffice\Model\StorefrontType[] | Storefront type filter.
$skip = 56; // int | Defines page start offset from beginning of sorted result list.
$take = 56; // int | Defines page length (how many consequent items of sorted result list should be taken).
$sorting = 'sorting_example'; // string | Defines sorting order of result list e.g.: \"Title ASC, LastModified DESC\".
$search = 'search_example'; // string | Search string for partial match.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetAll($types, $skip, $take, $sorting, $search, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
types	\Aurigma\BackOffice\Model\StorefrontType[]	Storefront type filter.	[optional]
skip	int	Defines page start offset from beginning of sorted result list.	[optional]
take	int	Defines page length (how many consequent items of sorted result list should be taken).	[optional]
sorting	string	Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".	[optional]
search	string	Search string for partial match.	[optional]
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\PagedOfStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetBigCommerceStorefront()`

storefrontsManagementGetBigCommerceStorefront($id, $tenant_id): \Aurigma\BackOffice\Model\MagentoStorefrontDto

Returns extended information about BigCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetBigCommerceStorefront($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetBigCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\MagentoStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetCustomStorefront()`

storefrontsManagementGetCustomStorefront($id, $tenant_id): \Aurigma\BackOffice\Model\CustomStorefrontDto

Returns extended information about custom storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetCustomStorefront($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetCustomStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\CustomStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetMagentoStorefront()`

storefrontsManagementGetMagentoStorefront($id, $tenant_id): \Aurigma\BackOffice\Model\MagentoStorefrontDto

Returns extended information about Magento storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetMagentoStorefront($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetMagentoStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\MagentoStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetNopCommerceStorefront()`

storefrontsManagementGetNopCommerceStorefront($id, $tenant_id): \Aurigma\BackOffice\Model\NopCommerceStorefrontDto

Returns extended information about NopCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetNopCommerceStorefront($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetNopCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\NopCommerceStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`storefrontsManagementGetWooCommerceStorefront()`

storefrontsManagementGetWooCommerceStorefront($id, $tenant_id): \Aurigma\BackOffice\Model\WooCommerceStorefrontDto

Returns extended information about WooCommerce storefront.

Example

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


// Configure API key authorization: ApiKey
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

// Configure API key authorization: Bearer
$config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Aurigma\BackOffice\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Aurigma\BackOffice\Api\StorefrontsManagementApi(
    // 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
);
$id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->storefrontsManagementGetWooCommerceStorefront($id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontsManagementApi->storefrontsManagementGetWooCommerceStorefront: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\WooCommerceStorefrontDto

Authorization

ApiKey, OAuth2ClientCredentials, OAuth2Implicit, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

FilesExpand file tree

StorefrontsManagementApi.md

Latest commit

History

StorefrontsManagementApi.md

File metadata and controls

Aurigma\BackOffice\StorefrontsManagementApi

storefrontsManagementCreateBigCommerceStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementCreateCustomStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementCreateMagentoStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementCreateNopCommerceStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementCreateWooCommerceStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGet()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetBigCommerceStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetCustomStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetMagentoStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetNopCommerceStorefront()

Example

Parameters

Return type

Authorization

HTTP request headers

storefrontsManagementGetWooCommerceStorefront()

`storefrontsManagementCreateBigCommerceStorefront()`

`storefrontsManagementCreateCustomStorefront()`

`storefrontsManagementCreateMagentoStorefront()`

`storefrontsManagementCreateNopCommerceStorefront()`

`storefrontsManagementCreateWooCommerceStorefront()`

`storefrontsManagementDelete()`

`storefrontsManagementGet()`

`storefrontsManagementGetAll()`

`storefrontsManagementGetBigCommerceStorefront()`

`storefrontsManagementGetCustomStorefront()`

`storefrontsManagementGetMagentoStorefront()`

`storefrontsManagementGetNopCommerceStorefront()`

`storefrontsManagementGetWooCommerceStorefront()`