Classes, interfaces and traits
AbstractApiV2Controller¶
Class AbstractApiV2Controller
This class defines the inner core functionality of a ApiV2Controller. It contains the
initialization and request validation functionality that every controller must have.
The functionality of this class is mark as private because child controllers must not alter
the state at this point but rather adjust to it. This will force them to follow the same
principles and methodologies.
Child API controllers can use the "init" method to initialize their common dependencies.
« More »
AbstractImagesApiV2Controller¶
Class AbstractImagesApiV2Controller
Provides a listing of image files.
« More »
AddressesApiV2Controller¶
Class AddressesApiV2Controller
Provides a gateway to the AddressBookService which handles the shop address resources.
« More »
AttachmentsApiV2Controller¶
Class AttachmentsApiV2Controller
This controller enables the API consumers to handle email attachments which can be later
used in emails. The most common scenario is that if an email has attachments, they must
be already uploaded before the email is sent.
« More »
CacheApiV2Controller¶
Class CategoriesApiV2Controller
Provides a gateway to the CategoryWriteService and CategoryReadService classes, which handle the shop category
resources.
« More »
CategoriesApiV2Controller¶
Class CategoriesApiV2Controller
Provides a gateway to the CategoryWriteService and CategoryReadService classes, which handle the shop category
resources.
« More »
CategoryIconsApiV2Controller¶
Class CategoryIconsApiV2Controller
This controller handles the Category Icon file operations. The clients of the API can list, upload, rename or delete
files that exist in the server.
« More »
CategoryImagesApiV2Controller¶
Class CategoryImagesApiV2Controller
This controller handles the Category Image file operations. The clients of the API can list, upload, rename or delete
files that exist in the server.
« More »
CountriesApiV2Controller¶
Class CountriesApiV2Controller
Provides a gateway to the CountryService which handles the shop country resources.
« More »
CronjobsApiV2Controller¶
Class CronjobsApiV2Controller
Provides a gateway to cronjob specific tasks.
« More »
CustomersApiV2Controller¶
Class CustomersApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the
child-controllers in order to gain access to request and response information. The $uri variable is an
array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations
without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should
not be called from a child-controller (like validation, authorization, rate limiting). The only way to
disable the execution of these methods is to override the controller.
« More »
DefaultApiV2Controller¶
Class DefaultApiV2Controller
The default APIv2 controller will be triggered when client consumers hit the "api.php/v2"
URI and it will return information about the API.
« More »
EmailsApiV2Controller¶
Class EmailsApiV2Controller
This controller provides a gateway to the EmailService of the system. The user is able to get, send, queue
and delete email records through his shop. Email forwarding is not directly supported but can be easily
implemented by getting an existing email and then sending it with the updated contact addresses.
API consumers can also upload attachments through the AttachmentsApiV2Controller and later use them within
their emails. The upload operation must be executed before sending/queuing the email because it is not possible
to send the email JSON data and upload a file at the same time. For more info see the AttachmentsV2Controller.
« More »
HttpApiV2Controller¶
Class HttpApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the
child-controllers in order to gain access to request and response information. The $uri variable is an
array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations
without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should
not be called from a child-controller (like validation, authorization, rate limiting). The only way to
disable the execution of these methods is to override the controller.
« More »
OrdersApiV2Controller¶
Class OrdersApiV2Controller
Provides a gateway to the OrderWriteService and OrderReadService classes, which handle the shop
order resources.
« More »
OrdersHistoryApiV2Controller¶
Class OrdersStatusHistoryApiV2Controller
Notice: This controller is a sub-resource of the OrdersV2Controller.
« More »
OrdersItemsApiV2Controller¶
Class OrdersItemsApiV2Controller
Notice: This controller is a sub-resource of the OrdersApiV2Controller.
« More »
OrdersItemsAttributesApiV2Controller¶
Class OrdersItemsAttributesApiV2Controller
Notice: This controller is a sub-resource of the OrdersItemsApiV2Controller.
« More »
OrdersTotalsApiV2Controller¶
Class OrdersTotalsApiV2Controller
Notice: This controller is a sub-resource of the OrdersV2Controller.
« More »
ProductImagesApiV2Controller¶
Class ProductImagesApiV2Controller
Provides an API interface for managing product images through the ProductWriteService.
Notice: This controller IS NOT a sub-resource of the ProductsApiV2Controller.
This controller can be reached by using one of the following URIs:
- http://shop.de/api.php/v2/product_images
or
- http://shop.de/api.php/v2/ProductImages
Using "productimages" as a resource name will not resolve to this controller.
« More »
ProductReviewsApiV2Controller¶
Class ProductReviewsApiV2Controller
Provides a gateway to the ReviewWriteService and ReviewReadService classes, which handle the shop
review resources.
« More »
ProductsApiV2Controller¶
Class ProductsApiV2Controller
Provides a gateway to the ProductWriteService and ProductReadService classes, which handle the shop
product resources.
« More »
ProductsLinksApiV2Controller¶
Class ProductsLinksApiV2Controller
Provides an API interface for managing the product links.
Notice: This controller is a sub-resource of the ProductsApiV2Controller.
« More »
ReviewsApiV2Controller¶
Class ReviewsApiV2Controller
Provides a gateway to the ReviewWriteService and ReviewReadService classes, which handle the shop
review resources.
« More »
TaxClassesApiV2Controller¶
Class TaxClassesApiV2Controller
Provides tax class information.
« More »
TaxRatesApiV2Controller¶
Class TaxRatesApiV2Controller
Provides tax rates information.
« More »
TaxZonesApiV2Controller¶
Class TaxZonesApiV2Controller
Provides tax zone information.
« More »
VpeApiV2Controller¶
Class VpeApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the
child-controllers in order to gain access to request and response information. The $uri variable is an
array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations
without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should
not be called from a child-controller (like validation, authorization, rate limiting). The only way to
disable the execution of these methods is to override the controller.
« More »
WithdrawalsApiV2Controller¶
Class WithdrawalsApiV2Controller
Provides a gateway to the WithdrawalWriteService and WithdrawalReadService classes, which handle the shop
withdrawal resources.
« More »
ZonesApiV2Controller¶
Class ZonesApiV2Controller
Provides a gateway to the CountryService which handles the shop zone resources.
« More »