- Readme
- Developer Guide
- Authorization
- Includables
- Pagination
- Sorting
- Retrieve Market Information
- Retrieve Branch Information
- Me
- Branches
- Orders
- Customers
- Products
- Product Categories
- Discounts
- Payment Methods
- Table
- Printer
- Webhook
- Orders Webhooks
- Product Webhooks
- Loyalty Webhooks
- Customers Webhooks
- Error Webhook
- Third-Party
Register Entity
Developing
DEVELOPMENT
DEVELOPMENT
POST
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Body Params application/json
market_id
string
required
company_slug
string
required
Example
{
"market_id": "7ba11b78-aa83-45aa-9f0a-1b8bf4d18480",
"company_slug": "Flavours Cafe"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://hook.flavours.sa/webhook/fai/register' \
--header 'Content-Type: application/json' \
--data-raw '{
"market_id": "7ba11b78-aa83-45aa-9f0a-1b8bf4d18480",
"company_slug": "Flavours Cafe"
}'
Responses
🟢200OK
application/json
Body
message
string
required
xid
string
required
Example
{
"message": "Entities Registered!",
"xid": "5c2ab9d2-f7ff-49e9-9727-34ac1908e17b"
}
Modified at 2024-12-27 12:19:05