Summary
Packages
- AddonValue
  - Summary
  - Interfaces
- AdminAccess
  - Summary
  - Collections
  - Deleters
  - Entities
  - Exceptions
  - Factories
  - Interfaces
  - Managers
  - Readers
  - Writers
- AdminHttpViewControllers
- Agreement
  - Summary
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - ValueObjects
- ApiV2Controllers
- Authentication
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Strategies
- Category
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Providers
  - Repositories
  - Storages
- Customer
  - Summary
  - Address
  - Country
  - CountryZone
  - Interfaces
  - Storages
  - Validation
  - ValueObjects
- CustomerGroup
  - Summary
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - Serializers
  - Services
  - ValueObjects
- Email
  - Summary
  - Collections
  - Entities
  - Exceptions
  - Interfaces
  - Repository
  - ValueObjects
- Extensions
  - Summary
  - Customers
  - Emails
  - Geschaeftskundenversand
  - Helpers
  - Invoices
  - Orders
  - ParcelShopFinder
  - QuickEdit
  - Serializers
  - Templates
- Geschaeftskundenversand
  - Summary
  - Exceptions
- Http
  - Summary
  - Collections
  - Exceptions
  - Factories
  - Interfaces
  - ValueObjects
- HttpViewControllers
- InfoBox
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Repositories
- Invoice
  - Summary
  - Interfaces
  - ValueObjects
- Loaders
  - Summary
  - CrossCuttingLoader
  - GXCoreLoader
  - Interfaces
- Manufacturer
  - Summary
  - Entities
  - Factories
  - Interfaces
  - Repositories
- Modules
  - Summary
  - Collections
  - Controllers
  - Interfaces
- NewsletterSubscription
  - Summary
  - Interfaces
- None
- Order
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - Storages
  - ValueObjects
- OrderStatus
  - Summary
  - Collections
  - Entities
  - Exceptions
  - Factories
  - Interfaces
  - Repositories
- PackingSlip
  - Summary
  - Collections
  - ValueObjects
- PersonalData
  - Summary
  - Storage
- Precheck
- Product
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Providers
  - Repositories
  - Storages
- ProductModule
  - Summary
  - Collections
  - Deleter
  - Entities
  - Factories
  - Interface
  - Interfaces
  - Reader
  - Repositories
  - Writer
- QuantityUnit
  - Summary
  - Entities
  - Factories
  - Repositories
- QuickEdit
  - Summary
  - Interfaces
  - Repositories
- Review
  - Summary
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - Services
  - ValueObjects
- Shared
  - Summary
  - ClassFinder
  - Exceptions
  - FileSystem
  - Interfaces
  - Storage
  - Types
- SharedShoppingCart
  - Summary
  - Interfaces
- ShoppingCart
  - Summary
  - Entities
  - Interfaces
- Slider
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - Storages
- Smarty
  - Summary
  - plugins
- StaticSeoUrl
  - Summary
  - Collections
  - Entities
  - Factories
  - Interfaces
  - Repositories
- StaticSeoUrls
- Statistics
  - Summary
  - Interfaces
- UserConfiguration
  - Summary
  - Interfaces
  - Repository
- VersionInfo
  - Summary
  - Factories
  - Reader
  - ValueObjects
- VPE
  - Summary
  - Entities
  - Factories
  - Repositories
- Withdrawal
  - Summary
  - Entities
  - Factories
  - Interfaces
  - Repositories
  - Services
  - ValueObjects
Classes

Class TaxRatesApiV2Controller

Provides tax rates information.

┗ TaxRatesApiV2Controller

Package: ApiV2Controllers
Category: System
Located at Controllers/Api/v2/TaxRatesApiV2Controller.inc.php

Methods summary


				
				 public 
				
				

				get( void )

Api

{get} /tax_rates Get Tax Rates

Apidescription

Get all tax rates or a single tax rate.

Apierror

404-NotFound Tax rate record could not be found.
400-BadRequest Invalid rax rate id provided (expected integer).

Apierrorexample

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

Error-Response (Invalid ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Provided tax rate ID is invalid, integer expected." }

Apiexample

{curl} Get All Tax Rates curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_rates

{curl} Get Tax Rate With ID = 1 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/tax_rates/1

Apigroup

TaxRates

Apiname

GetTaxRates

Apisuccessexample

{json} Success-Response [ { "id": "1", "taxZoneId": "5", "taxClassId": "1", "taxRate": "19.0000", "description": "19% MwSt." }, { "id": "2", "taxZoneId": "5", "taxClassId": "2", "taxRate": "7.0000", "description": "7% MwSt." }, { "id": "3", "taxZoneId": "6", "taxClassId": "1", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" }, { "id": "4", "taxZoneId": "6", "taxClassId": "2", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" }, { "id": "5", "taxZoneId": "6", "taxClassId": "3", "taxRate": "0.0000", "description": "EU-AUS-UST 0%" }, { "id": "6", "taxZoneId": "11", "taxClassId": "3", "taxRate": "19.0000", "description": "19% MwSt. (Deutschland)" }, { "id": "7", "taxZoneId": "12", "taxClassId": "3", "taxRate": "20.0000", "description": "20% MwSt. (\u00d6sterreich)" } ]

{json} Success-Response { "id": "1", "taxZoneId": "5", "taxClassId": "1", "taxRate": "19.0000", "description": "19% MwSt." }

Apiversion

2.4.0


				
				 public static
				
				

				getTaxRates( void )
				

				: array

Get tax rates

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

Properties inherited from AbstractApiV2Controller

$api, $uri