AaronKaa/Magento2RestApi

Getting started

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the composer.json file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type composer --version. This should display the current version of the Composer installed if the installation was successful.

• Using command line, navigate to the directory containing the generated files (including composer.json) for the SDK.
• Run the command composer install. This should install all the required dependencies and create the vendor directory in your project directory.

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

[curl]
; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
;curl.cainfo =

How to Use

The following section explains how to use the MagentoCommunity library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PhpStorm to browse to your generated SDK directory and then click OK.

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a PHP file to this project

Name it "testSDK"

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

require_once "../vendor/autoload.php";

It is important that the path inside require_once correctly points to the file autoload.php inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open Settings from File menu.

Select PHP from within Languages & Frameworks

Browse for Interpreters near the Interpreter option and choose your interpreter.

Once the interpreter is selected, click OK

To run your project, right click on your PHP file inside your Test project and click on Run

How to Test

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

API client can be initialized as following.

$client = new MagentoCommunityLib\MagentoCommunityClient();

Class Reference

List of Controllers

• StoreStoreRepositoryV1Controller
• StoreGroupRepositoryV1Controller
• StoreWebsiteRepositoryV1Controller
• StoreStoreConfigManagerV1Controller
• DirectoryCurrencyInformationAcquirerV1Controller
• DirectoryCountryInformationAcquirerV1Controller
• EavAttributeSetRepositoryV1Controller
• EavAttributeSetManagementV1Controller
• CustomerGroupRepositoryV1Controller
• CustomerGroupManagementV1Controller
• CustomerCustomerGroupConfigV1Controller
• CustomerCustomerMetadataV1Controller
• CustomerAddressMetadataV1Controller
• CustomerCustomerRepositoryV1Controller
• CustomerAccountManagementV1Controller
• CustomerAddressRepositoryV1Controller
• CmsPageRepositoryV1Controller
• CmsBlockRepositoryV1Controller
• CatalogProductRepositoryV1Controller
• CatalogProductAttributeTypesListV1Controller
• CatalogProductAttributeRepositoryV1Controller
• CatalogCategoryAttributeRepositoryV1Controller
• CatalogCategoryAttributeOptionManagementV1Controller
• CatalogProductTypeListV1Controller
• CatalogAttributeSetRepositoryV1Controller
• CatalogAttributeSetManagementV1Controller
• CatalogProductAttributeManagementV1Controller
• CatalogProductAttributeGroupRepositoryV1Controller
• CatalogProductAttributeOptionManagementV1Controller
• CatalogProductMediaAttributeManagementV1Controller
• CatalogProductAttributeMediaGalleryManagementV1Controller
• CatalogProductTierPriceManagementV1Controller
• CatalogTierPriceStorageV1Controller
• CatalogBasePriceStorageV1Controller
• CatalogCostStorageV1Controller
• CatalogSpecialPriceStorageV1Controller
• CatalogCategoryRepositoryV1Controller
• CatalogCategoryManagementV1Controller
• CatalogCategoryListV1Controller
• CatalogProductCustomOptionTypeListV1Controller
• CatalogProductCustomOptionRepositoryV1Controller
• CatalogProductLinkTypeListV1Controller
• CatalogProductLinkManagementV1Controller
• CatalogProductLinkRepositoryV1Controller
• CatalogCategoryLinkManagementV1Controller
• CatalogCategoryLinkRepositoryV1Controller
• CatalogProductWebsiteLinkRepositoryV1Controller
• CatalogProductRenderListV1Controller
• CatalogInventoryStockRegistryV1Controller
• BackendModuleServiceV1Controller
• QuoteCartRepositoryV1Controller
• QuoteCartManagementV1Controller
• QuoteGuestCartRepositoryV1Controller
• QuoteGuestCartManagementV1Controller
• QuoteShippingMethodManagementV1Controller
• QuoteShipmentEstimationV1Controller
• TemandoShippingQuoteShippingMethodManagementV1Controller
• QuoteGuestShippingMethodManagementV1Controller
• QuoteGuestShipmentEstimationV1Controller
• QuoteCartItemRepositoryV1Controller
• QuoteGuestCartItemRepositoryV1Controller
• QuotePaymentMethodManagementV1Controller
• QuoteGuestPaymentMethodManagementV1Controller
• QuoteBillingAddressManagementV1Controller
• QuoteGuestBillingAddressManagementV1Controller
• QuoteCouponManagementV1Controller
• QuoteGuestCouponManagementV1Controller
• QuoteCartTotalRepositoryV1Controller
• QuoteGuestCartTotalManagementV1Controller
• QuoteGuestCartTotalRepositoryV1Controller
• QuoteCartTotalManagementV1Controller
• SearchV1Controller
• SalesOrderRepositoryV1Controller
• SalesOrderManagementV1Controller
• SalesOrderAddressRepositoryV1Controller
• SalesOrderItemRepositoryV1Controller
• SalesInvoiceRepositoryV1Controller
• SalesInvoiceManagementV1Controller
• SalesInvoiceCommentRepositoryV1Controller
• SalesRefundInvoiceV1Controller
• SalesCreditmemoManagementV1Controller
• SalesCreditmemoRepositoryV1Controller
• SalesCreditmemoCommentRepositoryV1Controller
• SalesRefundOrderV1Controller
• SalesShipmentRepositoryV1Controller
• SalesShipmentManagementV1Controller
• SalesShipmentCommentRepositoryV1Controller
• SalesShipmentTrackRepositoryV1Controller
• SalesShipOrderV1Controller
• SalesTransactionRepositoryV1Controller
• SalesInvoiceOrderV1Controller
• CheckoutGuestShippingInformationManagementV1Controller
• CheckoutShippingInformationManagementV1Controller
• CheckoutTotalsInformationManagementV1Controller
• CheckoutGuestTotalsInformationManagementV1Controller
• CheckoutGuestPaymentInformationManagementV1Controller
• CheckoutPaymentInformationManagementV1Controller
• BundleProductLinkManagementV1Controller
• BundleProductOptionRepositoryV1Controller
• BundleProductOptionTypeListV1Controller
• BundleProductOptionManagementV1Controller
• CheckoutAgreementsCheckoutAgreementsRepositoryV1Controller
• ConfigurableProductLinkManagementV1Controller
• ConfigurableProductConfigurableProductManagementV1Controller
• ConfigurableProductOptionRepositoryV1Controller
• EbizmartsSagePaySuiteServerManagementV1Controller
• EbizmartsSagePaySuiteGuestServerManagementV1Controller
• EbizmartsSagePaySuiteFormManagementV1Controller
• EbizmartsSagePaySuiteGuestFormManagementV1Controller
• EbizmartsSagePaySuitePayPalManagementV1Controller
• EbizmartsSagePaySuiteGuestPayPalManagementV1Controller
• EbizmartsSagePaySuitePiMerchantV1Controller
• EbizmartsSagePaySuitePiManagementV1Controller
• EbizmartsSagePaySuiteGuestPiManagementV1Controller
• IntegrationAdminTokenServiceV1Controller
• IntegrationCustomerTokenServiceV1Controller
• DownloadableLinkRepositoryV1Controller
• DownloadableSampleRepositoryV1Controller
• GiftMessageCartRepositoryV1Controller
• GiftMessageItemRepositoryV1Controller
• GiftMessageGuestCartRepositoryV1Controller
• GiftMessageGuestItemRepositoryV1Controller
• AnalyticsLinkProviderV1Controller
• SalesRuleRuleRepositoryV1Controller
• SalesRuleCouponRepositoryV1Controller
• SalesRuleCouponManagementV1Controller
• AmazonPaymentAddressManagementV1Controller
• AmazonPaymentOrderInformationManagementV1Controller
• TaxTaxRateRepositoryV1Controller
• TaxTaxRuleRepositoryV1Controller
• TaxTaxClassRepositoryV1Controller
• StawHiveProductV1Controller
• StawHiveCartV1Controller
• StawHiveOrderV1Controller
• StawHiveInvoiceV1Controller
• TemandoShippingRmaRmaShipmentManagementV1Controller

StoreStoreRepositoryV1Controller

Get singleton instance

The singleton instance of the StoreStoreRepositoryV1Controller class can be accessed from the API Client.

$storeStoreRepositoryV1 = $client->getStoreStoreRepositoryV1();

getStoreStoreRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of all stores

function getStoreStoreRepositoryV1GetListGet()

Example Usage

$result = $storeStoreRepositoryV1->getStoreStoreRepositoryV1GetListGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StoreGroupRepositoryV1Controller

Get singleton instance

The singleton instance of the StoreGroupRepositoryV1Controller class can be accessed from the API Client.

$storeGroupRepositoryV1 = $client->getStoreGroupRepositoryV1();

getStoreGroupRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of all groups

function getStoreGroupRepositoryV1GetListGet()

Example Usage

$result = $storeGroupRepositoryV1->getStoreGroupRepositoryV1GetListGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StoreWebsiteRepositoryV1Controller

Get singleton instance

The singleton instance of the StoreWebsiteRepositoryV1Controller class can be accessed from the API Client.

$storeWebsiteRepositoryV1 = $client->getStoreWebsiteRepositoryV1();

getStoreWebsiteRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of all websites

function getStoreWebsiteRepositoryV1GetListGet()

Example Usage

$result = $storeWebsiteRepositoryV1->getStoreWebsiteRepositoryV1GetListGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StoreStoreConfigManagerV1Controller

Get singleton instance

The singleton instance of the StoreStoreConfigManagerV1Controller class can be accessed from the API Client.

$storeStoreConfigManagerV1 = $client->getStoreStoreConfigManagerV1();

getStoreStoreConfigManagerV1GetStoreConfigsGet

Tags: Skips Authentication

TODO: Add a method description

function getStoreStoreConfigManagerV1GetStoreConfigsGet($storeCodes = null)

Parameters

Parameter	Tags	Description
storeCodes	Optional Collection	TODO: Add a parameter description

Example Usage

$storeCodes = array('storeCodes');

$result = $storeStoreConfigManagerV1->getStoreStoreConfigManagerV1GetStoreConfigsGet($storeCodes);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

DirectoryCurrencyInformationAcquirerV1Controller

Get singleton instance

The singleton instance of the DirectoryCurrencyInformationAcquirerV1Controller class can be accessed from the API Client.

$directoryCurrencyInformationAcquirerV1 = $client->getDirectoryCurrencyInformationAcquirerV1();

getDirectoryCurrencyInformationAcquirerV1GetCurrencyInfoGet

Tags: Skips Authentication

Get currency information for the store.

function getDirectoryCurrencyInformationAcquirerV1GetCurrencyInfoGet()

Example Usage

$result = $directoryCurrencyInformationAcquirerV1->getDirectoryCurrencyInformationAcquirerV1GetCurrencyInfoGet();

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

DirectoryCountryInformationAcquirerV1Controller

Get singleton instance

The singleton instance of the DirectoryCountryInformationAcquirerV1Controller class can be accessed from the API Client.

$directoryCountryInformationAcquirerV1 = $client->getDirectoryCountryInformationAcquirerV1();

getDirectoryCountryInformationAcquirerV1GetCountriesInfoGet

Tags: Skips Authentication

Get all countries and regions information for the store.

function getDirectoryCountryInformationAcquirerV1GetCountriesInfoGet()

Example Usage

$result = $directoryCountryInformationAcquirerV1->getDirectoryCountryInformationAcquirerV1GetCountriesInfoGet();

Errors

Error Code	Error Description
0	Unexpected error

getDirectoryCountryInformationAcquirerV1GetCountryInfoGet

Tags: Skips Authentication

Get country and region information for the store.

function getDirectoryCountryInformationAcquirerV1GetCountryInfoGet($countryId)

Parameters

Parameter	Tags	Description
countryId	Required	TODO: Add a parameter description

Example Usage

$countryId = 'countryId';

$result = $directoryCountryInformationAcquirerV1->getDirectoryCountryInformationAcquirerV1GetCountryInfoGet($countryId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

EavAttributeSetRepositoryV1Controller

Get singleton instance

The singleton instance of the EavAttributeSetRepositoryV1Controller class can be accessed from the API Client.

$eavAttributeSetRepositoryV1 = $client->getEavAttributeSetRepositoryV1();

getEavAttributeSetRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of Attribute Sets 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#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getEavAttributeSetRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 155;
$searchCriteriaCurrentPage = 155;

$result = $eavAttributeSetRepositoryV1->getEavAttributeSetRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getEavAttributeSetRepositoryV1GetGet

Tags: Skips Authentication

Retrieve attribute set information based on given ID

function getEavAttributeSetRepositoryV1GetGet($attributeSetId)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 155;

$result = $eavAttributeSetRepositoryV1->getEavAttributeSetRepositoryV1GetGet($attributeSetId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateEavAttributeSetRepositoryV1SavePut

Tags: Skips Authentication

Save attribute set data

function updateEavAttributeSetRepositoryV1SavePut(
        $attributeSetId,
        $eavAttributeSetRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description
eavAttributeSetRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';
$eavAttributeSetRepositoryV1SavePutBody = new EavAttributeSetRepositoryV1SavePutBody();

$result = $eavAttributeSetRepositoryV1->updateEavAttributeSetRepositoryV1SavePut($attributeSetId, $eavAttributeSetRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteEavAttributeSetRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove attribute set by given ID

function deleteEavAttributeSetRepositoryV1DeleteByIdDelete($attributeSetId)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 155;

$result = $eavAttributeSetRepositoryV1->deleteEavAttributeSetRepositoryV1DeleteByIdDelete($attributeSetId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

EavAttributeSetManagementV1Controller

Get singleton instance

The singleton instance of the EavAttributeSetManagementV1Controller class can be accessed from the API Client.

$eavAttributeSetManagementV1 = $client->getEavAttributeSetManagementV1();

createEavAttributeSetManagementV1CreatePost

Tags: Skips Authentication

Create attribute set from data

function createEavAttributeSetManagementV1CreatePost($eavAttributeSetManagementV1CreatePostBody = null)

Parameters

Parameter	Tags	Description
eavAttributeSetManagementV1CreatePostBody	Optional	TODO: Add a parameter description

Example Usage

$eavAttributeSetManagementV1CreatePostBody = new EavAttributeSetManagementV1CreatePostBody();

$result = $eavAttributeSetManagementV1->createEavAttributeSetManagementV1CreatePost($eavAttributeSetManagementV1CreatePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CustomerGroupRepositoryV1Controller

Get singleton instance

The singleton instance of the CustomerGroupRepositoryV1Controller class can be accessed from the API Client.

$customerGroupRepositoryV1 = $client->getCustomerGroupRepositoryV1();

getCustomerGroupRepositoryV1GetByIdGet

Tags: Skips Authentication

Get customer group by group ID.

function getCustomerGroupRepositoryV1GetByIdGet($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 155;

$result = $customerGroupRepositoryV1->getCustomerGroupRepositoryV1GetByIdGet($id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerGroupRepositoryV1SavePut

Tags: Skips Authentication

Save customer group.

function updateCustomerGroupRepositoryV1SavePut(
        $id,
        $customerGroupRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
customerGroupRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$customerGroupRepositoryV1SavePutBody = new CustomerGroupRepositoryV1SavePutBody();

$result = $customerGroupRepositoryV1->updateCustomerGroupRepositoryV1SavePut($id, $customerGroupRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCustomerGroupRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete customer group by ID.

function deleteCustomerGroupRepositoryV1DeleteByIdDelete($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 155;

$result = $customerGroupRepositoryV1->deleteCustomerGroupRepositoryV1DeleteByIdDelete($id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerGroupRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. 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#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getCustomerGroupRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 155;
$searchCriteriaCurrentPage = 155;

$result = $customerGroupRepositoryV1->getCustomerGroupRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createCustomerGroupRepositoryV1SavePost

Tags: Skips Authentication

Save customer group.

function createCustomerGroupRepositoryV1SavePost($customerGroupRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
customerGroupRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$customerGroupRepositoryV1SavePostBody = new CustomerGroupRepositoryV1SavePutBody();

$result = $customerGroupRepositoryV1->createCustomerGroupRepositoryV1SavePost($customerGroupRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerGroupManagementV1Controller

Get singleton instance

The singleton instance of the CustomerGroupManagementV1Controller class can be accessed from the API Client.

$customerGroupManagementV1 = $client->getCustomerGroupManagementV1();

getCustomerGroupManagementV1GetDefaultGroupGet

Tags: Skips Authentication

Get default customer group.

function getCustomerGroupManagementV1GetDefaultGroupGet($storeId)

Parameters

Parameter	Tags	Description
storeId	Required	TODO: Add a parameter description

Example Usage

$storeId = 155;

$result = $customerGroupManagementV1->getCustomerGroupManagementV1GetDefaultGroupGet($storeId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerGroupManagementV1GetDefaultGroupGet1

Tags: Skips Authentication

Get default customer group.

function getCustomerGroupManagementV1GetDefaultGroupGet1($storeId = null)

Parameters

Parameter	Tags	Description
storeId	Optional	TODO: Add a parameter description

Example Usage

$storeId = 155;

$result = $customerGroupManagementV1->getCustomerGroupManagementV1GetDefaultGroupGet1($storeId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerGroupManagementV1IsReadonlyGet

Tags: Skips Authentication

Check if customer group can be deleted.

function getCustomerGroupManagementV1IsReadonlyGet($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 155;

$result = $customerGroupManagementV1->getCustomerGroupManagementV1IsReadonlyGet($id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerCustomerGroupConfigV1Controller

Get singleton instance

The singleton instance of the CustomerCustomerGroupConfigV1Controller class can be accessed from the API Client.

$customerCustomerGroupConfigV1 = $client->getCustomerCustomerGroupConfigV1();

updateCustomerCustomerGroupConfigV1SetDefaultCustomerGroupPut

Tags: Skips Authentication

Set system default customer group.

function updateCustomerCustomerGroupConfigV1SetDefaultCustomerGroupPut($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 155;

$result = $customerCustomerGroupConfigV1->updateCustomerCustomerGroupConfigV1SetDefaultCustomerGroupPut($id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerCustomerMetadataV1Controller

Get singleton instance

The singleton instance of the CustomerCustomerMetadataV1Controller class can be accessed from the API Client.

$customerCustomerMetadataV1 = $client->getCustomerCustomerMetadataV1();

getCustomerCustomerMetadataV1GetAttributeMetadataGet

Tags: Skips Authentication

Retrieve attribute metadata.

function getCustomerCustomerMetadataV1GetAttributeMetadataGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $customerCustomerMetadataV1->getCustomerCustomerMetadataV1GetAttributeMetadataGet($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerCustomerMetadataV1GetAttributesGet

Tags: Skips Authentication

Retrieve all attributes filtered by form code

function getCustomerCustomerMetadataV1GetAttributesGet($formCode)

Parameters

Parameter	Tags	Description
formCode	Required	TODO: Add a parameter description

Example Usage

$formCode = 'formCode';

$result = $customerCustomerMetadataV1->getCustomerCustomerMetadataV1GetAttributesGet($formCode);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerCustomerMetadataV1GetAllAttributesMetadataGet

Tags: Skips Authentication

Get all attribute metadata.

function getCustomerCustomerMetadataV1GetAllAttributesMetadataGet()

Example Usage

$result = $customerCustomerMetadataV1->getCustomerCustomerMetadataV1GetAllAttributesMetadataGet();

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerCustomerMetadataV1GetCustomAttributesMetadataGet

Tags: Skips Authentication

Get custom attributes metadata for the given data interface.

function getCustomerCustomerMetadataV1GetCustomAttributesMetadataGet($dataInterfaceName = null)

Parameters

Parameter	Tags	Description
dataInterfaceName	Optional	TODO: Add a parameter description

Example Usage

$dataInterfaceName = 'dataInterfaceName';

$result = $customerCustomerMetadataV1->getCustomerCustomerMetadataV1GetCustomAttributesMetadataGet($dataInterfaceName);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerAddressMetadataV1Controller

Get singleton instance

The singleton instance of the CustomerAddressMetadataV1Controller class can be accessed from the API Client.

$customerAddressMetadataV1 = $client->getCustomerAddressMetadataV1();

getCustomerAddressMetadataV1GetAttributeMetadataGet

Tags: Skips Authentication

Retrieve attribute metadata.

function getCustomerAddressMetadataV1GetAttributeMetadataGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $customerAddressMetadataV1->getCustomerAddressMetadataV1GetAttributeMetadataGet($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAddressMetadataV1GetAttributesGet

Tags: Skips Authentication

Retrieve all attributes filtered by form code

function getCustomerAddressMetadataV1GetAttributesGet($formCode)

Parameters

Parameter	Tags	Description
formCode	Required	TODO: Add a parameter description

Example Usage

$formCode = 'formCode';

$result = $customerAddressMetadataV1->getCustomerAddressMetadataV1GetAttributesGet($formCode);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAddressMetadataV1GetAllAttributesMetadataGet

Tags: Skips Authentication

Get all attribute metadata.

function getCustomerAddressMetadataV1GetAllAttributesMetadataGet()

Example Usage

$result = $customerAddressMetadataV1->getCustomerAddressMetadataV1GetAllAttributesMetadataGet();

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAddressMetadataV1GetCustomAttributesMetadataGet

Tags: Skips Authentication

Get custom attributes metadata for the given data interface.

function getCustomerAddressMetadataV1GetCustomAttributesMetadataGet($dataInterfaceName = null)

Parameters

Parameter	Tags	Description
dataInterfaceName	Optional	TODO: Add a parameter description

Example Usage

$dataInterfaceName = 'dataInterfaceName';

$result = $customerAddressMetadataV1->getCustomerAddressMetadataV1GetCustomAttributesMetadataGet($dataInterfaceName);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerCustomerRepositoryV1Controller

Get singleton instance

The singleton instance of the CustomerCustomerRepositoryV1Controller class can be accessed from the API Client.

$customerCustomerRepositoryV1 = $client->getCustomerCustomerRepositoryV1();

getCustomerCustomerRepositoryV1GetByIdGet

Tags: Skips Authentication

Get customer by Customer ID.

function getCustomerCustomerRepositoryV1GetByIdGet($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 155;

$result = $customerCustomerRepositoryV1->getCustomerCustomerRepositoryV1GetByIdGet($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerCustomerRepositoryV1SavePut

Tags: Skips Authentication

Create or update a customer.

function updateCustomerCustomerRepositoryV1SavePut(
        $customerId,
        $customerCustomerRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description
customerCustomerRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$customerId = 'customerId';
$customerCustomerRepositoryV1SavePutBody = new CustomerCustomerRepositoryV1SavePutBody();

$result = $customerCustomerRepositoryV1->updateCustomerCustomerRepositoryV1SavePut($customerId, $customerCustomerRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCustomerCustomerRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete customer by Customer ID.

function deleteCustomerCustomerRepositoryV1DeleteByIdDelete($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 155;

$result = $customerCustomerRepositoryV1->deleteCustomerCustomerRepositoryV1DeleteByIdDelete($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerCustomerRepositoryV1GetByIdGet1

Tags: Skips Authentication

Get customer by Customer ID.

function getCustomerCustomerRepositoryV1GetByIdGet1()

Example Usage

$result = $customerCustomerRepositoryV1->getCustomerCustomerRepositoryV1GetByIdGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerCustomerRepositoryV1SavePut1

Tags: Skips Authentication

Create or update a customer.

function updateCustomerCustomerRepositoryV1SavePut1($customerCustomerRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
customerCustomerRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$customerCustomerRepositoryV1SavePutBody = new CustomerCustomerRepositoryV1SavePutBody();

$result = $customerCustomerRepositoryV1->updateCustomerCustomerRepositoryV1SavePut1($customerCustomerRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerCustomerRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve customers which match a specified 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#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getCustomerCustomerRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 155;
$searchCriteriaCurrentPage = 155;

$result = $customerCustomerRepositoryV1->getCustomerCustomerRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerAccountManagementV1Controller

Get singleton instance

The singleton instance of the CustomerAccountManagementV1Controller class can be accessed from the API Client.

$customerAccountManagementV1 = $client->getCustomerAccountManagementV1();

createCustomerAccountManagementV1CreateAccountPost

Tags: Skips Authentication

Create customer account. Perform necessary business operations like sending email.

function createCustomerAccountManagementV1CreateAccountPost($customerAccountManagementV1CreateAccountPostBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1CreateAccountPostBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1CreateAccountPostBody = new CustomerAccountManagementV1CreateAccountPostBody();

$result = $customerAccountManagementV1->createCustomerAccountManagementV1CreateAccountPost($customerAccountManagementV1CreateAccountPostBody);

Errors

Error Code	Error Description
500	Internal Server error
0	Unexpected error

updateCustomerAccountManagementV1ActivateByIdPut

Tags: Skips Authentication

Activate a customer account using a key that was sent in a confirmation email.

function updateCustomerAccountManagementV1ActivateByIdPut($customerAccountManagementV1ActivateByIdPutBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1ActivateByIdPutBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1ActivateByIdPutBody = new CustomerAccountManagementV1ActivateByIdPutBody();

$result = $customerAccountManagementV1->updateCustomerAccountManagementV1ActivateByIdPut($customerAccountManagementV1ActivateByIdPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerAccountManagementV1ActivatePut

Tags: Skips Authentication

Activate a customer account using a key that was sent in a confirmation email.

function updateCustomerAccountManagementV1ActivatePut(
        $email,
        $customerAccountManagementV1ActivatePutBody = null)

Parameters

Parameter	Tags	Description
email	Required	TODO: Add a parameter description
customerAccountManagementV1ActivatePutBody	Optional	TODO: Add a parameter description

Example Usage

$email = 'email';
$customerAccountManagementV1ActivatePutBody = new CustomerAccountManagementV1ActivateByIdPutBody();

$result = $customerAccountManagementV1->updateCustomerAccountManagementV1ActivatePut($email, $customerAccountManagementV1ActivatePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerAccountManagementV1ChangePasswordByIdPut

Tags: Skips Authentication

Change customer password.

function updateCustomerAccountManagementV1ChangePasswordByIdPut($customerAccountManagementV1ChangePasswordByIdPutBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1ChangePasswordByIdPutBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1ChangePasswordByIdPutBody = new CustomerAccountManagementV1ChangePasswordByIdPutBody();

$result = $customerAccountManagementV1->updateCustomerAccountManagementV1ChangePasswordByIdPut($customerAccountManagementV1ChangePasswordByIdPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1ValidateResetPasswordLinkTokenGet

Tags: Skips Authentication

Check if password reset token is valid.

function getCustomerAccountManagementV1ValidateResetPasswordLinkTokenGet(
        $customerId,
        $resetPasswordLinkToken)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description
resetPasswordLinkToken	Required	TODO: Add a parameter description

Example Usage

$customerId = 63;
$resetPasswordLinkToken = 'resetPasswordLinkToken';

$result = $customerAccountManagementV1->getCustomerAccountManagementV1ValidateResetPasswordLinkTokenGet($customerId, $resetPasswordLinkToken);

Errors

Error Code	Error Description
400	400 Bad Request
500	Internal Server error
0	Unexpected error

updateCustomerAccountManagementV1InitiatePasswordResetPut

Tags: Skips Authentication

Send an email to the customer with a password reset link.

function updateCustomerAccountManagementV1InitiatePasswordResetPut($customerAccountManagementV1InitiatePasswordResetPutBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1InitiatePasswordResetPutBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1InitiatePasswordResetPutBody = new CustomerAccountManagementV1InitiatePasswordResetPutBody();

$result = $customerAccountManagementV1->updateCustomerAccountManagementV1InitiatePasswordResetPut($customerAccountManagementV1InitiatePasswordResetPutBody);

Errors

Error Code	Error Description
500	Internal Server error
0	Unexpected error

createCustomerAccountManagementV1ResetPasswordPost

Tags: Skips Authentication

Reset customer password.

function createCustomerAccountManagementV1ResetPasswordPost($customerAccountManagementV1ResetPasswordPostBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1ResetPasswordPostBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1ResetPasswordPostBody = new CustomerAccountManagementV1ResetPasswordPostBody();

$result = $customerAccountManagementV1->createCustomerAccountManagementV1ResetPasswordPost($customerAccountManagementV1ResetPasswordPostBody);

Errors

Error Code	Error Description
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1GetConfirmationStatusGet

Tags: Skips Authentication

Gets the account confirmation status.

function getCustomerAccountManagementV1GetConfirmationStatusGet($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 63;

$result = $customerAccountManagementV1->getCustomerAccountManagementV1GetConfirmationStatusGet($customerId);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createCustomerAccountManagementV1ResendConfirmationPost

Tags: Skips Authentication

Resend confirmation email.

function createCustomerAccountManagementV1ResendConfirmationPost($customerAccountManagementV1ResendConfirmationPostBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1ResendConfirmationPostBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1ResendConfirmationPostBody = new CustomerAccountManagementV1ResendConfirmationPostBody();

$result = $customerAccountManagementV1->createCustomerAccountManagementV1ResendConfirmationPost($customerAccountManagementV1ResendConfirmationPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCustomerAccountManagementV1ValidatePut

Tags: Skips Authentication

Validate customer data.

function updateCustomerAccountManagementV1ValidatePut($customerAccountManagementV1ValidatePutBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1ValidatePutBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1ValidatePutBody = new CustomerAccountManagementV1ValidatePutBody();

$result = $customerAccountManagementV1->updateCustomerAccountManagementV1ValidatePut($customerAccountManagementV1ValidatePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1IsReadonlyGet

Tags: Skips Authentication

Check if customer can be deleted.

function getCustomerAccountManagementV1IsReadonlyGet($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 63;

$result = $customerAccountManagementV1->getCustomerAccountManagementV1IsReadonlyGet($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createCustomerAccountManagementV1IsEmailAvailablePost

Tags: Skips Authentication

Check if given email is associated with a customer account in given website.

function createCustomerAccountManagementV1IsEmailAvailablePost($customerAccountManagementV1IsEmailAvailablePostBody = null)

Parameters

Parameter	Tags	Description
customerAccountManagementV1IsEmailAvailablePostBody	Optional	TODO: Add a parameter description

Example Usage

$customerAccountManagementV1IsEmailAvailablePostBody = new CustomerAccountManagementV1IsEmailAvailablePostBody();

$result = $customerAccountManagementV1->createCustomerAccountManagementV1IsEmailAvailablePost($customerAccountManagementV1IsEmailAvailablePostBody);

Errors

Error Code	Error Description
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1GetDefaultBillingAddressGet

Tags: Skips Authentication

Retrieve default billing address for the given customerId.

function getCustomerAccountManagementV1GetDefaultBillingAddressGet()

Example Usage

$result = $customerAccountManagementV1->getCustomerAccountManagementV1GetDefaultBillingAddressGet();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1GetDefaultBillingAddressGet1

Tags: Skips Authentication

Retrieve default billing address for the given customerId.

function getCustomerAccountManagementV1GetDefaultBillingAddressGet1($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 63;

$result = $customerAccountManagementV1->getCustomerAccountManagementV1GetDefaultBillingAddressGet1($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1GetDefaultShippingAddressGet

Tags: Skips Authentication

Retrieve default shipping address for the given customerId.

function getCustomerAccountManagementV1GetDefaultShippingAddressGet()

Example Usage

$result = $customerAccountManagementV1->getCustomerAccountManagementV1GetDefaultShippingAddressGet();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCustomerAccountManagementV1GetDefaultShippingAddressGet1

Tags: Skips Authentication

Retrieve default shipping address for the given customerId.

function getCustomerAccountManagementV1GetDefaultShippingAddressGet1($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	TODO: Add a parameter description

Example Usage

$customerId = 63;

$result = $customerAccountManagementV1->getCustomerAccountManagementV1GetDefaultShippingAddressGet1($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CustomerAddressRepositoryV1Controller

Get singleton instance

The singleton instance of the CustomerAddressRepositoryV1Controller class can be accessed from the API Client.

$customerAddressRepositoryV1 = $client->getCustomerAddressRepositoryV1();

getCustomerAddressRepositoryV1GetByIdGet

Tags: Skips Authentication

Retrieve customer address.

function getCustomerAddressRepositoryV1GetByIdGet($addressId)

Parameters

Parameter	Tags	Description
addressId	Required	TODO: Add a parameter description

Example Usage

$addressId = 63;

$result = $customerAddressRepositoryV1->getCustomerAddressRepositoryV1GetByIdGet($addressId);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCustomerAddressRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete customer address by ID.

function deleteCustomerAddressRepositoryV1DeleteByIdDelete($addressId)

Parameters

Parameter	Tags	Description
addressId	Required	TODO: Add a parameter description

Example Usage

$addressId = 63;

$result = $customerAddressRepositoryV1->deleteCustomerAddressRepositoryV1DeleteByIdDelete($addressId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CmsPageRepositoryV1Controller

Get singleton instance

The singleton instance of the CmsPageRepositoryV1Controller class can be accessed from the API Client.

$cmsPageRepositoryV1 = $client->getCmsPageRepositoryV1();

getCmsPageRepositoryV1GetByIdGet

Tags: Skips Authentication

Retrieve page.

function getCmsPageRepositoryV1GetByIdGet($pageId)

Parameters

Parameter	Tags	Description
pageId	Required	TODO: Add a parameter description

Example Usage

$pageId = 63;

$result = $cmsPageRepositoryV1->getCmsPageRepositoryV1GetByIdGet($pageId);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCmsPageRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete page by ID.

function deleteCmsPageRepositoryV1DeleteByIdDelete($pageId)

Parameters

Parameter	Tags	Description
pageId	Required	TODO: Add a parameter description

Example Usage

$pageId = 63;

$result = $cmsPageRepositoryV1->deleteCmsPageRepositoryV1DeleteByIdDelete($pageId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCmsPageRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve pages matching the specified criteria.

function getCmsPageRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 63;
$searchCriteriaCurrentPage = 63;

$result = $cmsPageRepositoryV1->getCmsPageRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createCmsPageRepositoryV1SavePost

Tags: Skips Authentication

Save page.

function createCmsPageRepositoryV1SavePost($cmsPageRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cmsPageRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cmsPageRepositoryV1SavePostBody = new CmsPageRepositoryV1SavePostBody();

$result = $cmsPageRepositoryV1->createCmsPageRepositoryV1SavePost($cmsPageRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCmsPageRepositoryV1SavePut

Tags: Skips Authentication

Save page.

function updateCmsPageRepositoryV1SavePut(
        $id,
        $cmsPageRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
cmsPageRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$cmsPageRepositoryV1SavePutBody = new CmsPageRepositoryV1SavePostBody();

$result = $cmsPageRepositoryV1->updateCmsPageRepositoryV1SavePut($id, $cmsPageRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CmsBlockRepositoryV1Controller

Get singleton instance

The singleton instance of the CmsBlockRepositoryV1Controller class can be accessed from the API Client.

$cmsBlockRepositoryV1 = $client->getCmsBlockRepositoryV1();

getCmsBlockRepositoryV1GetByIdGet

Tags: Skips Authentication

Retrieve block.

function getCmsBlockRepositoryV1GetByIdGet($blockId)

Parameters

Parameter	Tags	Description
blockId	Required	TODO: Add a parameter description

Example Usage

$blockId = 63;

$result = $cmsBlockRepositoryV1->getCmsBlockRepositoryV1GetByIdGet($blockId);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCmsBlockRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete block by ID.

function deleteCmsBlockRepositoryV1DeleteByIdDelete($blockId)

Parameters

Parameter	Tags	Description
blockId	Required	TODO: Add a parameter description

Example Usage

$blockId = 63;

$result = $cmsBlockRepositoryV1->deleteCmsBlockRepositoryV1DeleteByIdDelete($blockId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getCmsBlockRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve blocks matching the specified criteria.

function getCmsBlockRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 63;
$searchCriteriaCurrentPage = 63;

$result = $cmsBlockRepositoryV1->getCmsBlockRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createCmsBlockRepositoryV1SavePost

Tags: Skips Authentication

Save block.

function createCmsBlockRepositoryV1SavePost($cmsBlockRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cmsBlockRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cmsBlockRepositoryV1SavePostBody = new CmsBlockRepositoryV1SavePostBody();

$result = $cmsBlockRepositoryV1->createCmsBlockRepositoryV1SavePost($cmsBlockRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateCmsBlockRepositoryV1SavePut

Tags: Skips Authentication

Save block.

function updateCmsBlockRepositoryV1SavePut(
        $id,
        $cmsBlockRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
cmsBlockRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$cmsBlockRepositoryV1SavePutBody = new CmsBlockRepositoryV1SavePostBody();

$result = $cmsBlockRepositoryV1->updateCmsBlockRepositoryV1SavePut($id, $cmsBlockRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CatalogProductRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductRepositoryV1Controller class can be accessed from the API Client.

$catalogProductRepositoryV1 = $client->getCatalogProductRepositoryV1();

getCatalogProductRepositoryV1GetListGet

Tags: Skips Authentication

Get product list

function getCatalogProductRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 105;
$searchCriteriaCurrentPage = 105;

$result = $catalogProductRepositoryV1->getCatalogProductRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogProductRepositoryV1SavePost

Tags: Skips Authentication

Create product

function createCatalogProductRepositoryV1SavePost($catalogProductRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
catalogProductRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogProductRepositoryV1SavePostBody = new CatalogProductRepositoryV1SavePostBody();

$result = $catalogProductRepositoryV1->createCatalogProductRepositoryV1SavePost($catalogProductRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getCatalogProductRepositoryV1GetGet

Tags: Skips Authentication

Get info about product by product SKU

function getCatalogProductRepositoryV1GetGet(
        $sku,
        $editMode = null,
        $storeId = null,
        $forceReload = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
editMode	Optional	TODO: Add a parameter description
storeId	Optional	TODO: Add a parameter description
forceReload	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$editMode = false;
$storeId = 105;
$forceReload = false;

$result = $catalogProductRepositoryV1->getCatalogProductRepositoryV1GetGet($sku, $editMode, $storeId, $forceReload);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogProductRepositoryV1SavePut

Tags: Skips Authentication

Create product

function updateCatalogProductRepositoryV1SavePut(
        $sku,
        $catalogProductRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductRepositoryV1SavePutBody = new CatalogProductRepositoryV1SavePostBody();

$result = $catalogProductRepositoryV1->updateCatalogProductRepositoryV1SavePut($sku, $catalogProductRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

TODO: Add a method description

function deleteCatalogProductRepositoryV1DeleteByIdDelete($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $catalogProductRepositoryV1->deleteCatalogProductRepositoryV1DeleteByIdDelete($sku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeTypesListV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeTypesListV1Controller class can be accessed from the API Client.

$catalogProductAttributeTypesListV1 = $client->getCatalogProductAttributeTypesListV1();

getCatalogProductAttributeTypesListV1GetItemsGet

Tags: Skips Authentication

Retrieve list of product attribute types

function getCatalogProductAttributeTypesListV1GetItemsGet()

Example Usage

$result = $catalogProductAttributeTypesListV1->getCatalogProductAttributeTypesListV1GetItemsGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeRepositoryV1Controller class can be accessed from the API Client.

$catalogProductAttributeRepositoryV1 = $client->getCatalogProductAttributeRepositoryV1();

getCatalogProductAttributeRepositoryV1GetGet

Tags: Skips Authentication

Retrieve specific attribute

function getCatalogProductAttributeRepositoryV1GetGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $catalogProductAttributeRepositoryV1->getCatalogProductAttributeRepositoryV1GetGet($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogProductAttributeRepositoryV1SavePut

Tags: Skips Authentication

Save attribute data

function updateCatalogProductAttributeRepositoryV1SavePut(
        $attributeCode,
        $catalogProductAttributeRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description
catalogProductAttributeRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';
$catalogProductAttributeRepositoryV1SavePutBody = new CatalogProductAttributeRepositoryV1SavePutBody();

$result = $catalogProductAttributeRepositoryV1->updateCatalogProductAttributeRepositoryV1SavePut($attributeCode, $catalogProductAttributeRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductAttributeRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete Attribute by id

function deleteCatalogProductAttributeRepositoryV1DeleteByIdDelete($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $catalogProductAttributeRepositoryV1->deleteCatalogProductAttributeRepositoryV1DeleteByIdDelete($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getCatalogProductAttributeRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve all attributes for entity type

function getCatalogProductAttributeRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 13;
$searchCriteriaCurrentPage = 13;

$result = $catalogProductAttributeRepositoryV1->getCatalogProductAttributeRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogProductAttributeRepositoryV1SavePost

Tags: Skips Authentication

Save attribute data

function createCatalogProductAttributeRepositoryV1SavePost($catalogProductAttributeRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
catalogProductAttributeRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogProductAttributeRepositoryV1SavePostBody = new CatalogProductAttributeRepositoryV1SavePutBody();

$result = $catalogProductAttributeRepositoryV1->createCatalogProductAttributeRepositoryV1SavePost($catalogProductAttributeRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryAttributeRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryAttributeRepositoryV1Controller class can be accessed from the API Client.

$catalogCategoryAttributeRepositoryV1 = $client->getCatalogCategoryAttributeRepositoryV1();

getCatalogCategoryAttributeRepositoryV1GetGet

Tags: Skips Authentication

Retrieve specific attribute

function getCatalogCategoryAttributeRepositoryV1GetGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $catalogCategoryAttributeRepositoryV1->getCatalogCategoryAttributeRepositoryV1GetGet($attributeCode);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getCatalogCategoryAttributeRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve all attributes for entity type

function getCatalogCategoryAttributeRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 13;
$searchCriteriaCurrentPage = 13;

$result = $catalogCategoryAttributeRepositoryV1->getCatalogCategoryAttributeRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryAttributeOptionManagementV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryAttributeOptionManagementV1Controller class can be accessed from the API Client.

$catalogCategoryAttributeOptionManagementV1 = $client->getCatalogCategoryAttributeOptionManagementV1();

getCatalogCategoryAttributeOptionManagementV1GetItemsGet

Tags: Skips Authentication

Retrieve list of attribute options

function getCatalogCategoryAttributeOptionManagementV1GetItemsGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $catalogCategoryAttributeOptionManagementV1->getCatalogCategoryAttributeOptionManagementV1GetItemsGet($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductTypeListV1Controller

Get singleton instance

The singleton instance of the CatalogProductTypeListV1Controller class can be accessed from the API Client.

$catalogProductTypeListV1 = $client->getCatalogProductTypeListV1();

getCatalogProductTypeListV1GetProductTypesGet

Tags: Skips Authentication

Retrieve available product types

function getCatalogProductTypeListV1GetProductTypesGet()

Example Usage

$result = $catalogProductTypeListV1->getCatalogProductTypeListV1GetProductTypesGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogAttributeSetRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogAttributeSetRepositoryV1Controller class can be accessed from the API Client.

$catalogAttributeSetRepositoryV1 = $client->getCatalogAttributeSetRepositoryV1();

getCatalogAttributeSetRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of Attribute Sets

function getCatalogAttributeSetRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 13;
$searchCriteriaCurrentPage = 13;

$result = $catalogAttributeSetRepositoryV1->getCatalogAttributeSetRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getCatalogAttributeSetRepositoryV1GetGet

Tags: Skips Authentication

Retrieve attribute set information based on given ID

function getCatalogAttributeSetRepositoryV1GetGet($attributeSetId)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 13;

$result = $catalogAttributeSetRepositoryV1->getCatalogAttributeSetRepositoryV1GetGet($attributeSetId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogAttributeSetRepositoryV1SavePut

Tags: Skips Authentication

Save attribute set data

function updateCatalogAttributeSetRepositoryV1SavePut(
        $attributeSetId,
        $catalogAttributeSetRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description
catalogAttributeSetRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';
$catalogAttributeSetRepositoryV1SavePutBody = new CatalogAttributeSetRepositoryV1SavePutBody();

$result = $catalogAttributeSetRepositoryV1->updateCatalogAttributeSetRepositoryV1SavePut($attributeSetId, $catalogAttributeSetRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteCatalogAttributeSetRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove attribute set by given ID

function deleteCatalogAttributeSetRepositoryV1DeleteByIdDelete($attributeSetId)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 13;

$result = $catalogAttributeSetRepositoryV1->deleteCatalogAttributeSetRepositoryV1DeleteByIdDelete($attributeSetId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogAttributeSetManagementV1Controller

Get singleton instance

The singleton instance of the CatalogAttributeSetManagementV1Controller class can be accessed from the API Client.

$catalogAttributeSetManagementV1 = $client->getCatalogAttributeSetManagementV1();

createCatalogAttributeSetManagementV1CreatePost

Tags: Skips Authentication

Create attribute set from data

function createCatalogAttributeSetManagementV1CreatePost($catalogAttributeSetManagementV1CreatePostBody = null)

Parameters

Parameter	Tags	Description
catalogAttributeSetManagementV1CreatePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogAttributeSetManagementV1CreatePostBody = new CatalogAttributeSetManagementV1CreatePostBody();

$result = $catalogAttributeSetManagementV1->createCatalogAttributeSetManagementV1CreatePost($catalogAttributeSetManagementV1CreatePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeManagementV1Controller class can be accessed from the API Client.

$catalogProductAttributeManagementV1 = $client->getCatalogProductAttributeManagementV1();

getCatalogProductAttributeManagementV1GetAttributesGet

Tags: Skips Authentication

Retrieve related attributes based on given attribute set ID

function getCatalogProductAttributeManagementV1GetAttributesGet($attributeSetId)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';

$result = $catalogProductAttributeManagementV1->getCatalogProductAttributeManagementV1GetAttributesGet($attributeSetId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogProductAttributeManagementV1AssignPost

Tags: Skips Authentication

Assign attribute to attribute set

function createCatalogProductAttributeManagementV1AssignPost($catalogProductAttributeManagementV1AssignPostBody = null)

Parameters

Parameter	Tags	Description
catalogProductAttributeManagementV1AssignPostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogProductAttributeManagementV1AssignPostBody = new CatalogProductAttributeManagementV1AssignPostBody();

$result = $catalogProductAttributeManagementV1->createCatalogProductAttributeManagementV1AssignPost($catalogProductAttributeManagementV1AssignPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductAttributeManagementV1UnassignDelete

Tags: Skips Authentication

Remove attribute from attribute set

function deleteCatalogProductAttributeManagementV1UnassignDelete(
        $attributeSetId,
        $attributeCode)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';
$attributeCode = 'attributeCode';

$result = $catalogProductAttributeManagementV1->deleteCatalogProductAttributeManagementV1UnassignDelete($attributeSetId, $attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeGroupRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeGroupRepositoryV1Controller class can be accessed from the API Client.

$catalogProductAttributeGroupRepositoryV1 = $client->getCatalogProductAttributeGroupRepositoryV1();

getCatalogProductAttributeGroupRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve list of attribute groups

function getCatalogProductAttributeGroupRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 13;
$searchCriteriaCurrentPage = 13;

$result = $catalogProductAttributeGroupRepositoryV1->getCatalogProductAttributeGroupRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogProductAttributeGroupRepositoryV1SavePost

Tags: Skips Authentication

Save attribute group

function createCatalogProductAttributeGroupRepositoryV1SavePost($catalogProductAttributeGroupRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
catalogProductAttributeGroupRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogProductAttributeGroupRepositoryV1SavePostBody = new CatalogProductAttributeGroupRepositoryV1SavePostBody();

$result = $catalogProductAttributeGroupRepositoryV1->createCatalogProductAttributeGroupRepositoryV1SavePost($catalogProductAttributeGroupRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateCatalogProductAttributeGroupRepositoryV1SavePut

Tags: Skips Authentication

Save attribute group

function updateCatalogProductAttributeGroupRepositoryV1SavePut(
        $attributeSetId,
        $catalogProductAttributeGroupRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
attributeSetId	Required	TODO: Add a parameter description
catalogProductAttributeGroupRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';
$catalogProductAttributeGroupRepositoryV1SavePutBody = new CatalogProductAttributeGroupRepositoryV1SavePostBody();

$result = $catalogProductAttributeGroupRepositoryV1->updateCatalogProductAttributeGroupRepositoryV1SavePut($attributeSetId, $catalogProductAttributeGroupRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductAttributeGroupRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove attribute group by id

function deleteCatalogProductAttributeGroupRepositoryV1DeleteByIdDelete($groupId)

Parameters

Parameter	Tags	Description
groupId	Required	TODO: Add a parameter description

Example Usage

$groupId = 13;

$result = $catalogProductAttributeGroupRepositoryV1->deleteCatalogProductAttributeGroupRepositoryV1DeleteByIdDelete($groupId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeOptionManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeOptionManagementV1Controller class can be accessed from the API Client.

$catalogProductAttributeOptionManagementV1 = $client->getCatalogProductAttributeOptionManagementV1();

getCatalogProductAttributeOptionManagementV1GetItemsGet

Tags: Skips Authentication

Retrieve list of attribute options

function getCatalogProductAttributeOptionManagementV1GetItemsGet($attributeCode)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';

$result = $catalogProductAttributeOptionManagementV1->getCatalogProductAttributeOptionManagementV1GetItemsGet($attributeCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogProductAttributeOptionManagementV1AddPost

Tags: Skips Authentication

Add option to attribute

function createCatalogProductAttributeOptionManagementV1AddPost(
        $attributeCode,
        $catalogProductAttributeOptionManagementV1AddPostBody = null)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description
catalogProductAttributeOptionManagementV1AddPostBody	Optional	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';
$catalogProductAttributeOptionManagementV1AddPostBody = new CatalogProductAttributeOptionManagementV1AddPostBody();

$result = $catalogProductAttributeOptionManagementV1->createCatalogProductAttributeOptionManagementV1AddPost($attributeCode, $catalogProductAttributeOptionManagementV1AddPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductAttributeOptionManagementV1DeleteDelete

Tags: Skips Authentication

Delete option from attribute

function deleteCatalogProductAttributeOptionManagementV1DeleteDelete(
        $attributeCode,
        $optionId)

Parameters

Parameter	Tags	Description
attributeCode	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description

Example Usage

$attributeCode = 'attributeCode';
$optionId = 'optionId';

$result = $catalogProductAttributeOptionManagementV1->deleteCatalogProductAttributeOptionManagementV1DeleteDelete($attributeCode, $optionId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductMediaAttributeManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductMediaAttributeManagementV1Controller class can be accessed from the API Client.

$catalogProductMediaAttributeManagementV1 = $client->getCatalogProductMediaAttributeManagementV1();

getCatalogProductMediaAttributeManagementV1GetListGet

Tags: Skips Authentication

Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.

function getCatalogProductMediaAttributeManagementV1GetListGet($attributeSetName)

Parameters

Parameter	Tags	Description
attributeSetName	Required	TODO: Add a parameter description

Example Usage

$attributeSetName = 'attributeSetName';

$result = $catalogProductMediaAttributeManagementV1->getCatalogProductMediaAttributeManagementV1GetListGet($attributeSetName);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductAttributeMediaGalleryManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductAttributeMediaGalleryManagementV1Controller class can be accessed from the API Client.

$catalogProductAttributeMediaGalleryManagementV1 = $client->getCatalogProductAttributeMediaGalleryManagementV1();

getCatalogProductAttributeMediaGalleryManagementV1GetGet

Tags: Skips Authentication

Return information about gallery entry

function getCatalogProductAttributeMediaGalleryManagementV1GetGet(
        $sku,
        $entryId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
entryId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$entryId = 177;

$result = $catalogProductAttributeMediaGalleryManagementV1->getCatalogProductAttributeMediaGalleryManagementV1GetGet($sku, $entryId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogProductAttributeMediaGalleryManagementV1UpdatePut

Tags: Skips Authentication

Update gallery entry

function updateCatalogProductAttributeMediaGalleryManagementV1UpdatePut(
        $sku,
        $entryId,
        $catalogProductAttributeMediaGalleryManagementV1UpdatePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
entryId	Required	TODO: Add a parameter description
catalogProductAttributeMediaGalleryManagementV1UpdatePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$entryId = 'entryId';
$catalogProductAttributeMediaGalleryManagementV1UpdatePutBody = new CatalogProductAttributeMediaGalleryManagementV1UpdatePutBody();

$result = $catalogProductAttributeMediaGalleryManagementV1->updateCatalogProductAttributeMediaGalleryManagementV1UpdatePut($sku, $entryId, $catalogProductAttributeMediaGalleryManagementV1UpdatePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductAttributeMediaGalleryManagementV1RemoveDelete

Tags: Skips Authentication

Remove gallery entry

function deleteCatalogProductAttributeMediaGalleryManagementV1RemoveDelete(
        $sku,
        $entryId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
entryId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$entryId = 177;

$result = $catalogProductAttributeMediaGalleryManagementV1->deleteCatalogProductAttributeMediaGalleryManagementV1RemoveDelete($sku, $entryId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getCatalogProductAttributeMediaGalleryManagementV1GetListGet

Tags: Skips Authentication

Retrieve the list of gallery entries associated with given product

function getCatalogProductAttributeMediaGalleryManagementV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $catalogProductAttributeMediaGalleryManagementV1->getCatalogProductAttributeMediaGalleryManagementV1GetListGet($sku);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogProductAttributeMediaGalleryManagementV1CreatePost

Tags: Skips Authentication

Create new gallery entry

function createCatalogProductAttributeMediaGalleryManagementV1CreatePost(
        $sku,
        $catalogProductAttributeMediaGalleryManagementV1CreatePostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductAttributeMediaGalleryManagementV1CreatePostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductAttributeMediaGalleryManagementV1CreatePostBody = new CatalogProductAttributeMediaGalleryManagementV1UpdatePutBody();

$result = $catalogProductAttributeMediaGalleryManagementV1->createCatalogProductAttributeMediaGalleryManagementV1CreatePost($sku, $catalogProductAttributeMediaGalleryManagementV1CreatePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductTierPriceManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductTierPriceManagementV1Controller class can be accessed from the API Client.

$catalogProductTierPriceManagementV1 = $client->getCatalogProductTierPriceManagementV1();

getCatalogProductTierPriceManagementV1GetListGet

Tags: Skips Authentication

Get tier price of product

function getCatalogProductTierPriceManagementV1GetListGet(
        $sku,
        $customerGroupId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
customerGroupId	Required	'all' can be used to specify 'ALL GROUPS'

Example Usage

$sku = 'sku';
$customerGroupId = 'customerGroupId';

$result = $catalogProductTierPriceManagementV1->getCatalogProductTierPriceManagementV1GetListGet($sku, $customerGroupId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogProductTierPriceManagementV1AddPost

Tags: Skips Authentication

Create tier price for product

function createCatalogProductTierPriceManagementV1AddPost(
        $sku,
        $customerGroupId,
        $price,
        $qty)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
customerGroupId	Required	'all' can be used to specify 'ALL GROUPS'
price	Required	TODO: Add a parameter description
qty	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$customerGroupId = 'customerGroupId';
$price = 177.345554745917;
$qty = 177.345554745917;

$result = $catalogProductTierPriceManagementV1->createCatalogProductTierPriceManagementV1AddPost($sku, $customerGroupId, $price, $qty);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductTierPriceManagementV1RemoveDelete

Tags: Skips Authentication

Remove tier price from product

function deleteCatalogProductTierPriceManagementV1RemoveDelete(
        $sku,
        $customerGroupId,
        $qty)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
customerGroupId	Required	'all' can be used to specify 'ALL GROUPS'
qty	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$customerGroupId = 'customerGroupId';
$qty = 177.345554745917;

$result = $catalogProductTierPriceManagementV1->deleteCatalogProductTierPriceManagementV1RemoveDelete($sku, $customerGroupId, $qty);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogTierPriceStorageV1Controller

Get singleton instance

The singleton instance of the CatalogTierPriceStorageV1Controller class can be accessed from the API Client.

$catalogTierPriceStorageV1 = $client->getCatalogTierPriceStorageV1();

createCatalogTierPriceStorageV1GetPost

Tags: Skips Authentication

Return product prices. In case of at least one of skus is not found exception will be thrown.

function createCatalogTierPriceStorageV1GetPost($catalogTierPriceStorageV1GetPostBody = null)

Parameters

Parameter	Tags	Description
catalogTierPriceStorageV1GetPostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogTierPriceStorageV1GetPostBody = new CatalogTierPriceStorageV1GetPostBody();

$result = $catalogTierPriceStorageV1->createCatalogTierPriceStorageV1GetPost($catalogTierPriceStorageV1GetPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogTierPriceStorageV1ReplacePut

Tags: Skips Authentication

Remove existing tier prices and replace them with the new ones. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from replace list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function updateCatalogTierPriceStorageV1ReplacePut($catalogTierPriceStorageV1ReplacePutBody = null)

Parameters

Parameter	Tags	Description
catalogTierPriceStorageV1ReplacePutBody	Optional	TODO: Add a parameter description

Example Usage

$catalogTierPriceStorageV1ReplacePutBody = new CatalogTierPriceStorageV1ReplacePutBody();

$result = $catalogTierPriceStorageV1->updateCatalogTierPriceStorageV1ReplacePut($catalogTierPriceStorageV1ReplacePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogTierPriceStorageV1UpdatePost

Tags: Skips Authentication

Add or update product prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function createCatalogTierPriceStorageV1UpdatePost($catalogTierPriceStorageV1UpdatePostBody = null)

Parameters

Parameter	Tags	Description
catalogTierPriceStorageV1UpdatePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogTierPriceStorageV1UpdatePostBody = new CatalogTierPriceStorageV1ReplacePutBody();

$result = $catalogTierPriceStorageV1->createCatalogTierPriceStorageV1UpdatePost($catalogTierPriceStorageV1UpdatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogTierPriceStorageV1DeletePost

Tags: Skips Authentication

Delete product tier prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function createCatalogTierPriceStorageV1DeletePost($catalogTierPriceStorageV1DeletePostBody = null)

Parameters

Parameter	Tags	Description
catalogTierPriceStorageV1DeletePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogTierPriceStorageV1DeletePostBody = new CatalogTierPriceStorageV1ReplacePutBody();

$result = $catalogTierPriceStorageV1->createCatalogTierPriceStorageV1DeletePost($catalogTierPriceStorageV1DeletePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogBasePriceStorageV1Controller

Get singleton instance

The singleton instance of the CatalogBasePriceStorageV1Controller class can be accessed from the API Client.

$catalogBasePriceStorageV1 = $client->getCatalogBasePriceStorageV1();

createCatalogBasePriceStorageV1GetPost

Tags: Skips Authentication

Return product prices. In case of at least one of skus is not found exception will be thrown.

function createCatalogBasePriceStorageV1GetPost($catalogBasePriceStorageV1GetPostBody = null)

Parameters

Parameter	Tags	Description
catalogBasePriceStorageV1GetPostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogBasePriceStorageV1GetPostBody = new CatalogBasePriceStorageV1GetPostBody();

$result = $catalogBasePriceStorageV1->createCatalogBasePriceStorageV1GetPost($catalogBasePriceStorageV1GetPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogBasePriceStorageV1UpdatePost

Tags: Skips Authentication

Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid price, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function createCatalogBasePriceStorageV1UpdatePost($catalogBasePriceStorageV1UpdatePostBody = null)

Parameters

Parameter	Tags	Description
catalogBasePriceStorageV1UpdatePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogBasePriceStorageV1UpdatePostBody = new CatalogBasePriceStorageV1UpdatePostBody();

$result = $catalogBasePriceStorageV1->createCatalogBasePriceStorageV1UpdatePost($catalogBasePriceStorageV1UpdatePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCostStorageV1Controller

Get singleton instance

The singleton instance of the CatalogCostStorageV1Controller class can be accessed from the API Client.

$catalogCostStorageV1 = $client->getCatalogCostStorageV1();

createCatalogCostStorageV1GetPost

Tags: Skips Authentication

Return product prices. In case of at least one of skus is not found exception will be thrown.

function createCatalogCostStorageV1GetPost($catalogCostStorageV1GetPostBody = null)

Parameters

Parameter	Tags	Description
catalogCostStorageV1GetPostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogCostStorageV1GetPostBody = new CatalogCostStorageV1GetPostBody();

$result = $catalogCostStorageV1->createCatalogCostStorageV1GetPost($catalogCostStorageV1GetPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogCostStorageV1UpdatePost

Tags: Skips Authentication

Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid cost, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function createCatalogCostStorageV1UpdatePost($catalogCostStorageV1UpdatePostBody = null)

Parameters

Parameter	Tags	Description
catalogCostStorageV1UpdatePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogCostStorageV1UpdatePostBody = new CatalogCostStorageV1UpdatePostBody();

$result = $catalogCostStorageV1->createCatalogCostStorageV1UpdatePost($catalogCostStorageV1UpdatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogCostStorageV1DeletePost

Tags: Skips Authentication

Delete product cost. In case of at least one of skus is not found exception will be thrown. If error occurred during the delete exception will be thrown.

function createCatalogCostStorageV1DeletePost($catalogCostStorageV1DeletePostBody = null)

Parameters

Parameter	Tags	Description
catalogCostStorageV1DeletePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogCostStorageV1DeletePostBody = new CatalogCostStorageV1GetPostBody();

$result = $catalogCostStorageV1->createCatalogCostStorageV1DeletePost($catalogCostStorageV1DeletePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogSpecialPriceStorageV1Controller

Get singleton instance

The singleton instance of the CatalogSpecialPriceStorageV1Controller class can be accessed from the API Client.

$catalogSpecialPriceStorageV1 = $client->getCatalogSpecialPriceStorageV1();

createCatalogSpecialPriceStorageV1GetPost

Tags: Skips Authentication

Return product's special price. In case of at least one of skus is not found exception will be thrown.

function createCatalogSpecialPriceStorageV1GetPost($catalogSpecialPriceStorageV1GetPostBody = null)

Parameters

Parameter	Tags	Description
catalogSpecialPriceStorageV1GetPostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogSpecialPriceStorageV1GetPostBody = new CatalogSpecialPriceStorageV1GetPostBody();

$result = $catalogSpecialPriceStorageV1->createCatalogSpecialPriceStorageV1GetPost($catalogSpecialPriceStorageV1GetPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogSpecialPriceStorageV1UpdatePost

Tags: Skips Authentication

Add or update product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

function createCatalogSpecialPriceStorageV1UpdatePost($catalogSpecialPriceStorageV1UpdatePostBody = null)

Parameters

Parameter	Tags	Description
catalogSpecialPriceStorageV1UpdatePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogSpecialPriceStorageV1UpdatePostBody = new CatalogSpecialPriceStorageV1UpdatePostBody();

$result = $catalogSpecialPriceStorageV1->createCatalogSpecialPriceStorageV1UpdatePost($catalogSpecialPriceStorageV1UpdatePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogSpecialPriceStorageV1DeletePost

Tags: Skips Authentication

Delete product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the delete exception will be thrown.

function createCatalogSpecialPriceStorageV1DeletePost($catalogSpecialPriceStorageV1DeletePostBody = null)

Parameters

Parameter	Tags	Description
catalogSpecialPriceStorageV1DeletePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogSpecialPriceStorageV1DeletePostBody = new CatalogSpecialPriceStorageV1UpdatePostBody();

$result = $catalogSpecialPriceStorageV1->createCatalogSpecialPriceStorageV1DeletePost($catalogSpecialPriceStorageV1DeletePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryRepositoryV1Controller class can be accessed from the API Client.

$catalogCategoryRepositoryV1 = $client->getCatalogCategoryRepositoryV1();

getCatalogCategoryRepositoryV1GetGet

Tags: Skips Authentication

Get info about category by category id

function getCatalogCategoryRepositoryV1GetGet(
        $categoryId,
        $storeId = null)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description
storeId	Optional	TODO: Add a parameter description

Example Usage

$categoryId = 219;
$storeId = 219;

$result = $catalogCategoryRepositoryV1->getCatalogCategoryRepositoryV1GetGet($categoryId, $storeId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogCategoryRepositoryV1DeleteByIdentifierDelete

Tags: Skips Authentication

Delete category by identifier

function deleteCatalogCategoryRepositoryV1DeleteByIdentifierDelete($categoryId)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description

Example Usage

$categoryId = 219;

$result = $catalogCategoryRepositoryV1->deleteCatalogCategoryRepositoryV1DeleteByIdentifierDelete($categoryId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogCategoryRepositoryV1SavePost

Tags: Skips Authentication

Create category service

function createCatalogCategoryRepositoryV1SavePost($catalogCategoryRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
catalogCategoryRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogCategoryRepositoryV1SavePostBody = new CatalogCategoryRepositoryV1SavePostBody();

$result = $catalogCategoryRepositoryV1->createCatalogCategoryRepositoryV1SavePost($catalogCategoryRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogCategoryRepositoryV1SavePut

Tags: Skips Authentication

Create category service

function updateCatalogCategoryRepositoryV1SavePut(
        $id,
        $catalogCategoryRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
catalogCategoryRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$catalogCategoryRepositoryV1SavePutBody = new CatalogCategoryRepositoryV1SavePostBody();

$result = $catalogCategoryRepositoryV1->updateCatalogCategoryRepositoryV1SavePut($id, $catalogCategoryRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryManagementV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryManagementV1Controller class can be accessed from the API Client.

$catalogCategoryManagementV1 = $client->getCatalogCategoryManagementV1();

getCatalogCategoryManagementV1GetTreeGet

Tags: Skips Authentication

Retrieve list of categories

function getCatalogCategoryManagementV1GetTreeGet(
        $rootCategoryId = null,
        $depth = null)

Parameters

Parameter	Tags	Description
rootCategoryId	Optional	TODO: Add a parameter description
depth	Optional	TODO: Add a parameter description

Example Usage

$rootCategoryId = 219;
$depth = 219;

$result = $catalogCategoryManagementV1->getCatalogCategoryManagementV1GetTreeGet($rootCategoryId, $depth);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogCategoryManagementV1MovePut

Tags: Skips Authentication

Move category

function updateCatalogCategoryManagementV1MovePut(
        $categoryId,
        $catalogCategoryManagementV1MovePutBody = null)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description
catalogCategoryManagementV1MovePutBody	Optional	TODO: Add a parameter description

Example Usage

$categoryId = 219;
$catalogCategoryManagementV1MovePutBody = new CatalogCategoryManagementV1MovePutBody();

$result = $catalogCategoryManagementV1->updateCatalogCategoryManagementV1MovePut($categoryId, $catalogCategoryManagementV1MovePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

CatalogCategoryListV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryListV1Controller class can be accessed from the API Client.

$catalogCategoryListV1 = $client->getCatalogCategoryListV1();

getCatalogCategoryListV1GetListGet

Tags: Skips Authentication

Get category list

function getCatalogCategoryListV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 219;
$searchCriteriaCurrentPage = 219;

$result = $catalogCategoryListV1->getCatalogCategoryListV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductCustomOptionTypeListV1Controller

Get singleton instance

The singleton instance of the CatalogProductCustomOptionTypeListV1Controller class can be accessed from the API Client.

$catalogProductCustomOptionTypeListV1 = $client->getCatalogProductCustomOptionTypeListV1();

getCatalogProductCustomOptionTypeListV1GetItemsGet

Tags: Skips Authentication

Get custom option types

function getCatalogProductCustomOptionTypeListV1GetItemsGet()

Example Usage

$result = $catalogProductCustomOptionTypeListV1->getCatalogProductCustomOptionTypeListV1GetItemsGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductCustomOptionRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductCustomOptionRepositoryV1Controller class can be accessed from the API Client.

$catalogProductCustomOptionRepositoryV1 = $client->getCatalogProductCustomOptionRepositoryV1();

getCatalogProductCustomOptionRepositoryV1GetListGet

Tags: Skips Authentication

Get the list of custom options for a specific product

function getCatalogProductCustomOptionRepositoryV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $catalogProductCustomOptionRepositoryV1->getCatalogProductCustomOptionRepositoryV1GetListGet($sku);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getCatalogProductCustomOptionRepositoryV1GetGet

Tags: Skips Authentication

Get custom option for a specific product

function getCatalogProductCustomOptionRepositoryV1GetGet(
        $sku,
        $optionId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 219;

$result = $catalogProductCustomOptionRepositoryV1->getCatalogProductCustomOptionRepositoryV1GetGet($sku, $optionId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete

Tags: Skips Authentication

TODO: Add a method description

function deleteCatalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete(
        $sku,
        $optionId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 219;

$result = $catalogProductCustomOptionRepositoryV1->deleteCatalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete($sku, $optionId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogProductCustomOptionRepositoryV1SavePost

Tags: Skips Authentication

Save Custom Option

function createCatalogProductCustomOptionRepositoryV1SavePost($catalogProductCustomOptionRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
catalogProductCustomOptionRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$catalogProductCustomOptionRepositoryV1SavePostBody = new CatalogProductCustomOptionRepositoryV1SavePostBody();

$result = $catalogProductCustomOptionRepositoryV1->createCatalogProductCustomOptionRepositoryV1SavePost($catalogProductCustomOptionRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateCatalogProductCustomOptionRepositoryV1SavePut

Tags: Skips Authentication

Save Custom Option

function updateCatalogProductCustomOptionRepositoryV1SavePut(
        $optionId,
        $catalogProductCustomOptionRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
optionId	Required	TODO: Add a parameter description
catalogProductCustomOptionRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$optionId = 'optionId';
$catalogProductCustomOptionRepositoryV1SavePutBody = new CatalogProductCustomOptionRepositoryV1SavePostBody();

$result = $catalogProductCustomOptionRepositoryV1->updateCatalogProductCustomOptionRepositoryV1SavePut($optionId, $catalogProductCustomOptionRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductLinkTypeListV1Controller

Get singleton instance

The singleton instance of the CatalogProductLinkTypeListV1Controller class can be accessed from the API Client.

$catalogProductLinkTypeListV1 = $client->getCatalogProductLinkTypeListV1();

getCatalogProductLinkTypeListV1GetItemsGet

Tags: Skips Authentication

Retrieve information about available product link types

function getCatalogProductLinkTypeListV1GetItemsGet()

Example Usage

$result = $catalogProductLinkTypeListV1->getCatalogProductLinkTypeListV1GetItemsGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getCatalogProductLinkTypeListV1GetItemAttributesGet

Tags: Skips Authentication

Provide a list of the product link type attributes

function getCatalogProductLinkTypeListV1GetItemAttributesGet($type)

Parameters

Parameter	Tags	Description
type	Required	TODO: Add a parameter description

Example Usage

$type = 'type';

$result = $catalogProductLinkTypeListV1->getCatalogProductLinkTypeListV1GetItemAttributesGet($type);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductLinkManagementV1Controller

Get singleton instance

The singleton instance of the CatalogProductLinkManagementV1Controller class can be accessed from the API Client.

$catalogProductLinkManagementV1 = $client->getCatalogProductLinkManagementV1();

getCatalogProductLinkManagementV1GetLinkedItemsByTypeGet

Tags: Skips Authentication

Provide the list of links for a specific product

function getCatalogProductLinkManagementV1GetLinkedItemsByTypeGet(
        $sku,
        $type)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
type	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$type = 'type';

$result = $catalogProductLinkManagementV1->getCatalogProductLinkManagementV1GetLinkedItemsByTypeGet($sku, $type);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCatalogProductLinkManagementV1SetProductLinksPost

Tags: Skips Authentication

Assign a product link to another product

function createCatalogProductLinkManagementV1SetProductLinksPost(
        $sku,
        $catalogProductLinkManagementV1SetProductLinksPostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductLinkManagementV1SetProductLinksPostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductLinkManagementV1SetProductLinksPostBody = new CatalogProductLinkManagementV1SetProductLinksPostBody();

$result = $catalogProductLinkManagementV1->createCatalogProductLinkManagementV1SetProductLinksPost($sku, $catalogProductLinkManagementV1SetProductLinksPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductLinkRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductLinkRepositoryV1Controller class can be accessed from the API Client.

$catalogProductLinkRepositoryV1 = $client->getCatalogProductLinkRepositoryV1();

updateCatalogProductLinkRepositoryV1SavePut

Tags: Skips Authentication

Save product link

function updateCatalogProductLinkRepositoryV1SavePut(
        $sku,
        $catalogProductLinkRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductLinkRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductLinkRepositoryV1SavePutBody = new CatalogProductLinkRepositoryV1SavePutBody();

$result = $catalogProductLinkRepositoryV1->updateCatalogProductLinkRepositoryV1SavePut($sku, $catalogProductLinkRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductLinkRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

TODO: Add a method description

function deleteCatalogProductLinkRepositoryV1DeleteByIdDelete(
        $sku,
        $type,
        $linkedProductSku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
type	Required	TODO: Add a parameter description
linkedProductSku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$type = 'type';
$linkedProductSku = 'linkedProductSku';

$result = $catalogProductLinkRepositoryV1->deleteCatalogProductLinkRepositoryV1DeleteByIdDelete($sku, $type, $linkedProductSku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryLinkManagementV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryLinkManagementV1Controller class can be accessed from the API Client.

$catalogCategoryLinkManagementV1 = $client->getCatalogCategoryLinkManagementV1();

getCatalogCategoryLinkManagementV1GetAssignedProductsGet

Tags: Skips Authentication

Get products assigned to category

function getCatalogCategoryLinkManagementV1GetAssignedProductsGet($categoryId)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description

Example Usage

$categoryId = 127;

$result = $catalogCategoryLinkManagementV1->getCatalogCategoryLinkManagementV1GetAssignedProductsGet($categoryId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogCategoryLinkRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogCategoryLinkRepositoryV1Controller class can be accessed from the API Client.

$catalogCategoryLinkRepositoryV1 = $client->getCatalogCategoryLinkRepositoryV1();

updateCatalogCategoryLinkRepositoryV1SavePut

Tags: Skips Authentication

Assign a product to the required category

function updateCatalogCategoryLinkRepositoryV1SavePut(
        $categoryId,
        $catalogCategoryLinkRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description
catalogCategoryLinkRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$categoryId = 'categoryId';
$catalogCategoryLinkRepositoryV1SavePutBody = new CatalogCategoryLinkRepositoryV1SavePutBody();

$result = $catalogCategoryLinkRepositoryV1->updateCatalogCategoryLinkRepositoryV1SavePut($categoryId, $catalogCategoryLinkRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogCategoryLinkRepositoryV1SavePost

Tags: Skips Authentication

Assign a product to the required category

function createCatalogCategoryLinkRepositoryV1SavePost(
        $categoryId,
        $catalogCategoryLinkRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description
catalogCategoryLinkRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$categoryId = 'categoryId';
$catalogCategoryLinkRepositoryV1SavePostBody = new CatalogCategoryLinkRepositoryV1SavePutBody();

$result = $catalogCategoryLinkRepositoryV1->createCatalogCategoryLinkRepositoryV1SavePost($categoryId, $catalogCategoryLinkRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogCategoryLinkRepositoryV1DeleteByIdsDelete

Tags: Skips Authentication

Remove the product assignment from the category by category id and sku

function deleteCatalogCategoryLinkRepositoryV1DeleteByIdsDelete(
        $categoryId,
        $sku)

Parameters

Parameter	Tags	Description
categoryId	Required	TODO: Add a parameter description
sku	Required	TODO: Add a parameter description

Example Usage

$categoryId = 'categoryId';
$sku = 'sku';

$result = $catalogCategoryLinkRepositoryV1->deleteCatalogCategoryLinkRepositoryV1DeleteByIdsDelete($categoryId, $sku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductWebsiteLinkRepositoryV1Controller

Get singleton instance

The singleton instance of the CatalogProductWebsiteLinkRepositoryV1Controller class can be accessed from the API Client.

$catalogProductWebsiteLinkRepositoryV1 = $client->getCatalogProductWebsiteLinkRepositoryV1();

updateCatalogProductWebsiteLinkRepositoryV1SavePut

Tags: Skips Authentication

Assign a product to the website

function updateCatalogProductWebsiteLinkRepositoryV1SavePut(
        $sku,
        $catalogProductWebsiteLinkRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductWebsiteLinkRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductWebsiteLinkRepositoryV1SavePutBody = new CatalogProductWebsiteLinkRepositoryV1SavePutBody();

$result = $catalogProductWebsiteLinkRepositoryV1->updateCatalogProductWebsiteLinkRepositoryV1SavePut($sku, $catalogProductWebsiteLinkRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCatalogProductWebsiteLinkRepositoryV1SavePost

Tags: Skips Authentication

Assign a product to the website

function createCatalogProductWebsiteLinkRepositoryV1SavePost(
        $sku,
        $catalogProductWebsiteLinkRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
catalogProductWebsiteLinkRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$catalogProductWebsiteLinkRepositoryV1SavePostBody = new CatalogProductWebsiteLinkRepositoryV1SavePutBody();

$result = $catalogProductWebsiteLinkRepositoryV1->createCatalogProductWebsiteLinkRepositoryV1SavePost($sku, $catalogProductWebsiteLinkRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteCatalogProductWebsiteLinkRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove the website assignment from the product by product sku

function deleteCatalogProductWebsiteLinkRepositoryV1DeleteByIdDelete(
        $sku,
        $websiteId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
websiteId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$websiteId = 127;

$result = $catalogProductWebsiteLinkRepositoryV1->deleteCatalogProductWebsiteLinkRepositoryV1DeleteByIdDelete($sku, $websiteId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CatalogProductRenderListV1Controller

Get singleton instance

The singleton instance of the CatalogProductRenderListV1Controller class can be accessed from the API Client.

$catalogProductRenderListV1 = $client->getCatalogProductRenderListV1();

getCatalogProductRenderListV1GetListGet

Tags: Skips Authentication

Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc

function getCatalogProductRenderListV1GetListGet(
        $storeId,
        $currencyCode,
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
storeId	Required	TODO: Add a parameter description
currencyCode	Required	TODO: Add a parameter description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$storeId = 127;
$currencyCode = 'currencyCode';
$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 127;
$searchCriteriaCurrentPage = 127;

$result = $catalogProductRenderListV1->getCatalogProductRenderListV1GetListGet($storeId, $currencyCode, $searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

CatalogInventoryStockRegistryV1Controller

Get singleton instance

The singleton instance of the CatalogInventoryStockRegistryV1Controller class can be accessed from the API Client.

$catalogInventoryStockRegistryV1 = $client->getCatalogInventoryStockRegistryV1();

getCatalogInventoryStockRegistryV1GetStockItemBySkuGet

Tags: Skips Authentication

TODO: Add a method description

function getCatalogInventoryStockRegistryV1GetStockItemBySkuGet(
        $productSku,
        $scopeId = null)

Parameters

Parameter	Tags	Description
productSku	Required	TODO: Add a parameter description
scopeId	Optional	TODO: Add a parameter description

Example Usage

$productSku = 'productSku';
$scopeId = 127;

$result = $catalogInventoryStockRegistryV1->getCatalogInventoryStockRegistryV1GetStockItemBySkuGet($productSku, $scopeId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateCatalogInventoryStockRegistryV1UpdateStockItemBySkuPut

Tags: Skips Authentication

TODO: Add a method description

function updateCatalogInventoryStockRegistryV1UpdateStockItemBySkuPut(
        $productSku,
        $itemId,
        $catalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody = null)

Parameters

Parameter	Tags	Description
productSku	Required	TODO: Add a parameter description
itemId	Required	TODO: Add a parameter description
catalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody	Optional	TODO: Add a parameter description

Example Usage

$productSku = 'productSku';
$itemId = 'itemId';
$catalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody = new CatalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody();

$result = $catalogInventoryStockRegistryV1->updateCatalogInventoryStockRegistryV1UpdateStockItemBySkuPut($productSku, $itemId, $catalogInventoryStockRegistryV1UpdateStockItemBySkuPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getCatalogInventoryStockRegistryV1GetLowStockItemsGet

Tags: Skips Authentication

Retrieves a list of SKU's with low inventory qty

function getCatalogInventoryStockRegistryV1GetLowStockItemsGet(
        $scopeId,
        $qty,
        $currentPage = null,
        $pageSize = null)

Parameters

Parameter	Tags	Description
scopeId	Required	TODO: Add a parameter description
qty	Required	TODO: Add a parameter description
currentPage	Optional	TODO: Add a parameter description
pageSize	Optional	TODO: Add a parameter description

Example Usage

$scopeId = 127;
$qty = 127.573446080821;
$currentPage = 127;
$pageSize = 127;

$result = $catalogInventoryStockRegistryV1->getCatalogInventoryStockRegistryV1GetLowStockItemsGet($scopeId, $qty, $currentPage, $pageSize);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getCatalogInventoryStockRegistryV1GetStockStatusBySkuGet

Tags: Skips Authentication

TODO: Add a method description

function getCatalogInventoryStockRegistryV1GetStockStatusBySkuGet(
        $productSku,
        $scopeId = null)

Parameters

Parameter	Tags	Description
productSku	Required	TODO: Add a parameter description
scopeId	Optional	TODO: Add a parameter description

Example Usage

$productSku = 'productSku';
$scopeId = 127;

$result = $catalogInventoryStockRegistryV1->getCatalogInventoryStockRegistryV1GetStockStatusBySkuGet($productSku, $scopeId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

BackendModuleServiceV1Controller

Get singleton instance

The singleton instance of the BackendModuleServiceV1Controller class can be accessed from the API Client.

$backendModuleServiceV1 = $client->getBackendModuleServiceV1();

getBackendModuleServiceV1GetModulesGet

Tags: Skips Authentication

Returns an array of enabled modules

function getBackendModuleServiceV1GetModulesGet()

Example Usage

$result = $backendModuleServiceV1->getBackendModuleServiceV1GetModulesGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteCartRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteCartRepositoryV1Controller class can be accessed from the API Client.

$quoteCartRepositoryV1 = $client->getQuoteCartRepositoryV1();

getQuoteCartRepositoryV1GetGet

Tags: Skips Authentication

Enables an administrative user to return information for a specified cart.

function getQuoteCartRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 127;

$result = $quoteCartRepositoryV1->getQuoteCartRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuoteCartRepositoryV1GetListGet

Tags: Skips Authentication

Enables administrative users to list carts that match specified search 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#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getQuoteCartRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 127;
$searchCriteriaCurrentPage = 127;

$result = $quoteCartRepositoryV1->getQuoteCartRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateQuoteCartRepositoryV1SavePut

Tags: Skips Authentication

Save quote

function updateQuoteCartRepositoryV1SavePut($quoteCartRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
quoteCartRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$quoteCartRepositoryV1SavePutBody = new QuoteCartRepositoryV1SavePutBody();

$quoteCartRepositoryV1->updateQuoteCartRepositoryV1SavePut($quoteCartRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteCartManagementV1Controller

Get singleton instance

The singleton instance of the QuoteCartManagementV1Controller class can be accessed from the API Client.

$quoteCartManagementV1 = $client->getQuoteCartManagementV1();

updateQuoteCartManagementV1AssignCustomerPut

Tags: Skips Authentication

Assigns a specified customer to a specified shopping cart.

function updateQuoteCartManagementV1AssignCustomerPut(
        $cartId,
        $quoteCartManagementV1AssignCustomerPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteCartManagementV1AssignCustomerPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 36;
$quoteCartManagementV1AssignCustomerPutBody = new QuoteCartManagementV1AssignCustomerPutBody();

$result = $quoteCartManagementV1->updateQuoteCartManagementV1AssignCustomerPut($cartId, $quoteCartManagementV1AssignCustomerPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getQuoteCartManagementV1GetCartForCustomerGet

Tags: Skips Authentication

Returns information for the cart for a specified customer.

function getQuoteCartManagementV1GetCartForCustomerGet()

Example Usage

$result = $quoteCartManagementV1->getQuoteCartManagementV1GetCartForCustomerGet();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteCartManagementV1CreateEmptyCartForCustomerPost

Tags: Skips Authentication

Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

function createQuoteCartManagementV1CreateEmptyCartForCustomerPost()

Example Usage

$result = $quoteCartManagementV1->createQuoteCartManagementV1CreateEmptyCartForCustomerPost();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteCartManagementV1CreateEmptyCartPost

Tags: Skips Authentication

Creates an empty cart and quote for a guest.

function createQuoteCartManagementV1CreateEmptyCartPost()

Example Usage

$result = $quoteCartManagementV1->createQuoteCartManagementV1CreateEmptyCartPost();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteCartManagementV1CreateEmptyCartForCustomerPost1

Tags: Skips Authentication

Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

function createQuoteCartManagementV1CreateEmptyCartForCustomerPost1($customerId)

Parameters

Parameter	Tags	Description
customerId	Required	The customer ID.

Example Usage

$customerId = 36;

$result = $quoteCartManagementV1->createQuoteCartManagementV1CreateEmptyCartForCustomerPost1($customerId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCartManagementV1PlaceOrderPut

Tags: Skips Authentication

Places an order for a specified cart.

function updateQuoteCartManagementV1PlaceOrderPut($quoteCartManagementV1PlaceOrderPutBody = null)

Parameters

Parameter	Tags	Description
quoteCartManagementV1PlaceOrderPutBody	Optional	TODO: Add a parameter description

Example Usage

$quoteCartManagementV1PlaceOrderPutBody = new QuoteCartManagementV1PlaceOrderPutBody();

$result = $quoteCartManagementV1->updateQuoteCartManagementV1PlaceOrderPut($quoteCartManagementV1PlaceOrderPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCartManagementV1PlaceOrderPut1

Tags: Skips Authentication

Places an order for a specified cart.

function updateQuoteCartManagementV1PlaceOrderPut1(
        $cartId,
        $quoteCartManagementV1PlaceOrderPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteCartManagementV1PlaceOrderPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 36;
$quoteCartManagementV1PlaceOrderPutBody = new QuoteCartManagementV1PlaceOrderPutBody();

$result = $quoteCartManagementV1->updateQuoteCartManagementV1PlaceOrderPut1($cartId, $quoteCartManagementV1PlaceOrderPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestCartRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCartRepositoryV1Controller class can be accessed from the API Client.

$quoteGuestCartRepositoryV1 = $client->getQuoteGuestCartRepositoryV1();

getQuoteGuestCartRepositoryV1GetGet

Tags: Skips Authentication

Enable a guest user to return information for a specified cart.

function getQuoteGuestCartRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $quoteGuestCartRepositoryV1->getQuoteGuestCartRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteGuestCartManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCartManagementV1Controller class can be accessed from the API Client.

$quoteGuestCartManagementV1 = $client->getQuoteGuestCartManagementV1();

updateQuoteGuestCartManagementV1AssignCustomerPut

Tags: Skips Authentication

Assign a specified customer to a specified shopping cart.

function updateQuoteGuestCartManagementV1AssignCustomerPut(
        $cartId,
        $quoteGuestCartManagementV1AssignCustomerPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteGuestCartManagementV1AssignCustomerPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestCartManagementV1AssignCustomerPutBody = new QuoteGuestCartManagementV1AssignCustomerPutBody();

$result = $quoteGuestCartManagementV1->updateQuoteGuestCartManagementV1AssignCustomerPut($cartId, $quoteGuestCartManagementV1AssignCustomerPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createQuoteGuestCartManagementV1CreateEmptyCartPost

Tags: Skips Authentication

Enable an customer or guest user to create an empty cart and quote for an anonymous customer.

function createQuoteGuestCartManagementV1CreateEmptyCartPost()

Example Usage

$result = $quoteGuestCartManagementV1->createQuoteGuestCartManagementV1CreateEmptyCartPost();

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

updateQuoteGuestCartManagementV1PlaceOrderPut

Tags: Skips Authentication

Place an order for a specified cart.

function updateQuoteGuestCartManagementV1PlaceOrderPut(
        $cartId,
        $quoteGuestCartManagementV1PlaceOrderPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteGuestCartManagementV1PlaceOrderPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestCartManagementV1PlaceOrderPutBody = new QuoteGuestCartManagementV1PlaceOrderPutBody();

$result = $quoteGuestCartManagementV1->updateQuoteGuestCartManagementV1PlaceOrderPut($cartId, $quoteGuestCartManagementV1PlaceOrderPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteShippingMethodManagementV1Controller

Get singleton instance

The singleton instance of the QuoteShippingMethodManagementV1Controller class can be accessed from the API Client.

$quoteShippingMethodManagementV1 = $client->getQuoteShippingMethodManagementV1();

getQuoteShippingMethodManagementV1GetListGet

Tags: Skips Authentication

Lists applicable shipping methods for a specified quote.

function getQuoteShippingMethodManagementV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.

Example Usage

$cartId = 36;

$result = $quoteShippingMethodManagementV1->getQuoteShippingMethodManagementV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteShippingMethodManagementV1EstimateByAddressIdPost

Tags: Skips Authentication

Estimate shipping

function createQuoteShippingMethodManagementV1EstimateByAddressIdPost(
        $cartId,
        $quoteShippingMethodManagementV1EstimateByAddressIdPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.
quoteShippingMethodManagementV1EstimateByAddressIdPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 36;
$quoteShippingMethodManagementV1EstimateByAddressIdPostBody = new QuoteShippingMethodManagementV1EstimateByAddressIdPostBody();

$result = $quoteShippingMethodManagementV1->createQuoteShippingMethodManagementV1EstimateByAddressIdPost($cartId, $quoteShippingMethodManagementV1EstimateByAddressIdPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getQuoteShippingMethodManagementV1GetListGet1

Tags: Skips Authentication

Lists applicable shipping methods for a specified quote.

function getQuoteShippingMethodManagementV1GetListGet1()

Example Usage

$result = $quoteShippingMethodManagementV1->getQuoteShippingMethodManagementV1GetListGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteShipmentEstimationV1Controller

Get singleton instance

The singleton instance of the QuoteShipmentEstimationV1Controller class can be accessed from the API Client.

$quoteShipmentEstimationV1 = $client->getQuoteShipmentEstimationV1();

createQuoteShipmentEstimationV1EstimateByExtendedAddressPost

Tags: Skips Authentication

Estimate shipping by address and return list of available shipping methods

function createQuoteShipmentEstimationV1EstimateByExtendedAddressPost(
        $cartId,
        $quoteShipmentEstimationV1EstimateByExtendedAddressPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
quoteShipmentEstimationV1EstimateByExtendedAddressPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteShipmentEstimationV1EstimateByExtendedAddressPostBody = new QuoteShipmentEstimationV1EstimateByExtendedAddressPostBody();

$result = $quoteShipmentEstimationV1->createQuoteShipmentEstimationV1EstimateByExtendedAddressPost($cartId, $quoteShipmentEstimationV1EstimateByExtendedAddressPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createQuoteShipmentEstimationV1EstimateByExtendedAddressPost1

Tags: Skips Authentication

Estimate shipping by address and return list of available shipping methods

function createQuoteShipmentEstimationV1EstimateByExtendedAddressPost1($quoteShipmentEstimationV1EstimateByExtendedAddressPostBody = null)

Parameters

Parameter	Tags	Description
quoteShipmentEstimationV1EstimateByExtendedAddressPostBody	Optional	TODO: Add a parameter description

Example Usage

$quoteShipmentEstimationV1EstimateByExtendedAddressPostBody = new QuoteShipmentEstimationV1EstimateByExtendedAddressPostBody();

$result = $quoteShipmentEstimationV1->createQuoteShipmentEstimationV1EstimateByExtendedAddressPost1($quoteShipmentEstimationV1EstimateByExtendedAddressPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

TemandoShippingQuoteShippingMethodManagementV1Controller

Get singleton instance

The singleton instance of the TemandoShippingQuoteShippingMethodManagementV1Controller class can be accessed from the API Client.

$temandoShippingQuoteShippingMethodManagementV1 = $client->getTemandoShippingQuoteShippingMethodManagementV1();

createTemandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPost

Tags: Skips Authentication

Estimate shipping with extension attributes

function createTemandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPost($temandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPostBody = null)

Parameters

Parameter	Tags	Description
temandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPostBody	Optional	TODO: Add a parameter description

Example Usage

$temandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPostBody = new TemandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPostBody();

$result = $temandoShippingQuoteShippingMethodManagementV1->createTemandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPost($temandoShippingQuoteShippingMethodManagementV1EstimateByAddressIdPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestShippingMethodManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestShippingMethodManagementV1Controller class can be accessed from the API Client.

$quoteGuestShippingMethodManagementV1 = $client->getQuoteGuestShippingMethodManagementV1();

getQuoteGuestShippingMethodManagementV1GetListGet

Tags: Skips Authentication

List applicable shipping methods for a specified quote.

function getQuoteGuestShippingMethodManagementV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestShippingMethodManagementV1->getQuoteGuestShippingMethodManagementV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteGuestShipmentEstimationV1Controller

Get singleton instance

The singleton instance of the QuoteGuestShipmentEstimationV1Controller class can be accessed from the API Client.

$quoteGuestShipmentEstimationV1 = $client->getQuoteGuestShipmentEstimationV1();

createQuoteGuestShipmentEstimationV1EstimateByExtendedAddressPost

Tags: Skips Authentication

Estimate shipping by address and return list of available shipping methods

function createQuoteGuestShipmentEstimationV1EstimateByExtendedAddressPost(
        $cartId,
        $quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody = new QuoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody();

$result = $quoteGuestShipmentEstimationV1->createQuoteGuestShipmentEstimationV1EstimateByExtendedAddressPost($cartId, $quoteGuestShipmentEstimationV1EstimateByExtendedAddressPostBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

QuoteCartItemRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteCartItemRepositoryV1Controller class can be accessed from the API Client.

$quoteCartItemRepositoryV1 = $client->getQuoteCartItemRepositoryV1();

getQuoteCartItemRepositoryV1GetListGet

Tags: Skips Authentication

Lists items that are assigned to a specified cart.

function getQuoteCartItemRepositoryV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 36;

$result = $quoteCartItemRepositoryV1->getQuoteCartItemRepositoryV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteCartItemRepositoryV1SavePost

Tags: Skips Authentication

Add/update the specified cart item.

function createQuoteCartItemRepositoryV1SavePost(
        $quoteId,
        $quoteCartItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
quoteId	Required	TODO: Add a parameter description
quoteCartItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$quoteId = 'quoteId';
$quoteCartItemRepositoryV1SavePostBody = new QuoteCartItemRepositoryV1SavePostBody();

$result = $quoteCartItemRepositoryV1->createQuoteCartItemRepositoryV1SavePost($quoteId, $quoteCartItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCartItemRepositoryV1SavePut

Tags: Skips Authentication

Add/update the specified cart item.

function updateQuoteCartItemRepositoryV1SavePut(
        $cartId,
        $itemId,
        $quoteCartItemRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
itemId	Required	TODO: Add a parameter description
quoteCartItemRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$itemId = 'itemId';
$quoteCartItemRepositoryV1SavePutBody = new QuoteCartItemRepositoryV1SavePostBody();

$result = $quoteCartItemRepositoryV1->updateQuoteCartItemRepositoryV1SavePut($cartId, $itemId, $quoteCartItemRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteQuoteCartItemRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Removes the specified item from the specified cart.

function deleteQuoteCartItemRepositoryV1DeleteByIdDelete(
        $cartId,
        $itemId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
itemId	Required	The item ID of the item to be removed.

Example Usage

$cartId = 77;
$itemId = 77;

$result = $quoteCartItemRepositoryV1->deleteQuoteCartItemRepositoryV1DeleteByIdDelete($cartId, $itemId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuoteCartItemRepositoryV1GetListGet1

Tags: Skips Authentication

Lists items that are assigned to a specified cart.

function getQuoteCartItemRepositoryV1GetListGet1()

Example Usage

$result = $quoteCartItemRepositoryV1->getQuoteCartItemRepositoryV1GetListGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteCartItemRepositoryV1SavePost1

Tags: Skips Authentication

Add/update the specified cart item.

function createQuoteCartItemRepositoryV1SavePost1($quoteCartItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
quoteCartItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$quoteCartItemRepositoryV1SavePostBody = new QuoteCartItemRepositoryV1SavePostBody();

$result = $quoteCartItemRepositoryV1->createQuoteCartItemRepositoryV1SavePost1($quoteCartItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCartItemRepositoryV1SavePut1

Tags: Skips Authentication

Add/update the specified cart item.

function updateQuoteCartItemRepositoryV1SavePut1(
        $itemId,
        $quoteCartItemRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
itemId	Required	TODO: Add a parameter description
quoteCartItemRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$itemId = 'itemId';
$quoteCartItemRepositoryV1SavePutBody = new QuoteCartItemRepositoryV1SavePostBody();

$result = $quoteCartItemRepositoryV1->updateQuoteCartItemRepositoryV1SavePut1($itemId, $quoteCartItemRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteQuoteCartItemRepositoryV1DeleteByIdDelete1

Tags: Skips Authentication

Removes the specified item from the specified cart.

function deleteQuoteCartItemRepositoryV1DeleteByIdDelete1($itemId)

Parameters

Parameter	Tags	Description
itemId	Required	The item ID of the item to be removed.

Example Usage

$itemId = 77;

$result = $quoteCartItemRepositoryV1->deleteQuoteCartItemRepositoryV1DeleteByIdDelete1($itemId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestCartItemRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCartItemRepositoryV1Controller class can be accessed from the API Client.

$quoteGuestCartItemRepositoryV1 = $client->getQuoteGuestCartItemRepositoryV1();

getQuoteGuestCartItemRepositoryV1GetListGet

Tags: Skips Authentication

List items that are assigned to a specified cart.

function getQuoteGuestCartItemRepositoryV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestCartItemRepositoryV1->getQuoteGuestCartItemRepositoryV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

createQuoteGuestCartItemRepositoryV1SavePost

Tags: Skips Authentication

Add/update the specified cart item.

function createQuoteGuestCartItemRepositoryV1SavePost(
        $cartId,
        $quoteGuestCartItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
quoteGuestCartItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestCartItemRepositoryV1SavePostBody = new QuoteGuestCartItemRepositoryV1SavePostBody();

$result = $quoteGuestCartItemRepositoryV1->createQuoteGuestCartItemRepositoryV1SavePost($cartId, $quoteGuestCartItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

updateQuoteGuestCartItemRepositoryV1SavePut

Tags: Skips Authentication

Add/update the specified cart item.

function updateQuoteGuestCartItemRepositoryV1SavePut(
        $cartId,
        $itemId,
        $quoteGuestCartItemRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
itemId	Required	TODO: Add a parameter description
quoteGuestCartItemRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$itemId = 'itemId';
$quoteGuestCartItemRepositoryV1SavePutBody = new QuoteGuestCartItemRepositoryV1SavePostBody();

$result = $quoteGuestCartItemRepositoryV1->updateQuoteGuestCartItemRepositoryV1SavePut($cartId, $itemId, $quoteGuestCartItemRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

deleteQuoteGuestCartItemRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove the specified item from the specified cart.

function deleteQuoteGuestCartItemRepositoryV1DeleteByIdDelete(
        $cartId,
        $itemId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
itemId	Required	The item ID of the item to be removed.

Example Usage

$cartId = 'cartId';
$itemId = 77;

$result = $quoteGuestCartItemRepositoryV1->deleteQuoteGuestCartItemRepositoryV1DeleteByIdDelete($cartId, $itemId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuotePaymentMethodManagementV1Controller

Get singleton instance

The singleton instance of the QuotePaymentMethodManagementV1Controller class can be accessed from the API Client.

$quotePaymentMethodManagementV1 = $client->getQuotePaymentMethodManagementV1();

getQuotePaymentMethodManagementV1GetGet

Tags: Skips Authentication

Returns the payment method for a specified shopping cart.

function getQuotePaymentMethodManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 77;

$result = $quotePaymentMethodManagementV1->getQuotePaymentMethodManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuotePaymentMethodManagementV1SetPut

Tags: Skips Authentication

Adds a specified payment method to a specified shopping cart.

function updateQuotePaymentMethodManagementV1SetPut(
        $cartId,
        $quotePaymentMethodManagementV1SetPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quotePaymentMethodManagementV1SetPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 77;
$quotePaymentMethodManagementV1SetPutBody = new QuotePaymentMethodManagementV1SetPutBody();

$result = $quotePaymentMethodManagementV1->updateQuotePaymentMethodManagementV1SetPut($cartId, $quotePaymentMethodManagementV1SetPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuotePaymentMethodManagementV1GetListGet

Tags: Skips Authentication

Lists available payment methods for a specified shopping cart. 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#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

function getQuotePaymentMethodManagementV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 77;

$result = $quotePaymentMethodManagementV1->getQuotePaymentMethodManagementV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuotePaymentMethodManagementV1GetGet1

Tags: Skips Authentication

Returns the payment method for a specified shopping cart.

function getQuotePaymentMethodManagementV1GetGet1()

Example Usage

$result = $quotePaymentMethodManagementV1->getQuotePaymentMethodManagementV1GetGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuotePaymentMethodManagementV1SetPut1

Tags: Skips Authentication

Adds a specified payment method to a specified shopping cart.

function updateQuotePaymentMethodManagementV1SetPut1($quotePaymentMethodManagementV1SetPutBody = null)

Parameters

Parameter	Tags	Description
quotePaymentMethodManagementV1SetPutBody	Optional	TODO: Add a parameter description

Example Usage

$quotePaymentMethodManagementV1SetPutBody = new QuotePaymentMethodManagementV1SetPutBody();

$result = $quotePaymentMethodManagementV1->updateQuotePaymentMethodManagementV1SetPut1($quotePaymentMethodManagementV1SetPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuotePaymentMethodManagementV1GetListGet1

Tags: Skips Authentication

Lists available payment methods for a specified shopping cart. 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#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

function getQuotePaymentMethodManagementV1GetListGet1()

Example Usage

$result = $quotePaymentMethodManagementV1->getQuotePaymentMethodManagementV1GetListGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestPaymentMethodManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestPaymentMethodManagementV1Controller class can be accessed from the API Client.

$quoteGuestPaymentMethodManagementV1 = $client->getQuoteGuestPaymentMethodManagementV1();

getQuoteGuestPaymentMethodManagementV1GetGet

Tags: Skips Authentication

Return the payment method for a specified shopping cart.

function getQuoteGuestPaymentMethodManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestPaymentMethodManagementV1->getQuoteGuestPaymentMethodManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

updateQuoteGuestPaymentMethodManagementV1SetPut

Tags: Skips Authentication

Add a specified payment method to a specified shopping cart.

function updateQuoteGuestPaymentMethodManagementV1SetPut(
        $cartId,
        $quoteGuestPaymentMethodManagementV1SetPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteGuestPaymentMethodManagementV1SetPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestPaymentMethodManagementV1SetPutBody = new QuoteGuestPaymentMethodManagementV1SetPutBody();

$result = $quoteGuestPaymentMethodManagementV1->updateQuoteGuestPaymentMethodManagementV1SetPut($cartId, $quoteGuestPaymentMethodManagementV1SetPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

getQuoteGuestPaymentMethodManagementV1GetListGet

Tags: Skips Authentication

List available payment methods for a specified shopping cart. 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#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

function getQuoteGuestPaymentMethodManagementV1GetListGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestPaymentMethodManagementV1->getQuoteGuestPaymentMethodManagementV1GetListGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteBillingAddressManagementV1Controller

Get singleton instance

The singleton instance of the QuoteBillingAddressManagementV1Controller class can be accessed from the API Client.

$quoteBillingAddressManagementV1 = $client->getQuoteBillingAddressManagementV1();

getQuoteBillingAddressManagementV1GetGet

Tags: Skips Authentication

Returns the billing address for a specified quote.

function getQuoteBillingAddressManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 77;

$result = $quoteBillingAddressManagementV1->getQuoteBillingAddressManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteBillingAddressManagementV1AssignPost

Tags: Skips Authentication

Assigns a specified billing address to a specified cart.

function createQuoteBillingAddressManagementV1AssignPost(
        $cartId,
        $quoteBillingAddressManagementV1AssignPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteBillingAddressManagementV1AssignPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 77;
$quoteBillingAddressManagementV1AssignPostBody = new QuoteBillingAddressManagementV1AssignPostBody();

$result = $quoteBillingAddressManagementV1->createQuoteBillingAddressManagementV1AssignPost($cartId, $quoteBillingAddressManagementV1AssignPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuoteBillingAddressManagementV1GetGet1

Tags: Skips Authentication

Returns the billing address for a specified quote.

function getQuoteBillingAddressManagementV1GetGet1()

Example Usage

$result = $quoteBillingAddressManagementV1->getQuoteBillingAddressManagementV1GetGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createQuoteBillingAddressManagementV1AssignPost1

Tags: Skips Authentication

Assigns a specified billing address to a specified cart.

function createQuoteBillingAddressManagementV1AssignPost1($quoteBillingAddressManagementV1AssignPostBody = null)

Parameters

Parameter	Tags	Description
quoteBillingAddressManagementV1AssignPostBody	Optional	TODO: Add a parameter description

Example Usage

$quoteBillingAddressManagementV1AssignPostBody = new QuoteBillingAddressManagementV1AssignPostBody();

$result = $quoteBillingAddressManagementV1->createQuoteBillingAddressManagementV1AssignPost1($quoteBillingAddressManagementV1AssignPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestBillingAddressManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestBillingAddressManagementV1Controller class can be accessed from the API Client.

$quoteGuestBillingAddressManagementV1 = $client->getQuoteGuestBillingAddressManagementV1();

getQuoteGuestBillingAddressManagementV1GetGet

Tags: Skips Authentication

Return the billing address for a specified quote.

function getQuoteGuestBillingAddressManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestBillingAddressManagementV1->getQuoteGuestBillingAddressManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

createQuoteGuestBillingAddressManagementV1AssignPost

Tags: Skips Authentication

Assign a specified billing address to a specified cart.

function createQuoteGuestBillingAddressManagementV1AssignPost(
        $cartId,
        $quoteGuestBillingAddressManagementV1AssignPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteGuestBillingAddressManagementV1AssignPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestBillingAddressManagementV1AssignPostBody = new QuoteGuestBillingAddressManagementV1AssignPostBody();

$result = $quoteGuestBillingAddressManagementV1->createQuoteGuestBillingAddressManagementV1AssignPost($cartId, $quoteGuestBillingAddressManagementV1AssignPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteCouponManagementV1Controller

Get singleton instance

The singleton instance of the QuoteCouponManagementV1Controller class can be accessed from the API Client.

$quoteCouponManagementV1 = $client->getQuoteCouponManagementV1();

getQuoteCouponManagementV1GetGet

Tags: Skips Authentication

Returns information for a coupon in a specified cart.

function getQuoteCouponManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 241;

$result = $quoteCouponManagementV1->getQuoteCouponManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteQuoteCouponManagementV1RemoveDelete

Tags: Skips Authentication

Deletes a coupon from a specified cart.

function deleteQuoteCouponManagementV1RemoveDelete($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 241;

$result = $quoteCouponManagementV1->deleteQuoteCouponManagementV1RemoveDelete($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCouponManagementV1SetPut

Tags: Skips Authentication

Adds a coupon by code to a specified cart.

function updateQuoteCouponManagementV1SetPut(
        $cartId,
        $couponCode)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
couponCode	Required	The coupon code data.

Example Usage

$cartId = 241;
$couponCode = 'couponCode';

$result = $quoteCouponManagementV1->updateQuoteCouponManagementV1SetPut($cartId, $couponCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuoteCouponManagementV1GetGet1

Tags: Skips Authentication

Returns information for a coupon in a specified cart.

function getQuoteCouponManagementV1GetGet1()

Example Usage

$result = $quoteCouponManagementV1->getQuoteCouponManagementV1GetGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteQuoteCouponManagementV1RemoveDelete1

Tags: Skips Authentication

Deletes a coupon from a specified cart.

function deleteQuoteCouponManagementV1RemoveDelete1()

Example Usage

$result = $quoteCouponManagementV1->deleteQuoteCouponManagementV1RemoveDelete1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateQuoteCouponManagementV1SetPut1

Tags: Skips Authentication

Adds a coupon by code to a specified cart.

function updateQuoteCouponManagementV1SetPut1($couponCode)

Parameters

Parameter	Tags	Description
couponCode	Required	The coupon code data.

Example Usage

$couponCode = 'couponCode';

$result = $quoteCouponManagementV1->updateQuoteCouponManagementV1SetPut1($couponCode);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestCouponManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCouponManagementV1Controller class can be accessed from the API Client.

$quoteGuestCouponManagementV1 = $client->getQuoteGuestCouponManagementV1();

getQuoteGuestCouponManagementV1GetGet

Tags: Skips Authentication

Return information for a coupon in a specified cart.

function getQuoteGuestCouponManagementV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestCouponManagementV1->getQuoteGuestCouponManagementV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

deleteQuoteGuestCouponManagementV1RemoveDelete

Tags: Skips Authentication

Delete a coupon from a specified cart.

function deleteQuoteGuestCouponManagementV1RemoveDelete($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestCouponManagementV1->deleteQuoteGuestCouponManagementV1RemoveDelete($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

updateQuoteGuestCouponManagementV1SetPut

Tags: Skips Authentication

Add a coupon by code to a specified cart.

function updateQuoteGuestCouponManagementV1SetPut(
        $cartId,
        $couponCode)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
couponCode	Required	The coupon code data.

Example Usage

$cartId = 'cartId';
$couponCode = 'couponCode';

$result = $quoteGuestCouponManagementV1->updateQuoteGuestCouponManagementV1SetPut($cartId, $couponCode);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteCartTotalRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteCartTotalRepositoryV1Controller class can be accessed from the API Client.

$quoteCartTotalRepositoryV1 = $client->getQuoteCartTotalRepositoryV1();

getQuoteCartTotalRepositoryV1GetGet

Tags: Skips Authentication

Returns quote totals data for a specified cart.

function getQuoteCartTotalRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 241;

$result = $quoteCartTotalRepositoryV1->getQuoteCartTotalRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getQuoteCartTotalRepositoryV1GetGet1

Tags: Skips Authentication

Returns quote totals data for a specified cart.

function getQuoteCartTotalRepositoryV1GetGet1()

Example Usage

$result = $quoteCartTotalRepositoryV1->getQuoteCartTotalRepositoryV1GetGet1();

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

QuoteGuestCartTotalManagementV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCartTotalManagementV1Controller class can be accessed from the API Client.

$quoteGuestCartTotalManagementV1 = $client->getQuoteGuestCartTotalManagementV1();

updateQuoteGuestCartTotalManagementV1CollectTotalsPut

Tags: Skips Authentication

Set shipping/billing methods and additional data for cart and collect totals for guest.

function updateQuoteGuestCartTotalManagementV1CollectTotalsPut(
        $cartId,
        $quoteGuestCartTotalManagementV1CollectTotalsPutBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
quoteGuestCartTotalManagementV1CollectTotalsPutBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$quoteGuestCartTotalManagementV1CollectTotalsPutBody = new QuoteGuestCartTotalManagementV1CollectTotalsPutBody();

$result = $quoteGuestCartTotalManagementV1->updateQuoteGuestCartTotalManagementV1CollectTotalsPut($cartId, $quoteGuestCartTotalManagementV1CollectTotalsPutBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

QuoteGuestCartTotalRepositoryV1Controller

Get singleton instance

The singleton instance of the QuoteGuestCartTotalRepositoryV1Controller class can be accessed from the API Client.

$quoteGuestCartTotalRepositoryV1 = $client->getQuoteGuestCartTotalRepositoryV1();

getQuoteGuestCartTotalRepositoryV1GetGet

Tags: Skips Authentication

Return quote totals data for a specified cart.

function getQuoteGuestCartTotalRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.

Example Usage

$cartId = 'cartId';

$result = $quoteGuestCartTotalRepositoryV1->getQuoteGuestCartTotalRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

QuoteCartTotalManagementV1Controller

Get singleton instance

The singleton instance of the QuoteCartTotalManagementV1Controller class can be accessed from the API Client.

$quoteCartTotalManagementV1 = $client->getQuoteCartTotalManagementV1();

updateQuoteCartTotalManagementV1CollectTotalsPut

Tags: Skips Authentication

Set shipping/billing methods and additional data for cart and collect totals.

function updateQuoteCartTotalManagementV1CollectTotalsPut($quoteCartTotalManagementV1CollectTotalsPutBody = null)

Parameters

Parameter	Tags	Description
quoteCartTotalManagementV1CollectTotalsPutBody	Optional	TODO: Add a parameter description

Example Usage

$quoteCartTotalManagementV1CollectTotalsPutBody = new QuoteCartTotalManagementV1CollectTotalsPutBody();

$result = $quoteCartTotalManagementV1->updateQuoteCartTotalManagementV1CollectTotalsPut($quoteCartTotalManagementV1CollectTotalsPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SearchV1Controller

Get singleton instance

The singleton instance of the SearchV1Controller class can be accessed from the API Client.

$searchV1 = $client->getSearchV1();

searchV1SearchGet

Tags: Skips Authentication

Make Full Text Search and return found Documents

function searchV1SearchGet(
        $searchCriteriaRequestName = null,
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaRequestName	Optional	TODO: Add a parameter description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaRequestName = 'searchCriteria[requestName]';
$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 241;
$searchCriteriaCurrentPage = 241;

$result = $searchV1->searchV1SearchGet($searchCriteriaRequestName, $searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

SalesOrderRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesOrderRepositoryV1Controller class can be accessed from the API Client.

$salesOrderRepositoryV1 = $client->getSalesOrderRepositoryV1();

getSalesOrderRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified order.

function getSalesOrderRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderRepositoryV1->getSalesOrderRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesOrderRepositoryV1GetListGet

Tags: Skips Authentication

Lists orders that match specified search 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#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesOrderRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 241;
$searchCriteriaCurrentPage = 241;

$result = $salesOrderRepositoryV1->getSalesOrderRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateSalesOrderRepositoryV1SavePut

Tags: Skips Authentication

Performs persist operations for a specified order.

function updateSalesOrderRepositoryV1SavePut($salesOrderRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
salesOrderRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$salesOrderRepositoryV1SavePutBody = new SalesOrderRepositoryV1SavePutBody();

$result = $salesOrderRepositoryV1->updateSalesOrderRepositoryV1SavePut($salesOrderRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified order.

function createSalesOrderRepositoryV1SavePost($salesOrderRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesOrderRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesOrderRepositoryV1SavePostBody = new SalesOrderRepositoryV1SavePutBody();

$result = $salesOrderRepositoryV1->createSalesOrderRepositoryV1SavePost($salesOrderRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesOrderManagementV1Controller

Get singleton instance

The singleton instance of the SalesOrderManagementV1Controller class can be accessed from the API Client.

$salesOrderManagementV1 = $client->getSalesOrderManagementV1();

getSalesOrderManagementV1GetStatusGet

Tags: Skips Authentication

Gets the status for a specified order.

function getSalesOrderManagementV1GetStatusGet($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->getSalesOrderManagementV1GetStatusGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderManagementV1CancelPost

Tags: Skips Authentication

Cancels a specified order.

function createSalesOrderManagementV1CancelPost($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->createSalesOrderManagementV1CancelPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderManagementV1NotifyPost

Tags: Skips Authentication

Emails a user a specified order.

function createSalesOrderManagementV1NotifyPost($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->createSalesOrderManagementV1NotifyPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderManagementV1HoldPost

Tags: Skips Authentication

Holds a specified order.

function createSalesOrderManagementV1HoldPost($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->createSalesOrderManagementV1HoldPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderManagementV1UnHoldPost

Tags: Skips Authentication

Releases a specified order from hold status.

function createSalesOrderManagementV1UnHoldPost($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->createSalesOrderManagementV1UnHoldPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesOrderManagementV1GetCommentsListGet

Tags: Skips Authentication

Lists comments for a specified order.

function getSalesOrderManagementV1GetCommentsListGet($id)

Parameters

Parameter	Tags	Description
id	Required	The order ID.

Example Usage

$id = 241;

$result = $salesOrderManagementV1->getSalesOrderManagementV1GetCommentsListGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesOrderManagementV1AddCommentPost

Tags: Skips Authentication

Adds a comment to a specified order.

function createSalesOrderManagementV1AddCommentPost(
        $id,
        $salesOrderManagementV1AddCommentPostBody = null)

Parameters

Parameter	Tags	Description
id	Required	The order ID.
salesOrderManagementV1AddCommentPostBody	Optional	TODO: Add a parameter description

Example Usage

$id = 28;
$salesOrderManagementV1AddCommentPostBody = new SalesOrderManagementV1AddCommentPostBody();

$result = $salesOrderManagementV1->createSalesOrderManagementV1AddCommentPost($id, $salesOrderManagementV1AddCommentPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesOrderAddressRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesOrderAddressRepositoryV1Controller class can be accessed from the API Client.

$salesOrderAddressRepositoryV1 = $client->getSalesOrderAddressRepositoryV1();

updateSalesOrderAddressRepositoryV1SavePut

Tags: Skips Authentication

Performs persist operations for a specified order address.

function updateSalesOrderAddressRepositoryV1SavePut(
        $parentId,
        $salesOrderAddressRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
parentId	Required	TODO: Add a parameter description
salesOrderAddressRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$parentId = 'parent_id';
$salesOrderAddressRepositoryV1SavePutBody = new SalesOrderAddressRepositoryV1SavePutBody();

$result = $salesOrderAddressRepositoryV1->updateSalesOrderAddressRepositoryV1SavePut($parentId, $salesOrderAddressRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesOrderItemRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesOrderItemRepositoryV1Controller class can be accessed from the API Client.

$salesOrderItemRepositoryV1 = $client->getSalesOrderItemRepositoryV1();

getSalesOrderItemRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified order item.

function getSalesOrderItemRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The order item ID.

Example Usage

$id = 28;

$result = $salesOrderItemRepositoryV1->getSalesOrderItemRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesOrderItemRepositoryV1GetListGet

Tags: Skips Authentication

Lists order items that match specified search 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#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesOrderItemRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 28;
$searchCriteriaCurrentPage = 28;

$result = $salesOrderItemRepositoryV1->getSalesOrderItemRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesInvoiceRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesInvoiceRepositoryV1Controller class can be accessed from the API Client.

$salesInvoiceRepositoryV1 = $client->getSalesInvoiceRepositoryV1();

getSalesInvoiceRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified invoice.

function getSalesInvoiceRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The invoice ID.

Example Usage

$id = 28;

$result = $salesInvoiceRepositoryV1->getSalesInvoiceRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesInvoiceRepositoryV1GetListGet

Tags: Skips Authentication

Lists invoices that match specified search 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#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesInvoiceRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 28;
$searchCriteriaCurrentPage = 28;

$result = $salesInvoiceRepositoryV1->getSalesInvoiceRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesInvoiceRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified invoice.

function createSalesInvoiceRepositoryV1SavePost($salesInvoiceRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesInvoiceRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesInvoiceRepositoryV1SavePostBody = new SalesInvoiceRepositoryV1SavePostBody();

$result = $salesInvoiceRepositoryV1->createSalesInvoiceRepositoryV1SavePost($salesInvoiceRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesInvoiceManagementV1Controller

Get singleton instance

The singleton instance of the SalesInvoiceManagementV1Controller class can be accessed from the API Client.

$salesInvoiceManagementV1 = $client->getSalesInvoiceManagementV1();

getSalesInvoiceManagementV1GetCommentsListGet

Tags: Skips Authentication

Lists comments for a specified invoice.

function getSalesInvoiceManagementV1GetCommentsListGet($id)

Parameters

Parameter	Tags	Description
id	Required	The invoice ID.

Example Usage

$id = 28;

$result = $salesInvoiceManagementV1->getSalesInvoiceManagementV1GetCommentsListGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesInvoiceManagementV1NotifyPost

Tags: Skips Authentication

Emails a user a specified invoice.

function createSalesInvoiceManagementV1NotifyPost($id)

Parameters

Parameter	Tags	Description
id	Required	The invoice ID.

Example Usage

$id = 28;

$result = $salesInvoiceManagementV1->createSalesInvoiceManagementV1NotifyPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesInvoiceManagementV1SetVoidPost

Tags: Skips Authentication

Voids a specified invoice.

function createSalesInvoiceManagementV1SetVoidPost($id)

Parameters

Parameter	Tags	Description
id	Required	The invoice ID.

Example Usage

$id = 28;

$result = $salesInvoiceManagementV1->createSalesInvoiceManagementV1SetVoidPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesInvoiceManagementV1SetCapturePost

Tags: Skips Authentication

Sets invoice capture.

function createSalesInvoiceManagementV1SetCapturePost($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 28;

$result = $salesInvoiceManagementV1->createSalesInvoiceManagementV1SetCapturePost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesInvoiceCommentRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesInvoiceCommentRepositoryV1Controller class can be accessed from the API Client.

$salesInvoiceCommentRepositoryV1 = $client->getSalesInvoiceCommentRepositoryV1();

createSalesInvoiceCommentRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified invoice comment.

function createSalesInvoiceCommentRepositoryV1SavePost($salesInvoiceCommentRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesInvoiceCommentRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesInvoiceCommentRepositoryV1SavePostBody = new SalesInvoiceCommentRepositoryV1SavePostBody();

$result = $salesInvoiceCommentRepositoryV1->createSalesInvoiceCommentRepositoryV1SavePost($salesInvoiceCommentRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesRefundInvoiceV1Controller

Get singleton instance

The singleton instance of the SalesRefundInvoiceV1Controller class can be accessed from the API Client.

$salesRefundInvoiceV1 = $client->getSalesRefundInvoiceV1();

createSalesRefundInvoiceV1ExecutePost

Tags: Skips Authentication

Create refund for invoice

function createSalesRefundInvoiceV1ExecutePost(
        $invoiceId,
        $salesRefundInvoiceV1ExecutePostBody = null)

Parameters

Parameter	Tags	Description
invoiceId	Required	TODO: Add a parameter description
salesRefundInvoiceV1ExecutePostBody	Optional	TODO: Add a parameter description

Example Usage

$invoiceId = 28;
$salesRefundInvoiceV1ExecutePostBody = new SalesRefundInvoiceV1ExecutePostBody();

$result = $salesRefundInvoiceV1->createSalesRefundInvoiceV1ExecutePost($invoiceId, $salesRefundInvoiceV1ExecutePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesCreditmemoManagementV1Controller

Get singleton instance

The singleton instance of the SalesCreditmemoManagementV1Controller class can be accessed from the API Client.

$salesCreditmemoManagementV1 = $client->getSalesCreditmemoManagementV1();

getSalesCreditmemoManagementV1GetCommentsListGet

Tags: Skips Authentication

Lists comments for a specified credit memo.

function getSalesCreditmemoManagementV1GetCommentsListGet($id)

Parameters

Parameter	Tags	Description
id	Required	The credit memo ID.

Example Usage

$id = 191;

$result = $salesCreditmemoManagementV1->getSalesCreditmemoManagementV1GetCommentsListGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateSalesCreditmemoManagementV1CancelPut

Tags: Skips Authentication

Cancels a specified credit memo.

function updateSalesCreditmemoManagementV1CancelPut($id)

Parameters

Parameter	Tags	Description
id	Required	The credit memo ID.

Example Usage

$id = 191;

$result = $salesCreditmemoManagementV1->updateSalesCreditmemoManagementV1CancelPut($id);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createSalesCreditmemoManagementV1NotifyPost

Tags: Skips Authentication

Emails a user a specified credit memo.

function createSalesCreditmemoManagementV1NotifyPost($id)

Parameters

Parameter	Tags	Description
id	Required	The credit memo ID.

Example Usage

$id = 191;

$result = $salesCreditmemoManagementV1->createSalesCreditmemoManagementV1NotifyPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesCreditmemoManagementV1RefundPost

Tags: Skips Authentication

Prepare creditmemo to refund and save it.

function createSalesCreditmemoManagementV1RefundPost($salesCreditmemoManagementV1RefundPostBody = null)

Parameters

Parameter	Tags	Description
salesCreditmemoManagementV1RefundPostBody	Optional	TODO: Add a parameter description

Example Usage

$salesCreditmemoManagementV1RefundPostBody = new SalesCreditmemoManagementV1RefundPostBody();

$result = $salesCreditmemoManagementV1->createSalesCreditmemoManagementV1RefundPost($salesCreditmemoManagementV1RefundPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesCreditmemoRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesCreditmemoRepositoryV1Controller class can be accessed from the API Client.

$salesCreditmemoRepositoryV1 = $client->getSalesCreditmemoRepositoryV1();

getSalesCreditmemoRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified credit memo.

function getSalesCreditmemoRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The credit memo ID.

Example Usage

$id = 191;

$result = $salesCreditmemoRepositoryV1->getSalesCreditmemoRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesCreditmemoRepositoryV1GetListGet

Tags: Skips Authentication

Lists credit memos that match specified search 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#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesCreditmemoRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 191;
$searchCriteriaCurrentPage = 191;

$result = $salesCreditmemoRepositoryV1->getSalesCreditmemoRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesCreditmemoRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified credit memo.

function createSalesCreditmemoRepositoryV1SavePost($salesCreditmemoRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesCreditmemoRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesCreditmemoRepositoryV1SavePostBody = new SalesCreditmemoRepositoryV1SavePostBody();

$result = $salesCreditmemoRepositoryV1->createSalesCreditmemoRepositoryV1SavePost($salesCreditmemoRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesCreditmemoCommentRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesCreditmemoCommentRepositoryV1Controller class can be accessed from the API Client.

$salesCreditmemoCommentRepositoryV1 = $client->getSalesCreditmemoCommentRepositoryV1();

createSalesCreditmemoCommentRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified entity.

function createSalesCreditmemoCommentRepositoryV1SavePost(
        $id,
        $salesCreditmemoCommentRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
salesCreditmemoCommentRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$salesCreditmemoCommentRepositoryV1SavePostBody = new SalesCreditmemoCommentRepositoryV1SavePostBody();

$result = $salesCreditmemoCommentRepositoryV1->createSalesCreditmemoCommentRepositoryV1SavePost($id, $salesCreditmemoCommentRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesRefundOrderV1Controller

Get singleton instance

The singleton instance of the SalesRefundOrderV1Controller class can be accessed from the API Client.

$salesRefundOrderV1 = $client->getSalesRefundOrderV1();

createSalesRefundOrderV1ExecutePost

Tags: Skips Authentication

Create offline refund for order

function createSalesRefundOrderV1ExecutePost(
        $orderId,
        $salesRefundOrderV1ExecutePostBody = null)

Parameters

Parameter	Tags	Description
orderId	Required	TODO: Add a parameter description
salesRefundOrderV1ExecutePostBody	Optional	TODO: Add a parameter description

Example Usage

$orderId = 191;
$salesRefundOrderV1ExecutePostBody = new SalesRefundOrderV1ExecutePostBody();

$result = $salesRefundOrderV1->createSalesRefundOrderV1ExecutePost($orderId, $salesRefundOrderV1ExecutePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesShipmentRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesShipmentRepositoryV1Controller class can be accessed from the API Client.

$salesShipmentRepositoryV1 = $client->getSalesShipmentRepositoryV1();

getSalesShipmentRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified shipment.

function getSalesShipmentRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The shipment ID.

Example Usage

$id = 191;

$result = $salesShipmentRepositoryV1->getSalesShipmentRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesShipmentRepositoryV1GetListGet

Tags: Skips Authentication

Lists shipments that match specified search 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#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesShipmentRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 191;
$searchCriteriaCurrentPage = 191;

$result = $salesShipmentRepositoryV1->getSalesShipmentRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesShipmentRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified shipment.

function createSalesShipmentRepositoryV1SavePost($salesShipmentRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesShipmentRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesShipmentRepositoryV1SavePostBody = new SalesShipmentRepositoryV1SavePostBody();

$result = $salesShipmentRepositoryV1->createSalesShipmentRepositoryV1SavePost($salesShipmentRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesShipmentManagementV1Controller

Get singleton instance

The singleton instance of the SalesShipmentManagementV1Controller class can be accessed from the API Client.

$salesShipmentManagementV1 = $client->getSalesShipmentManagementV1();

getSalesShipmentManagementV1GetCommentsListGet

Tags: Skips Authentication

Lists comments for a specified shipment.

function getSalesShipmentManagementV1GetCommentsListGet($id)

Parameters

Parameter	Tags	Description
id	Required	The shipment ID.

Example Usage

$id = 191;

$result = $salesShipmentManagementV1->getSalesShipmentManagementV1GetCommentsListGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createSalesShipmentManagementV1NotifyPost

Tags: Skips Authentication

Emails user a specified shipment.

function createSalesShipmentManagementV1NotifyPost($id)

Parameters

Parameter	Tags	Description
id	Required	The shipment ID.

Example Usage

$id = 191;

$result = $salesShipmentManagementV1->createSalesShipmentManagementV1NotifyPost($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesShipmentManagementV1GetLabelGet

Tags: Skips Authentication

Gets a specified shipment label.

function getSalesShipmentManagementV1GetLabelGet($id)

Parameters

Parameter	Tags	Description
id	Required	The shipment label ID.

Example Usage

$id = 191;

$result = $salesShipmentManagementV1->getSalesShipmentManagementV1GetLabelGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesShipmentCommentRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesShipmentCommentRepositoryV1Controller class can be accessed from the API Client.

$salesShipmentCommentRepositoryV1 = $client->getSalesShipmentCommentRepositoryV1();

createSalesShipmentCommentRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified shipment comment.

function createSalesShipmentCommentRepositoryV1SavePost(
        $id,
        $salesShipmentCommentRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
salesShipmentCommentRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$id = 'id';
$salesShipmentCommentRepositoryV1SavePostBody = new SalesShipmentCommentRepositoryV1SavePostBody();

$result = $salesShipmentCommentRepositoryV1->createSalesShipmentCommentRepositoryV1SavePost($id, $salesShipmentCommentRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesShipmentTrackRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesShipmentTrackRepositoryV1Controller class can be accessed from the API Client.

$salesShipmentTrackRepositoryV1 = $client->getSalesShipmentTrackRepositoryV1();

createSalesShipmentTrackRepositoryV1SavePost

Tags: Skips Authentication

Performs persist operations for a specified shipment track.

function createSalesShipmentTrackRepositoryV1SavePost($salesShipmentTrackRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesShipmentTrackRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesShipmentTrackRepositoryV1SavePostBody = new SalesShipmentTrackRepositoryV1SavePostBody();

$result = $salesShipmentTrackRepositoryV1->createSalesShipmentTrackRepositoryV1SavePost($salesShipmentTrackRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteSalesShipmentTrackRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Deletes a specified shipment track by ID.

function deleteSalesShipmentTrackRepositoryV1DeleteByIdDelete($id)

Parameters

Parameter	Tags	Description
id	Required	The shipment track ID.

Example Usage

$id = 191;

$result = $salesShipmentTrackRepositoryV1->deleteSalesShipmentTrackRepositoryV1DeleteByIdDelete($id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesShipOrderV1Controller

Get singleton instance

The singleton instance of the SalesShipOrderV1Controller class can be accessed from the API Client.

$salesShipOrderV1 = $client->getSalesShipOrderV1();

createSalesShipOrderV1ExecutePost

Tags: Skips Authentication

Creates new Shipment for given Order.

function createSalesShipOrderV1ExecutePost(
        $orderId,
        $salesShipOrderV1ExecutePostBody = null)

Parameters

Parameter	Tags	Description
orderId	Required	TODO: Add a parameter description
salesShipOrderV1ExecutePostBody	Optional	TODO: Add a parameter description

Example Usage

$orderId = 100;
$salesShipOrderV1ExecutePostBody = new SalesShipOrderV1ExecutePostBody();

$result = $salesShipOrderV1->createSalesShipOrderV1ExecutePost($orderId, $salesShipOrderV1ExecutePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesTransactionRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesTransactionRepositoryV1Controller class can be accessed from the API Client.

$salesTransactionRepositoryV1 = $client->getSalesTransactionRepositoryV1();

getSalesTransactionRepositoryV1GetGet

Tags: Skips Authentication

Loads a specified transaction.

function getSalesTransactionRepositoryV1GetGet($id)

Parameters

Parameter	Tags	Description
id	Required	The transaction ID.

Example Usage

$id = 100;

$result = $salesTransactionRepositoryV1->getSalesTransactionRepositoryV1GetGet($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

getSalesTransactionRepositoryV1GetListGet

Tags: Skips Authentication

Lists transactions that match specified search 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#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesTransactionRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 100;
$searchCriteriaCurrentPage = 100;

$result = $salesTransactionRepositoryV1->getSalesTransactionRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesInvoiceOrderV1Controller

Get singleton instance

The singleton instance of the SalesInvoiceOrderV1Controller class can be accessed from the API Client.

$salesInvoiceOrderV1 = $client->getSalesInvoiceOrderV1();

createSalesInvoiceOrderV1ExecutePost

Tags: Skips Authentication

TODO: Add a method description

function createSalesInvoiceOrderV1ExecutePost(
        $orderId,
        $salesInvoiceOrderV1ExecutePostBody = null)

Parameters

Parameter	Tags	Description
orderId	Required	TODO: Add a parameter description
salesInvoiceOrderV1ExecutePostBody	Optional	TODO: Add a parameter description

Example Usage

$orderId = 100;
$salesInvoiceOrderV1ExecutePostBody = new SalesInvoiceOrderV1ExecutePostBody();

$result = $salesInvoiceOrderV1->createSalesInvoiceOrderV1ExecutePost($orderId, $salesInvoiceOrderV1ExecutePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CheckoutGuestShippingInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutGuestShippingInformationManagementV1Controller class can be accessed from the API Client.

$checkoutGuestShippingInformationManagementV1 = $client->getCheckoutGuestShippingInformationManagementV1();

createCheckoutGuestShippingInformationManagementV1SaveAddressInformationPost

Tags: Skips Authentication

TODO: Add a method description

function createCheckoutGuestShippingInformationManagementV1SaveAddressInformationPost(
        $cartId,
        $checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody = new CheckoutGuestShippingInformationManagementV1SaveAddressInformationPostBody();

$result = $checkoutGuestShippingInformationManagementV1->createCheckoutGuestShippingInformationManagementV1SaveAddressInformationPost($cartId, $checkoutGuestShippingInformationManagementV1SaveAddressInformationPostBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

CheckoutShippingInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutShippingInformationManagementV1Controller class can be accessed from the API Client.

$checkoutShippingInformationManagementV1 = $client->getCheckoutShippingInformationManagementV1();

createCheckoutShippingInformationManagementV1SaveAddressInformationPost

Tags: Skips Authentication

TODO: Add a method description

function createCheckoutShippingInformationManagementV1SaveAddressInformationPost($checkoutShippingInformationManagementV1SaveAddressInformationPostBody = null)

Parameters

Parameter	Tags	Description
checkoutShippingInformationManagementV1SaveAddressInformationPostBody	Optional	TODO: Add a parameter description

Example Usage

$checkoutShippingInformationManagementV1SaveAddressInformationPostBody = new CheckoutShippingInformationManagementV1SaveAddressInformationPostBody();

$result = $checkoutShippingInformationManagementV1->createCheckoutShippingInformationManagementV1SaveAddressInformationPost($checkoutShippingInformationManagementV1SaveAddressInformationPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCheckoutShippingInformationManagementV1SaveAddressInformationPost1

Tags: Skips Authentication

TODO: Add a method description

function createCheckoutShippingInformationManagementV1SaveAddressInformationPost1(
        $cartId,
        $checkoutShippingInformationManagementV1SaveAddressInformationPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutShippingInformationManagementV1SaveAddressInformationPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 100;
$checkoutShippingInformationManagementV1SaveAddressInformationPostBody = new CheckoutShippingInformationManagementV1SaveAddressInformationPostBody();

$result = $checkoutShippingInformationManagementV1->createCheckoutShippingInformationManagementV1SaveAddressInformationPost1($cartId, $checkoutShippingInformationManagementV1SaveAddressInformationPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CheckoutTotalsInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutTotalsInformationManagementV1Controller class can be accessed from the API Client.

$checkoutTotalsInformationManagementV1 = $client->getCheckoutTotalsInformationManagementV1();

createCheckoutTotalsInformationManagementV1CalculatePost

Tags: Skips Authentication

Calculate quote totals based on address and shipping method.

function createCheckoutTotalsInformationManagementV1CalculatePost(
        $cartId,
        $checkoutTotalsInformationManagementV1CalculatePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutTotalsInformationManagementV1CalculatePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 100;
$checkoutTotalsInformationManagementV1CalculatePostBody = new CheckoutTotalsInformationManagementV1CalculatePostBody();

$result = $checkoutTotalsInformationManagementV1->createCheckoutTotalsInformationManagementV1CalculatePost($cartId, $checkoutTotalsInformationManagementV1CalculatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCheckoutTotalsInformationManagementV1CalculatePost1

Tags: Skips Authentication

Calculate quote totals based on address and shipping method.

function createCheckoutTotalsInformationManagementV1CalculatePost1($checkoutTotalsInformationManagementV1CalculatePostBody = null)

Parameters

Parameter	Tags	Description
checkoutTotalsInformationManagementV1CalculatePostBody	Optional	TODO: Add a parameter description

Example Usage

$checkoutTotalsInformationManagementV1CalculatePostBody = new CheckoutTotalsInformationManagementV1CalculatePostBody();

$result = $checkoutTotalsInformationManagementV1->createCheckoutTotalsInformationManagementV1CalculatePost1($checkoutTotalsInformationManagementV1CalculatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CheckoutGuestTotalsInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutGuestTotalsInformationManagementV1Controller class can be accessed from the API Client.

$checkoutGuestTotalsInformationManagementV1 = $client->getCheckoutGuestTotalsInformationManagementV1();

createCheckoutGuestTotalsInformationManagementV1CalculatePost

Tags: Skips Authentication

Calculate quote totals based on address and shipping method.

function createCheckoutGuestTotalsInformationManagementV1CalculatePost(
        $cartId,
        $checkoutGuestTotalsInformationManagementV1CalculatePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutGuestTotalsInformationManagementV1CalculatePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$checkoutGuestTotalsInformationManagementV1CalculatePostBody = new CheckoutGuestTotalsInformationManagementV1CalculatePostBody();

$result = $checkoutGuestTotalsInformationManagementV1->createCheckoutGuestTotalsInformationManagementV1CalculatePost($cartId, $checkoutGuestTotalsInformationManagementV1CalculatePostBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

CheckoutGuestPaymentInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutGuestPaymentInformationManagementV1Controller class can be accessed from the API Client.

$checkoutGuestPaymentInformationManagementV1 = $client->getCheckoutGuestPaymentInformationManagementV1();

getCheckoutGuestPaymentInformationManagementV1GetPaymentInformationGet

Tags: Skips Authentication

Get payment information

function getCheckoutGuestPaymentInformationManagementV1GetPaymentInformationGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $checkoutGuestPaymentInformationManagementV1->getCheckoutGuestPaymentInformationManagementV1GetPaymentInformationGet($cartId);

Errors

Error Code	Error Description
0	Unexpected error

createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost(
        $cartId,
        $checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody = new CheckoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $checkoutGuestPaymentInformationManagementV1->createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost($cartId, $checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationPost

Tags: Skips Authentication

Set payment information for a specified cart.

function createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationPost(
        $cartId,
        $checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description
checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody = new CheckoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $checkoutGuestPaymentInformationManagementV1->createCheckoutGuestPaymentInformationManagementV1SavePaymentInformationPost($cartId, $checkoutGuestPaymentInformationManagementV1SavePaymentInformationPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

CheckoutPaymentInformationManagementV1Controller

Get singleton instance

The singleton instance of the CheckoutPaymentInformationManagementV1Controller class can be accessed from the API Client.

$checkoutPaymentInformationManagementV1 = $client->getCheckoutPaymentInformationManagementV1();

getCheckoutPaymentInformationManagementV1GetPaymentInformationGet

Tags: Skips Authentication

Get payment information

function getCheckoutPaymentInformationManagementV1GetPaymentInformationGet()

Example Usage

$result = $checkoutPaymentInformationManagementV1->getCheckoutPaymentInformationManagementV1GetPaymentInformationGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createCheckoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createCheckoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost($checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody = new CheckoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $checkoutPaymentInformationManagementV1->createCheckoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost($checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createCheckoutPaymentInformationManagementV1SavePaymentInformationPost

Tags: Skips Authentication

Set payment information for a specified cart.

function createCheckoutPaymentInformationManagementV1SavePaymentInformationPost($checkoutPaymentInformationManagementV1SavePaymentInformationPostBody = null)

Parameters

Parameter	Tags	Description
checkoutPaymentInformationManagementV1SavePaymentInformationPostBody	Optional	TODO: Add a parameter description

Example Usage

$checkoutPaymentInformationManagementV1SavePaymentInformationPostBody = new CheckoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $checkoutPaymentInformationManagementV1->createCheckoutPaymentInformationManagementV1SavePaymentInformationPost($checkoutPaymentInformationManagementV1SavePaymentInformationPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

BundleProductLinkManagementV1Controller

Get singleton instance

The singleton instance of the BundleProductLinkManagementV1Controller class can be accessed from the API Client.

$bundleProductLinkManagementV1 = $client->getBundleProductLinkManagementV1();

createBundleProductLinkManagementV1AddChildByProductSkuPost

Tags: Skips Authentication

Add child product to specified Bundle option by product sku

function createBundleProductLinkManagementV1AddChildByProductSkuPost(
        $sku,
        $optionId,
        $bundleProductLinkManagementV1AddChildByProductSkuPostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description
bundleProductLinkManagementV1AddChildByProductSkuPostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 100;
$bundleProductLinkManagementV1AddChildByProductSkuPostBody = new BundleProductLinkManagementV1AddChildByProductSkuPostBody();

$result = $bundleProductLinkManagementV1->createBundleProductLinkManagementV1AddChildByProductSkuPost($sku, $optionId, $bundleProductLinkManagementV1AddChildByProductSkuPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateBundleProductLinkManagementV1SaveChildPut

Tags: Skips Authentication

TODO: Add a method description

function updateBundleProductLinkManagementV1SaveChildPut(
        $sku,
        $id,
        $bundleProductLinkManagementV1SaveChildPutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description
bundleProductLinkManagementV1SaveChildPutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 'id';
$bundleProductLinkManagementV1SaveChildPutBody = new BundleProductLinkManagementV1AddChildByProductSkuPostBody();

$result = $bundleProductLinkManagementV1->updateBundleProductLinkManagementV1SaveChildPut($sku, $id, $bundleProductLinkManagementV1SaveChildPutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getBundleProductLinkManagementV1GetChildrenGet

Tags: Skips Authentication

Get all children for Bundle product

function getBundleProductLinkManagementV1GetChildrenGet(
        $productSku,
        $optionId = null)

Parameters

Parameter	Tags	Description
productSku	Required	TODO: Add a parameter description
optionId	Optional	TODO: Add a parameter description

Example Usage

$productSku = 'productSku';
$optionId = 100;

$result = $bundleProductLinkManagementV1->getBundleProductLinkManagementV1GetChildrenGet($productSku, $optionId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteBundleProductLinkManagementV1RemoveChildDelete

Tags: Skips Authentication

Remove product from Bundle product option

function deleteBundleProductLinkManagementV1RemoveChildDelete(
        $sku,
        $optionId,
        $childSku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description
childSku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 141;
$childSku = 'childSku';

$result = $bundleProductLinkManagementV1->deleteBundleProductLinkManagementV1RemoveChildDelete($sku, $optionId, $childSku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

BundleProductOptionRepositoryV1Controller

Get singleton instance

The singleton instance of the BundleProductOptionRepositoryV1Controller class can be accessed from the API Client.

$bundleProductOptionRepositoryV1 = $client->getBundleProductOptionRepositoryV1();

getBundleProductOptionRepositoryV1GetListGet

Tags: Skips Authentication

Get all options for bundle product

function getBundleProductOptionRepositoryV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $bundleProductOptionRepositoryV1->getBundleProductOptionRepositoryV1GetListGet($sku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getBundleProductOptionRepositoryV1GetGet

Tags: Skips Authentication

Get option for bundle product

function getBundleProductOptionRepositoryV1GetGet(
        $sku,
        $optionId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 141;

$result = $bundleProductOptionRepositoryV1->getBundleProductOptionRepositoryV1GetGet($sku, $optionId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteBundleProductOptionRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove bundle option

function deleteBundleProductOptionRepositoryV1DeleteByIdDelete(
        $sku,
        $optionId)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
optionId	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$optionId = 141;

$result = $bundleProductOptionRepositoryV1->deleteBundleProductOptionRepositoryV1DeleteByIdDelete($sku, $optionId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

BundleProductOptionTypeListV1Controller

Get singleton instance

The singleton instance of the BundleProductOptionTypeListV1Controller class can be accessed from the API Client.

$bundleProductOptionTypeListV1 = $client->getBundleProductOptionTypeListV1();

getBundleProductOptionTypeListV1GetItemsGet

Tags: Skips Authentication

Get all types for options for bundle products

function getBundleProductOptionTypeListV1GetItemsGet()

Example Usage

$result = $bundleProductOptionTypeListV1->getBundleProductOptionTypeListV1GetItemsGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

BundleProductOptionManagementV1Controller

Get singleton instance

The singleton instance of the BundleProductOptionManagementV1Controller class can be accessed from the API Client.

$bundleProductOptionManagementV1 = $client->getBundleProductOptionManagementV1();

createBundleProductOptionManagementV1SavePost

Tags: Skips Authentication

Add new option for bundle product

function createBundleProductOptionManagementV1SavePost($bundleProductOptionManagementV1SavePostBody = null)

Parameters

Parameter	Tags	Description
bundleProductOptionManagementV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$bundleProductOptionManagementV1SavePostBody = new BundleProductOptionManagementV1SavePostBody();

$result = $bundleProductOptionManagementV1->createBundleProductOptionManagementV1SavePost($bundleProductOptionManagementV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateBundleProductOptionManagementV1SavePut

Tags: Skips Authentication

Add new option for bundle product

function updateBundleProductOptionManagementV1SavePut(
        $optionId,
        $bundleProductOptionManagementV1SavePutBody = null)

Parameters

Parameter	Tags	Description
optionId	Required	TODO: Add a parameter description
bundleProductOptionManagementV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$optionId = 'optionId';
$bundleProductOptionManagementV1SavePutBody = new BundleProductOptionManagementV1SavePostBody();

$result = $bundleProductOptionManagementV1->updateBundleProductOptionManagementV1SavePut($optionId, $bundleProductOptionManagementV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

CheckoutAgreementsCheckoutAgreementsRepositoryV1Controller

Get singleton instance

The singleton instance of the CheckoutAgreementsCheckoutAgreementsRepositoryV1Controller class can be accessed from the API Client.

$checkoutAgreementsCheckoutAgreementsRepositoryV1 = $client->getCheckoutAgreementsCheckoutAgreementsRepositoryV1();

getCheckoutAgreementsCheckoutAgreementsRepositoryV1GetListGet

Tags: Skips Authentication

Lists active checkout agreements.

function getCheckoutAgreementsCheckoutAgreementsRepositoryV1GetListGet()

Example Usage

$result = $checkoutAgreementsCheckoutAgreementsRepositoryV1->getCheckoutAgreementsCheckoutAgreementsRepositoryV1GetListGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

ConfigurableProductLinkManagementV1Controller

Get singleton instance

The singleton instance of the ConfigurableProductLinkManagementV1Controller class can be accessed from the API Client.

$configurableProductLinkManagementV1 = $client->getConfigurableProductLinkManagementV1();

getConfigurableProductLinkManagementV1GetChildrenGet

Tags: Skips Authentication

Get all children for Configurable product

function getConfigurableProductLinkManagementV1GetChildrenGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $configurableProductLinkManagementV1->getConfigurableProductLinkManagementV1GetChildrenGet($sku);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteConfigurableProductLinkManagementV1RemoveChildDelete

Tags: Skips Authentication

Remove configurable product option

function deleteConfigurableProductLinkManagementV1RemoveChildDelete(
        $sku,
        $childSku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
childSku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$childSku = 'childSku';

$result = $configurableProductLinkManagementV1->deleteConfigurableProductLinkManagementV1RemoveChildDelete($sku, $childSku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createConfigurableProductLinkManagementV1AddChildPost

Tags: Skips Authentication

TODO: Add a method description

function createConfigurableProductLinkManagementV1AddChildPost(
        $sku,
        $configurableProductLinkManagementV1AddChildPostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
configurableProductLinkManagementV1AddChildPostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$configurableProductLinkManagementV1AddChildPostBody = new ConfigurableProductLinkManagementV1AddChildPostBody();

$result = $configurableProductLinkManagementV1->createConfigurableProductLinkManagementV1AddChildPost($sku, $configurableProductLinkManagementV1AddChildPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

ConfigurableProductConfigurableProductManagementV1Controller

Get singleton instance

The singleton instance of the ConfigurableProductConfigurableProductManagementV1Controller class can be accessed from the API Client.

$configurableProductConfigurableProductManagementV1 = $client->getConfigurableProductConfigurableProductManagementV1();

updateConfigurableProductConfigurableProductManagementV1GenerateVariationPut

Tags: Skips Authentication

Generate variation based on same product

function updateConfigurableProductConfigurableProductManagementV1GenerateVariationPut($configurableProductConfigurableProductManagementV1GenerateVariationPutBody = null)

Parameters

Parameter	Tags	Description
configurableProductConfigurableProductManagementV1GenerateVariationPutBody	Optional	TODO: Add a parameter description

Example Usage

$configurableProductConfigurableProductManagementV1GenerateVariationPutBody = new ConfigurableProductConfigurableProductManagementV1GenerateVariationPutBody();

$result = $configurableProductConfigurableProductManagementV1->updateConfigurableProductConfigurableProductManagementV1GenerateVariationPut($configurableProductConfigurableProductManagementV1GenerateVariationPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

ConfigurableProductOptionRepositoryV1Controller

Get singleton instance

The singleton instance of the ConfigurableProductOptionRepositoryV1Controller class can be accessed from the API Client.

$configurableProductOptionRepositoryV1 = $client->getConfigurableProductOptionRepositoryV1();

getConfigurableProductOptionRepositoryV1GetGet

Tags: Skips Authentication

Get option for configurable product

function getConfigurableProductOptionRepositoryV1GetGet(
        $sku,
        $id)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 141;

$result = $configurableProductOptionRepositoryV1->getConfigurableProductOptionRepositoryV1GetGet($sku, $id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateConfigurableProductOptionRepositoryV1SavePut

Tags: Skips Authentication

Save option

function updateConfigurableProductOptionRepositoryV1SavePut(
        $sku,
        $id,
        $configurableProductOptionRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description
configurableProductOptionRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 'id';
$configurableProductOptionRepositoryV1SavePutBody = new ConfigurableProductOptionRepositoryV1SavePutBody();

$result = $configurableProductOptionRepositoryV1->updateConfigurableProductOptionRepositoryV1SavePut($sku, $id, $configurableProductOptionRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteConfigurableProductOptionRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Remove option from configurable product

function deleteConfigurableProductOptionRepositoryV1DeleteByIdDelete(
        $sku,
        $id)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 141;

$result = $configurableProductOptionRepositoryV1->deleteConfigurableProductOptionRepositoryV1DeleteByIdDelete($sku, $id);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getConfigurableProductOptionRepositoryV1GetListGet

Tags: Skips Authentication

Get all options for configurable product

function getConfigurableProductOptionRepositoryV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $configurableProductOptionRepositoryV1->getConfigurableProductOptionRepositoryV1GetListGet($sku);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createConfigurableProductOptionRepositoryV1SavePost

Tags: Skips Authentication

Save option

function createConfigurableProductOptionRepositoryV1SavePost(
        $sku,
        $configurableProductOptionRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
configurableProductOptionRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$configurableProductOptionRepositoryV1SavePostBody = new ConfigurableProductOptionRepositoryV1SavePutBody();

$result = $configurableProductOptionRepositoryV1->createConfigurableProductOptionRepositoryV1SavePost($sku, $configurableProductOptionRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteServerManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteServerManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteServerManagementV1 = $client->getEbizmartsSagePaySuiteServerManagementV1();

createEbizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createEbizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
ebizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$ebizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPostBody = new EbizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $ebizmartsSagePaySuiteServerManagementV1->createEbizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteServerManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteGuestServerManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteGuestServerManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteGuestServerManagementV1 = $client->getEbizmartsSagePaySuiteGuestServerManagementV1();

createEbizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createEbizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
ebizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$ebizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPostBody = new EbizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $ebizmartsSagePaySuiteGuestServerManagementV1->createEbizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteGuestServerManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteFormManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteFormManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteFormManagementV1 = $client->getEbizmartsSagePaySuiteFormManagementV1();

getEbizmartsSagePaySuiteFormManagementV1GetEncryptedRequestGet

Tags: Skips Authentication

TODO: Add a method description

function getEbizmartsSagePaySuiteFormManagementV1GetEncryptedRequestGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $ebizmartsSagePaySuiteFormManagementV1->getEbizmartsSagePaySuiteFormManagementV1GetEncryptedRequestGet($cartId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteGuestFormManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteGuestFormManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteGuestFormManagementV1 = $client->getEbizmartsSagePaySuiteGuestFormManagementV1();

getEbizmartsSagePaySuiteGuestFormManagementV1GetEncryptedRequestGet

Tags: Skips Authentication

TODO: Add a method description

function getEbizmartsSagePaySuiteGuestFormManagementV1GetEncryptedRequestGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $ebizmartsSagePaySuiteGuestFormManagementV1->getEbizmartsSagePaySuiteGuestFormManagementV1GetEncryptedRequestGet($cartId);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuitePayPalManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuitePayPalManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuitePayPalManagementV1 = $client->getEbizmartsSagePaySuitePayPalManagementV1();

getEbizmartsSagePaySuitePayPalManagementV1SavePaymentInformationAndPlaceOrderGet

Tags: Skips Authentication

TODO: Add a method description

function getEbizmartsSagePaySuitePayPalManagementV1SavePaymentInformationAndPlaceOrderGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $ebizmartsSagePaySuitePayPalManagementV1->getEbizmartsSagePaySuitePayPalManagementV1SavePaymentInformationAndPlaceOrderGet($cartId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteGuestPayPalManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteGuestPayPalManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteGuestPayPalManagementV1 = $client->getEbizmartsSagePaySuiteGuestPayPalManagementV1();

getEbizmartsSagePaySuiteGuestPayPalManagementV1SavePaymentInformationAndPlaceOrderGet

Tags: Skips Authentication

TODO: Add a method description

function getEbizmartsSagePaySuiteGuestPayPalManagementV1SavePaymentInformationAndPlaceOrderGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';

$result = $ebizmartsSagePaySuiteGuestPayPalManagementV1->getEbizmartsSagePaySuiteGuestPayPalManagementV1SavePaymentInformationAndPlaceOrderGet($cartId);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuitePiMerchantV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuitePiMerchantV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuitePiMerchantV1 = $client->getEbizmartsSagePaySuitePiMerchantV1();

getEbizmartsSagePaySuitePiMerchantV1GetSessionKeyGet

Tags: Skips Authentication

Creates a merchant session key (MSK).

function getEbizmartsSagePaySuitePiMerchantV1GetSessionKeyGet()

Example Usage

$result = $ebizmartsSagePaySuitePiMerchantV1->getEbizmartsSagePaySuitePiMerchantV1GetSessionKeyGet();

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuitePiManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuitePiManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuitePiManagementV1 = $client->getEbizmartsSagePaySuitePiManagementV1();

createEbizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createEbizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
ebizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$ebizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPostBody = new EbizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $ebizmartsSagePaySuitePiManagementV1->createEbizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuitePiManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

EbizmartsSagePaySuiteGuestPiManagementV1Controller

Get singleton instance

The singleton instance of the EbizmartsSagePaySuiteGuestPiManagementV1Controller class can be accessed from the API Client.

$ebizmartsSagePaySuiteGuestPiManagementV1 = $client->getEbizmartsSagePaySuiteGuestPiManagementV1();

createEbizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPost

Tags: Skips Authentication

Set payment information and place order for a specified cart.

function createEbizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
ebizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$ebizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPostBody = new EbizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPostBody();

$result = $ebizmartsSagePaySuiteGuestPiManagementV1->createEbizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPost($ebizmartsSagePaySuiteGuestPiManagementV1SavePaymentInformationAndPlaceOrderPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

IntegrationAdminTokenServiceV1Controller

Get singleton instance

The singleton instance of the IntegrationAdminTokenServiceV1Controller class can be accessed from the API Client.

$integrationAdminTokenServiceV1 = $client->getIntegrationAdminTokenServiceV1();

createIntegrationAdminTokenServiceV1CreateAdminAccessTokenPost

Tags: Skips Authentication

Create access token for admin given the admin credentials.

function createIntegrationAdminTokenServiceV1CreateAdminAccessTokenPost($integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody = null)

Parameters

Parameter	Tags	Description
integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody	Optional	TODO: Add a parameter description

Example Usage

$integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody = new IntegrationAdminTokenServiceV1CreateAdminAccessTokenPostBody();

$result = $integrationAdminTokenServiceV1->createIntegrationAdminTokenServiceV1CreateAdminAccessTokenPost($integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
500	Internal Server error
0	Unexpected error

Back to List of Controllers

IntegrationCustomerTokenServiceV1Controller

Get singleton instance

The singleton instance of the IntegrationCustomerTokenServiceV1Controller class can be accessed from the API Client.

$integrationCustomerTokenServiceV1 = $client->getIntegrationCustomerTokenServiceV1();

createIntegrationCustomerTokenServiceV1CreateCustomerAccessTokenPost

Tags: Skips Authentication

Create access token for admin given the customer credentials.

function createIntegrationCustomerTokenServiceV1CreateCustomerAccessTokenPost($integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody = null)

Parameters

Parameter	Tags	Description
integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody	Optional	TODO: Add a parameter description

Example Usage

$integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody = new IntegrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody();

$result = $integrationCustomerTokenServiceV1->createIntegrationCustomerTokenServiceV1CreateCustomerAccessTokenPost($integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

DownloadableLinkRepositoryV1Controller

Get singleton instance

The singleton instance of the DownloadableLinkRepositoryV1Controller class can be accessed from the API Client.

$downloadableLinkRepositoryV1 = $client->getDownloadableLinkRepositoryV1();

getDownloadableLinkRepositoryV1GetListGet

Tags: Skips Authentication

List of links with associated samples

function getDownloadableLinkRepositoryV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $downloadableLinkRepositoryV1->getDownloadableLinkRepositoryV1GetListGet($sku);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createDownloadableLinkRepositoryV1SavePost

Tags: Skips Authentication

Update downloadable link of the given product (link type and its resources cannot be changed)

function createDownloadableLinkRepositoryV1SavePost(
        $sku,
        $downloadableLinkRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
downloadableLinkRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$downloadableLinkRepositoryV1SavePostBody = new DownloadableLinkRepositoryV1SavePostBody();

$result = $downloadableLinkRepositoryV1->createDownloadableLinkRepositoryV1SavePost($sku, $downloadableLinkRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateDownloadableLinkRepositoryV1SavePut

Tags: Skips Authentication

Update downloadable link of the given product (link type and its resources cannot be changed)

function updateDownloadableLinkRepositoryV1SavePut(
        $sku,
        $id,
        $downloadableLinkRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description
downloadableLinkRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 'id';
$downloadableLinkRepositoryV1SavePutBody = new DownloadableLinkRepositoryV1SavePostBody();

$result = $downloadableLinkRepositoryV1->updateDownloadableLinkRepositoryV1SavePut($sku, $id, $downloadableLinkRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteDownloadableLinkRepositoryV1DeleteDelete

Tags: Skips Authentication

Delete downloadable link

function deleteDownloadableLinkRepositoryV1DeleteDelete($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 50;

$result = $downloadableLinkRepositoryV1->deleteDownloadableLinkRepositoryV1DeleteDelete($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

DownloadableSampleRepositoryV1Controller

Get singleton instance

The singleton instance of the DownloadableSampleRepositoryV1Controller class can be accessed from the API Client.

$downloadableSampleRepositoryV1 = $client->getDownloadableSampleRepositoryV1();

getDownloadableSampleRepositoryV1GetListGet

Tags: Skips Authentication

List of samples for downloadable product

function getDownloadableSampleRepositoryV1GetListGet($sku)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description

Example Usage

$sku = 'sku';

$result = $downloadableSampleRepositoryV1->getDownloadableSampleRepositoryV1GetListGet($sku);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createDownloadableSampleRepositoryV1SavePost

Tags: Skips Authentication

Update downloadable sample of the given product

function createDownloadableSampleRepositoryV1SavePost(
        $sku,
        $downloadableSampleRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
downloadableSampleRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$downloadableSampleRepositoryV1SavePostBody = new DownloadableSampleRepositoryV1SavePostBody();

$result = $downloadableSampleRepositoryV1->createDownloadableSampleRepositoryV1SavePost($sku, $downloadableSampleRepositoryV1SavePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

updateDownloadableSampleRepositoryV1SavePut

Tags: Skips Authentication

Update downloadable sample of the given product

function updateDownloadableSampleRepositoryV1SavePut(
        $sku,
        $id,
        $downloadableSampleRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
sku	Required	TODO: Add a parameter description
id	Required	TODO: Add a parameter description
downloadableSampleRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$sku = 'sku';
$id = 'id';
$downloadableSampleRepositoryV1SavePutBody = new DownloadableSampleRepositoryV1SavePostBody();

$result = $downloadableSampleRepositoryV1->updateDownloadableSampleRepositoryV1SavePut($sku, $id, $downloadableSampleRepositoryV1SavePutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteDownloadableSampleRepositoryV1DeleteDelete

Tags: Skips Authentication

Delete downloadable sample

function deleteDownloadableSampleRepositoryV1DeleteDelete($id)

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

$id = 50;

$result = $downloadableSampleRepositoryV1->deleteDownloadableSampleRepositoryV1DeleteDelete($id);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

GiftMessageCartRepositoryV1Controller

Get singleton instance

The singleton instance of the GiftMessageCartRepositoryV1Controller class can be accessed from the API Client.

$giftMessageCartRepositoryV1 = $client->getGiftMessageCartRepositoryV1();

getGiftMessageCartRepositoryV1GetGet

Tags: Skips Authentication

Return the gift message for a specified order.

function getGiftMessageCartRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.

Example Usage

$cartId = 50;

$result = $giftMessageCartRepositoryV1->getGiftMessageCartRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createGiftMessageCartRepositoryV1SavePost

Tags: Skips Authentication

Set the gift message for an entire order.

function createGiftMessageCartRepositoryV1SavePost(
        $cartId,
        $giftMessageCartRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
giftMessageCartRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 50;
$giftMessageCartRepositoryV1SavePostBody = new GiftMessageCartRepositoryV1SavePostBody();

$result = $giftMessageCartRepositoryV1->createGiftMessageCartRepositoryV1SavePost($cartId, $giftMessageCartRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getGiftMessageCartRepositoryV1GetGet1

Tags: Skips Authentication

Return the gift message for a specified order.

function getGiftMessageCartRepositoryV1GetGet1()

Example Usage

$result = $giftMessageCartRepositoryV1->getGiftMessageCartRepositoryV1GetGet1();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createGiftMessageCartRepositoryV1SavePost1

Tags: Skips Authentication

Set the gift message for an entire order.

function createGiftMessageCartRepositoryV1SavePost1($giftMessageCartRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
giftMessageCartRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$giftMessageCartRepositoryV1SavePostBody = new GiftMessageCartRepositoryV1SavePostBody();

$result = $giftMessageCartRepositoryV1->createGiftMessageCartRepositoryV1SavePost1($giftMessageCartRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

GiftMessageItemRepositoryV1Controller

Get singleton instance

The singleton instance of the GiftMessageItemRepositoryV1Controller class can be accessed from the API Client.

$giftMessageItemRepositoryV1 = $client->getGiftMessageItemRepositoryV1();

getGiftMessageItemRepositoryV1GetGet

Tags: Skips Authentication

Return the gift message for a specified item in a specified shopping cart.

function getGiftMessageItemRepositoryV1GetGet(
        $cartId,
        $itemId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.
itemId	Required	The item ID.

Example Usage

$cartId = 50;
$itemId = 50;

$result = $giftMessageItemRepositoryV1->getGiftMessageItemRepositoryV1GetGet($cartId, $itemId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createGiftMessageItemRepositoryV1SavePost

Tags: Skips Authentication

Set the gift message for a specified item in a specified shopping cart.

function createGiftMessageItemRepositoryV1SavePost(
        $cartId,
        $itemId,
        $giftMessageItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
itemId	Required	The item ID.
giftMessageItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 213;
$itemId = 213;
$giftMessageItemRepositoryV1SavePostBody = new GiftMessageItemRepositoryV1SavePostBody();

$result = $giftMessageItemRepositoryV1->createGiftMessageItemRepositoryV1SavePost($cartId, $itemId, $giftMessageItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

getGiftMessageItemRepositoryV1GetGet1

Tags: Skips Authentication

Return the gift message for a specified item in a specified shopping cart.

function getGiftMessageItemRepositoryV1GetGet1($itemId)

Parameters

Parameter	Tags	Description
itemId	Required	The item ID.

Example Usage

$itemId = 213;

$result = $giftMessageItemRepositoryV1->getGiftMessageItemRepositoryV1GetGet1($itemId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

createGiftMessageItemRepositoryV1SavePost1

Tags: Skips Authentication

Set the gift message for a specified item in a specified shopping cart.

function createGiftMessageItemRepositoryV1SavePost1(
        $itemId,
        $giftMessageItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
itemId	Required	The item ID.
giftMessageItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$itemId = 213;
$giftMessageItemRepositoryV1SavePostBody = new GiftMessageItemRepositoryV1SavePostBody();

$result = $giftMessageItemRepositoryV1->createGiftMessageItemRepositoryV1SavePost1($itemId, $giftMessageItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

GiftMessageGuestCartRepositoryV1Controller

Get singleton instance

The singleton instance of the GiftMessageGuestCartRepositoryV1Controller class can be accessed from the API Client.

$giftMessageGuestCartRepositoryV1 = $client->getGiftMessageGuestCartRepositoryV1();

getGiftMessageGuestCartRepositoryV1GetGet

Tags: Skips Authentication

Return the gift message for a specified order.

function getGiftMessageGuestCartRepositoryV1GetGet($cartId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.

Example Usage

$cartId = 'cartId';

$result = $giftMessageGuestCartRepositoryV1->getGiftMessageGuestCartRepositoryV1GetGet($cartId);

Errors

Error Code	Error Description
0	Unexpected error

createGiftMessageGuestCartRepositoryV1SavePost

Tags: Skips Authentication

Set the gift message for an entire order.

function createGiftMessageGuestCartRepositoryV1SavePost(
        $cartId,
        $giftMessageGuestCartRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
giftMessageGuestCartRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$giftMessageGuestCartRepositoryV1SavePostBody = new GiftMessageGuestCartRepositoryV1SavePostBody();

$result = $giftMessageGuestCartRepositoryV1->createGiftMessageGuestCartRepositoryV1SavePost($cartId, $giftMessageGuestCartRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

GiftMessageGuestItemRepositoryV1Controller

Get singleton instance

The singleton instance of the GiftMessageGuestItemRepositoryV1Controller class can be accessed from the API Client.

$giftMessageGuestItemRepositoryV1 = $client->getGiftMessageGuestItemRepositoryV1();

getGiftMessageGuestItemRepositoryV1GetGet

Tags: Skips Authentication

Return the gift message for a specified item in a specified shopping cart.

function getGiftMessageGuestItemRepositoryV1GetGet(
        $cartId,
        $itemId)

Parameters

Parameter	Tags	Description
cartId	Required	The shopping cart ID.
itemId	Required	The item ID.

Example Usage

$cartId = 'cartId';
$itemId = 213;

$result = $giftMessageGuestItemRepositoryV1->getGiftMessageGuestItemRepositoryV1GetGet($cartId, $itemId);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

createGiftMessageGuestItemRepositoryV1SavePost

Tags: Skips Authentication

Set the gift message for a specified item in a specified shopping cart.

function createGiftMessageGuestItemRepositoryV1SavePost(
        $cartId,
        $itemId,
        $giftMessageGuestItemRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	The cart ID.
itemId	Required	The item ID.
giftMessageGuestItemRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$itemId = 213;
$giftMessageGuestItemRepositoryV1SavePostBody = new GiftMessageGuestItemRepositoryV1SavePostBody();

$result = $giftMessageGuestItemRepositoryV1->createGiftMessageGuestItemRepositoryV1SavePost($cartId, $itemId, $giftMessageGuestItemRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
0	Unexpected error

Back to List of Controllers

AnalyticsLinkProviderV1Controller

Get singleton instance

The singleton instance of the AnalyticsLinkProviderV1Controller class can be accessed from the API Client.

$analyticsLinkProviderV1 = $client->getAnalyticsLinkProviderV1();

getAnalyticsLinkProviderV1GetGet

Tags: Skips Authentication

TODO: Add a method description

function getAnalyticsLinkProviderV1GetGet()

Example Usage

$result = $analyticsLinkProviderV1->getAnalyticsLinkProviderV1GetGet();

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

SalesRuleRuleRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesRuleRuleRepositoryV1Controller class can be accessed from the API Client.

$salesRuleRuleRepositoryV1 = $client->getSalesRuleRuleRepositoryV1();

getSalesRuleRuleRepositoryV1GetByIdGet

Tags: Skips Authentication

Get rule by ID.

function getSalesRuleRuleRepositoryV1GetByIdGet($ruleId)

Parameters

Parameter	Tags	Description
ruleId	Required	TODO: Add a parameter description

Example Usage

$ruleId = 213;

$result = $salesRuleRuleRepositoryV1->getSalesRuleRuleRepositoryV1GetByIdGet($ruleId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateSalesRuleRuleRepositoryV1SavePut

Tags: Skips Authentication

Save sales rule.

function updateSalesRuleRuleRepositoryV1SavePut(
        $ruleId,
        $salesRuleRuleRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
ruleId	Required	TODO: Add a parameter description
salesRuleRuleRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$ruleId = 'ruleId';
$salesRuleRuleRepositoryV1SavePutBody = new SalesRuleRuleRepositoryV1SavePutBody();

$result = $salesRuleRuleRepositoryV1->updateSalesRuleRuleRepositoryV1SavePut($ruleId, $salesRuleRuleRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteSalesRuleRuleRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete rule by ID.

function deleteSalesRuleRuleRepositoryV1DeleteByIdDelete($ruleId)

Parameters

Parameter	Tags	Description
ruleId	Required	TODO: Add a parameter description

Example Usage

$ruleId = 213;

$result = $salesRuleRuleRepositoryV1->deleteSalesRuleRuleRepositoryV1DeleteByIdDelete($ruleId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getSalesRuleRuleRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve sales rules that match te specified 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#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesRuleRuleRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 213;
$searchCriteriaCurrentPage = 213;

$result = $salesRuleRuleRepositoryV1->getSalesRuleRuleRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createSalesRuleRuleRepositoryV1SavePost

Tags: Skips Authentication

Save sales rule.

function createSalesRuleRuleRepositoryV1SavePost($salesRuleRuleRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesRuleRuleRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesRuleRuleRepositoryV1SavePostBody = new SalesRuleRuleRepositoryV1SavePutBody();

$result = $salesRuleRuleRepositoryV1->createSalesRuleRuleRepositoryV1SavePost($salesRuleRuleRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

SalesRuleCouponRepositoryV1Controller

Get singleton instance

The singleton instance of the SalesRuleCouponRepositoryV1Controller class can be accessed from the API Client.

$salesRuleCouponRepositoryV1 = $client->getSalesRuleCouponRepositoryV1();

getSalesRuleCouponRepositoryV1GetByIdGet

Tags: Skips Authentication

Get coupon by coupon id.

function getSalesRuleCouponRepositoryV1GetByIdGet($couponId)

Parameters

Parameter	Tags	Description
couponId	Required	TODO: Add a parameter description

Example Usage

$couponId = 0;

$result = $salesRuleCouponRepositoryV1->getSalesRuleCouponRepositoryV1GetByIdGet($couponId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

updateSalesRuleCouponRepositoryV1SavePut

Tags: Skips Authentication

Save a coupon.

function updateSalesRuleCouponRepositoryV1SavePut(
        $couponId,
        $salesRuleCouponRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
couponId	Required	TODO: Add a parameter description
salesRuleCouponRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$couponId = 'couponId';
$salesRuleCouponRepositoryV1SavePutBody = new SalesRuleCouponRepositoryV1SavePutBody();

$result = $salesRuleCouponRepositoryV1->updateSalesRuleCouponRepositoryV1SavePut($couponId, $salesRuleCouponRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

deleteSalesRuleCouponRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete coupon by coupon id.

function deleteSalesRuleCouponRepositoryV1DeleteByIdDelete($couponId)

Parameters

Parameter	Tags	Description
couponId	Required	TODO: Add a parameter description

Example Usage

$couponId = 0;

$result = $salesRuleCouponRepositoryV1->deleteSalesRuleCouponRepositoryV1DeleteByIdDelete($couponId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getSalesRuleCouponRepositoryV1GetListGet

Tags: Skips Authentication

Retrieve a coupon using the specified search 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#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getSalesRuleCouponRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 0;
$searchCriteriaCurrentPage = 0;

$result = $salesRuleCouponRepositoryV1->getSalesRuleCouponRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createSalesRuleCouponRepositoryV1SavePost

Tags: Skips Authentication

Save a coupon.

function createSalesRuleCouponRepositoryV1SavePost($salesRuleCouponRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
salesRuleCouponRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesRuleCouponRepositoryV1SavePostBody = new SalesRuleCouponRepositoryV1SavePutBody();

$result = $salesRuleCouponRepositoryV1->createSalesRuleCouponRepositoryV1SavePost($salesRuleCouponRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

SalesRuleCouponManagementV1Controller

Get singleton instance

The singleton instance of the SalesRuleCouponManagementV1Controller class can be accessed from the API Client.

$salesRuleCouponManagementV1 = $client->getSalesRuleCouponManagementV1();

createSalesRuleCouponManagementV1GeneratePost

Tags: Skips Authentication

Generate coupon for a rule

function createSalesRuleCouponManagementV1GeneratePost($salesRuleCouponManagementV1GeneratePostBody = null)

Parameters

Parameter	Tags	Description
salesRuleCouponManagementV1GeneratePostBody	Optional	TODO: Add a parameter description

Example Usage

$salesRuleCouponManagementV1GeneratePostBody = new SalesRuleCouponManagementV1GeneratePostBody();

$result = $salesRuleCouponManagementV1->createSalesRuleCouponManagementV1GeneratePost($salesRuleCouponManagementV1GeneratePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createSalesRuleCouponManagementV1DeleteByIdsPost

Tags: Skips Authentication

Delete coupon by coupon ids.

function createSalesRuleCouponManagementV1DeleteByIdsPost($salesRuleCouponManagementV1DeleteByIdsPostBody = null)

Parameters

Parameter	Tags	Description
salesRuleCouponManagementV1DeleteByIdsPostBody	Optional	TODO: Add a parameter description

Example Usage

$salesRuleCouponManagementV1DeleteByIdsPostBody = new SalesRuleCouponManagementV1DeleteByIdsPostBody();

$result = $salesRuleCouponManagementV1->createSalesRuleCouponManagementV1DeleteByIdsPost($salesRuleCouponManagementV1DeleteByIdsPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createSalesRuleCouponManagementV1DeleteByCodesPost

Tags: Skips Authentication

Delete coupon by coupon codes.

function createSalesRuleCouponManagementV1DeleteByCodesPost($salesRuleCouponManagementV1DeleteByCodesPostBody = null)

Parameters

Parameter	Tags	Description
salesRuleCouponManagementV1DeleteByCodesPostBody	Optional	TODO: Add a parameter description

Example Usage

$salesRuleCouponManagementV1DeleteByCodesPostBody = new SalesRuleCouponManagementV1DeleteByCodesPostBody();

$result = $salesRuleCouponManagementV1->createSalesRuleCouponManagementV1DeleteByCodesPost($salesRuleCouponManagementV1DeleteByCodesPostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers

AmazonPaymentAddressManagementV1Controller

Get singleton instance

The singleton instance of the AmazonPaymentAddressManagementV1Controller class can be accessed from the API Client.

$amazonPaymentAddressManagementV1 = $client->getAmazonPaymentAddressManagementV1();

updateAmazonPaymentAddressManagementV1GetShippingAddressPut

Tags: Skips Authentication

TODO: Add a method description

function updateAmazonPaymentAddressManagementV1GetShippingAddressPut(
        $amazonOrderReferenceId,
        $amazonPaymentAddressManagementV1GetShippingAddressPutBody = null)

Parameters

Parameter	Tags	Description
amazonOrderReferenceId	Required	TODO: Add a parameter description
amazonPaymentAddressManagementV1GetShippingAddressPutBody	Optional	TODO: Add a parameter description

Example Usage

$amazonOrderReferenceId = 'amazonOrderReferenceId';
$amazonPaymentAddressManagementV1GetShippingAddressPutBody = new AmazonPaymentAddressManagementV1GetShippingAddressPutBody();

$result = $amazonPaymentAddressManagementV1->updateAmazonPaymentAddressManagementV1GetShippingAddressPut($amazonOrderReferenceId, $amazonPaymentAddressManagementV1GetShippingAddressPutBody);

Errors

Error Code	Error Description
0	Unexpected error

updateAmazonPaymentAddressManagementV1GetBillingAddressPut

Tags: Skips Authentication

TODO: Add a method description

function updateAmazonPaymentAddressManagementV1GetBillingAddressPut(
        $amazonOrderReferenceId,
        $amazonPaymentAddressManagementV1GetBillingAddressPutBody = null)

Parameters

Parameter	Tags	Description
amazonOrderReferenceId	Required	TODO: Add a parameter description
amazonPaymentAddressManagementV1GetBillingAddressPutBody	Optional	TODO: Add a parameter description

Example Usage

$amazonOrderReferenceId = 'amazonOrderReferenceId';
$amazonPaymentAddressManagementV1GetBillingAddressPutBody = new AmazonPaymentAddressManagementV1GetShippingAddressPutBody();

$result = $amazonPaymentAddressManagementV1->updateAmazonPaymentAddressManagementV1GetBillingAddressPut($amazonOrderReferenceId, $amazonPaymentAddressManagementV1GetBillingAddressPutBody);

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

AmazonPaymentOrderInformationManagementV1Controller

Get singleton instance

The singleton instance of the AmazonPaymentOrderInformationManagementV1Controller class can be accessed from the API Client.

$amazonPaymentOrderInformationManagementV1 = $client->getAmazonPaymentOrderInformationManagementV1();

deleteAmazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete

Tags: Skips Authentication

TODO: Add a method description

function deleteAmazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete()

Example Usage

$amazonPaymentOrderInformationManagementV1->deleteAmazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete();

Errors

Error Code	Error Description
0	Unexpected error

Back to List of Controllers

TaxTaxRateRepositoryV1Controller

Get singleton instance

The singleton instance of the TaxTaxRateRepositoryV1Controller class can be accessed from the API Client.

$taxTaxRateRepositoryV1 = $client->getTaxTaxRateRepositoryV1();

updateTaxTaxRateRepositoryV1SavePut

Tags: Skips Authentication

Create or update tax rate

function updateTaxTaxRateRepositoryV1SavePut($taxTaxRateRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
taxTaxRateRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$taxTaxRateRepositoryV1SavePutBody = new TaxTaxRateRepositoryV1SavePutBody();

$result = $taxTaxRateRepositoryV1->updateTaxTaxRateRepositoryV1SavePut($taxTaxRateRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createTaxTaxRateRepositoryV1SavePost

Tags: Skips Authentication

Create or update tax rate

function createTaxTaxRateRepositoryV1SavePost($taxTaxRateRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
taxTaxRateRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$taxTaxRateRepositoryV1SavePostBody = new TaxTaxRateRepositoryV1SavePutBody();

$result = $taxTaxRateRepositoryV1->createTaxTaxRateRepositoryV1SavePost($taxTaxRateRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxRateRepositoryV1GetGet

Tags: Skips Authentication

Get tax rate

function getTaxTaxRateRepositoryV1GetGet($rateId)

Parameters

Parameter	Tags	Description
rateId	Required	TODO: Add a parameter description

Example Usage

$rateId = 0;

$result = $taxTaxRateRepositoryV1->getTaxTaxRateRepositoryV1GetGet($rateId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteTaxTaxRateRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete tax rate

function deleteTaxTaxRateRepositoryV1DeleteByIdDelete($rateId)

Parameters

Parameter	Tags	Description
rateId	Required	TODO: Add a parameter description

Example Usage

$rateId = 0;

$result = $taxTaxRateRepositoryV1->deleteTaxTaxRateRepositoryV1DeleteByIdDelete($rateId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxRateRepositoryV1GetListGet

Tags: Skips Authentication

Search TaxRates 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#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getTaxTaxRateRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 0;
$searchCriteriaCurrentPage = 0;

$result = $taxTaxRateRepositoryV1->getTaxTaxRateRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

TaxTaxRuleRepositoryV1Controller

Get singleton instance

The singleton instance of the TaxTaxRuleRepositoryV1Controller class can be accessed from the API Client.

$taxTaxRuleRepositoryV1 = $client->getTaxTaxRuleRepositoryV1();

updateTaxTaxRuleRepositoryV1SavePut

Tags: Skips Authentication

Save TaxRule

function updateTaxTaxRuleRepositoryV1SavePut($taxTaxRuleRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
taxTaxRuleRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$taxTaxRuleRepositoryV1SavePutBody = new TaxTaxRuleRepositoryV1SavePutBody();

$result = $taxTaxRuleRepositoryV1->updateTaxTaxRuleRepositoryV1SavePut($taxTaxRuleRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

createTaxTaxRuleRepositoryV1SavePost

Tags: Skips Authentication

Save TaxRule

function createTaxTaxRuleRepositoryV1SavePost($taxTaxRuleRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
taxTaxRuleRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$taxTaxRuleRepositoryV1SavePostBody = new TaxTaxRuleRepositoryV1SavePutBody();

$result = $taxTaxRuleRepositoryV1->createTaxTaxRuleRepositoryV1SavePost($taxTaxRuleRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxRuleRepositoryV1GetGet

Tags: Skips Authentication

Get TaxRule

function getTaxTaxRuleRepositoryV1GetGet($ruleId)

Parameters

Parameter	Tags	Description
ruleId	Required	TODO: Add a parameter description

Example Usage

$ruleId = 0;

$result = $taxTaxRuleRepositoryV1->getTaxTaxRuleRepositoryV1GetGet($ruleId);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

deleteTaxTaxRuleRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete TaxRule

function deleteTaxTaxRuleRepositoryV1DeleteByIdDelete($ruleId)

Parameters

Parameter	Tags	Description
ruleId	Required	TODO: Add a parameter description

Example Usage

$ruleId = 163;

$result = $taxTaxRuleRepositoryV1->deleteTaxTaxRuleRepositoryV1DeleteByIdDelete($ruleId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxRuleRepositoryV1GetListGet

Tags: Skips Authentication

Search TaxRules 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#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

function getTaxTaxRuleRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 163;
$searchCriteriaCurrentPage = 163;

$result = $taxTaxRuleRepositoryV1->getTaxTaxRuleRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

TaxTaxClassRepositoryV1Controller

Get singleton instance

The singleton instance of the TaxTaxClassRepositoryV1Controller class can be accessed from the API Client.

$taxTaxClassRepositoryV1 = $client->getTaxTaxClassRepositoryV1();

createTaxTaxClassRepositoryV1SavePost

Tags: Skips Authentication

Create a Tax Class

function createTaxTaxClassRepositoryV1SavePost($taxTaxClassRepositoryV1SavePostBody = null)

Parameters

Parameter	Tags	Description
taxTaxClassRepositoryV1SavePostBody	Optional	TODO: Add a parameter description

Example Usage

$taxTaxClassRepositoryV1SavePostBody = new TaxTaxClassRepositoryV1SavePostBody();

$result = $taxTaxClassRepositoryV1->createTaxTaxClassRepositoryV1SavePost($taxTaxClassRepositoryV1SavePostBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxClassRepositoryV1GetGet

Tags: Skips Authentication

Get a tax class with the given tax class id.

function getTaxTaxClassRepositoryV1GetGet($taxClassId)

Parameters

Parameter	Tags	Description
taxClassId	Required	TODO: Add a parameter description

Example Usage

$taxClassId = 163;

$result = $taxTaxClassRepositoryV1->getTaxTaxClassRepositoryV1GetGet($taxClassId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

deleteTaxTaxClassRepositoryV1DeleteByIdDelete

Tags: Skips Authentication

Delete a tax class with the given tax class id.

function deleteTaxTaxClassRepositoryV1DeleteByIdDelete($taxClassId)

Parameters

Parameter	Tags	Description
taxClassId	Required	TODO: Add a parameter description

Example Usage

$taxClassId = 163;

$result = $taxTaxClassRepositoryV1->deleteTaxTaxClassRepositoryV1DeleteByIdDelete($taxClassId);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

updateTaxTaxClassRepositoryV1SavePut

Tags: Skips Authentication

Create a Tax Class

function updateTaxTaxClassRepositoryV1SavePut(
        $classId,
        $taxTaxClassRepositoryV1SavePutBody = null)

Parameters

Parameter	Tags	Description
classId	Required	TODO: Add a parameter description
taxTaxClassRepositoryV1SavePutBody	Optional	TODO: Add a parameter description

Example Usage

$classId = 'classId';
$taxTaxClassRepositoryV1SavePutBody = new TaxTaxClassRepositoryV1SavePostBody();

$result = $taxTaxClassRepositoryV1->updateTaxTaxClassRepositoryV1SavePut($classId, $taxTaxClassRepositoryV1SavePutBody);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

getTaxTaxClassRepositoryV1GetListGet

Tags: Skips Authentication

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.

function getTaxTaxClassRepositoryV1GetListGet(
        $searchCriteriaFilterGroupsFiltersField = null,
        $searchCriteriaFilterGroupsFiltersValue = null,
        $searchCriteriaFilterGroupsFiltersConditionType = null,
        $searchCriteriaSortOrdersField = null,
        $searchCriteriaSortOrdersDirection = null,
        $searchCriteriaPageSize = null,
        $searchCriteriaCurrentPage = null)

Parameters

Parameter	Tags	Description
searchCriteriaFilterGroupsFiltersField	Optional	Field
searchCriteriaFilterGroupsFiltersValue	Optional	Value
searchCriteriaFilterGroupsFiltersConditionType	Optional	Condition type
searchCriteriaSortOrdersField	Optional	Sorting field.
searchCriteriaSortOrdersDirection	Optional	Sorting direction.
searchCriteriaPageSize	Optional	Page size.
searchCriteriaCurrentPage	Optional	Current page.

Example Usage

$searchCriteriaFilterGroupsFiltersField = 'searchCriteria[filterGroups][][filters][][field]';
$searchCriteriaFilterGroupsFiltersValue = 'searchCriteria[filterGroups][][filters][][value]';
$searchCriteriaFilterGroupsFiltersConditionType = 'searchCriteria[filterGroups][][filters][][conditionType]';
$searchCriteriaSortOrdersField = 'searchCriteria[sortOrders][][field]';
$searchCriteriaSortOrdersDirection = 'searchCriteria[sortOrders][][direction]';
$searchCriteriaPageSize = 163;
$searchCriteriaCurrentPage = 163;

$result = $taxTaxClassRepositoryV1->getTaxTaxClassRepositoryV1GetListGet($searchCriteriaFilterGroupsFiltersField, $searchCriteriaFilterGroupsFiltersValue, $searchCriteriaFilterGroupsFiltersConditionType, $searchCriteriaSortOrdersField, $searchCriteriaSortOrdersDirection, $searchCriteriaPageSize, $searchCriteriaCurrentPage);

Errors

Error Code	Error Description
400	400 Bad Request
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StawHiveProductV1Controller

Get singleton instance

The singleton instance of the StawHiveProductV1Controller class can be accessed from the API Client.

$stawHiveProductV1 = $client->getStawHiveProductV1();

createStawHiveProductV1CreateAttributeSetPost

Tags: Skips Authentication

Creates a new attribute set and adds new attributes to it, the default api doesn't provide this functionality.

function createStawHiveProductV1CreateAttributeSetPost(
        $attributeSetId,
        $stawHiveProductV1CreateAttributeSetPostBody = null)

Parameters

Parameter	Tags	Description
attributeSetId	Required	New attribute set id.
stawHiveProductV1CreateAttributeSetPostBody	Optional	TODO: Add a parameter description

Example Usage

$attributeSetId = 'attributeSetId';
$stawHiveProductV1CreateAttributeSetPostBody = new StawHiveProductV1CreateAttributeSetPostBody();

$result = $stawHiveProductV1->createStawHiveProductV1CreateAttributeSetPost($attributeSetId, $stawHiveProductV1CreateAttributeSetPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StawHiveCartV1Controller

Get singleton instance

The singleton instance of the StawHiveCartV1Controller class can be accessed from the API Client.

$stawHiveCartV1 = $client->getStawHiveCartV1();

createStawHiveCartV1SetupPost

Tags: Skips Authentication

Returns greeting message to user

function createStawHiveCartV1SetupPost(
        $cartId,
        $stawHiveCartV1SetupPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	Cart quote id.
stawHiveCartV1SetupPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$stawHiveCartV1SetupPostBody = new StawHiveCartV1SetupPostBody();

$result = $stawHiveCartV1->createStawHiveCartV1SetupPost($cartId, $stawHiveCartV1SetupPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createStawHiveCartV1ItemsPost

Tags: Skips Authentication

Returns greeting message to user

function createStawHiveCartV1ItemsPost(
        $cartId,
        $stawHiveCartV1ItemsPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	Cart quote id.
stawHiveCartV1ItemsPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$stawHiveCartV1ItemsPostBody = new StawHiveCartV1ItemsPostBody();

$result = $stawHiveCartV1->createStawHiveCartV1ItemsPost($cartId, $stawHiveCartV1ItemsPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createStawHiveCartV1PlaceOrderPost

Tags: Skips Authentication

Places an order from a quote with additonal data.

function createStawHiveCartV1PlaceOrderPost(
        $cartId,
        $stawHiveCartV1PlaceOrderPostBody = null)

Parameters

Parameter	Tags	Description
cartId	Required	Cart quote id.
stawHiveCartV1PlaceOrderPostBody	Optional	TODO: Add a parameter description

Example Usage

$cartId = 'cartId';
$stawHiveCartV1PlaceOrderPostBody = new StawHiveCartV1SetupPostBody();

$result = $stawHiveCartV1->createStawHiveCartV1PlaceOrderPost($cartId, $stawHiveCartV1PlaceOrderPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StawHiveOrderV1Controller

Get singleton instance

The singleton instance of the StawHiveOrderV1Controller class can be accessed from the API Client.

$stawHiveOrderV1 = $client->getStawHiveOrderV1();

createStawHiveOrderV1CreatePost

Tags: Skips Authentication

Creates a new order.

function createStawHiveOrderV1CreatePost(
        $orderId,
        $stawHiveOrderV1CreatePostBody = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order id.
stawHiveOrderV1CreatePostBody	Optional	TODO: Add a parameter description

Example Usage

$orderId = 'orderId';
$stawHiveOrderV1CreatePostBody = new StawHiveOrderV1CreatePostBody();

$result = $stawHiveOrderV1->createStawHiveOrderV1CreatePost($orderId, $stawHiveOrderV1CreatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

createStawHiveOrderV1SetupPost

Tags: Skips Authentication

Set additional order information such as the ordered from date.

function createStawHiveOrderV1SetupPost(
        $orderId,
        $stawHiveOrderV1SetupPostBody = null)

Parameters

Parameter	Tags	Description
orderId	Required	Order id.
stawHiveOrderV1SetupPostBody	Optional	TODO: Add a parameter description

Example Usage

$orderId = 'orderId';
$stawHiveOrderV1SetupPostBody = new StawHiveOrderV1CreatePostBody();

$result = $stawHiveOrderV1->createStawHiveOrderV1SetupPost($orderId, $stawHiveOrderV1SetupPostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

StawHiveInvoiceV1Controller

Get singleton instance

The singleton instance of the StawHiveInvoiceV1Controller class can be accessed from the API Client.

$stawHiveInvoiceV1 = $client->getStawHiveInvoiceV1();

createStawHiveInvoiceV1CreatePost

Tags: Skips Authentication

Creates an invoice.

function createStawHiveInvoiceV1CreatePost($stawHiveInvoiceV1CreatePostBody = null)

Parameters

Parameter	Tags	Description
stawHiveInvoiceV1CreatePostBody	Optional	TODO: Add a parameter description

Example Usage

$stawHiveInvoiceV1CreatePostBody = new StawHiveInvoiceV1CreatePostBody();

$result = $stawHiveInvoiceV1->createStawHiveInvoiceV1CreatePost($stawHiveInvoiceV1CreatePostBody);

Errors

Error Code	Error Description
401	401 Unauthorized
0	Unexpected error

Back to List of Controllers

TemandoShippingRmaRmaShipmentManagementV1Controller

Get singleton instance

The singleton instance of the TemandoShippingRmaRmaShipmentManagementV1Controller class can be accessed from the API Client.

$temandoShippingRmaRmaShipmentManagementV1 = $client->getTemandoShippingRmaRmaShipmentManagementV1();

updateTemandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut

Tags: Skips Authentication

Assign platform shipment IDs to a core RMA entity.

function updateTemandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut(
        $rmaId,
        $temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody = null)

Parameters

Parameter	Tags	Description
rmaId	Required	TODO: Add a parameter description
temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody	Optional	TODO: Add a parameter description

Example Usage

$rmaId = 163;
$temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody = new TemandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody();

$result = $temandoShippingRmaRmaShipmentManagementV1->updateTemandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut($rmaId, $temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody);

Errors

Error Code	Error Description
401	401 Unauthorized
500	Internal Server error
0	Unexpected error

Back to List of Controllers