Skip to content

Latest commit

 

History

History
252 lines (168 loc) · 9 KB

TaxTaxClassRepositoryV1Api.md

File metadata and controls

252 lines (168 loc) · 9 KB
Raw

SpringImport\Swagger\Magento2\Client\TaxTaxClassRepositoryV1Api

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

Method HTTP request Description
taxTaxClassRepositoryV1DeleteByIdDelete DELETE /V1/taxClasses/{taxClassId}
taxTaxClassRepositoryV1GetGet GET /V1/taxClasses/{taxClassId}
taxTaxClassRepositoryV1GetListGet GET /V1/taxClasses/search
taxTaxClassRepositoryV1SavePost POST /V1/taxClasses
taxTaxClassRepositoryV1SavePut PUT /V1/taxClasses/{classId}

taxTaxClassRepositoryV1DeleteByIdDelete

bool taxTaxClassRepositoryV1DeleteByIdDelete($taxClassId)

Delete a tax class with the given tax class id.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\TaxTaxClassRepositoryV1Api();
$taxClassId = 56; // int | 

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

Parameters

Name Type Description Notes
taxClassId int

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]

taxTaxClassRepositoryV1GetGet

\SpringImport\Swagger\Magento2\Client\Model\TaxDataTaxClassInterface taxTaxClassRepositoryV1GetGet($taxClassId)

Get a tax class with the given tax class id.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\TaxTaxClassRepositoryV1Api();
$taxClassId = 56; // int | 

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

Parameters

Name Type Description Notes
taxClassId int

Return type

\SpringImport\Swagger\Magento2\Client\Model\TaxDataTaxClassInterface

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]

taxTaxClassRepositoryV1GetListGet

\SpringImport\Swagger\Magento2\Client\Model\TaxDataTaxClassSearchResultsInterface taxTaxClassRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field, $searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType, $searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction, $searchCriteriaPageSize, $searchCriteriaCurrentPage)

Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\TaxTaxClassRepositoryV1Api();
$searchCriteriaFilterGroups0Filters0Field = "searchCriteriaFilterGroups0Filters0Field_example"; // string | Field
$searchCriteriaFilterGroups0Filters0Value = "searchCriteriaFilterGroups0Filters0Value_example"; // string | Value
$searchCriteriaFilterGroups0Filters0ConditionType = "searchCriteriaFilterGroups0Filters0ConditionType_example"; // string | Condition type
$searchCriteriaSortOrders0Field = "searchCriteriaSortOrders0Field_example"; // string | Sorting field.
$searchCriteriaSortOrders0Direction = "searchCriteriaSortOrders0Direction_example"; // string | Sorting direction.
$searchCriteriaPageSize = 56; // int | Page size.
$searchCriteriaCurrentPage = 56; // int | Current page.

try {
    $result = $api_instance->taxTaxClassRepositoryV1GetListGet($searchCriteriaFilterGroups0Filters0Field, $searchCriteriaFilterGroups0Filters0Value, $searchCriteriaFilterGroups0Filters0ConditionType, $searchCriteriaSortOrders0Field, $searchCriteriaSortOrders0Direction, $searchCriteriaPageSize, $searchCriteriaCurrentPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TaxTaxClassRepositoryV1Api->taxTaxClassRepositoryV1GetListGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
searchCriteriaFilterGroups0Filters0Field string Field [optional]
searchCriteriaFilterGroups0Filters0Value string Value [optional]
searchCriteriaFilterGroups0Filters0ConditionType string Condition type [optional]
searchCriteriaSortOrders0Field string Sorting field. [optional]
searchCriteriaSortOrders0Direction string Sorting direction. [optional]
searchCriteriaPageSize int Page size. [optional]
searchCriteriaCurrentPage int Current page. [optional]

Return type

\SpringImport\Swagger\Magento2\Client\Model\TaxDataTaxClassSearchResultsInterface

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]

taxTaxClassRepositoryV1SavePost

string taxTaxClassRepositoryV1SavePost($body)

Create a Tax Class

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\TaxTaxClassRepositoryV1Api();
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body116(); // \SpringImport\Swagger\Magento2\Client\Model\Body116 | 

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

Parameters

Name Type Description Notes
body \SpringImport\Swagger\Magento2\Client\Model\Body116 [optional]

Return type

string

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]

taxTaxClassRepositoryV1SavePut

string taxTaxClassRepositoryV1SavePut($classId, $body)

Create a Tax Class

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\TaxTaxClassRepositoryV1Api();
$classId = "classId_example"; // string | 
$body = new \SpringImport\Swagger\Magento2\Client\Model\Body117(); // \SpringImport\Swagger\Magento2\Client\Model\Body117 | 

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

Parameters

Name Type Description Notes
classId string
body \SpringImport\Swagger\Magento2\Client\Model\Body117 [optional]

Return type

string

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]