Skip to content

ProductSpecificationsApi.md

Latest commit

 

History

History
244 lines (172 loc) · 10.4 KB

ProductSpecificationsApi.md

File metadata and controls

244 lines (172 loc) · 10.4 KB

Aurigma\Storefront\ProductSpecificationsApi

All URIs are relative to http://localhost.

Method HTTP request Description
productSpecificationsGet() GET /api/storefront/v1/product-specifications/{id} Returns a product specification by identifier.
productSpecificationsGetAll() GET /api/storefront/v1/product-specifications Returns all product specifications, relevant to the specified query parameters.
productSpecificationsGetConfiguration() GET /api/storefront/v1/product-specifications/{id}/config Returns a product personlization workflow configuration by product specification identifier.

productSpecificationsGet()

productSpecificationsGet($id, $tenant_id): \Aurigma\Storefront\Model\ProductSpecificationDto

Returns a product specification by identifier.

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\ProductSpecificationsApi(
    // 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 | Product specification identifier.
$tenant_id = 56; // int | Tenant identifier.

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

Parameters

Name Type Description Notes
id int Product specification 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]

productSpecificationsGetAll()

productSpecificationsGetAll($skip, $take, $sorting, $search, $tenant_id): \Aurigma\Storefront\Model\PagedOfProductSpecificationDto

Returns all product specifications, 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\ProductSpecificationsApi(
    // 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
);
$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->productSpecificationsGetAll($skip, $take, $sorting, $search, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductSpecificationsApi->productSpecificationsGetAll: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
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.: &quot;Title ASC, LastModified DESC&quot;. [optional]
search string Search string for partial match. [optional]
tenant_id int Tenant identifier. [optional]

Return type

\Aurigma\Storefront\Model\PagedOfProductSpecificationDto

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]

productSpecificationsGetConfiguration()

productSpecificationsGetConfiguration($id, $tenant_id): string

Returns a product personlization workflow configuration by product specification identifier.

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\ProductSpecificationsApi(
    // 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 | Product specification identifier.
$tenant_id = 56; // int | Tenant identifier.

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

Parameters

Name Type Description Notes
id int Product specification 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]