Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

Feed Builder and Data Builder offer the same sources. Feed Builder lists them on the Feed Fields tab, Data Builder on the Mapping tab. In provisioning XML, use the code as source=.

Product fields#

Code Label Value
code Product Code The product code. On a variant row, the part’s code.
name Name The product name. Feed Builder variant rows add the options, for example T-Shirt (Red, M). Data Builder variant rows use the part’s name.
sku SKU The SKU. On a variant row, the part’s SKU, or its code when blank.
price Price Amount and currency, for example 15.90 USD. Variant rows use Miva’s variant pricing.
sale_price Sale Price (price group discounts) See Sale price
weight Weight The weight, without a unit
shipping_length Shipping Length From shipping rules, with the store’s dimension unit, for example 12.00 in. Empty when not set.
shipping_width Shipping Width As above
shipping_height Shipping Height As above
taxable Taxable 1 or 0
active Active 1 or 0
descrip Description The description, with HTML. Use the strip HTML transform for most channels.
dt_created Date Created A Unix timestamp
dt_updated Date Updated A Unix timestamp
product_url Product URL See Product URL
item_group_id Item Group ID The product’s code on variant rows. Empty otherwise.
in_stock Availability (from inventory) in stock or out of stock. See Availability.
inventory_count Inventory Count The available quantity. 0 when inventory isn’t tracked.
category_path Category Path (for product_type) See Category path

After these come:

  • every product custom field, by its code (image custom fields are left out; use Main Image or Additional Images)
  • every attribute code, listed as “Attribute: “. Filled on variant rows only, with the option prompt. See Variants.

Category fields#

Code Label
code Category Code
name Name
page_title Page Title
page_code Page Code (for category URL)
active Active
disp_order Display Order
dt_created Date Created
dt_updated Date Updated

After these come every category custom field.

Special sources#

Source Code in XML Value
(Constant value) __constant__ The constant text on every row
(Main Image) __main_image__ The image of the type in image_type, as a full URL
(Additional Images) __additional_images__ The images of the types in image_types, as full URLs, up to 10

How values are worked out#

Product URL#

The product’s canonical URL from URL Management, on the store’s domain. When the product has none, a merchant.mvc?Screen=PROD&Store_Code=...&Product_Code=... link.

A variant row uses its product’s URL with Variant_ID=<id> added, so the page opens with that variant selected.

Availability#

in stock or out of stock.

  • An inactive product is out of stock.
  • When inventory isn’t tracked for the product, an active product is in stock.
  • When it is tracked, the product is in stock while the available quantity is above its out-of-stock level. The product’s own inventory settings win over the store’s defaults.
  • A variant is in stock only when every one of its parts has enough stock for the quantity the variant uses.

Channels spell this differently. Use conditional output to change it, for example to in_stock / out_of_stock for Google and ChatGPT.

Category path#

The names from the product’s canonical category up to the top level, joined with >, for example Household > Living Room > TV Stands. When the product has no canonical category, its first active category is used. Up to 20 levels.

Sale price#

The price a shopper without an account pays after price group discounts:

  1. The module finds the price groups that apply to a shopper with no account.
  2. It reads the discounted price stored by Miva’s Pre-Calculate Discount Prices task, when there is one.
  3. Otherwise it asks Miva’s discount modules what the price would be.

It counts discounts that change a product’s price, such as legacy price group discounts, Product Discount, Specific Sale Price and Volume Pricing. Basket discounts don’t count. The value is empty unless it’s lower than the price. Variant rows use the variant’s price and discounts.

Prices and currency#

Price and Sale Price are written as amount and currency code, for example 15.90 USD, with two decimals (none for JPY, KRW, HUF and TWD) and no thousands separator. The currency code comes from the store’s currency module, or the store’s country when the module doesn’t say.

Image URLs#

Images are made into full URLs with the domain’s graphics root (Domain Settings, Root Directory for Graphics), on the secure URL when the domain has one. A path that’s already a full URL is left as is.

Custom fields#

A custom field’s value comes from the module that owns it. On a variant row:

  • Feed Builder uses the part product’s value when it has one, otherwise the master product’s.
  • Data Builder uses the part product’s value, or the master product’s when the field is set to Value from: Master product.

See Product identifiers and custom fields for the fields channels ask for.