Pull the Catalog
This page describes how to pull a catalog from Lightspeed into HubRise and what information is received in HubRise.
To pull a catalog from Lightspeed, follow these steps:
- From the Lightspeed Restaurant Bridge main page, select the Actions tab, then click Pull catalog.
- Click Confirm when prompted.
IMPORTANT NOTE: This operation will replace your current HubRise catalog.
Depending on how large your catalog is, it might take a few minutes for your HubRise catalog to be fully updated.
The following sections provide more details on how your Lightspeed catalog is mapped to HubRise.
The categories in the Lightspeed catalog are mapped one-to-one to categories of products on HubRise.
The category name is sent to HubRise, while category ref code and descriptions are not supported on Lightspeed.
Lightspeed supports skus, but not products. For every item in the Lightspeed catalog, Lightspeed Restaurant Bridge creates a corresponding sku in HubRise with the following information (if available):
- Sku name.
- Sku ref code.
Lightspeed supports groups of items, which are sent to HubRise as option lists and options.
The HubRise option type is selected according to the following rule:
- A group with selection policy Select exactly one item is converted to a single-choice option list.
- A group with any other selection policy is converted to a multiple-choice option list.
Lightspeed supports production instructions, which are generally preparation instructions for the kitchen. These are sent to HubRise as multiple-choice options with no associated price.
The following sections provide technical details on how your Lightspeed catalog is encoded in HubRise.
For every category, the following fields are sent to HubRise:
name: The name of the category.
ref: A sequential numerical number is generated automatically for every category.
For every sku, Lightspeed sends the following information to HubRise:
name: The name of the sku.
description: The description of the sku.
image_ids: The list of image IDs associated with the sku.
skus: A list containing a single sku.
skus.ref: The ref code of the sku, which will be passed along in orders.
skus.price: The price of the sku.
skus.option_list_refs: The list of options attached to the sku.
Every option list has a sequential
ref that starts with
deal_. For every option, the following information is sent to HubRise:
name: The name of the option.
ref: The ref code of the option.
price: The price of the option.
Every production instruction group is mapped to HubRise as an option list. For every instruction, the following information is sent to HubRise:
name: The name of the instruction.
ref: The ref code of the instruction, preceded by a
price: Always 0.