Aurigma\BackOffice\ProductReferencesManagementApi

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

Method	HTTP request	Description
productReferencesManagementCreate()	POST /api/backoffice/v1/product-references	Creates a new storefront product reference.
productReferencesManagementDelete()	DELETE /api/backoffice/v1/product-references/{reference}	Deletes the storefront product reference.
productReferencesManagementGet()	GET /api/backoffice/v1/product-references/{reference}	Returns a storefront product reference.
productReferencesManagementGetAll()	GET /api/backoffice/v1/product-references	Returns all storefront product references relevant to the specified query parameters.

`productReferencesManagementCreate()`

productReferencesManagementCreate($storefront_id, $tenant_id, $product_references_management_create_request): \Aurigma\BackOffice\Model\ProductReferenceDto

Creates a new storefront product reference.

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\ProductReferencesManagementApi(
    // 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.
$product_references_management_create_request = new \Aurigma\BackOffice\Model\ProductReferencesManagementCreateRequest(); // \Aurigma\BackOffice\Model\ProductReferencesManagementCreateRequest | Create operation parameters.

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

Parameters

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

Return type

\Aurigma\BackOffice\Model\ProductReferenceDto

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]

`productReferencesManagementDelete()`

productReferencesManagementDelete($reference, $storefront_id, $tenant_id): \Aurigma\BackOffice\Model\ProductReferenceDto

Deletes the storefront product reference.

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\ProductReferencesManagementApi(
    // 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->productReferencesManagementDelete($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesManagementApi->productReferencesManagementDelete: ', $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\BackOffice\Model\ProductReferenceDto

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]

`productReferencesManagementGet()`

productReferencesManagementGet($reference, $storefront_id, $tenant_id): \Aurigma\BackOffice\Model\ProductReferenceDto

Returns a storefront product reference.

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\ProductReferencesManagementApi(
    // 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 | An 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->productReferencesManagementGet($reference, $storefront_id, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesManagementApi->productReferencesManagementGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
reference	string	An 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\BackOffice\Model\ProductReferenceDto

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]

`productReferencesManagementGetAll()`

productReferencesManagementGetAll($storefront_id, $product_reference, $product_specification_id, $product_id, $product_link_id, $product_bundle_id, $skip, $take, $sorting, $search, $sku, $tags, $custom_fields, $tenant_id): \Aurigma\BackOffice\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\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\ProductReferencesManagementApi(
    // 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, e.g online store product identifier.
$product_specification_id = 56; // int | Customer's Canvas product specification filter.
$product_id = 56; // int | Customer's Canvas product filter.
$product_link_id = 56; // int | Customer's Canvas product link filter.
$product_bundle_id = 56; // int | Customer's Canvas product bundle 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.
$tags = array('tags_example'); // string[] | List of tags that product should have.
$custom_fields = 'custom_fields_example'; // string | Serialized custom fields dictionary filter. For example: {\"public\":\"true\",\"name\":\"my item\"}.
$tenant_id = 56; // int | Tenant identifier.

try {
    $result = $apiInstance->productReferencesManagementGetAll($storefront_id, $product_reference, $product_specification_id, $product_id, $product_link_id, $product_bundle_id, $skip, $take, $sorting, $search, $sku, $tags, $custom_fields, $tenant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductReferencesManagementApi->productReferencesManagementGetAll: ', $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, e.g online store product identifier.	[optional]
product_specification_id	int	Customer's Canvas product specification filter.	[optional]
product_id	int	Customer's Canvas product filter.	[optional]
product_link_id	int	Customer's Canvas product link filter.	[optional]
product_bundle_id	int	Customer's Canvas product bundle 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]
tags	string[]	List of tags that product should have.	[optional]
custom_fields	string	Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.	[optional]
tenant_id	int	Tenant identifier.	[optional]

Return type

\Aurigma\BackOffice\Model\PagedOfProductReferenceDto

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Aurigma\BackOffice\ProductReferencesManagementApi

`productReferencesManagementCreate()`

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesManagementDelete()`

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesManagementGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesManagementGetAll()`

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

ProductReferencesManagementApi.md

Latest commit

History

ProductReferencesManagementApi.md

File metadata and controls

Aurigma\BackOffice\ProductReferencesManagementApi

productReferencesManagementCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesManagementDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesManagementGet()

Example

Parameters

Return type

Authorization

HTTP request headers

productReferencesManagementGetAll()

Example

Parameters

Return type

Authorization

HTTP request headers

`productReferencesManagementCreate()`

`productReferencesManagementDelete()`

`productReferencesManagementGet()`

`productReferencesManagementGetAll()`