Aurigma\Storefront\ProductReferencesApi

All URIs are relative to http://localhost.

Method	HTTP request	Description
productReferencesCreate()	POST /api/storefront/v1/product-references	Creates a new storefront product reference.
productReferencesDelete()	DELETE /api/storefront/v1/product-references/{reference}	Deletes the storefront product reference.
productReferencesGet()	GET /api/storefront/v1/product-references/{reference}	Returns a storefront product reference.
productReferencesGetAll()	GET /api/storefront/v1/product-references	Returns all storefront product references relevant to the specified query parameters.
productReferencesGetProductConfig()	GET /api/storefront/v1/product-references/{reference}/product-config	Returns a product personalization workflow configuration by storefront product reference.
productReferencesGetProductCostDetails()	GET /api/storefront/v1/product-references/{reference}/product-cost-details	Returns a product cost details from ecommerce system.
productReferencesGetProductSpecification()	GET /api/storefront/v1/product-references/{reference}/product-specification	Returns a product specification by the storefront product reference.

`productReferencesCreate()`

productReferencesCreate($storefront_id, $tenant_id, $create_product_reference_dto): \Aurigma\Storefront\Model\ProductReferenceDto

Creates a new storefront product reference.

Example

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


// Configure API key authorization: apiKey
$config = Aurigma\Storefront\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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.
$tenant_id = 56; // int | Tenant identifier.
$create_product_reference_dto = new \Aurigma\Storefront\Model\CreateProductReferenceDto(); // \Aurigma\Storefront\Model\CreateProductReferenceDto | Create operation parameters.

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

Parameters

Name	Type	Description	Notes
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]
create_product_reference_dto	\Aurigma\Storefront\Model\CreateProductReferenceDto	Create operation parameters.	[optional]

Return type

\Aurigma\Storefront\Model\ProductReferenceDto

Authorization

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

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json

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

`productReferencesDelete()`

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

Deletes the storefront product reference.

Example

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


// Configure API key authorization: apiKey
$config = Aurigma\Storefront\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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->productReferencesDelete($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesDelete: ', $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

\Aurigma\Storefront\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]

`productReferencesGet()`

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

Returns a storefront product reference.

Example

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


// Configure API key authorization: apiKey
$config = Aurigma\Storefront\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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->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 product specification, e.g online store product identifier.
storefront_id	int	Storefront identifier.
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\Storefront\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_specification_id, $skip, $take, $sorting, $search, $tenant_id): \Aurigma\Storefront\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\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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_specification_id = 56; // int | Cusomer's Canvas product specification 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->productReferencesGetAll($storefront_id, $product_reference, $product_specification_id, $skip, $take, $sorting, $search, $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_specification_id	int	Cusomer's Canvas product specification 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\Storefront\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]

`productReferencesGetProductConfig()`

productReferencesGetProductConfig($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\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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->productReferencesGetProductConfig($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductConfig: ', $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]

`productReferencesGetProductCostDetails()`

productReferencesGetProductCostDetails($reference, $sku, $storefront_id, $storefront_user_id, $currency_code, $quantity, $tenant_id): \Aurigma\Storefront\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\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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\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]

`productReferencesGetProductSpecification()`

productReferencesGetProductSpecification($reference, $storefront_id, $tenant_id): \Aurigma\Storefront\Model\ProductSpecificationDto

Returns a product specification by the storefront product reference.

Example

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


// Configure API key authorization: apiKey
$config = Aurigma\Storefront\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\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

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

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

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

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


$apiInstance = new Aurigma\Storefront\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->productReferencesGetProductSpecification($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesApi->productReferencesGetProductSpecification: ', $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

\Aurigma\Storefront\Model\ProductSpecificationDto

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\ProductReferencesApi

productReferencesCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGet()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductCostDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesGetProductSpecification()

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesCreate()`

`productReferencesDelete()`

`productReferencesGet()`

`productReferencesGetAll()`

`productReferencesGetProductConfig()`

`productReferencesGetProductCostDetails()`

`productReferencesGetProductSpecification()`