Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

Latest commit

 

History

History
252 lines (168 loc) · 9.44 KB

CatalogProductAttributeRepositoryV1Api.md

File metadata and controls

252 lines (168 loc) · 9.44 KB
Raw

Swagger\Client\CatalogProductAttributeRepositoryV1Api

All URIs are relative to http://t213.vg/rest/default

Method HTTP request Description
catalogProductAttributeRepositoryV1DeleteByIdDelete DELETE /V1/products/attributes/{attributeCode}
catalogProductAttributeRepositoryV1GetGet GET /V1/products/attributes/{attributeCode}
catalogProductAttributeRepositoryV1GetListGet GET /V1/products/attributes
catalogProductAttributeRepositoryV1SavePost POST /V1/products/attributes
catalogProductAttributeRepositoryV1SavePut PUT /V1/products/attributes/{attributeCode}

catalogProductAttributeRepositoryV1DeleteByIdDelete

bool catalogProductAttributeRepositoryV1DeleteByIdDelete($attribute_code)

Delete Attribute by id

Example

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

$api_instance = new Swagger\Client\Api\CatalogProductAttributeRepositoryV1Api();
$attribute_code = "attribute_code_example"; // string | 

try {
    $result = $api_instance->catalogProductAttributeRepositoryV1DeleteByIdDelete($attribute_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogProductAttributeRepositoryV1Api->catalogProductAttributeRepositoryV1DeleteByIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
attribute_code string

Return type

bool

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

catalogProductAttributeRepositoryV1GetGet

\Swagger\Client\Model\CatalogDataProductAttributeInterface catalogProductAttributeRepositoryV1GetGet($attribute_code)

Retrieve specific attribute

Example

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

$api_instance = new Swagger\Client\Api\CatalogProductAttributeRepositoryV1Api();
$attribute_code = "attribute_code_example"; // string | 

try {
    $result = $api_instance->catalogProductAttributeRepositoryV1GetGet($attribute_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogProductAttributeRepositoryV1Api->catalogProductAttributeRepositoryV1GetGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
attribute_code string

Return type

\Swagger\Client\Model\CatalogDataProductAttributeInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

catalogProductAttributeRepositoryV1GetListGet

\Swagger\Client\Model\CatalogDataProductAttributeSearchResultsInterface catalogProductAttributeRepositoryV1GetListGet($search_criteria_filter_groups_filters_field, $search_criteria_filter_groups_filters_value, $search_criteria_filter_groups_filters_condition_type, $search_criteria_sort_orders_field, $search_criteria_sort_orders_direction, $search_criteria_page_size, $search_criteria_current_page)

Retrieve all attributes for entity type

Example

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

$api_instance = new Swagger\Client\Api\CatalogProductAttributeRepositoryV1Api();
$search_criteria_filter_groups_filters_field = "search_criteria_filter_groups_filters_field_example"; // string | Field
$search_criteria_filter_groups_filters_value = "search_criteria_filter_groups_filters_value_example"; // string | Value
$search_criteria_filter_groups_filters_condition_type = "search_criteria_filter_groups_filters_condition_type_example"; // string | Condition type
$search_criteria_sort_orders_field = "search_criteria_sort_orders_field_example"; // string | Sorting field.
$search_criteria_sort_orders_direction = "search_criteria_sort_orders_direction_example"; // string | Sorting direction.
$search_criteria_page_size = 56; // int | Page size.
$search_criteria_current_page = 56; // int | Current page.

try {
    $result = $api_instance->catalogProductAttributeRepositoryV1GetListGet($search_criteria_filter_groups_filters_field, $search_criteria_filter_groups_filters_value, $search_criteria_filter_groups_filters_condition_type, $search_criteria_sort_orders_field, $search_criteria_sort_orders_direction, $search_criteria_page_size, $search_criteria_current_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogProductAttributeRepositoryV1Api->catalogProductAttributeRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
search_criteria_filter_groups_filters_field string Field [optional]
search_criteria_filter_groups_filters_value string Value [optional]
search_criteria_filter_groups_filters_condition_type string Condition type [optional]
search_criteria_sort_orders_field string Sorting field. [optional]
search_criteria_sort_orders_direction string Sorting direction. [optional]
search_criteria_page_size int Page size. [optional]
search_criteria_current_page int Current page. [optional]

Return type

\Swagger\Client\Model\CatalogDataProductAttributeSearchResultsInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

catalogProductAttributeRepositoryV1SavePost

\Swagger\Client\Model\CatalogDataProductAttributeInterface catalogProductAttributeRepositoryV1SavePost($body)

Save attribute data

Example

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

$api_instance = new Swagger\Client\Api\CatalogProductAttributeRepositoryV1Api();
$body = new \Swagger\Client\Model\Body21(); // \Swagger\Client\Model\Body21 | 

try {
    $result = $api_instance->catalogProductAttributeRepositoryV1SavePost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogProductAttributeRepositoryV1Api->catalogProductAttributeRepositoryV1SavePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\Body21 [optional]

Return type

\Swagger\Client\Model\CatalogDataProductAttributeInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

catalogProductAttributeRepositoryV1SavePut

\Swagger\Client\Model\CatalogDataProductAttributeInterface catalogProductAttributeRepositoryV1SavePut($attribute_code, $body)

Save attribute data

Example

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

$api_instance = new Swagger\Client\Api\CatalogProductAttributeRepositoryV1Api();
$attribute_code = "attribute_code_example"; // string | 
$body = new \Swagger\Client\Model\Body20(); // \Swagger\Client\Model\Body20 | 

try {
    $result = $api_instance->catalogProductAttributeRepositoryV1SavePut($attribute_code, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogProductAttributeRepositoryV1Api->catalogProductAttributeRepositoryV1SavePut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
attribute_code string
body \Swagger\Client\Model\Body20 [optional]

Return type

\Swagger\Client\Model\CatalogDataProductAttributeInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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