HubRise

https://www.hubrise.com/docs
Admin
HubRise is a middleware platform that connects third-party solutions for restaurants and hospitality...
Tokens:11,918
Snippets:232
Trust Score:8.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example JSON Order Request

Source: https://www.hubrise.com/docs/hubrise-logs/understanding-json-syntax

This JSON object represents a sample order, demonstrating the structure for items, payment details, and service type. It includes nested objects and arrays.

```json
{
  "items": [
    {
      "product": "pizza margherita",
      "quantity": 1,
      "options": [
        {
          "type": "topping",
          "name": "olives"
        }
      ]
    },
    {
      "product": "bacon burger",
      "quantity": 2,
      "options": []
    }
  ],
  "payment": {
    "total": "20.45 EUR",
    "type": "cash"
  },
  "service type": "collection"
}
```

--------------------------------

### Define a JSON list of elements

Source: https://www.hubrise.com/docs/hubrise-logs/organising-information

Shows how to associate a single key with multiple values using square brackets.

```json
{
  "pizza margherita": {
    "ingredients": ["tomato", "mozzarella"]
  }
}
```

--------------------------------

### Injecting a name parameter into the authorization URL

Source: https://www.hubrise.com/docs/faqs/connect-multiple-instances-same-app

Insert the name parameter between the base URL and the account_id parameter to distinguish between multiple app instances.

```text
https://manager.hubrise.com/oauth2/v1/authorize?name=BrandName&account_id=
```

--------------------------------

### Configure CNAME DNS Records

Source: https://www.hubrise.com/docs/white-label

Add these records to your domain provider's management interface to point your subdomains to the appropriate HubRise services.

```text
menus  1800 IN CNAME catalog-manager.hubrise-apps.com.orders 1800 IN CNAME orderline.hubrise-apps.com.portal 1800 IN CNAME manager.hubrise.com.
```

--------------------------------

### Define a basic JSON key-value pair

Source: https://www.hubrise.com/docs/hubrise-logs/organising-information

Represents a simple object and its feature using a key-value pair enclosed in curly brackets.

```json
{
  "pizza": "round"
}
```

--------------------------------

### Order Request Data Model

Source: https://www.hubrise.com/docs/hubrise-logs/hubrise-data-model

Details the keys and descriptions for order objects processed by HubRise.

```APIDOC
## Order Request Data Model

### Description
This model defines the structure of order requests received and logged by HubRise.

### Data Fields
- **private_ref** (string) - The internal ID for the order.
- **service_type** (string) - The type of service (e.g., "delivery", "collection", "eat_in").
- **service_type_ref** (string) - The code associated with service_type in the EPOS system.
- **expected_time** (datetime) - The date and time the order should be ready or delivered.
- **expected_time_pickup** (boolean) - If true, expected_time is the pickup time.
- **asap** (boolean) - If true, the order can be made any time.
- **confirmed_time** (datetime) - The date and time confirmed by the merchant.
- **status** (string) - The status of the order (e.g., "new", "accepted", "received", "rejected").
- **total** (number) - The amount paid by the customer.
- **coupon_codes** (array) - The coupon codes used by the customer.
- **customer_id** (string) - The unique customer ID.
- **items** (array) - The list of items in the order.
- **payments** (array) - The list of payment methods used.
- **deals** (array) - The list of deals present in the order.
- **discounts** (array) - The list of discount codes applied to the order.
- **loyalty_operations** (array) - The list of operations applied to the customer's loyalty card.
- **charges** (array) - The list of additional charges applied to the order.
```

--------------------------------

### Item Object Definition

Source: https://www.hubrise.com/docs/hubrise-logs/hubrise-data-model

Details the structure of an item object representing a product purchased in an order.

```APIDOC
## Item Object

### Description
Represents a product purchased by the customer within an order.

### Fields
- **product_name** (string) - The name of the product.
- **sku_name** (string) - The sku name of the product, typically indicating the size or colour.
- **sku_ref** (string) - The code associated with the product (EPOS code).
- **price** (number) - The price of a single product.
- **quantity** (number) - The quantity ordered.
- **subtotal** (number) - The total price of the product (price x quantity).
- **options** (array) - The optional changes (ingredients or toppings) associated with the product.
- **deal_line** (object) - Information about the deal if the item is part of one.
- **points_earned** (number) - Points earned by the customer with this product.
- **points_used** (number) - Points used by the customer with this product.
```

--------------------------------

### Payment Object Definition

Source: https://www.hubrise.com/docs/hubrise-logs/hubrise-data-model

Details the structure of a payment object representing payment methods used for an order.

```APIDOC
## Payment Object

### Description
Represents a payment method used by the customer. Multiple payment objects can exist per order.

### Fields
- **type** (string) - The payment type (e.g., 'cash' or 'online').
- **name** (string) - The name associated with the payment method.
- **info** (object) - Additional information associated with the payment (e.g., PayPal email or card details).
- **ref** (string) - The EPOS code associated with this payment type.
- **amount** (number) - The total amount paid by the customer.
```

--------------------------------

### Define a nested JSON object

Source: https://www.hubrise.com/docs/hubrise-logs/organising-information

Demonstrates how to nest a JSON object within another to represent complex relationships.

```json
{
  "pizza margherita": {
    "size": "12 inches",
    "price": "8 EUR"
  }
}
```
Tokens:
Raw