Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AbstractApiV2Controller
  • AbstractImagesApiV2Controller
  • AddressesApiV2Controller
  • AttachmentsApiV2Controller
  • CategoriesApiV2Controller
  • CategoryIconsApiV2Controller
  • CategoryImagesApiV2Controller
  • CountriesApiV2Controller
  • CustomersApiV2Controller
  • DefaultApiV2Controller
  • EmailsApiV2Controller
  • HttpApiV2Controller
  • OrdersApiV2Controller
  • OrdersHistoryApiV2Controller
  • OrdersItemsApiV2Controller
  • OrdersItemsAttributesApiV2Controller
  • OrdersTotalsApiV2Controller
  • ProductImagesApiV2Controller
  • ProductsApiV2Controller
  • ProductsLinksApiV2Controller
  • ZonesApiV2Controller

Class OrdersHistoryApiV2Controller

Class OrdersStatusHistoryApiV2Controller

Notice: This controller is a sub-resource of the OrdersV2Controller.

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

Methods summary

protected
# __initialize( )

Initializes API Controller

Initializes API Controller

Throws

HttpApiV2Exception
On missing ID.
public
# get( )

Api

{get} /orders/:id/history/:id Get Order History

Apidescription

Returns multiple or a single order status history records. This method supports all the GET parameters that are mentioned in the "Introduction" section of this documentation.


Apiexample

{curl} Get All Entries curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/orders/400210/history


{curl} Get Entry With ID = 3 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/orders/400210/history/3


Apigroup

Orders

Apiname

GetOrderHistory

Apiversion

2.1.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

protected OrderWriteService $orderWriteService

Order write service.

Order write service.

#
protected OrderReadService $orderReadService

Order read service.

Order read service.

#
protected OrderJsonSerializer $orderJsonSerializer

Order JSON serializer.

Order JSON serializer.

#

Properties inherited from AbstractApiV2Controller

$api, $uri

API documentation generated by ApiGen