Class CustomerGroupsApiV2Controller

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.

AbstractApiV2Controller

┗ HttpApiV2Controller

┗ CustomerGroupsApiV2Controller

Package: ApiV2Controllers
Category: System
See: AbstractApiV2Controller
Todo:

Add _cacheResponse() helper function which will cache request data and it will provide the required headers.

Located at Controllers/Api/v2/CustomerGroupsApiV2Controller.inc.php

Methods summary


				
				 protected 
				
				

				__initialize( void )

Initialize controller components.


				
				 public 
				
				

				get( void )

Api

{get} /customer_groups/:id Get customer groups

Apidescription

Get multiple or a single customer groups record through the GET method

Apierror

400-BadRequest CustomerGroups data were not provided or customer groups record ID was not provided or is invalid.

404-NotFound CustomerGroups record could not be found.

Apierrorexample

Error-Response (Missing or invalid ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "CustomerGroups record ID was not provided or is invalid." }

Error-Response (CustomerGroups Not Found) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "CustomerGroups record could not be found." }

Apiexample

{curl} Get All CustomerGroups records curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/customer_groups

{curl} Get CustomerGroups record With ID = 982 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/customer_groups/982

Apigroup

CustomerGroups

Apiname

GetCustomerGroups

Apiversion

2.5.0


				
				 public 
				
				

				post( void )

Api

{post} /customer_groups Create CustomerGroups

Apidescription

This method enables the creation of a new CustomerGroups into the system.

Apierror

400-BadRequest The body of the request was empty.

Apierrorexample

Error-Response HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "CustomerGroups data were not provided." }

Apigroup

CustomerGroups

Apiname

CreateCustomerGroups

Apiparam

{Object} names Object with language code as keys and name as values.
{Object} settings Object with customer group settings, visit the example for further information.

{Object} configurations Object with customer group configurations, visit the example for further information.

Apiparamexample

{json} CustomerGroups entity { "names": { "EN": "Kids", "DE": "Kinder" }, "settings": { "public": false, "otDiscountFlag": false, "graduatedPrices": false, "showPrice": true, "showPriceTax": false, "addTaxOt": false, "discountAttributes": false, "fsk18": false, "fsk18Display": false, "writeReviews": false, "readReviews": false }, "configurations": { "minOrder": 2.50, "maxOrder": 20.00, "discount": 0.5, "otDiscount": 0, "unallowedPaymentModules": [ "paypal", "cod", "moneyorder" ], "unallowedShippingModules": [ "selfpickup" ] } }

Apisuccess

(201) Request-Body If successful, this method returns the complete customerGroups resource in the response body.

Apisuccessexample

{json} Success-Response { "id": 2, "names": { "EN": "Kids", "DE": "Kinder" }, "settings": { "public": false, "otDiscountFlag": false, "graduatedPrices": false, "showPrice": true, "showPriceTax": false, "addTaxOt": false, "discountAttributes": false, "fsk18": false, "fsk18Display": false, "writeReviews": false, "readReviews": false }, "configurations": { "minOrder": 2.50, "maxOrder": 20.00, "discount": 0.5, "otDiscount": 0, "unallowedPaymentModules": [ "paypal", "cod", "moneyorder" ], "unallowedShippingModules": [ "selfpickup" ] } }

Apiversion

2.5.0


				
				 public 
				
				

				patch( void )

Api

{patch} /customer_groups/:id Updates CustomerGroup entity

Apidescription

Use this method if you want to update an existing customer groups record.

Apierror

400-BadRequest CustomerGroups data were not provided or customerGroups record ID was not provided or is invalid.

404-NotFoundRequest CustomerGroups data were not provided or customerGroups record ID was not provided or is invalid.

Apierrorexample

Error-Response (Empty request body) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "CustomerGroups data were not provided." }

Error-Response (Missing or invalid ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "CustomerGroups record ID was not provided or is invalid." }

Error-Response (Entity not found) HTTP/1.1 400 Bad Request { "code": 404, "status": "error", "message": "Customer group entity was not found with provided id [ID]" }

Apigroup

CustomerGroups

Apiname

UpdateCustomerGroups

Apiparam

{Object} names Object with language code as keys and name as values.
{Object} settings Object with customer group settings, visit the example for further information.

{Object} configurations Object with customer group configurations, visit the example for further information.

Apiparamexample

Apisuccess

(200) Request-Body If successful, this method returns the complete customerGroups resource in the response body.

Apisuccessexample

Apiversion

2.5.0


				
				 public 
				
				

				delete( void )

Api

{delete} /customer_groups/:id Delete CustomerGroups

Apidescription

Removes a customer groups record from the system. This method will always return success even if the customer group does not exist.

Apiexample

{curl} Delete CustomerGroups with ID = 84 curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/customer_groups/84

Apigroup

CustomerGroups

Apiname

DeleteCustomerGroups

Apisuccessexample

{json} Success-Response { "code": 200, "status": "success", "action": "delete", "customerGroupId": 84 }

Apiversion

2.5.0


				
				 protected 
				
				

				_serializeCustomerGroupCollection( CustomerGroupCollection $customerGroupCollection )
				

				: array

Serializes customer group collections.


				
				 protected 
				
				

				_serializeCustomerGroup( CustomerGroupInterface $customerGroup )
				

				: array

Serializes customer group entities.


				
				 protected 
				
				

				_deserializeCustomerGroup( string $customerGroupJson, integer|null $id = null )
				

				: QuantityUnitInterface

Deserialize a json string to a customer unit entity.

Parameters

$customerGroupJson: Customer group json to be serialized.
$id: (Optional) Id of entity to be deserialize.

Returns

QuantityUnitInterface
Deserialize customer group entity.


				
				 protected 
				
				

				_serializeCustomerGroupNames( array $customerGroupNames )
				

				: array

Serializes customer group names array.


				
				 protected 
				
				

				_serializeCustomerGroupSettings( CustomerGroupSettingsInterface $settings )
				

				: array

Serializes customer group settings value objects.


				
				 protected 
				
				

				_deserializeCustomerGroupSettings( array $settings )
				

				: CustomerGroupSettingsInterface

Deserialize customer group settings.


				
				 protected 
				
				

				_serializeCustomerGroupConfigurations( CustomerGroupConfigurationsInterface $configurations )
				

				: array

Serializes customer group configuration value objects.

Parameters

$configurations: Customer group configuration object to be serialized.

Returns

array
Serialized customer group configuration array.


				
				 protected 
				
				

				_deserializeCustomerGroupConfigurations( array $configurations )
				

				: CustomerGroupConfigurationsInterface

Deserialize customer group configurations.

Methods inherited from HttpApiV2Controller

_linkResponse(), _locateResource(), _mapResponse(), _minimizeResponse(), _paginateResponse(), _searchResponse(), _setJsonValue(), _sortResponse(), _writeResponse()

Methods inherited from AbstractApiV2Controller

__construct(), _prepareResponse(), _setRateLimitHeader(), _validateRequest()

Constants summary

Constants inherited from AbstractApiV2Controller

DEFAULT_CONTROLLER_NAME, DEFAULT_PAGE_ITEMS, DEFAULT_RATE_LIMIT, DEFAULT_RATE_RESET_PERIOD

Properties summary


				
				protected  
				

				
					$readService
				

				: CustomerGroupReadServiceInterface


				
				protected  
				

				
					$writeService
				

				: CustomerGroupWriteServiceInterface

Properties inherited from AbstractApiV2Controller

$api, $uri