Aurigma\Storefront\Products\ProductReferencesApi

All URIs are relative to http://localhost.

Method	HTTP request	Description
productReferencesGet()	GET /api/storefront/v1/product-references/ext/{reference}	Returns a storefront product reference.
productReferencesGetAll()	GET /api/storefront/v1/product-references/ext	Returns all storefront product references relevant to the specified query parameters.
productReferencesGetAllProductLinks()	GET /api/storefront/v1/product-references/ext/product-links	Returns a list of product links associated with storefront product references relevant to the specified query parameters.
productReferencesGetProduct()	GET /api/storefront/v1/product-references/ext/{reference}/product	Returns a product by storefront product reference.
productReferencesGetProductCostDetails()	GET /api/storefront/v1/product-references/ext/{reference}/product-cost-details	Returns a product cost details from ecommerce system.
productReferencesGetProductFilter()	GET /api/storefront/v1/product-references/ext/{reference}/product-filter	Returns a product filter by storefront product reference.
productReferencesGetProductLink()	GET /api/storefront/v1/product-references/ext/{reference}/product-link	Returns a product link by storefront product reference.
productReferencesGetProductPersonalizationWorkflow()	GET /api/storefront/v1/product-references/ext/{reference}/product-personalization-workflow	Returns a product personalization workflow configuration by storefront product reference.
productReferencesObsoleteGetProduct()	GET /api/storefront/v1/product-references/{reference}/product	Returns a product by storefront product reference.
productReferencesObsoleteGetProductFilter()	GET /api/storefront/v1/product-references/{reference}/product-filter	Returns a product filter by storefront product reference.
productReferencesObsoleteGetProductLink()	GET /api/storefront/v1/product-references/{reference}/product-link	Returns a product link by storefront product reference.
productReferencesObsoleteGetProductPersonalizationWorkflow()	GET /api/storefront/v1/product-references/{reference}/product-personalization-workflow	Returns a product personalization workflow configuration by storefront product reference.

`productReferencesGet()`

productReferencesGet($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductReferenceDto

Returns a storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas products, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGet($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas products, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductReferenceDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetAll()`

productReferencesGetAll($storefront_id, $product_reference, $product_id, $product_version_id, $product_link_id, $skip, $take, $sorting, $search, $sku, $tenant_id): \Aurigma\Storefront\Products\Model\PagedOfProductReferenceDto

Returns all storefront product references relevant to the specified query parameters.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$storefront_id = 56; // int | Storefront identifier.
$product_reference = 'product_reference_example'; // string | Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.
$product_id = 56; // int | Cusomer's Canvas product filter.
$product_version_id = 56; // int | Cusomer's Canvas product version filter.
$product_link_id = 56; // int | Cusomer's Canvas product link 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.
$sku = 'sku_example'; // string | SKU filter.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetAll($storefront_id, $product_reference, $product_id, $product_version_id, $product_link_id, $skip, $take, $sorting, $search, $sku, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
storefront_id	int	Storefront identifier.
product_reference	string	Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.	[optional]
product_id	int	Cusomer's Canvas product filter.	[optional]
product_version_id	int	Cusomer's Canvas product version filter.	[optional]
product_link_id	int	Cusomer's Canvas product link 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]
sku	string	SKU filter.	[optional]
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\PagedOfProductReferenceDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetAllProductLinks()`

productReferencesGetAllProductLinks($storefront_id, $product_reference, $product_id, $product_version_id, $product_link_id, $skip, $take, $sorting, $search, $sku, $tenant_id): \Aurigma\Storefront\Products\Model\PagedOfProductLinkDto

Returns a list of product links associated with storefront product references relevant to the specified query parameters.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$storefront_id = 56; // int | Storefront identifier.
$product_reference = 'product_reference_example'; // string | Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.
$product_id = 56; // int | Cusomer's Canvas product filter.
$product_version_id = 56; // int | Cusomer's Canvas product version filter.
$product_link_id = 56; // int | Cusomer's Canvas product link 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.
$sku = 'sku_example'; // string | SKU filter.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetAllProductLinks($storefront_id, $product_reference, $product_id, $product_version_id, $product_link_id, $skip, $take, $sorting, $search, $sku, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetAllProductLinks: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
storefront_id	int	Storefront identifier.
product_reference	string	Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.	[optional]
product_id	int	Cusomer's Canvas product filter.	[optional]
product_version_id	int	Cusomer's Canvas product version filter.	[optional]
product_link_id	int	Cusomer's Canvas product link 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]
sku	string	SKU filter.	[optional]
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\PagedOfProductLinkDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetProduct()`

productReferencesGetProduct($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductDto

Returns a product by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetProduct($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetProductCostDetails()`

productReferencesGetProductCostDetails($reference, $sku, $storefront_id, $storefront_user_id, $currency_code, $quantity, $tenant_id): \Aurigma\Storefront\Products\Model\ProductCostDetailsDto

Returns a product cost details from ecommerce system.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
$sku = 'sku_example'; // string | Product SKU.
$storefront_id = 56; // int | Storefront identifier.
$storefront_user_id = 'storefront_user_id_example'; // string | Storefront user identifier.
$currency_code = 'currency_code_example'; // string | Product cost currency code.
$quantity = 1; // int | Product quantity.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetProductCostDetails($reference, $sku, $storefront_id, $storefront_user_id, $currency_code, $quantity, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductCostDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
sku	string	Product SKU.
storefront_id	int	Storefront identifier.
storefront_user_id	string	Storefront user identifier.	[optional]
currency_code	string	Product cost currency code.	[optional]
quantity	int	Product quantity.	[optional] [default to 1]
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductCostDetailsDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetProductFilter()`

productReferencesGetProductFilter($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductFilterDto

Returns a product filter by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetProductFilter($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductFilter: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductFilterDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetProductLink()`

productReferencesGetProductLink($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductLinkDto

Returns a product link by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetProductLink($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductLink: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductLinkDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesGetProductPersonalizationWorkflow()`

productReferencesGetProductPersonalizationWorkflow($reference, $storefront_id, $tenant_id): string

Returns a product personalization workflow configuration by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesGetProductPersonalizationWorkflow($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductPersonalizationWorkflow: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

string

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesObsoleteGetProduct()`

productReferencesObsoleteGetProduct($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductDto

Returns a product by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesObsoleteGetProduct($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesObsoleteGetProduct: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesObsoleteGetProductFilter()`

productReferencesObsoleteGetProductFilter($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductFilterDto

Returns a product filter by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesObsoleteGetProductFilter($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesObsoleteGetProductFilter: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductFilterDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesObsoleteGetProductLink()`

productReferencesObsoleteGetProductLink($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Products\Model\ProductLinkDto

Returns a product link by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesObsoleteGetProductLink($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesObsoleteGetProductLink: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\Products\Model\ProductLinkDto

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

`productReferencesObsoleteGetProductPersonalizationWorkflow()`

productReferencesObsoleteGetProductPersonalizationWorkflow($reference, $storefront_id, $tenant_id): string

Returns a product personalization workflow configuration by storefront product reference.

Example

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


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

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

// Configure OAuth2 access token for authorization: oauth2-clientCredentials
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-code
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2-implicit
$config = Aurigma\Storefront\Products\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Aurigma\Storefront\Products\Api\ProductReferencesApi(
    // 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
);
$reference = 'reference_example'; // string | Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
$storefront_id = 56; // int | Storefront identifier.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesObsoleteGetProductPersonalizationWorkflow($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesObsoleteGetProductPersonalizationWorkflow: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

string

Authorization

apiKey, bearerAuth, oauth2-clientCredentials, oauth2-code, oauth2-implicit

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

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

Files

ProductReferencesApi.md

Latest commit

History

ProductReferencesApi.md

File metadata and controls

Aurigma\Storefront\Products\ProductReferencesApi

productReferencesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetAllProductLinks()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductCostDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductFilter()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductLink()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductPersonalizationWorkflow()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesObsoleteGetProduct()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesObsoleteGetProductFilter()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesObsoleteGetProductLink()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesObsoleteGetProductPersonalizationWorkflow()

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesGet()`

`productReferencesGetAll()`

`productReferencesGetAllProductLinks()`

`productReferencesGetProduct()`

`productReferencesGetProductCostDetails()`

`productReferencesGetProductFilter()`

`productReferencesGetProductLink()`

`productReferencesGetProductPersonalizationWorkflow()`

`productReferencesObsoleteGetProduct()`

`productReferencesObsoleteGetProductFilter()`

`productReferencesObsoleteGetProductLink()`

`productReferencesObsoleteGetProductPersonalizationWorkflow()`