Help Center

 

shipping-icon.png
Shipping
What is postcode question in pop-up about?
It help us to display the products that can be shipped to your area
View all

Becoming a Seller: Creating & maintaining your catalogue

This table lists all data fields available to you in your catalogue and groups them as mandatory and recommended.

Mandatory Fields: these are the fields without which www.buythebox.co cannot take, invoice and ship an order.
Default Label Product Attribute Code Tip/ Glossary Source/ Default Value
Alcoholic Product ? alcohol_product The SKU contains more than 1.15% alcohol by volume and therefore must be declared, under legislation, as an alcoholic product.
Base Unit Height (CM) omnyfy_dimensions_height Base Unit (ie the lowest level retail unit) height in cms.
Base Unit Length (CM) omnyfy_dimensions_length Base Unit (ie the lowest level retail unit) depth/ length in cms.
Base Unit Weight (KG) weight The gross weight of the Base Unit (ie the lowest level retail unit) in kilograms. Must be entered, and accurate, to support shipping cost estimates, recovery and pricing.
Base Unit Width (CM) omnyfy_dimensions_width Base Unit (ie the lowest level retail unit) width in cms.
Brand brand Brand of this product.
Categories category_ids Category/s that this item belongs to, generally aligned to those categories in supermarket/ grocery retail environments.
Dangerous Good dangerous_good Is the item classed as a dangerous good?
Dynamic Price price_type For bundled products, indicate if the price is dynamic, i.e. automatically calculated by the contents selected/ prescribed within the bundle; or whether the selected/ prescribed bundle is fixed.
GST Class tax_class_id The name/ identification of the tax class that is associated with this product.
Made In country_of_manufacture The country that the item is manufactured in. If Australia is selected the Australian Made Statement and Australian Made % values must also be completed.
Manufacturer manufacturer The manufacturer of this item.
Master Brand master_brand Master brand (if applicable) of this item, e.g. Nestle is a master brand, Allens lollies and Old Gold chocolate are brands.
Price price The price, excluding tax, of the SKU.
RRP rrp Recommended Retail Price including tax of the Base Unit.
Shipping Category easyship_shipping_category Choose the merchandise categories that reflect the item (s) that you intend to ship.
Recommended Fields: completing these fields enriches your buyers experience and increases the likelihood of getting an order, or having a buyer add more items to an order.  These fields support buyers searching, comparing, exploring, researching.
100 ML/ GM Per Base Unit attr_100_units_per_base_unit The number of 100 ml, gm etc units in the base unit. Useful for nutritional research and price comparisons. Value should match that on the products packaging label which is mandatory for packaged most food & beverage in Australia.
Allergens Present ingredients_allergen List of any allergens present in the food or beverage.
Allow Gift Message gift_message_available Whether or not the item may have a gift message added to/ with its packaging.
Autosettings
Availability quantity_and_stock_status Indicates if the SKU is in stock or out of stock. 
Available From custom_design_from Nominate the start date for a new theme to take effect.
Available Until custom_design_to Nominate the end date, if applicable, for a new theme to take effect.
Base Unit Contents base_unit_contents The quantity of contents (mls, gms etc) that are contained in one base unit.
Base Unit GTIN/ Barcode base_unit_gtin The GTIN/ barcode numbers of the base unit.
Base Unit Type base_unit_type The type of unit of measure (container type, eg: bottle, bag, packet, can, etc).
Base Units per Box/ TU base_units_per_traded_unit The number of base units packed within the traded unit.
Base Units per MPK A multi_pack_a_base_quantity The number of base units contained in the lowest multi pack.
Base Units per MPK B multi_pack_b_base_quantity The number of base units contained in an intermediate multi pack.
Base UOM base_unit_of_measure The type of metric (eg: litres, millilitres, kilograms etc) that the base unit contains.
Box/ TU Gross Weight (KG) tu_gross_weight Gross weight of a full box/ carton of this product.
Box/ TU GTIN/ Barcode traded_unit_gtin The GTIN/ barcode of the traded unit./ Box/ TU GTIN/ Barcode.
Box/ TU Height (CM) tu_height Height of a full box/ carton of this product.
Box/ TU Layers Pallet (HI) pallet_hi High- number of traded (shipping, selling) units per pallet layer. Useful for B2B planning logistics, costs etc of purchasing in pallets.
Box/ TU Length (CM) tu_length Length of a full box/ carton of this product.
Box/ TU Net Weight (KG) weight_net The net contents weight of a full box/ carton of the product in kilograms.
Box/ TU Per Layer (TI) pallet_ti Tier- number of layers per pallet. Useful for B2B planning logistics, costs etc of purchasing in layers or pallets.
Box/ TU Per Pallet pallet_tu Trade units per pallet, calculated field of Ti x Hi. Useful for B2B planning logistics, costs etc of purchasing in pallets.
Box/ TU Type traded_unit_type For a full box/ carton of the product, the type of package, eg: box, crate, case etc.
Box/ TU Width (CM) tu_width Width of a full box/ carton of this product.
Bundle Items
Color color For non food & beverage items (eg: apparel, general merchandise), the colour of the product.
Cost cost $ cost per traded unit exc. GST, NOT visible to buyers.
Custom Layout Update custom_layout_update_file Custom graphic design layout update files.
Customer Sub Type sub_channel Sales/ distribution sub channel/s that this item is suitable for. Select the sub channel/s for which this item is relevant to assist customers item search.
Customer Type channel Sales/ distribution channels, ie: types of venues/ outlets, that this item is suitable or recommended for. Select the channel/s for which this item is relevant to assist customers item search.
Display Actual Price msrp_display_actual_price_type Determines where the actual price of the product is visible to the customer.
Display Product Options In options_container Determines where the product options appear on the product page.
Dynamic SKU sku_type For bundle items, set Dynamic SKU = Yes to allow the system to generate a SKU for the bundle; SKU = N where the vendor wishes to enter their own SKU value.
Dynamic Weight weight_type Determines if the weight of a bundle item is variable (i.e. calculated based on the components) or fixed (based on a set value). Must be entered, and accurate, to support shipping cost estimates, recovery and pricing.
Enable Product status Determines if the product is visible on the webstore or not, ie: when under design/ edit vs. complete. Set to N when creating, editing, testing or discontinuing etc; Set to Y to publish to the online store.
Flavour flavour For food & beverage, the flavour of the item.
Frequency stripe_sub_interval
From at least % Australian ingredients australian_percentage Where the Australian made statement is “made in” or “packed in”, state the minimum % of Australian ingredients. Value should match that on the products packaging label which is mandatory for packaged most food & beverage in Australia.
GI: Region region In the case of wine, strictly the Wine Australia Geographic Indicators Region as appears on the label. In the case of other food & beverage, the geographic region where the items ingredients are majority sourced from and/ or that which reflects the brands heritage. Useful for those customers seeking item/s from particular geographic regions.
GI: State state In the case of wine, strictly the Wine Australia Geographic Indicators State as appears on the label. In the case of other food & beverage, the geographic region where the items ingredients are majority sourced from and/ or that which reflects the brands heritage. Useful for those customers seeking item/s from particular geographic regions.
GI: Sub Region region_sub In the case of wine, strictly the Wine Australia Geographic Indicators Sub Region as appears on the label. In the case of other food & beverage, the geographic region where the items ingredients are majority sourced from and/ or that which reflects the brands heritage. Useful for those customers seeking item/s from particular geographic regions.
GI: Zone zone In the case of wine, strictly the Wine Australia Geographic Indicators Zone as appears on the label. In the case of other food & beverage, the geographic region where the items ingredients are majority sourced from and/ or that which reflects the brands heritage. Useful for those customers seeking item/s from particular geographic regions.
Image Gallery gallery Items may have one or many images which are stored in the image gallery. Configurable items can have settings applied that alter the images shown for different configurations.
Ingredient Claims ingredients_claims claim there is an ingredient in your product.
Ingredients ingredients Ingredients as shown on the item label. Useful for nutritional research and price comparisons. Value should match that on the products packaging label which is mandatory for packaged most food & beverage in Australia.
Initial Fee stripe_sub_initial_fee
Is Featured sw_featured
Layout page_layout Sets the layout of each webstore page, think of it as a floor plan of each page.
Max Temp (Cel.) temp_max The maximum temperature of the items recommended storage temperature.
Max. Shelf Life (Days) maximum_shelf_life_days Maximum number of days (at manufacture or despatch) shelf life of this item.
Media Gallery media_gallery Media Gallery provides tools for managing uploaded media files.
Meta Description meta_description Meta descriptions provide a brief overview of the page for search results listings. Ideally, a meta description should be between 150-160 characters in length, although the field will accept up to 255 characters.
Meta Keywords meta_keyword Although some search engines ignore meta keywords, others continue to use them. The current best practice is to incorporate high-value keywords in the meta title and meta description.
Meta Title meta_title The meta title appears in the title bar and tab of your browser and search results listings. The meta title should be unique to the page, and less than seventy characters in length.
MPK A GTIN/ Barcode multi_pack_a_gtin The GTIN/ barcode of the lowest multi pack.
MPK A Per Box/ TU multi_pack_a_per_traded_unit The number of lowest multi packs in the traded unit.
MPK A RRP multi_pack_a_rrp Vendors Recommended Retail price (typically in supermarket/ grocery retail) inc. GST for the lowest multi pack. Necessary for calculating the retailers gross profit margin which is in turn a useful evaluation criteria for the retailer.
MPK B GTIN/ Barcode multi_pack_b_gtin The GTIN/ barcode of an intermediate multi pack.
MPK B Per Box/ TU multi_pack_b_per_traded_unit The number of intermediate multi packs within a traded unit/ carton/ box.
MPK B RRP multi_pack_b_rrp Vendors Recommended Retail price (typically in supermarket/ grocery retail) inc. GST for an intermediate multi pack. Necessary for calculating the retailers gross profit margin which is in turn a useful evaluation criteria for the retailer.
MSRP/ RRP Base Unit msrp Vendors Recommended Retail price (typically in supermarket/ grocery retail) inc. GST for the base unit. Necessary for calculating the retailers gross profit margin which is in turn a useful evaluation criteria for the retailer.
New from Date new_from_date To be shown as a new item, enter the date listed on buy box.co.
New Layout custom_layout Nominate a new graphic design layout for the item/ product.
New Theme custom_design Nominate a “new” graphic design theme for the item/ product.
New to Date new_to_date Enter a date 90 days from any “new from date”.
Occasion occasion Select the occasion/s for which this item is relevant to assist customers item search.
Price View price_view Determines if the product price is shown as a range, from the least expensive to the most expensive (Price Range) or with the least expensive shown (As Low As). Options:
Product Image Size product_image_size The size (pixels, dimensions) of the product image.
Product information custom_block Information about the product, ingredients, features & benefits, use cases, brand heritage etc.
Product information (detailed) custom_block_2 Information about the product, ingredients, features & benefits, use cases, brand heritage, vendor etc.
Product Page Type product_page_type Allows the user to select from a range of different templates for product page graphical design layout.
Repeat Every stripe_sub_interval_count
Return Allowed rma_allowed Indicates if the item can be returned; value must be set consistent with Australian law, or where silent the vendors terms & conditions of sale.
Search Weight mst_search_weight Prioritorises which attributes are considered more (higher weighting) or less (lower weighting) important in the store search results.
Serve size serve_size The serve size. Value should match that on the products packaging label which is mandatory for packaged most food & beverage in Australia.
Serve Size UOM serve_size_unit_of_measure The serve unit of measure, eg: ml, gms etc.
Serves per Base Unit serves_per_base_unit The number of serves in the base unit. Useful for nutritional research and price comparisons. Value should match that on the products packaging label which is mandatory for packaged most food & beverage in Australia. Required if price per serve is to be presented.
Ship Bundle Items shipment_type Indicates if SKU in a bundle can be shipped separately, or only together with the other items in the bundle.
Small small_image The small image is used for the product images in listings on category and search results pages and to display the product images needed for sections such as for Up-sells, Cross-sells, and the New Products List. Example size: 470 x 470 pixels
Special Price special_price Special/ discount price.
Special Price From Date special_from_date The start date for special prices.
Special Price To Date special_to_date End date for special pricing.
Subscription Enabled stripe_sub_enabled
Swatch swatch_image A swatch can be used to illustrate the color, pattern, or texture. Example size: 50 x 50 pixels
Temp Regime temp_type The storage/ logistics and retailing temperature regime/ zone of the item.
Thumbnail thumbnail Thumbnail images appear in the thumbnail gallery, shopping cart and in some blocks such as Related Items. Example size: 50 x 50 pixels
Tier Price tier_price Tier pricing lets you offer a quantity discount from a product listing or product page in the storefront. The discount can be applied to a specific store view or customer group or shared catalog
Trial Days stripe_sub_trial
URL Key url_key

The URL key is the part of a static URL that describes the product or category. When you create a product or category, an initial URL key is automatically generated, based on the name. To change the URL key, see the Search Engine Optimization section of the product information.

The URL key should consist of lowercase characters with hyphens to separate words. A well-designed, “search engine friendly” URL key might include the product name and key words to improve the way it is indexed by search engines. The URL key can be configured to create an automatic redirect if the URL key changes.

Visibility visibility

Determines if the product is visible in the catalog, and made available for search. Values:
Not Visible Individually — The product is not included in product listings, although it might be available as a variation of another product.
Catalog — The product appears in all catalog listings.
Search —The product is available for search operations.
Catalog, Search — The product is included in catalog listings and is also available for search.