Shopware: Most-used fields

The table below gives information about most-used fields that you can import from Shopware. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name	Adverity UI name	Description	Use in Adverity
amountNet	amountNet	The net price of the entire order, excluding taxes and other charges.	metric
amountTotal	amountTotal	The total gross amount of the order, including taxes.	metric
calculatedTaxes.tax	calculatedTaxes.tax	The amount of tax calculated for the associated item or order component, based on the applicable tax rules.	metric
calculatedTaxes.taxRate	calculatedTaxes.taxRate	The tax rate applied in the calculation of taxes for the associated item or order component.	metric
currencyId	currencyId	A unique identifier for the currency used in the order.	dimension
currencyIsoCode	currencyIsoCode	The standard international three-digit code (ISO 4217) representing the currency used for the order, such as ‘USD’ for United States Dollar.	dimension
customFields	customFields	Additional custom fields that can be added to orders for storing extra information relevant to the business.	dimension
lineItem.label	lineItem.label	The descriptive name of the product or item included in the order.	dimension
lineItem.productId	lineItem.productId	The unique identifier of the product in the order line item.	dimension
lineItem.productNumber	lineItem.productNumber	The unique identifier assigned to the product associated with the line item, often used as a SKU or article number.	dimension
lineItem.quantity	lineItem.quantity	The number of units for a specific product or item included in the order line item.	metric
lineItem.tax	lineItem.tax	The tax amount applied to a specific line item within an order.	metric
lineItem.totalPrice	lineItem.totalPrice	The total price of the order line item, including tax.	metric
lineItem.unitPrice	lineItem.unitPrice	The unit price of a single product in the order line item, including tax.	metric
orderDate	orderDate	The date when the order was placed.	dimension
orderDateTime	orderDateTime	The full date and time when the order was placed.	dimension
orderId	orderId	The unique identifier of the order.	dimension
orderNumber	orderNumber	The customer-facing order number.	dimension
orderTransaction.stateMachineState.id	orderTransaction.stateMachineState.id	A unique identifier for the current state of an order transaction within the Shopware state machine, indicating its status (e.g., ‘open’, ‘paid’, ‘cancelled’).	dimension
orderTransaction.stateMachineState.name	orderTransaction.stateMachineState.name	The display name for the current state of an order transaction, providing a human-readable description of its status, such as ‘Open’ or ‘Paid’.	dimension
orderTransaction.stateMachineState.technicalName	orderTransaction.stateMachineState.technicalName	The technical name for the current state of an order transaction, used internally by the Shopware state machine (e.g., ‘open’, ‘paid’, ‘refunded’).	dimension
orderTransactionId	orderTransactionId	A unique identifier for a specific payment transaction associated with the order.	dimension
salesChannelId	salesChannelId	A unique identifier for the sales channel through which the order was placed.	dimension
shippingCosts.tax	shippingCosts.tax	The amount of tax calculated specifically for the shipping costs of the order.	metric
shippingCosts.totalPrice	shippingCosts.totalPrice	The total cost for shipping, considering the quantity of items.	metric
shippingCosts.unitPrice	shippingCosts.unitPrice	The shipping cost for a single item (unit).	metric