Pull the Catalog
This page explains how you can pull your HubRise catalog into Smood, what information is sent to Smood, and how you can synchronise your inventory.
Pull a Catalog
As a preliminary step, you need to populate your HubRise catalog. Then you can set up Smood to pull your catalog automatically when it is updated on HubRise, or pull it manually when needed.
Populate a HubRise Catalog
Some EPOS solutions offer the ability to export the catalog to HubRise. Refer to your EPOS documentation on the HubRise website Apps page to verify. If your EPOS does not offer this feature, you can populate your HubRise catalog manually, using the HubRise Catalog Manager.
If you use the same catalog across multiple platforms, consider creating catalog variants to customise the price and availability of your products for each platform.
For more information on HubRise catalogs, see Catalogs. To learn how to create and manage catalog variants with the Catalog Manager, see Variants.
Select the Catalog Variant to Pull
If you create a catalog variant for Smood on HubRise, you need to select it from the Smood back office before you pull your catalog. Follow these steps:
- Log in to your Smood back office.
- Select the restaurant.
- Click the Settings tab, then in the Integrations section, click Settings.
- In the POS Order References Settings dialog that appears, from the Catalog variant to retrieve list, select the catalog variant.
- To confirm, click Save.
The catalog variant that you choose is used for both manual and automatic pull.
Manual Catalog Pull
Once your catalog is populated on HubRise, you can manually pull it into your Smood restaurant by following these steps:
- Log in to your Smood back office.
- Select the restaurant.
- Click the Settings tab, then in the Integrations section, click Pull HubRise catalog.
- To confirm, click Yes.
To understand how the HubRise catalog is mapped to Smood, see the technical reference section below.
Automatic Catalog Pull
Smood can automatically pull your HubRise catalog every time it is updated in HubRise. By default, this option is turned off. You can enable it by following these steps:
- Log in to your Smood back office.
- Select the restaurant.
- Click the Settings tab, then in the Integrations section, click Settings.
- In the POS Order References Settings dialog that appears, select the Enable automatic sync of the catalog option, then click Save.
Synchronise Inventory
Smood can mark your products unavailable based on your HubRise inventory. You can let Smood update the inventory automatically, or update it manually.
Products with a stock of 0
in HubRise will be marked unavailable in Smood, and removed from the menu. When the stock is updated in HubRise, the product will be marked available again.
Automatic Inventory Update
Smood can automatically update the availability of your products when your inventory is updated on HubRise. By default, this option is turned off. To turn it on, follow these steps:
- Log in to your Smood back office.
- Select the restaurant for which you want to edit products.
- Click the Settings tab, then under the Integrations section, click Settings.
- In the POS Order References Settings dialog that appears, select the Enable automatic sync of the inventory option, then click Save.
Manual Inventory Update
To manually update your Smood inventory, follow these steps:
- Log in to your Smood back office.
- Select the restaurant for which you want to edit products.
- Click the Settings tab, then in the Integrations section, click Pull HubRise inventory.
- To confirm, click Yes.
Technical Reference
The following sections describe how HubRise catalogs are mapped to Smood.
Categories
HubRise categories are mapped one-to-one with categories on Smood. Smood uses the categories' name
and description
fields.
Smood only supports one level of categories. If you use subcategories in your HubRise catalog, these will be mapped to main categories in Smood.
Products and SKUs
For every HubRise SKU, Smood creates a product with the following information:
product.name
andskus.name
: The name of the product. For example, if the HubRise product name isPizza margherita
and the SKU name is8"
, Smood creates a product namedPizza margherita 8"
product.description
: The description of the product.product.image_ids
: The IDs of the images associated with the product.product.tags
: We support the following tag:deal_only
: When this tag is set, the product is not available as a standalone item on the menu, but can be ordered as part of a deal.
skus.ref
: The ref code of the SKU, which will be passed along in orders.skus.price
: The price of the SKU.
Note that Smood does not natively support products with SKUs, so a product with SKUs in HubRise will be mapped to multiple products in Smood.
Options
For every option list in the catalog, Smood uses the following information:
name
: The name of the option list.min_selections
andmax_selections
: The minimum and maximum number of options that can be selected.
For every option in an option list, Smood uses the following information:
ref
: The ref code of the option.name
: The option name.price
: The price for a single option.
Deals
In HubRise, deals are promotions which apply to a specific set of products. An example deal is a Lunch menu deal, that includes a pizza and a dessert.
Deals in HubRise are mapped to products with options in Smood. Smood will use the following information from HubRise:
ref
: The ref code of the product.name
: The name of the product.description
: The description of the product.lines[].label
: If present, the name of the group of options.lines[].skus[]
: The options in the group.
The options from the products in the deal are discarded. For example, if a deal includes a pizza, the customer will not be able to choose the pizza toppings.
IMPORTANT NOTE: Smood discards options from products in deals. Furthermore, if an option is required for a product, the deal will not be imported.
It is not possible to create deals manually in the Smood back office. If you want to use deals, you must pull a catalog from HubRise.
Discounts
Discounts are not imported into Smood.
Charges
Charges are not imported into Smood.