Skip to main content

Adobe Commerce/Magento 2 to iPaaS.com Deposit Ticket Mapping Documentation

How the deposit ticket raised from an Adobe Commerce/Magento 2 order transfers into iPaaS.com, carrying the non-gift-card portion of the order and its lines, tax and payments.

Summary

The integration raises a deposit ticket from an Adobe Commerce/Magento 2 order and transfers it into iPaaS.com as its own Transaction of type Ticket. The ticket carries the non-gift-card portion of the originating order — its ordinary product lines, its tax, and its payments — and is linked back to the order's Transaction as its parent.

The ticket is identified by an order number ending in -D. That suffix is applied by the integration itself when it raises the ticket; it is not a store naming convention and subscribers do not configure anything in Magento to produce it.

Four child collections write the ticket's lines, tax, and payments onto the same Transaction. The family is add-only — it creates deposit tickets and does not maintain them afterwards. The transfer is unidirectional.

ID Format

Manual Sync ID Format

Enter the deposit ticket's record identifier — the originating Magento order record identifier with the -D suffix appended, for example 1234-D.

The plain order record identifier without the suffix resolves the originating order rather than the ticket.

External ID Format

After a successful transfer, iPaaS.com stores the deposit ticket's identifier as the external ID on a record linking it to the iPaaS.com Transaction. The ticket's own TransactionNumber carries the suffixed order number, and a separate mapping records the underlying Magento entity identifier.

The ticket is also linked to its originating order: the ParentId mapping strips the -D suffix from the ticket's identifier and looks up the Transaction created for that order, so the ticket hangs beneath the order rather than standing alone.

Deleted Record Support

Outbound delete is not supported for deposit tickets. Removing an order or ticket in Adobe Commerce/Magento 2 does not remove the corresponding Transaction from iPaaS.com, and delete mappings are not included in the default templates for this family.

Custom Field Support

Several destination fields in this family are iPaaS.com custom fields rather than standard Transaction fields, and must exist in the subscriber's environment before the mappings that populate them will land:

  • Mage Entity ID on the Transaction, recording the underlying Magento order entity identifier.

  • SellingUnit on the Transaction Line.

  • Giftcard Number and AuthCode on the Transaction Payment.

Mapping Collection Status

Status: Enabled. All five collections in this family ship enabled.

Trigger Events: Creation of a deposit ticket raised from an order in Adobe Commerce/Magento 2, plus Manual Sync on demand.

Adobe Commerce/Magento 2 has no native webhook capability, so automatic transfers depend on the third-party webhook extension being installed and configured in the Magento store. Manual Sync is always available regardless.

A deposit ticket is raised for every order that reaches iPaaS.com, not only for orders that took a deposit. Subscribers or their MiSP should expect one ticket Transaction per order and size their expectations for volume and downstream processing accordingly. Where only some orders should produce a deposit ticket, that condition must be applied through this collection's mapping filter.

Duplicate or Conflicting Mappings

Two other parent collections read the same underlying Adobe Commerce/Magento 2 orders and are separated from this one only by the order-number suffix in their filters:

  • Add/Update Adobe Commerce/Magento 2 Order TO iPaaS.com processes ordinary orders — those whose order number ends in neither -D nor -GC.

  • Add/Update Adobe Commerce/Magento 2 Gift Card Ticket TO iPaaS.com processes the orders whose order number ends in -GC.

Because all three families operate over the same underlying orders, the suffix conditions in the three filters are what prevent one record from being processed twice into conflicting Transactions. Subscribers or their MiSP should review all three filters together before enabling or modifying any of them. Loosening the suffix condition on any one collection can cause the same record to be written by more than one.

This family also depends on Add Adobe Commerce/Magento 2 Gift Card TO iPaaS.com where a deposit is paid by gift card: the gift-card payment child resolves a card by its number, so the card must already have been transferred.

Duplicate matching

This integration implements no selectable collision-handling methods, and the behavior is not configurable on these collections. The external-ID record linking the ticket to its iPaaS.com Transaction decides whether a transfer creates or updates; TransactionNumber acts as the fallback match where no link yet exists.

Because this family is add-only, a ticket already present in iPaaS.com is not overwritten by a later transfer.

Unmapped field overwrite risk

The add-only setting means an existing deposit ticket Transaction is not overwritten, so the usual re-transfer overwrite risk does not apply here. The fields written on creation are, on the header, Mage Entity ID, SystemId, TransactionNumber, ParentId, Type, Status, EmailAddress, DiscountAmount, TaxAmount, ShippingAmount, Subtotal, Total, TotalQty and TransactionCreatedDateTime — together with the line, tax and payment values written by the four child collections.

The consequence runs the other way: because later changes are not sent, a deposit ticket does not track subsequent changes to the originating order. A ticket reflects the order as it stood when the ticket was raised.

The mitigation is a DestinationValue. Where an iPaaS.com field must hold a specific value that the source record does not supply, set a DestinationValue on that mapping so the integration writes the value chosen there instead of taking it from the source.

Supported Child Collections

The parent collection is Add Adobe Commerce/Magento 2 Deposit Ticket TO iPaaS.com. It is the parent of four child collections, each of which writes its records onto the Transaction created by the parent and none of which transfers independently of it:

  • Add Adobe Commerce/Magento 2 Deposit Ticket Line TO iPaaS.com: the ticket's ordinary product lines.

  • Add Adobe Commerce/Magento 2 Deposit Ticket Tax TO iPaaS.com: the ticket's single consolidated tax record.

  • Add Adobe Commerce/Magento 2 Deposit Ticket Payment TO iPaaS.com: payments for every tender other than gift card.

  • Add Adobe Commerce/Magento 2 Deposit Ticket Payment Gift Card TO iPaaS.com: gift card tender payments.

System Caveats

Adobe Commerce/Magento 2 Caveats

  • The ticket is raised by the integration, not by Magento. The -D suffix and the ticket record itself are produced by the integration from the originating order. Nothing needs to be configured in Magento to create them.

  • Gift-card lines are excluded from the ticket. The line collection matches only lines whose product type is not a gift voucher, so a gift card sold on the originating order is carried by the gift card ticket family rather than here.

  • Gift-card lines are matched on one product type. A store whose gift-card products use a different product type, such as amgiftcard, must update this collection's line filter and its line Type formula, or those lines will be captured here as ordinary products. The complete list of values to change is in the Adobe Commerce/Magento 2 Known Limitations article.

  • Ticket retrieval is subject to Magento's API limits. Because a ticket is raised for every order, the request volume roughly doubles against the order family alone. Stagger large manual catch-up runs rather than issuing them concurrently.

iPaaS.com Caveats

  • The originating order must have transferred first. The ParentId mapping resolves the Transaction created for the order the ticket was raised from. If that order has not transferred, the ticket has no parent to attach to.

  • A customer identity must be resolvable. Every Transaction must be tied to a customer; this family satisfies that through the order's email address.

  • Payment methods must be configured. The translated payment method value must match a Payment Method configured in the subscriber's iPaaS.com environment, or the payment cannot be written.

  • A gift card paying for a deposit must exist in iPaaS.com. The gift-card payment child resolves a card by its number.

Integration-Specific Caveats

  • A deposit ticket is raised for every order. As shipped there is no business-rule condition restricting ticket creation to orders that actually took a deposit. Subscribers receive one ticket Transaction per order, which may represent no real deposit. Where only some orders should produce one, add that condition to this collection's mapping filter.

  • The ticket's totals net out gift cards sold. Subtotal is the order's subtotal less the value of any gift cards sold, and Total is that subtotal plus tax, shipping and discount, again less the gift cards sold. TotalQty counts only non-gift-card items. This is what keeps the deposit ticket and the gift card ticket from double-counting the same order.

  • The status is fixed. Every deposit ticket arrives as Pending, regardless of the originating order's Magento status. The order and gift card ticket families translate the Magento status instead.

  • The family is add-only. A deposit ticket is a point-in-time record of the order as it stood when the ticket was raised, and is not maintained afterwards.

  • Gift-card totals do not account for line quantity at the time this documentation was written. Where a gift-card line carries a quantity greater than one, the amount netted out of the deposit ticket's totals may be understated. Subscribers or their MiSP whose stores sell multiple gift cards on one line should verify the resulting ticket totals before relying on them.

Setup Requirements

Adobe Commerce/Magento 2 Configuration

  • Install and configure the third-party webhook extension if tickets should transfer automatically.

  • Confirm the product type the store's gift card products use, so gift-card lines are correctly excluded here.

iPaaS.com Configuration

  • Confirm the order family is enabled and orders are transferring, since the ticket links to the originating order's Transaction.

  • Decide whether a deposit ticket is wanted for every order, and add a filter condition here if not.

  • Enable Add Adobe Commerce/Magento 2 Gift Card TO iPaaS.com and load the store's cards where deposits are paid by gift card.

  • Review the payment method Lookup Translation and confirm every destination value matches a Payment Method configured in the environment.

  • Create the iPaaS.com custom fields listed under Custom Field Support above.

  • Review the filters on this collection and on the order and gift card ticket parents together, confirming the three families remain mutually exclusive.

  • Enable the inbound flow for Adobe Commerce/Magento 2 orders on the subscription's Inbound Data Flows page.

Full step-by-step setup instructions are in the Adobe Commerce/Magento 2 Installation Instructions article, and the webhook extension setup is covered in Configure Mageplaza Webhooks for iPaaS.com.

Integration Flow

  1. An order is placed in Adobe Commerce/Magento 2 and transfers to iPaaS.com through the order family.

  2. The integration raises a deposit ticket from that order, giving it the order's identifier with a -D suffix.

  3. The ticket is evaluated against this collection's filter, which admits only records whose number ends in -D, excludes anything ending in -GC, and excludes Magento's two fraud statuses.

  4. The ParentId mapping strips the suffix and looks up the Transaction created for the originating order, so the ticket is attached beneath it.

  5. The parent mappings populate the ticket header, with the totals netting out any gift cards sold on the order.

  6. The child collections write the ticket's ordinary product lines, its single tax record, and its payments onto the same Transaction.

Prerequisite Handling

Prerequisite processing is deliberately skipped for the ticket itself. A record whose number ends in -D or -GC returns immediately, because its prerequisites — the customer, and any gift cards sold — were already handled by the originating order's transfer.

The practical consequence is that a ticket cannot be relied upon to bring its own customer or gift cards with it. If the originating order failed to transfer, the ticket will be missing its parent Transaction and potentially the records its payments refer to.

Mappings

Add Adobe Commerce/Magento 2 Deposit Ticket TO iPaaS.com (Parent)

iPaaS.com data type: Transaction

Mapping Filter

IncrementId.EndsWith("-D") && !IncrementId.EndsWith("-GC") && !(Status  ==  "suspected_fraud") && !(Status  ==  "fraud")

This collection processes only records whose order number ends in -D, the suffix the integration applies when it raises a deposit ticket. The second condition excludes anything ending in -GC, keeping gift card tickets out. The two fraud conditions exclude records Magento has flagged as suspect, so they do not reach downstream fulfillment or financial systems. Records that do not pass are skipped without error.

Subscribers or their MiSP whose store uses custom fraud-review statuses beyond Magento's two built-in values should extend this filter to exclude those statuses as well. This is also the filter to extend where only some orders should produce a deposit ticket.

Mapping Type

Source Field (Adobe Commerce/Magento 2)

Destination Field (iPaaS.com)

Description

Dynamic Formula

SpaceportSystemId

SystemId

Required. Resolves the current subscription's system identifier. Do not change or remove this mapping.

Field

IncrementId

TransactionNumber

Required. The suffixed ticket number. Also the fallback duplicate-detection key.

Static

"Ticket"

Type

Required. Fixed so deposit tickets land in the ticket bucket downstream rather than with ordinary orders.

Static

"Pending"

Status

Required. Every deposit ticket arrives Pending, regardless of the originating order's Magento status.

Dynamic Formula

return await GetSpaceportIdAsync(EntityId.Substring(0, EntityId.Length - 2), "Transaction", SpaceportSystemId);

ParentId

Required. Links the ticket to its originating order by stripping the two-character -D suffix from the identifier and looking up that order's Transaction. If the originating order has not transferred, no parent is resolved.

Field

CustomerEmail

EmailAddress

Recommended. Ties the Transaction to a customer.

Dynamic Formula

Subtotal - GiftCardSoldTotal(Items)

Subtotal

Recommended. The order's subtotal less the value of any gift cards sold on it, so the deposit ticket and the gift card ticket do not double-count the same order.

Dynamic Formula

Subtotal + TaxAmount + ShippingAmount + DiscountAmount - GiftCardSoldTotal(Items)

Total

Recommended. The netted subtotal plus tax, shipping and discount, less the gift cards sold.

Dynamic Formula

ProductSoldCount(Items)

TotalQty

Recommended. The count of non-gift-card items on the originating order.

Field

DiscountAmount

DiscountAmount

Recommended. The originating order's discount total.

Field

TaxAmount

TaxAmount

Recommended. The originating order's tax total.

Field

ShippingAmount

ShippingAmount

Recommended. The originating order's shipping total.

Field

EntityId

Mage Entity ID (custom field)

Optional. Records the underlying Magento order entity identifier on the ticket.

Dynamic Formula

DateTimeOffsetFromLocalDateTime(CoalesceToDateTime(CreatedAt))

TransactionCreatedDateTime

Optional. The originating record's created date. Unlike the order family, which stamps the transfer time, this reads the source date.

Add Adobe Commerce/Magento 2 Deposit Ticket Line TO iPaaS.com (Child)

iPaaS.com data type: Transaction Line

Mapping Filter

IsEmpty(ParentItemId) && ProductType != "giftvoucher"

This collection writes the ticket's ordinary product lines. A line passes only when it is a top-level line — which excludes the duplicate child lines that configurable and bundle products generate in Magento — and only when its product type is not a gift voucher, since gift cards belong to the gift card ticket family.

Mapping Type

Source Field (Adobe Commerce/Magento 2)

Destination Field (iPaaS.com)

Description

Dynamic Formula

(ProductType == "giftvoucher" ? "Gift Card" : "Product")

Type

Required. Resolves to Product for every line this collection processes, because the filter already excludes gift vouchers.

Static

"Pending"

Status

Required. Lines are staged as Pending so downstream processing advances them from a consistent starting point.

Dynamic Formula

SkuFromOrderLine(Sku.Replace("/", "-"))

Sku

Required. Takes the line SKU, replaces forward slashes with hyphens, and strips any unit suffix so the base catalog SKU is sent. Must match an existing product or variant. Also the line match key on re-sync.

Field

Description

Description

Recommended. The item name on the line.

Field

QtyOrdered

Qty

Recommended. Also feeds the per-unit price calculation on this line.

Dynamic Formula

Price - (DiscountAmount / QtyOrdered.Value)

UnitPrice

Recommended. Net price per unit after the per-unit share of the line discount. Ensure the quantity source is present and greater than zero.

Field

RowTotal

ExtendedPrice

Recommended. Extended line amount before line-level tax.

Field

DiscountAmount

DiscountAmount

Recommended. Line-level discount amount.

Field

SellUnit

SellingUnit (custom field)

Optional. The line's unit of measure.

Field

OriginalPrice

OriginalUnitPrice

Optional. Pre-discount unit price.

Field

DiscountPercent

DiscountPercent

Optional. Line-level discount percentage.

Field

TaxPercent

TaxPercent

Optional. Line-level tax rate.

Field

Weight

Weight

Optional. Item weight.

Note that this collection maps no line-level tax amount, where the equivalent order line collection does. Line tax reaches the ticket only through the consolidated tax record below.

Add Adobe Commerce/Magento 2 Deposit Ticket Tax TO iPaaS.com (Child)

iPaaS.com data type: Transaction Tax

This collection carries no mapping filter. It runs against every ticket the parent transfers and writes a single consolidated tax record.

Mapping Type

Source Field (Adobe Commerce/Magento 2)

Destination Field (iPaaS.com)

Description

Dynamic Formula

(Parent.ExtensionAttributes != null && Parent.ExtensionAttributes.AppliedTaxes != null && Parent.ExtensionAttributes.AppliedTaxes.Count > 0 ? Parent.ExtensionAttributes.AppliedTaxes[0].Title : "Avalara")

Authority

Recommended. The taxing authority, from the title of the first applied tax, falling back to a built-in default when the record carries no applied-tax detail.

Dynamic Formula

Parent.TaxAmount

Amount

Recommended. The whole record's tax rather than a breakdown by jurisdiction or line.

Add Adobe Commerce/Magento 2 Deposit Ticket Payment TO iPaaS.com (Child)

iPaaS.com data type: Transaction Payment

Mapping Filter

Method != "giftcard"

This collection writes the ticket's payments for every tender other than gift card.

Mapping Type

Source Field (Adobe Commerce/Magento 2)

Destination Field (iPaaS.com)

Description

Lookup Translation

Lookup Translation: M2 Transaction Payment Method To iPaaS

Method

Required. The translated value must match a Payment Method configured in iPaaS.com, or the payment cannot be written.

Dynamic Formula

(Parent.Status == "pending" ? (ConvertToDecimal(AmountOrdered)-GiftCardSoldTotal(Parent.Items)) : (ConvertToDecimal(AmountPaid)-GiftCardSoldTotal(Parent.Items)))

Amount

Recommended. Uses the amount ordered while the order is pending and the amount paid afterwards, subtracting gift cards sold so they are not double-counted.

Dynamic Formula

(CoalesceToDecimal(BaseAmountPaid,0) > 0 ? "Complete" : "Authorized")

Status

Recommended. Set to Complete when any amount has been paid, otherwise Authorized.

Field

Method

Description

Optional. Preserves the raw Magento method code alongside the translated value.

Add Adobe Commerce/Magento 2 Deposit Ticket Payment Gift Card TO iPaaS.com (Child)

iPaaS.com data type: Transaction Payment

Mapping Filter

Method=="giftcard"

This collection writes the ticket's gift card tender payments — that is, where a gift card was used to pay the deposit.

Mapping Type

Source Field (Adobe Commerce/Magento 2)

Destination Field (iPaaS.com)

Description

Dynamic Formula

var gcNumber = await iPaaSGiftCardIdAsync(giftcardnumber); return JSONToDictionary("{\"GiftCardId\":\"" + gcNumber + "\"}");

MethodInfo

Required for gift-card payments. Resolves the payment's gift card number to the matching iPaaS.com gift card and records its identifier. The card must already exist in iPaaS.com.

Lookup Translation

Lookup Translation: M2 Transaction Payment Method To iPaaS

Method

Required. The gift card row is the one that applies here.

Static

"Complete"

Status

Recommended. Gift-card tenders are treated as already collected.

Dynamic Formula

(Parent.Status == "pending" ? (ConvertToDecimal(AmountOrdered)-GiftCardSoldTotal(Parent.Items)) : (ConvertToDecimal(AmountPaid)-GiftCardSoldTotal(Parent.Items)))

Amount

Recommended. Same calculation as the standard payment collection.

Field

giftcardnumber

Giftcard Number (custom field)

Optional. Records which gift card was used.

Field

authcode

AuthCode (custom field)

Optional. Preserves the gift-card authorization reference.

Field

Method

Description

Optional. Preserves the raw Magento method code.

Lookup Translations

M2 Transaction Payment Method To iPaaS

Used by the Method mapping on both payment collections. The parent collection uses a fixed status rather than a translation, so no status translation applies to this family.

Source Value

Destination Value

Notes

authnetcim

CASH

authorizenet

CASH

braintree

CASH

checkmo

CASH

paypal_express

CASH

purchaseorder

CASH

giftcard

GC

Applies to the gift card payment collection only.

Add a row for any payment method the store uses that is not already listed, and confirm each destination value matches a Payment Method configured in the environment. A payment whose method code is missing from this translation will not be matched.

Error Handling

The full catalog of messages this integration produces, with causes and resolutions, is in the Adobe Commerce/Magento 2 Error Messages article. The conditions most often seen on this transfer are:

  • A ticket with no parent Transaction. The originating order had not transferred when the ticket was processed. Resolution: confirm the order transferred, then re-sync the ticket.

  • A gift card reference that cannot be resolved. A gift-card payment names a card that does not exist in iPaaS.com. Resolution: transfer the card through the gift card collection, then re-sync.

  • A payment method that is not configured. Resolution: add the missing translation row, or configure the Payment Method in iPaaS.com.

  • A line SKU that does not resolve. A product line names a SKU with no matching iPaaS.com product or variant. Resolution: transfer the product, then re-sync.

Errors are reported under Dashboard / Integration Monitoring / Error Logs.

Testing & Validation

Test Scenarios

  1. Place an order in Adobe Commerce/Magento 2 and confirm both the order Transaction and a separate deposit ticket Transaction of type Ticket arrive in iPaaS.com.

  2. Confirm the ticket is linked to the originating order's Transaction as its parent.

  3. Manually sync using the suffixed identifier and confirm it resolves; confirm the unsuffixed identifier resolves the order instead.

  4. Confirm the ticket arrives with a status of Pending regardless of the originating order's Magento status.

  5. Place an order containing both ordinary products and a gift card, and confirm the deposit ticket's totals exclude the gift-card value while the gift card ticket carries it.

  6. Confirm the deposit ticket's lines exclude the gift-card line.

  7. Pay a deposit with a gift card and confirm the payment routes to the gift card payment collection and links to the correct card.

  8. Update the originating order after the ticket has transferred, re-run, and confirm the ticket is not updated — verifying the add-only behavior.

  9. Place an order and set its Magento status to a fraud status, then confirm no deposit ticket is processed.

  10. Confirm the expected volume: one deposit ticket per order, and decide whether a filter condition is needed to reduce it.

Validation Checklist

  • The order family is enabled and orders are transferring, so tickets have a parent to attach to.

  • The decision on whether every order should raise a deposit ticket has been made, and a filter condition added if not.

  • Every custom field listed under Custom Field Support exists in the iPaaS.com environment.

  • The payment method translation covers every method the store uses.

  • The parent filters on the order, deposit ticket and gift card ticket families remain mutually exclusive.

  • The gift-card product type used by the store matches the value in the line filter.

  • Custom fraud-review statuses, where the store uses them, have been added to this filter.

Additional Notes

  • The -D suffix is an integration constant applied when the ticket is raised from an originating order. It is not a store naming convention and requires no configuration in Magento.

  • A deposit ticket is raised for every order that reaches iPaaS.com. Where that is more than a subscriber needs, the mapping filter is the place to restrict it.

  • The ticket's totals deliberately net out gift cards sold, which is what keeps the deposit ticket and the gift card ticket from double-counting the same order.

  • The family is add-only, so a ticket is a point-in-time record of the order as it stood when the ticket was raised.

  • Validate dynamic formulas and filter changes in a staging environment before enabling automatic transfers in production.

Related Documents

Did this answer your question?