Pull Orders

Connecting WooCommerce to HubRise allows you to receive orders directly in your EPOS or any other solution connected to your HubRise account.

This page describes the information that HubRise receives from WooCommerce for your orders.

Items and Options

WooCommerce orders contain the complete information about items and options, including name, POS ref code, quantity, and price. However, WooCommerce options have always zero as a price. Deals are not supported.

Customers' comments on single products are not supported on WooCommerce. If you rely on these comments for cooking or serving instructions (for example, "Medium rare cooking", or "Cut in slices"), you should add the corresponding items in your EPOS and include them as options in the WooCommerce menu, so that they are correctly encoded.

Order Statuses

IMPORTANT NOTE: In this section, we capitalise the first letter of WooCommerce statuses to make them easier to distinguish from HubRise status names. For example, Processing is a WooCommerce status, while accepted is a HubRise status.

When the Status Changes in HubRise

When the order status changes in HubRise, the status in WooCommerce changes according to the following correspondence:

WooCommerce's orders are created on HubRise with status new.

When the Status Changes in WooCommerce

When the order status changes in WooCommerce, the status in HubRise changes according to the following correspondence:

Service Types

In the default WooCommerce installation, the service type is always delivery. To support additional service types, you need to customise your WooCommerce installation to include this value in the order metadata.

Related FAQ: How Can I Encode Custom Metadata In An Order?

Customer Details

WooCommerce Bridge provides full customer information about orders, including name, delivery address, and contact details, and saves it in HubRise.

Payments

WooCommerce supports four types of payments in an order:

• Cash on delivery
• Check
• Direct bank transfer
• PayPal standard

IMPORTANT NOTE: Payment ref codes will soon be customisable from the configuration page. For more information, contact HubRise on support@hubrise.com.

Discounts

WooCommerce discounts are sent to HubRise, if present in an order.

Charges

WooCommerce supports only delivery charges, which are sent to HubRise if present in an order.

Technical Reference

This section describes how orders are encoded in the JSON payloads you receive from WooCommerce Bridge.

Items

The mapping of items from WooCommerce to HubRise depends on the configuration of WooCommerce Bridge, especially the Order Item Metadata section. For configuration details, refer to Order Item Metadata.

WooCommerce products in an order are mapped to products with or without a SKU, according to the following rules:

• Simple products are sent as products without a SKU.
• Variable products with an attribute whose name matches the Metadata key(s) for SKU name field are sent as products with a SKU, where the SKU name is the attribute's value.
• Variable products with attributes that do not match the criteria are sent as products without a SKU.

For every item in the order, WooCommerce Bridge sends the following information to HubRise:

• product_name: The name of the product.
• sku_name: The SKU name for products with a SKU, or null for products without. See the note above for details.
• sku_ref: The ref code of the item.
• price: The price for a single item.
• quantity: The number of items included in the order.
• customer_notes: Customer notes for the item, derived from the attribute with a key that matches the Metadata key(s) for customer notes field, if available.
• options: An array of options attached to the item, sourced from attributes that are neither used as SKU name nor customer notes, and do not match the Discarded metadata keys field.

Options

If a product contains an option, WooCommerce Bridge provides the following information:

• option_list_name: The placeholder for the option list name, with default value Options
• name: The option name

A product can have at most one attached option.

"items": [  {    "product_name": "Vegan Vegetarian - 18inch Classic",    "sku_name": null,    "sku_ref": "vegan_vegetarian_a18inch_classic",    "price": "19.95 EUR",    "quantity": "1",    "tax_rate": null,    "options": [      {        "option_list_name": "Options",        "name": "18inch Classic"      }    ]  }]

Customer

For new customers, WooCommerce Bridge creates a customer record on HubRise. For existing customers, WooCommerce Bridge simply adds the HubRise customer_id to the order.

WooCommerce Bridge encodes all the available customer's details from WooCommerce, such as:

• address_1: The first line of the address.
• address_2: The second line of the address.
• city: The city of the address.
• postal_code: The postcode of the address.
• state: The state of the address.
• email: The customer's email address.
• phone: The customer's phone number.
• delivery_notes: The delivery notes that the customer includes at checkout.

Delivery Charges

Delivery charges are applied for orders delivered by the restaurant.

The available fields in the payloads are the following:

• name: The name of the delivery charge, which is Delivery charge by default.
• ref: The ref code of the charge. Its default value can be set from the Configuration page of WooCommerce Bridge and should match the value in your EPOS.
• price: The total amount of the delivery charge.

"charges": [  {    "name": "Delivery charge",    "ref": "1111",    "price": "3.50 EUR"  }]

Discounts

The discount applied to the order is passed in a single object in the HubRise discounts array.

The available fields in the payload are the following:

• name: The name of the discount.
• price_off: The total amount of the discount.

Custom Fields

The custom_fields object is used by WooCommerce Bridge to store the metadata that WooCommerce sends in the order. This information is not provided by default by the WooCommerce API, but the actual format depends on the installed plugins and code customisation made on the website.

For example, the custom_fields object can encode the service type or the expected delivery time for the order.