diff --git a/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example b/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example index 431563be62..db2233af95 100644 --- a/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example +++ b/docs/api/rest_api/rest_api_reference/input/examples/orders/GET/OrderList.json.example @@ -1,6 +1,7 @@ { "OrderList": { "_media-type": "application/vnd.ibexa.api.OrderList+json", + "count": 10, "Order": [ { "_media-type": "application/vnd.ibexa.api.Order+json", diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml index 383d2b68ec..b487b71fc4 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-orders.raml @@ -32,6 +32,13 @@ displayName: Orders get: displayName: Load orders description: Loads a list of orders. + queryParameters: + offset: + description: The offset of the result set. + type: integer + limit: + description: The number of orders returned. + type: integer headers: Accept: description: OrderList - If set, the orders list returned in XML or JSON format. diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml index 8640e047ad..5f94961bfb 100644 --- a/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml +++ b/docs/api/rest_api/rest_api_reference/input/ibexa-types.raml @@ -5315,6 +5315,8 @@ OrderList: description: 'This class represents an orders list.' type: object properties: + count: + type: integer Order: type: Order[] diff --git a/docs/api/rest_api/rest_api_reference/rest_api_reference.html b/docs/api/rest_api/rest_api_reference/rest_api_reference.html index 3ffb82e8d9..307914e2bd 100644 --- a/docs/api/rest_api/rest_api_reference/rest_api_reference.html +++ b/docs/api/rest_api/rest_api_reference/rest_api_reference.html @@ -86497,7 +86497,59 @@
| Property | +Type | +Value | +
|---|---|---|
| + offset + | ++ + + integer + + + + + | +
+ The offset of the result set. + + |
+
| + limit + | ++ + + integer + + + + + | +
+ The number of orders returned. + + |
+
{
"OrderList": {
"_media-type": "application/vnd.ibexa.api.OrderList+json",
+ "count": 10,
"Order": [
{
"_media-type": "application/vnd.ibexa.api.Order+json",
@@ -86632,7 +86685,7 @@ Types
"email": "aa@aa.aa"
},
"OrderCurrency": {
- "_media-
+
{
"OrderList": {
"_media-type": "application/vnd.ibexa.api.OrderList+json",
+ "count": 10,
"Order": [
{
"_media-type": "application/vnd.ibexa.api.Order+json",
@@ -164398,6 +164452,18 @@ Types
-
+ count
+
+ *
+
+(integer)
+ -
+
+
+
+
+
+ -
Order
*