The Shopware integration provides ready-made functions you can call when building mappings. They handle common lookups and conversions against your connected Shopware store and your iPaaS.com data, such as resolving products, taxes, units, manufacturers, and categories by name or number, converting customer groups and categories between the two systems, reading order and line item details, translating order and payment statuses, and totaling promotions and quantities, so you do not have to write that logic yourself.

These functions are available anywhere you write a formula for the Shopware integration:

The functions are grouped below by the area of the integration they support.

What it does: Searches Shopware for a product with the given product number and returns its Shopware product ID.

Signature: Task<string> GetProductIdByProductNumber(string ProductNumber)

How to call it: await GetProductIdByProductNumber(ProductNumber)

Returns: string. The Shopware product ID, or null when the product number is blank or no product matches.

Example: "wood-78" returns the matching Shopware product ID.

When to use it: Use it when you have a Shopware product number and need the underlying Shopware product ID.

What it does: Searches Shopware for a product with the given SKU and returns its Shopware product ID.

Signature: Task<string> GetProductIdBySku(string productSku)

How to call it: await GetProductIdBySku(productSku)

Returns: string. The Shopware product ID, or null when the SKU is blank or no product matches.

Example: "P12345" returns the matching Shopware product ID.

When to use it: Use it when synchronizing line items or other records that reference a product by SKU.

What it does: Looks up an iPaaS.com product by its ID and returns the product name.

Signature: Task<string> GetProductNameById(int Id)

How to call it: await GetProductNameById(Id)

Returns: string. The iPaaS.com product name, or null when the ID is not greater than 0 or no product is found.

Example: 34234 returns "Lumber Muted Acacia".

When to use it: Use it when a mapping needs the product name for a known iPaaS.com product ID.

What it does: Looks up a Shopware product by SKU and returns its gross price.

Signature: Task<double> GetProductGrossPriceBySku(string productSku)

How to call it: await GetProductGrossPriceBySku(productSku)

Returns: double. The product's gross price, or 0 when the SKU is blank, the product is not found, or no price is available.

Example: "P12345" returns the product's gross price.

When to use it: Use it when calculating or validating a Shopware product price from its SKU.

What it does: Looks up a manufacturer in Shopware by name and returns its ID. If the manufacturer does not exist and the action is set to create, it creates the manufacturer and returns the new ID.

Signature: Task<string> GetManufacturerIdByName(string ManufactureName, string action = null, string link = null)

How to call it: await GetManufacturerIdByName(ManufactureName, action, link)

Returns: string. The existing or newly created Shopware manufacturer ID, or null when the name is blank or the manufacturer is not found and not created.

Example: await GetManufacturerIdByName("Koro", "create", "www.koro.ca") returns the manufacturer ID, creating it if needed.

When to use it: Use it when mapping a product's manufacturer, optionally creating the manufacturer on first use.

What it does: Looks up a tax rate in Shopware by name and returns its Shopware tax ID.

Signature: Task<string> GetTaxIdByName(string Name)

How to call it: await GetTaxIdByName(Name)

Returns: string. The Shopware tax ID, or null when the tax is not found.

Example: "Standard rate" returns the matching Shopware tax ID.

When to use it: Use it to map the tax ID on a product during creation or update.

What it does: Looks up a unit of measure in Shopware by name and returns its ID.

Signature: Task<string> GetUnitIdByUnitName(string UnitName = null)

How to call it: await GetUnitIdByUnitName(UnitName)

Returns: string. The Shopware unit ID, or null when the name is blank or the unit is not found.

Example: "Kilogram" returns the matching Shopware unit ID.

When to use it: Use it when a mapping needs a unit ID and the unit is already defined in Shopware. Use SetUnitIdByUnitName if the unit should be created when missing.

What it does: Looks up a unit of measure in Shopware by name and returns its ID. If the unit does not exist, it creates the unit (using the name, with a lowercase short code) and returns the new ID.

Signature: Task<string> SetUnitIdByUnitName(string UnitName)

How to call it: await SetUnitIdByUnitName(UnitName)

Returns: string. The existing or newly created Shopware unit ID, or null when the name is blank.

Example: "Kilogram" returns its ID, creating the unit in Shopware first if it does not exist.

When to use it: Use it during product creation or update when the unit must always be present in Shopware, creating it if necessary.

What it does: Looks up a delivery time in Shopware by name and returns its ID.

Signature: Task<string> GetDeliveryTimeIdByName(string Name)

How to call it: await GetDeliveryTimeIdByName(Name)

Returns: string. The Shopware delivery time ID, or null when the delivery time is not found.

Example: "1-3 Tage" returns the matching Shopware delivery time ID.

When to use it: Use it to map a product's delivery time to its Shopware ID.

What it does: Takes the list of categories assigned to an iPaaS.com product and returns the corresponding Shopware category IDs, keeping only the categories that already exist in Shopware.

Signature: Task<List<string>> GetShopwareCategoryIdsFromCategories(object categories)

How to call it: await GetShopwareCategoryIdsFromCategories(categories)

Returns: List<string>. The Shopware category IDs that matched, or null when the input is null.

Example: A list such as ["Electronics", "Home Appliances", "Garden"] returns the Shopware IDs of the categories that exist in Shopware.

When to use it: Use it during product creation or update to link a product to its Shopware categories by ID.

What it does: Searches Shopware for a property group with the given name and returns its ID.

Signature: Task<string> GetPropertyGroupByPropertyGroupName(string name)

How to call it: await GetPropertyGroupByPropertyGroupName(name)

Returns: string. The Shopware property group ID, or null when the name is blank or no property group matches.

Example: "Bike Colour" returns the matching Shopware property group ID.

When to use it: Use it when mapping a product's property (option) group to its Shopware ID.

What it does: Searches Shopware for a property group option with the given name and returns its ID.

Signature: Task<string> GetPropertyGroupByPropertyGroupOptionName(string name)

How to call it: await GetPropertyGroupByPropertyGroupOptionName(name)

Returns: string. The Shopware property group option ID, or null when the name is blank or no option matches.

Example: "Red" returns the matching Shopware property group option ID.

When to use it: Use it when mapping a specific property value (such as a color option) to its Shopware option ID.

What it does: Looks up a tag in Shopware by name and returns its Shopware tag ID.

Signature: Task<string> GetTagIdByName(string Name)

How to call it: await GetTagIdByName(Name)

Returns: string. The Shopware tag ID, or null when the tag is not found.

Example: "Physical" returns the matching Shopware tag ID.

When to use it: Use it to map a tag ID on a product during creation or update.

What it does: Takes a list of Shopware tag IDs and returns their names as a single comma-separated string.

Signature: Task<string> GetTagNames(List<string> TagIds)

How to call it: await GetTagNames(TagIds)

Returns: string. A comma-separated list of tag names, or null when the list is empty or no valid tags are found.

Example: Two tag IDs return a value such as "Preorder, physical".

When to use it: Use it to resolve the tags on a record into readable names during a create or update flow.

What it does: Looks up a sales channel in Shopware by name and returns its ID.

Signature: Task<string> GetChannelIdByName(string Name)

How to call it: await GetChannelIdByName(Name)

Returns: string. The Shopware sales channel ID, or null when the channel is not found.

Example: "Beauty Store PWA" returns the matching Shopware sales channel ID.

When to use it: Use it when assigning products or other records to a specific Shopware sales channel.

What it does: Builds the sales channel visibility assignments for a Shopware product from a list of channel IDs and their visibility values. Existing assignments for the product are updated, and channels no longer listed are removed.

Signature: Task<List<Visibility>> AssignShopwareProductToChannelIds(string productId, string channelIdsWithVisibilities)

How to call it: await AssignShopwareProductToChannelIds(productId, channelIdsWithVisibilities)

Returns: List<Visibility>. The visibility assignments for the product (each with the sales channel ID and visibility value), or null when no valid assignments are produced.

Example: Two sales channel IDs with visibilities are passed as one string in the form id1|30,id2|20.

When to use it: Use it when mapping which sales channels a Shopware product is visible in, and at what visibility level.

What it does: Takes an iPaaS.com location ID and returns the matching Shopware warehouse ID.

Signature: Task<string> GetWareHouseIdByIpaasLocationId(object LocationId)

How to call it: await GetWareHouseIdByIpaasLocationId(LocationId)

Returns: string. The Shopware warehouse ID linked to the location, or null when no match is found.

Example: "34333" returns the linked Shopware warehouse ID.

When to use it: Use it when mapping inventory to the correct Shopware warehouse for an iPaaS.com location.

What it does: Takes one or more Shopware warehouse group names as a comma-separated string and returns their Shopware warehouse group IDs.

Signature: Task<List<string>> GetWareHouseGroupIdsByName(string GroupName)

How to call it: await GetWareHouseGroupIdsByName(GroupName)

Returns: List<string>. The Shopware warehouse group IDs that matched, or null when none are found.

Example: "My Clifton Group,Example Warehouse Group 1" returns the IDs of the warehouse groups that exist in Shopware.

When to use it: Use it when mapping a product or inventory record to one or more Shopware warehouse groups by name.

What it does: Searches Shopware for a customer with the given email address and returns the Shopware customer ID.

Signature: Task<string> GetCustomerIdByEmail(object emailAddress)

How to call it: await GetCustomerIdByEmail(emailAddress)

Returns: string. The Shopware customer ID, or null when the email is blank or no customer matches.

Example: "john.01@gmail.com" returns the matching Shopware customer ID.

When to use it: Use it as a duplicate-email check before creating a customer in Shopware.

What it does: Retrieves a single field (first name, last name, or email) for an iPaaS.com customer by ID.

Signature: Task<string> GetiPaaSCustomerData(string iPaaSCustomerId, string desiredFieldData)

How to call it: await GetiPaaSCustomerData(iPaaSCustomerId, desiredFieldData)

Returns: string. The requested customer field value, or null when the customer or field is not found.

Example: With ID "45454" and "firstname", the customer's first name is returned.

When to use it: Use it in customer creation or update flows, including B2B employee mapping, to pull a specific detail for a known iPaaS.com customer.

What it does: Looks up a customer group in Shopware by name and returns its ID.

Signature: Task<string> GetGroupIdByName(string Name)

How to call it: await GetGroupIdByName(Name)

Returns: string. The Shopware customer group ID, or null when the group is not found.

Example: "B2B" returns the matching Shopware customer group ID.

When to use it: Use it when assigning a customer, product, or transaction to a specific Shopware customer group.

What it does: Converts a Shopware customer group ID into the matching iPaaS.com customer category, returning a single-item list that pairs the iPaaS.com category ID with the Shopware group name.

Signature: Task<object> ConvertShopwareCategoryToiPaaS(string groupId)

How to call it: await ConvertShopwareCategoryToiPaaS(groupId)

Returns: object. A single-item list holding the iPaaS.com customer category (its ID and the Shopware group name), or an empty list when no matching iPaaS.com category exists.

Example: "c5f40f4aa93c45279cb9b6bed7c1a64a" returns the matching iPaaS.com customer category.

When to use it: Use it in customer creation or update flows to map Shopware customer groups to iPaaS.com customer categories.

What it does: Checks whether a B2B employee with the given email already exists in iPaaS.com.

Signature: Task<bool> B2BEmployeeDuplicateCheck(string email)

How to call it: await B2BEmployeeDuplicateCheck(email)

Returns: bool. True when a matching B2B employee already exists, false when the email is blank or no match is found.

Example: "test-b2b@gmail.com" returns true when that B2B employee already exists.

When to use it: Use it during B2B customer relationship creation or update to prevent duplicate employee records.

What it does: Looks up a currency in Shopware by name and returns its Shopware currency ID.

Signature: Task<string> GetCurrencyIdByName(string Name)

How to call it: await GetCurrencyIdByName(Name)

Returns: string. The Shopware currency ID, or null when the currency is not found.

Example: "Euro" returns the matching Shopware currency ID.

When to use it: Use it to map a currency ID on a product or transaction during creation or update.

What it does: Looks up a Shopware currency by ID and returns its name.

Signature: Task<string> GetCurrencyNameById(string Id)

How to call it: await GetCurrencyNameById(Id)

Returns: string. The currency name, or null when the ID is blank or no currency is found.

Example: "b7d2554b0ce847cd82f3ac9bd1c0dfca" returns "Euro".

When to use it: Use it when a mapping needs the currency name for a known Shopware currency ID.

What it does: Looks up a language in Shopware by name and returns its ID. Only language names written in Latin characters are supported.

Signature: Task<string> GetLanguageIdByName(string Name)

How to call it: await GetLanguageIdByName(Name)

Returns: string. The Shopware language ID, or null when the language is not found or the name contains non-Latin characters.

Example: "Suomi" returns the matching Shopware language ID.

When to use it: Use it when setting the language for a product, transaction, or other Shopware record.

What it does: Looks up a country in Shopware by its ISO code and returns the Shopware country ID.

Signature: Task<string> GetCountryIdByIso(string Iso)

How to call it: await GetCountryIdByIso(Iso)

Returns: string. The Shopware country ID, or null when the country is not found.

Example: "fi-FI" returns the matching Shopware country ID.

When to use it: Use it to map country IDs on transactions, customer addresses, or other Shopware records.

What it does: Looks up a country state in Shopware by its short code and returns the Shopware state ID.

Signature: Task<string> GetStateIdByShortCode(string shortCode)

How to call it: await GetStateIdByShortCode(shortCode)

Returns: string. The Shopware country state ID, or null when the state is not found.

Example: "DE-NW" returns the matching Shopware state ID.

When to use it: Use it to map country state IDs on addresses or transaction data.

What it does: Looks up a country in Shopware by ID and returns its name, optionally in a specific language.

Signature: Task<string> CountryNameFromId(string CountryId, string Language = null)

How to call it: await CountryNameFromId(CountryId, Language)

Returns: string. The country name, or null when the country ID is blank or no country is found.

Example: A country ID with the German language returns a value such as "deutsch".

When to use it: Use it when a mapping needs a country's name in a particular language.

What it does: Looks up a country state in Shopware by its country ID and state ID and returns the state name, optionally in a specific language.

Signature: Task<string> StateNameFromId(string CountryId, string CountryStateId, string Language = null)

How to call it: await StateNameFromId(CountryId, CountryStateId, Language)

Returns: string. The country state name, or null when either ID is blank or no state is found.

Example: A country ID and state ID return a value such as "Bremen".

When to use it: Use it when a mapping needs a state's name in a particular language.

What it does: Looks up a payment method in Shopware by name and returns its ID.

Signature: Task<string> GetPaymentIdByName(string Name)

How to call it: await GetPaymentIdByName(Name)

Returns: string. The Shopware payment method ID, or null when the payment method is not found.

Example: "Nachnahme" returns the matching Shopware payment method ID.

When to use it: Use it to set the default payment method ID on transactions or orders in Shopware.

What it does: Looks up a Shopware payment method by ID and returns its name.

Signature: Task<string> GetPaymentMethodNameById(string PaymentId)

How to call it: await GetPaymentMethodNameById(PaymentId)

Returns: string. The payment method name, or null when the ID is blank or no payment method is found.

Example: "3c07c644a5dd4f5e894d5f136ceccc45" returns "Vorkasse".

When to use it: Use it when a mapping needs the readable payment method name for a known Shopware payment method ID.

What it does: Looks up a shipping method in iPaaS.com by name and returns its iPaaS.com ID.

Signature: Task<string> GetShippingMethodIdByName(string name)

How to call it: await GetShippingMethodIdByName(name)

Returns: string. The iPaaS.com shipping method ID, or null when the name is blank or no shipping method matches.

Example: "Standard" returns the matching iPaaS.com shipping method ID.

When to use it: Use it to resolve the shipping method ID for a transaction.

What it does: Looks up a Shopware shipping method by ID and returns its name.

Signature: Task<string> GetShippingMethodNameById(string Id)

How to call it: await GetShippingMethodNameById(Id)

Returns: string. The shipping method name, or null when the ID is blank or no shipping method is found.

Example: "0190106bb38b74f48001d2be909b7d80" returns a value such as "TCS".

When to use it: Use it when a mapping needs the readable shipping method name for a known Shopware shipping method ID.

What it does: Reads a Shopware order's deliveries and returns the shipping order address ID.

Signature: Task<string> GetShippingOrderAddressIdByOrderId(string OrderId)

How to call it: await GetShippingOrderAddressIdByOrderId(OrderId)

Returns: string. The shipping order address ID for the order, or null when the ID is blank or no delivery is found.

Example: "0190106bb38b74f48001d2be909b7d80" returns the order's shipping address ID.

When to use it: Use it when a fulfillment or delivery mapping needs the order's shipping address ID.

What it does: Checks whether a Shopware order exists for the given order ID.

Signature: Task<bool> ShopwareOrderExist(string orderId)

How to call it: await ShopwareOrderExist(orderId)

Returns: bool. True when the order exists, false when the ID is blank or no order is found.

Example: "12345" returns true when that Shopware order exists.

When to use it: Use it to validate that an order exists in Shopware before performing actions such as delivery or invoicing.

What it does: Returns the customer ID associated with a Shopware order.

Signature: Task<string> GetCustomerIdByOrderId(string orderId)

How to call it: await GetCustomerIdByOrderId(orderId)

Returns: string. The customer ID for the order, or null when the ID is blank or no customer is found.

Example: "019b2da383e87181aa9e9a62d72322a8" returns the associated customer ID.

When to use it: Use it when a transaction or return mapping needs the customer tied to an order.

What it does: Returns the billing address ID associated with a Shopware order.

Signature: Task<string> GetBillingAddressIdByOrderId(string orderId)

How to call it: await GetBillingAddressIdByOrderId(orderId)

Returns: string. The billing address ID for the order, or null when the ID is blank or no billing address is found.

Example: "019b2da383e87181aa9e9a62d72322a8" returns the order's billing address ID.

When to use it: Use it when an order or return mapping needs the order's billing address ID.

What it does: Returns the customer email address associated with a Shopware order.

Signature: Task<string> GetEmailByOrderId(string orderId)

How to call it: await GetEmailByOrderId(orderId)

Returns: string. The email address for the order, or null when the ID is blank or no email is found.

Example: "019b0e3575bd70d6a9a8772183e6c38a" returns a value such as "customer@example.com".

When to use it: Use it when an order mapping needs the customer's email, such as for notifications or linking records.

What it does: Returns the Shopware technical name for an order status, given the status display name.

Signature: Task<string> GetOrderTechnicalNameByStatusName(string statusName)

How to call it: await GetOrderTechnicalNameByStatusName(statusName)

Returns: string. The order status technical name, or null when the status name is blank or no match is found.

Example: "Open" returns "open".

When to use it: Use it when a mapping must set a Shopware order status by its technical name.

What it does: Returns the Shopware technical name for an order delivery status, given the status display name.

Signature: Task<string> GetOrderDeliveryTechnicalNameByStatusName(string statusName)

How to call it: await GetOrderDeliveryTechnicalNameByStatusName(statusName)

Returns: string. The order delivery status technical name, or null when the status name is blank or no match is found.

Example: "Shipped" returns "shipped".

When to use it: Use it when synchronizing transaction tracking or delivery status by its Shopware technical name.

What it does: Returns the Shopware technical name for an order payment status, given the status display name.

Signature: Task<string> GetOrderTransactionTechnicalNameByStatusName(string statusName)

How to call it: await GetOrderTransactionTechnicalNameByStatusName(statusName)

Returns: string. The order payment status technical name, or null when the status name is blank or no match is found.

Example: "Paid" returns "paid".

When to use it: Use it when synchronizing payment status by its Shopware technical name.

What it does: Looks up a Shopware state by ID and returns the transaction (payment) state name.

Signature: Task<string> TransactionStateNameFromId(string stateId)

How to call it: await TransactionStateNameFromId(stateId)

Returns: string. The transaction state name, or null when the ID is blank or no state is found.

Example: A state ID returns a value such as "Pending".

When to use it: Use it when a mapping needs the readable transaction state name for a known state ID.

What it does: Looks up a Shopware state by ID and returns the order state name.

Signature: Task<string> OrderStateNameFromId(string stateId)

How to call it: await OrderStateNameFromId(stateId)

Returns: string. The order state name, or null when the ID is blank or no state is found.

Example: A state ID returns a value such as "Pending".

When to use it: Use it when a mapping needs the readable order state name for a known state ID.

What it does: Looks up a Shopware state by ID and returns the order line state name.

Signature: Task<string> OrderLineStateNameFromId(string stateId)

How to call it: await OrderLineStateNameFromId(stateId)

Returns: string. The order line state name, or null when the ID is blank or no state is found.

Example: A state ID returns a value such as "Pending".

When to use it: Use it when a mapping needs the readable order line state name for a known state ID.

What it does: Returns the Shopware order state ID for a state name in a given language.

Signature: Task<string> GetStateIdByOrderStateName(string StateName, string LanguageName)

How to call it: await GetStateIdByOrderStateName(StateName, LanguageName)

Returns: string. The Shopware order state ID, or null when either value is blank or no match is found.

Example: await GetStateIdByOrderStateName("Open", "English") returns the matching order state ID.

When to use it: Use it when setting a Shopware order's state from a state name.

What it does: Returns the Shopware order delivery state ID for a state name in a given language.

Signature: Task<string> GetStateIdByOrderDeliveryStateName(string StateName, string LanguageName)

How to call it: await GetStateIdByOrderDeliveryStateName(StateName, LanguageName)

Returns: string. The Shopware order delivery state ID, or null when either value is blank or no match is found.

Example: await GetStateIdByOrderDeliveryStateName("Shipped", "English") returns the matching delivery state ID.

When to use it: Use it when setting a Shopware order delivery's state from a state name.

What it does: Returns the Shopware order return state ID for a state name in a given language.

Signature: Task<string> GetStateIdByOrderReturnStateName(string StateName, string LanguageName)

How to call it: await GetStateIdByOrderReturnStateName(StateName, LanguageName)

Returns: string. The Shopware order return state ID, or null when either value is blank or no match is found.

Example: await GetStateIdByOrderReturnStateName("Open", "English") returns the matching return state ID.

When to use it: Use it when setting a Shopware order return's state from a state name.

What it does: Returns the Shopware order line item state ID for a state name.

Signature: Task<string> GetStateIdByOrderLineStateName(string StateName)

How to call it: await GetStateIdByOrderLineStateName(StateName)

Returns: string. The Shopware order line item state ID, or null when the name is blank or no match is found.

Example: "Open" returns the matching order line item state ID.

When to use it: Use it when setting a Shopware order line item's state from a state name.

What it does: Returns the Shopware order line ID for a given order and product SKU.

Signature: Task<string> GetShopwareOrderLineIdByOrderIdAndProductSku(string orderId, string productSku)

How to call it: await GetShopwareOrderLineIdByOrderIdAndProductSku(orderId, productSku)

Returns: string. The Shopware order line ID, or null when either value is blank or no matching line is found.

Example: Order "12345" and SKU "SKU-789" return the matching order line ID.

When to use it: Use it to identify a specific line item within a Shopware order, such as for updates, fulfillment, or returns.

What it does: Returns the price details of a Shopware order line for a given order and product SKU.

Signature: Task<Price> GetShopwareOrderLinePriceByOrderIdAndProductSku(string orderId, string productSku)

How to call it: await GetShopwareOrderLinePriceByOrderIdAndProductSku(orderId, productSku)

Returns: Price. The line's price details (unit price, total price, tax rules, calculated taxes, quantity, and related prices), or null when either value is blank or no matching line is found.

Example: Order "12345" and SKU "SKU-789" return the line's price details.

When to use it: Use it for financial calculations, invoice generation, or validating pricing on a Shopware order line.

What it does: Returns the SKU for a Shopware order line item ID.

Signature: Task<string> GetLineItemSku(string orderLineId)

How to call it: await GetLineItemSku(orderLineId)

Returns: string. The line item's SKU, or null when the ID is blank or no SKU is found.

Example: "019b0e3575bd70d6a9a8772183e6c38a" returns a value such as "SKU-ABC-123".

When to use it: Use it when an order or return mapping needs the product SKU for a specific order line.

What it does: Returns the description for a Shopware order line item ID.

Signature: Task<string> GetLineItemDescription(string orderLineId)

How to call it: await GetLineItemDescription(orderLineId)

Returns: string. The line item's description, or null when the ID is blank or no description is found.

Example: "019b0e3575bd70d6a9a8772183e6c38a" returns a value such as "Red Cotton T-Shirt, Size M".

When to use it: Use it when populating line item details in an order or return transaction.

What it does: Finds the iPaaS.com line item on a transaction whose SKU matches the given value and returns that line item's iPaaS.com ID.

Signature: Task<string> GetiPaaSLineItemId(string sku, string iPaaSOrderId)

How to call it: await GetiPaaSLineItemId(sku, iPaaSOrderId)

Returns: string. The iPaaS.com line item ID, or null when no line item with that SKU is found.

Example: SKU "150556" on order "12543" returns the matching iPaaS.com line item ID.

When to use it: Use it when creating partial deliveries that must reference the iPaaS.com line item behind a SKU.

What it does: Returns the quantity of a specific line item on an iPaaS.com transaction, located by the line item ID.

Signature: Task<int?> GetiPaaSTransactionLineItemQuantity(string iPaaSLineItemId)

How to call it: await GetiPaaSTransactionLineItemQuantity(iPaaSLineItemId)

Returns: int?. The line item quantity, or 0 when the line item is not found.

Example: "150556" returns the quantity of that line item.

When to use it: Use it when processing transactions to read a line item's quantity for fulfillment, inventory, or mapping.

What it does: Finds the line on an iPaaS.com transaction whose SKU matches the given value and returns its quantity as a 64-bit integer.

Signature: Task<long> GetQuantityOfLineItem(string iPaaSLineItemId, string iPaaSOrderId)

How to call it: await GetQuantityOfLineItem(iPaaSLineItemId, iPaaSOrderId)

Returns: long. The matched line item's quantity, or 0 when the transaction or a matching SKU is not found.

Example: SKU "SKU-00123" on order "ORD-98765" returns the line's quantity.

When to use it: Use it during order mapping or sync when a line item's quantity must be resolved by SKU before writing to Shopware.

What it does: Adds up the quantities across a list of transaction lines and returns the total.

Signature: int GetQtyOfLines(List<TransactionLine> TransactionLineObject)

How to call it: GetQtyOfLines(TransactionLineObject)

Returns: int. The total quantity across all lines, or 0 when the list is empty or the total is not greater than 0.

Example: Two lines with quantities 1 and 2 return 3.

When to use it: Use it to compute the total item count for a transaction.

What it does: Adds up the total price of every promotion on a transaction and returns the sum.

Signature: Task<double> GetSumOfPromotions(object Promotions)

How to call it: await GetSumOfPromotions(Promotions)

Returns: double. The total value of all promotions (as a positive amount), or 0 when there are none.

Example: A single promotion with a total price of 77 returns 77.

When to use it: Use it to total the promotion value on a transaction.

What it does: Reads a value from an iPaaS.com custom field object by matching the given custom field name.

Signature: Task<object> GetValueFromCustomField(object customFieldObj, object textFieldName)

How to call it: await GetValueFromCustomField(customFieldObj, textFieldName)

Returns: object. The matched custom field value, or null when either input is null or no field matches.

Example: With a custom field named "First Name", passing "First Name" returns that field's value.

When to use it: Use it in creation or update flows where a custom field value must be read or normalized.

What it does: Reads the date value of a named custom field. When the field has no value, it returns the current date plus 2 days; otherwise it returns the field's date.

Signature: object SetDateInCustomFieldEarliestArrival(object customFieldObjValue, string FieldName)

How to call it: SetDateInCustomFieldEarliestArrival(customFieldObjValue, FieldName)

Returns: object. The field's date when present, the current date plus 2 days when the field is empty, or null when the inputs are missing or the field is not found.

Example: For an earliest arrival date field with no value, the current date plus 2 days is returned.

When to use it: Use it to set an earliest arrival date, with a fallback when none is provided.

What it does: Reads the date value of a named custom field. When the field has no value, it returns the current date plus 14 days; otherwise it returns the field's date.

Signature: object SetDateInCustomFieldLatestArrival(object customFieldObjValue, string FieldName)

How to call it: SetDateInCustomFieldLatestArrival(customFieldObjValue, FieldName)

Returns: object. The field's date when present, the current date plus 14 days when the field is empty, or null when the inputs are missing or the field is not found.

Example: For a latest arrival date field with no value, the current date plus 14 days is returned.

When to use it: Use it to set a latest arrival date, with a fallback when none is provided.

What it does: Generates a new globally unique identifier and returns it as a compact 32-character hexadecimal string with no hyphens.

Signature: object GetUniqueID()

How to call it: GetUniqueID()

Parameters: none.

Returns: object. A 32-character hexadecimal unique identifier (its underlying type is a string).

Example: Returns a value such as "a3f4c2d1e5b647809f1234567890abcd".

When to use it: Use it to generate a collision-free identifier for a record or transaction without relying on a database sequence.

What it does: Returns the value of a subscription preset setting by its name.

Signature: string GetPresetValue(string presetName)

How to call it: GetPresetValue(presetName)

Returns: string. The preset value, or null when the name is blank or the setting cannot be resolved.

Example: "Currency ID" returns the value configured for that preset.

When to use it: Use it to read an optional configuration value defined at the subscription level, without hard-coding it in a mapping.