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 amount of the order, excluding taxes.	metric
amountTotal	amountTotal	The total gross amount of the order, including taxes.	metric
billingAddress.city	billingAddress.city	The city of the customer’s billing address.	dimension
billingAddress.company	billingAddress.company	The company name associated with the billing address, if applicable.	dimension
billingAddress.country	billingAddress.country	The country of the customer’s billing address.	dimension
billingAddress.countryId	billingAddress.countryId	The unique identifier of the country for the customer’s billing address.	dimension
billingAddress.street	billingAddress.street	The street and house number of the customer’s billing address.	dimension
billingAddress.zipcode	billingAddress.zipcode	The postal code of the customer’s billing address.	dimension
calculatedTaxes.tax	calculatedTaxes.tax	The specific amount of tax calculated for an item or a part of the total price, based on the applicable tax rate.	metric
calculatedTaxes.taxRate	calculatedTaxes.taxRate	The percentage rate used to calculate the tax for an item or a part of the total price.	metric
currencyId	currencyId	The unique identifier of the currency used for the order.	dimension
currencyIsoCode	currencyIsoCode	The ISO 4217 code of the currency used for the order (e.g., EUR, USD).	dimension
customer.firstName	customer.firstName	The first name of the customer who placed the order.	dimension
customer.id	customer.id	The unique identifier of the customer who placed the order.	dimension
customer.lastName	customer.lastName	The last name of the customer who placed the order.	dimension
lineItem.label	lineItem.label	The name or description of the product in the order line item.	dimension
lineItem.productId	lineItem.productId	The unique identifier of the product in the order line item.	dimension
lineItem.productNumber	lineItem.productNumber	The unique product number or SKU of the item in the order line item.	dimension
lineItem.quantity	lineItem.quantity	The quantity of the product in the order line item.	metric
lineItem.tax	lineItem.tax	The tax amount applied to the order line item.	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
orderReturnCreatedAt	orderReturnCreatedAt	The date and time when the order return was created. This field is available with the Shopware Commercial Extension.	dimension
orderReturnId	orderReturnId	The unique identifier of the order return. This field is available with the Shopware Commercial Extension.	dimension
orderReturnLineItemId	orderReturnLineItemId	The unique identifier of the line item within an order return. This field is available with the Shopware Commercial Extension.	dimension
orderReturnLineItemQuantity	orderReturnLineItemQuantity	The quantity of the returned product in the order return line item. This field is available with the Shopware Commercial Extension.	metric
orderTransaction.stateMachineState.id	orderTransaction.stateMachineState.id	The unique identifier of the current state of the order transaction’s state machine.	dimension
orderTransaction.stateMachineState.name	orderTransaction.stateMachineState.name	The human-readable name of the current state of the order transaction (e.g., ‘Open’, ‘Paid’, ‘Cancelled’).	dimension
orderTransaction.stateMachineState.technicalName	orderTransaction.stateMachineState.technicalName	The technical name of the current state of the order transaction, used for programmatic identification (e.g., ‘open’, ‘paid’, ‘cancelled’).	dimension
orderTransactionId	orderTransactionId	The unique identifier of the order transaction.	dimension
salesChannelId	salesChannelId	The unique identifier of the sales channel through which the order was placed.	dimension
shippingAddress.city	shippingAddress.city	The city of the customer’s shipping address.	dimension
shippingAddress.company	shippingAddress.company	The company name associated with the shipping address, if applicable.	dimension
shippingAddress.country	shippingAddress.country	The country of the customer’s shipping address.	dimension
shippingAddress.countryId	shippingAddress.countryId	The unique identifier of the country for the customer’s shipping address.	dimension
shippingAddress.street	shippingAddress.street	The street and house number of the customer’s shipping address.	dimension
shippingAddress.zipCode	shippingAddress.zipCode	The postal code of the customer’s shipping address.	dimension
shippingCosts.quantity	shippingCosts.quantity	The number of items associated with the shipping costs for an order.	metric
shippingCosts.tax	shippingCosts.tax	The tax amount applied to the shipping costs.	metric
shippingCosts.totalPrice	shippingCosts.totalPrice	The total price of the shipping costs, including tax.	metric
shippingCosts.unitPrice	shippingCosts.unitPrice	The unit price of the shipping costs, including tax.	metric