For the complete documentation index, see llms.txt. This page is also available as Markdown.

Web Integration - Items

Configure item master data sync, attributes, and publishing rules.

Summary

The integration framework supports a number of methods for Bevica Items to be integrated with the website.

Page links:

  • Items and Web Products

  • Web unit of Measure

  • Allowed Web Sales Unit of Measures

  • Web Catalogue

  • Web Decode List (Cross References)

  • Updating Marketing Description

Items and Web Products

There are two main ways to manage your items with your website depending on the specific requirements. We do not recommend mixing these methods.

  1. Web Items – Bevica Item = Website Item

  2. Web Products – Website Product = multiple Bevica Items

Web Items

This is the simplest approach and means that each Bevica Item has a single Web Item and on the website you have a one-to-one relationship.

On the Item card select ‘Web Published’. The following then automatically occurs:

  • Web Product Code is created as the Item No.

    • Is set to Published = TRUE

  • Web ID is populated with a unique identifier (GUID)

This item is then available on the Item endpoint.

Web Products

This setup is primarily used where the website has a parent item with different variants of it. Most typically this would be different bottle and/or case sizes.

Go to Web Product List and complete the following:

Field
Usage

Code

The unique identifier for this Web Product. Depending on how you set up your item numbers this may be a shortened version that identifies the item to some degree

Marketing Description

Initially comes from the Primary Item No. but can be amended. This is how the Item will be named in the website

Primary Item No.

The primary item from which some of the item data will come from

Published

How many Items are Published

No. of Items

How many Items are assigned to this Web Product

It is useful to look at an example. Assume that we have 3 items:

  • CB100A20 Chateau Bevique 2020, 75cl

  • CB100H20 Chateau Bevique 2020, 37.5cl

  • CB100M20 Chateau Bevique 2020, 150cl

The following setup could apply:

  • We create a Web Product ‘Code’ of CB100

  • We assign CB100A20 as the ‘Primary Item No.’

  • The Web Product Marketing Description comes from the Primary Item so is populated as “Chateau Bevique 2020, 75cl”. We manually clean this up by editing the field to remove the unit size to make it “Chateau Bevique 2020”

  • We navigate to items CB100H20 and CB100M20 and select the ‘Web Product Code’ of CB100 to assign them to it. There are now 3 items in ‘No. of Items’

  • We make sure all three items are ‘Web Published’. There are now 3 items in ‘Published’

  • If we stopped selling the 150cl we can either set that Item to ‘Web Published’ = No, if it was a temporary change, or remove the ‘Web Product Code’ from the item to disassociate it.

The data to the website would be similar to:

  • Web Product CB100

    • {Web Product Data}

    • Web Item CB100A20

      • {Item Data}

    • Web Item CB100H20

      • {Item Data}

    • Web Item CB100M20

      • {Item Data}

Web Product to Item Data Hierarchy

The following fields are populated from the Web Product Primary Item No on the Web Products endpoint:

  • Web Product Code

  • Marketing Description

  • Category Code / Description (2 fields)

  • Country Code / Description

  • Region Code / Description

  • Sub Region Code / Description

  • Producer Code / Name

  • Item Classification Description

  • Alcohol %

  • Vintage

  • Grapes (a string of grape names)

  • Attributes (item attributes and values)

The following data is on each item node:

  • Web ID

  • Published (True/False)

  • Deleted (True/False)

  • Last Modified DateTime

  • Item No.

  • Blocked (Blank, All, Ship, Invoice)

  • Description

  • Base UoM Code (e.g. 75cl)

  • Base UoM Description

  • Sales UoM Code (e.g. 6x75cl)

  • Sales UoM Description

  • Sales UoM Qty Per Base (e.g. 6)

  • Unit Volume

  • Duty Paid / Duty Free Price (dependant on setup)

  • Stock (dependant on setup)

  • Purchasing Code

  • Weight

  • Web UoM Code (see section below)

  • Web UoM Description

  • Web UoM Qty Per Base

  • Web Sales Unit Only (see section below)

  • Web Catalogue (see section below)

Web Unit of Measure

In some circumstances you may require different Sales Unit of Measure setup to facilitate order processing in Bevica to what you want to show on the web. For example, you may process transactions in bottles but want the website to give options for bottles and cases.

The ‘Web Unit of Measure’ can be set to be different from the ‘Sales Unit of Measure’. In the example above where you process orders primarily in bottles, the Base UoM and Sales UoM might be ‘75cl’ so orders default to bottles. You can set the ‘Web UoM’ to be ‘12x75cl’ so this would be displayed on the website.

The unit of measure must be set up in the Item Units of Measure.

Note that this field is optional, but if used we would recommend consistency across all items by ensuring they all have a Web UoM populated. It will always default to the Sales UoM.

Allowed Web Sales Unit of Measure

You may want to force items to be sold in a specific unit of measure. For example, not allowing a case to be split on web sales. Set this field to one of the following:

  • Blank – no restriction

  • Base – base unit of measure only

  • Sales – sales unit of measure only

  • Web – web unit of measure only

This is only a data tag to the website so they would need to implement logic on their side to manage the allowed sales units of measure.

Web Catalogue

You may restrict items to only be sold through specific web stores or channels. The Web Catalogue helps to manage this if required.

You create your own set of Web Catalogues and apply them to the items. In this example, we have three channels defined. Against this item, only two have been selected: The Web Product Item node would return a comma-separated string {EXPORT, UK TRADE} in the ‘Web Catalogue’ field.

Note that this is optional. If you have a single web store this may not be required.

Web Decode List (Cross References)

Sometimes the website Item data may need to be converted to a Bevica Item, or other type of entity. The Web Decode List manages this.

Field
Usage

Id

The website Id for this ‘item’

Type

Item, Resource, G/L Account

Code

The Bevica ‘code’ for the relevant type

Description

Defaults from the Type and Code, but can be amended to appear differently on Sales Documents

Negative Sign

If this needs to be converted

Examples of usage may include:

  • Delivery charges to a Resource or G/L Account

  • Gift Voucher sales

  • Discount Vouchers or use of Gift Voucher

  • Ticket or Event Sales

  • Converting multiple items on the website to a single Bevica item. For example, if you have different branding on the website

Updating Marketing Descriptions

If you have updated the marketing description on your items you need to update the website item list with the new values.

Go to Web Item List and select 'Update Marketing Description' from the ribbon

Last updated

Was this helpful?