Skip to content

Commit a1b0bcf

Browse files
committed
[FBX-5866] Update the latest docs
1 parent 34c428d commit a1b0bcf

File tree

8 files changed

+57
-7
lines changed

8 files changed

+57
-7
lines changed

changelog/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Changelog
22

3+
## 24th October 2025
4+
* [API Operations:](../operations/README.md)
5+
* Updated operations index to include all missing operations.
6+
* Added missing order operations: [Get order](../operations/orders.md#get-order), [Create order](../operations/orders.md#create-order), [Update order](../operations/orders.md#update-order).
7+
* Added missing register operation: [Get register](../operations/registers.md#get-register).
8+
* Added missing webhook operations: [Get webhook endpoints](../operations/webhookendpoints.md#get-webhook-endpoints), [Update webhook endpoint](../operations/webhookendpoints.md#update-webhook-endpoint).
9+
* Added missing operations: [Get modifier sets](../operations/modifiersets.md#get-modifier-sets), [Get modifier set](../operations/modifiersets.md#get-modifier-set), [Get outlets](../operations/outlets.md#get-outlets), [Get payment methods](../operations/paymentmethods.md#get-payment-methods), [Create payment](../operations/payments.md#create-a-payment), [Get product bundles](../operations/productbundles.md#get-product-bundles), [Get promo codes](../operations/promocodes.md#get-promo-codes), [Get revenue centers](../operations/revenuecenters.md#get-revenue-centers), [Get health check](../operations/system.md#get-the-health-check).
10+
* Sorted all operations alphabetically for better navigation.
11+
312
## 23rd October 2025
413
* [Create a payment:](../operations/payments.md#create-a-payment)
514
* New operation added for creating payments.

operations/areas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,5 @@ Below is a list of all possible fields this endpoint can return including relati
8080

8181
| Property | Type | Contract | Description |
8282
| :-- | :-- | :-- | :-- |
83-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
83+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
8484
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |

operations/bookings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ Below is a list of all possible fields this endpoint can return including relati
233233

234234
| Property | Type | Contract | Description |
235235
| :-- | :-- | :-- | :-- |
236-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
236+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
237237
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |
238238

239239
## Create booking

operations/customers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Below is a list of all possible fields this endpoint can return including relati
8989

9090
| Property | Type | Contract | Description |
9191
| :-- | :-- | :-- | :-- |
92-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
92+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
9393
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |
9494

9595
## Create customer

operations/invoices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,5 +319,5 @@ Below is a list of all possible fields this endpoint can return including relati
319319

320320
| Property | Type | Contract | Description |
321321
| :-- | :-- | :-- | :-- |
322-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
322+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
323323
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |

operations/orders.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ This operation creates an order.
482482

483483
**Note:** This operation needs [Authentication](../essential-guide/authentication.md) and supports the following JSON:API features:
484484

485-
- [Relationships](../guidelines/relationships.md) - `invoice`, `customer`, `booking`, `tables`, `promoCode`, `outlet`, `revenueCenter`, `taxes`, `orderItems` using `include` query parameter.
485+
- [Relationships](../guidelines/relationships.md) - `invoice`, `customer`, `booking`, `tables`, `promoCode`, `outlet`, `revenueCenter`, `taxes`, `orderItems`, `payments` using `include` query parameter.
486486
- [Sparse fieldsets](../guidelines/sparse-fieldsets.md) - supports all fields of `order` and related resources with `fields` query parameter.
487487

488488
### Request
@@ -541,6 +541,14 @@ This operation creates an order.
541541
"tempId": "order-bundle-item-1"
542542
}
543543
]
544+
},
545+
"payments": {
546+
"data": [
547+
{
548+
"type": "payments",
549+
"tempId": "payment-1"
550+
}
551+
]
544552
}
545553
},
546554
"included": {
@@ -638,6 +646,39 @@ This operation creates an order.
638646
"quantity": "1.00",
639647
"discount": "5.00",
640648
"discountType": "percentage"
649+
},
650+
"relationships": {
651+
"productBundle": {
652+
"data": {
653+
"type": "productBundles",
654+
"id": "123e4567-e89b-12d3-a456-426614174000"
655+
}
656+
}
657+
}
658+
}
659+
],
660+
"payments": [
661+
{
662+
"type": "payments",
663+
"tempId": "payment-1",
664+
"attributes": {
665+
"amount": "100.00",
666+
"notes": "Payment for order",
667+
"tipAmount": "15.00"
668+
},
669+
"relationships": {
670+
"paymentMethod": {
671+
"data": {
672+
"type": "paymentMethods",
673+
"id": "4014e105-57d6-4b12-a4fc-164601ec53e9"
674+
}
675+
},
676+
"register": {
677+
"data": {
678+
"type": "registers",
679+
"id": "4014e105-57d6-4b12-a4fc-164601ec53e9"
680+
}
681+
}
641682
}
642683
}
643684
]

operations/products.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,5 +243,5 @@ Below is a list of all possible fields this endpoint can return including relati
243243

244244
| Property | Type | Contract | Description |
245245
| :-- | :-- | :-- | :-- |
246-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
246+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
247247
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |

operations/tables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,5 +79,5 @@ Below is a list of all possible fields this endpoint can return including relati
7979

8080
| Property | Type | Contract | Description |
8181
| :-- | :-- | :-- | :-- |
82-
| `prev` | string | required, max length 1024 characters | The link to the previous page of results. |
82+
| `prev` | string,null | optional, max length 1024 characters | The link to the previous page of results. |
8383
| `next` | string,null | optional, max length 1024 characters | The link to the next page of results. |

0 commit comments

Comments
 (0)