Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Geschaeftskundenversand
    • Helpers
    • Invoices
    • Orders
    • ParcelShopFinder
    • QuickEdit
    • Serializers
    • Templates
  • Geschaeftskundenversand
    • Exceptions
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • OrderStatus
    • Collections
    • Entities
    • Exceptions
    • Factories
    • Interfaces
    • Repositories
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • QuickEdit
    • Interfaces
    • Repositories
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository
  • VersionInfo
    • Factories
    • Reader
    • ValueObjects

Classes

  • AbstractApiV2Controller
  • AbstractImagesApiV2Controller
  • AddressesApiV2Controller
  • AddressFormatsApiV2Controller
  • AttachmentsApiV2Controller
  • CategoriesApiV2Controller
  • CategoryIconsApiV2Controller
  • CategoryImagesApiV2Controller
  • CountriesApiV2Controller
  • CustomersApiV2Controller
  • DefaultApiV2Controller
  • EmailsApiV2Controller
  • HttpApiV2Controller
  • OrdersApiV2Controller
  • OrdersHistoryApiV2Controller
  • OrdersItemsApiV2Controller
  • OrdersItemsAttributesApiV2Controller
  • OrderStatusesApiV2Controller
  • OrdersTotalsApiV2Controller
  • ProductImagesApiV2Controller
  • ProductsApiV2Controller
  • ProductsLinksApiV2Controller
  • ShopInformationApiV2Controller
  • TaxClassesApiV2Controller
  • TaxRatesApiV2Controller
  • TaxZonesApiV2Controller
  • ZonesApiV2Controller

Class AddressFormatsApiV2Controller

Class AddressFormatsApiV2Controller

Provides address format information.

AbstractApiV2Controller
Extended by HttpApiV2Controller
Extended by AddressFormatsApiV2Controller
Package: ApiV2Controllers
Category: System
Located at Controllers/Api/v2/AddressFormatsApiV2Controller.inc.php

Methods summary

public
# get( )

Api

{get} /address_formats Get Address Formats

Apidescription

Get all address formats or a single address format.

Apierror

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

Apierrorexample

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


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


Apiexample

{curl} Get All Address Formats curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/address_formats


{curl} Get Address Format With ID = 1 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/address_formats/1


Apigroup

AddressFormats

Apiname

GetAddressFormats

Apisuccessexample

{json} Success-Response [ { "id": "1", "format": "$firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country", "summary": "$city / $country" }, { "id": "2", "format": "$firstname $lastname$cr$streets$cr$city, $state $postcode$cr$country", "summary": "$city, $state / $country" }, { "id": "3", "format": "$firstname $lastname$cr$streets$cr$city$cr$postcode - $statecomma$country", "summary": "$state / $country" }, { "id": "4", "format": "$firstname $lastname$cr$streets$cr$city ($postcode)$cr$country", "summary": "$postcode / $country" }, { "id": "5", "format": "$firstname $lastname$cr$streets$cr$postcode $city$cr$country", "summary": "$city / $country" } ]


{json} Success-Response { "id": "1", "format": "$firstname $lastname$cr$streets$cr$city, $postcode$cr$statecomma$country",, "summary": "$city / $country" }


Apiversion

2.4.0

Methods inherited from HttpApiV2Controller

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

Methods inherited from AbstractApiV2Controller

__construct()

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

API documentation generated by ApiGen