REST Order StatusHistory

Get the status history of orders.

Get the status history of an order

Gets the status of an order. The ID of the order must be specified.

/rest/orders/{orderId}/status-history

Parameters

Field	Type	Description
orderId	`Int`	The ID of the order

Success 200

Response is a List

Field	Type	Description
`id`	`Int`	The ID of the status history entry
`orderId`	`Int`	The ID of the order
`statusId`	`Float`	The ID of the status
`createdAt`	`String\|\Carbon`	The date when the entry was created
`userId`	`Int`	The ID of the user
`procedureText`	`String`	The information text of the procedure that created the entry

Response (example)

[{"orderId":416,"statusId":5,"createdAt":"2019-02-01T12:19:47+01:00","userId":6,"procedureText":"Esse voluptates consequatur.","id":8},{"orderId":938,"statusId":1,"createdAt":"2019-02-13T03:07:14+01:00","userId":2,"procedureText":"Ut delectus et.","id":743}]

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List status histories of orders

Lists the status histories of all orders. The result can be limited to an order, a status type, a period of time or a user.

/rest/orders/status-history

Parameters

Field	Type	Description
orderId	`Int`	The ID of the order
statusId	`Float`	The ID of the status
createdAtFrom	`String`	Get entries with createdAt date after this date
createdAtTo	`String`	Get entries with createdAt date before this date
userId	`String`	The ID of the user

Success 200

Field	Type	Description
`page`	`Int`	Current page of the response
`totalsCount`	`Int`	The total number of entries in the response
`isLastPage`	`Bool`	Flag that indicates if the page shown is the last page of the response
`lastPageNumber`	`Int`	The last page number
`firstOnPage`	`Int`	The index of the first item of the current page result
`lastOnPage`	`Int`	The index of the last item of the current page result
`itemsPerPage`	`Int`	The requested amount of items per result page
`entries`	`StatusHistoryEntry[]`	List of `StatusHistoryEntry`
`id`	`Int`	The ID of the status history entry
`orderId`	`Int`	The ID of the order
`statusId`	`Float`	The ID of the status
`createdAt`	`String\|\Carbon`	The date when the entry was created
`userId`	`Int`	The ID of the user
`procedureText`	`String`	The information text of the procedure that created the entry

Response (example)

{"page":1,"totalsCount":2,"isLastPage":true,"entries":[{"orderId":150,"statusId":9,"createdAt":"2019-02-06T08:37:54+01:00","userId":7,"procedureText":"Nisi aut et esse.","id":483},{"orderId":713,"statusId":9,"createdAt":"2019-02-01T17:22:20+01:00","userId":8,"procedureText":"Nihil repellat autem qui rerum tempore.","id":440}],"lastPageNumber":1,"firstOnPage":1,"lastOnPage":2,"itemsPerPage":25}

Errors 4xx

Code	Exception	Description
401	`League\OAuth2\Server\Exception\AccessDeniedException`	The resource owner or authorization server denied the request.
401	`League\OAuth2\Server\Exception\InvalidRequestException`	The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.