Available Data Fields

This page lists all data fields available in the connector. These fields can be used as primary field or fallback in the OCI and cXML configuration.

The Protocols column shows in which context the respective field is available.

Context

Fields that relate to the general session context (sales channel, language, currency).

Data field	Description	Protocols
`currencyIsoCode`	ISO currency code of the sales channel (e.g. `EUR`)	OCI, cXML
`languageShortCode`	Language short code of the sales channel (e.g. `de-DE`)	cXML

Fields that relate to an individual cart line item.

Data field	Description	Protocols
`lineItemQuantity`	Ordered quantity of the line item	OCI, cXML
`lineItemReference`	Reference ID of the cart line item	OCI, cXML
`lineItemTotalPrice`	Total price of the line item (quantity × unit price)	OCI, cXML
`lineItemUnitPrice`	Unit price of the line item	OCI, cXML

Fields that return master data of the product.

Data field	Description	Protocols
`productId`	Internal Shopware product ID	OCI, cXML
`productName`	Product name (language-dependent)	OCI, cXML
`productTranslatedName`	Translated product name	OCI, cXML
`productDescription`	Product description (HTML)	OCI, cXML
`productTranslatedDescription`	Translated product description	OCI, cXML
`productNumber`	Article number (SKU)	OCI, cXML
`productEan`	EAN / GTIN	OCI, cXML
`productWeight`	Weight (in kilograms)	OCI, cXML
`productWidth`	Width	OCI, cXML
`productHeight`	Height	OCI, cXML
`productLength`	Length	OCI, cXML
`productTaxRate`	Tax rate in percent	OCI, cXML
`productSellingUnit`	Selling unit	OCI, cXML
`productPackingUnit`	Packing unit	OCI, cXML
`productPackingUnitPlural`	Packing unit (plural)	OCI, cXML
`productManufacturerName`	Manufacturer name	OCI, cXML
`productManufacturerTranslatedName`	Translated manufacturer name	OCI, cXML
`productManufacturerNumber`	Manufacturer article number (MPN)	OCI, cXML

These fields read connector-specific custom fields from the product.

Data field	Description	Custom field key	Protocols
`productOciEClass`	eCl@ss classification number	`agiqon_oci_e_class`	OCI, cXML
`productOciMe`	Packing unit (OCI-specific)	`agiqon_oci_me`	OCI, cXML

Data field	Description	Protocols
`productCustomField`	Any Shopware custom field on the product — provide the technical field name in the configurator	OCI, cXML

Fields for products configured with the Customized Products plugin. These fields return no value for standard products.

Data field	Description	Protocols
`customizedProductLabels`	All option labels of the customized product, joined with `\|` (e.g. `First name\|Last name`)	OCI, cXML
`customizedProductOptions`	All option values of the customized product in the format `Label: Value`, joined with newline	OCI, cXML

Fields for the shipping line item. These fields are only available when Append shipping is enabled in the connector configuration.

Data field	Description	Protocols
`shippingName`	Name of the shipping method	OCI
`shippingNumber`	Shipping number — configurable per shipping method (see Shipping Methods)	OCI
`shippingInternArticleNumber`	Internal article number of the shipping method	OCI
`shippingCostsTotalPrice`	Total amount of the shipping costs	OCI
`shippingCostsTaxRate`	Tax rate of the shipping costs in percent (calculated from tax amount and total price)	OCI

note

Shipping fields are currently only available for OCI.

Fields that return values from the connector system configuration of the respective sales channel.

Data field	Description	Protocols
`systemDefaultUnit`	Default unit of measure from the connector configuration	OCI, cXML

Fields that return information about the current transmission session.

Data field	Description	Protocols
`sessionTransmissionId`	Unique ID of the current transmission session	OCI, cXML