Connect with Us!
Latest Event
Latest Case Study
Latest Case Study
Discover Affino
Subscriptions Import Guide
Introduction
We have created a new subscription import engine for Clients to migrate their subscriptions to Affino.
For this, we have unified the Order import into a single file, including the new Subscription Import.
The file will be split into different sheet tabs within the XLSX file:
- Orders Import
- Orders Line Items Import
- Subscriptions Import
Please note: you will need to have created your catalogue items first before you can relate the orders, order line items and subscriptions with the import.
Order Import
The subscription import will be performed via the Order Import screen.
Control > Commerce > Order Import
Click on the Help button to read the help text for each field.
You can also download the sample file used for the import:
Columns: Orders Import
The following columns are set in the Orders Import sheet (tab):
- ExternalOrderID
- PreviousExternalOrderID
- OrderDate
- OrderNote
- OrderStatus
- OrderType
- CurrencyCode
- SubTotal
- CouponCode
- Coupon
- Discount
- Shipping
- Tax
- Total
- PaymentMethod
- PaymentReference
- PaymentStatus
- PaymentDate
- PaymentAmount
- PaymentTax
- PaymentGatewaySubscriptionID
- PaymentGatewayCreated
- PaymentGatewayStatus
- PaymentGatewayCustomerID
- PaymentGatewayPaymentProvider
- PaymentGatewayMandate
- PaymentIntentID
- CustomerExternalUserID
- CustomerUserCode
- CustomerFirstName
- CustomerLastName
- CustomerEmail
- CustomerAccountName
- EndUserFirstName
- EndUserLastName
- EndUserEmail
- OrderOwnerFirstName
- OrderOwnerLastName
- OrderOwnerEmail
- InvoiceTitle
- InvoiceFirstName
- InvoiceLastName
- InvoiceTelephone1
- InvoiceTelephone2
- InvoiceFax
- InvoiceEmail
- InvoiceWebsite
- InvoiceCompany
- InvoiceAddress1
- InvoiceAddress2
- InvoiceTownCity
- InvoiceCountyState
- InvoiceISOCode
- InvoiceCountry
- InvoicePostcodeZip
- BillingTitle
- BillingFirstName
- BillingLastName
- BillingTelephone1
- BillingTelephone2
- BillingFax
- BillingEmail
- BillingWebsite
- BillingCompany
- BillingAddress1
- BillingAddress2
- BillingTownCity
- BillingCountyState
- BillingISOCode
- BillingCountry
- BillingPostcodeZip
- DeliveryTitle
- DeliveryFirstName
- DeliveryLastName
- DeliveryTelephone1
- DeliveryTelephone2
- DeliveryFax
- DeliveryEmail
- DeliveryWebsite
- DeliveryCompany
- DeliveryAddress1
- DeliveryAddress2
- DeliveryTownCity
- DeliveryCountyState
- DeliveryISOCode
- DeliveryCountry
- DeliveryPostcodeZip
- DeliveryMethod
- DeliveryDate
- DeliveryTimeFrame
- AWBDetails
- GiftYN
- GiftAidYN
- StoreProfileName
- IPAddress
- Referrer
Columns: Orders Line Items Import
The following columns are set in the Orders Line Items Import sheet (tab):
- ExternalOrderID
- ExternalOrderLineItemID
- CatalogueID
- CatalogueItemName
- Quantity
- OriginalPrice
- Discount
- UnitPrice
- LineTotal
- TaxAmount
- TotalPriceWithTax
- CouponAmount
- TaxCodeName
- TaxRuleName
Columns: Subscriptions Import
The following columns are set in the Subscriptions Import sheet (tab):
- ExternalOrderLineItemID
- SubscriptionPlanCode
- SubscriptionPlanName
- SubscriptionStartDate
- SubscriptionEndDate
- RenewAction
- SubscriberUserCode
- Notes
- StopCodeCode
- StopCodeDate
Key fields & Workflow
The 3 tabs work in conjuction when importing subscriptions.
The Subscriptions tab depends on the Order Line Items tab.
And the Order Line Items tab depends on the Orders tab.
There are certain fields that are key to importing subscriptions.
Orders Import tab:
- ExternalOrderID: the order ID that comes from your legacy system
- PreviousExternalOrderID: as above, but used for renewal orders
- PaymentMethod, PaymentReference and PaymentStatus: these are payment details related to the purchase
- CustomerExternalUserID: the External User ID of your customer/contact set in your legacy system
Orders Line Items Import tab:
- ExternalOrderID: linked to the ExternalOrderID column on the Orders tab
- ExternalOrderLineItemID: this value will come from your legacy system (the purchased subscription)
Subscriptions Import tab:
- ExternalOrderLineItemID: linked to the ExternalOrderLineItemID column on the Orders Line Items Import tab
- SubscriberUserCode: this links to subscription plan to the User. This is the Contact ID/User Code in Affino.
You must declare/specify the subscriber, regardless of the end user or customer.
Note: the Subscriber is obtained from these fields:
- SubscriberExternalUserID
- SubscriberEmail
- SubscriberUserCode).
- in that order/priority.
As you can see, the linking columns (the ones that tie all three sheets/tabs together) are:
- Orders Import tab: ExternalOrderID
- -
- Orders Line Items Import tab: ExternalOrderID
- Orders Line Items Import tab: ExternalOrderLineItemID
- -
- Subscriptions Import tab: ExternalOrderLineItemID
- Subscriptions Import tab: SubscriberUserCode
Obligatory Columns
OrdersImport (Tab)
---------------------------
1] ExternalOrderID
2] OrderDate
3] CurrencyCode
4] SubTotal
5] Tax
6] Total
7] OrderType
8] StoreProfileName
OrdersLineItemsImport (Tab)
-------------------------------------------
1] ExternalOrderID
2] Quantity
3] UnitPrice
4] LineTotal
5] TaxAmount
6] TotalPriceWithTax
If Importing Subscriptions (if rows exist in SubscriptionsImport (Tab):
1] SubscriptionStartDate
2] SubscriptionEndDate
Stop Codes
The Stop Code column is available on the Subscriptions Import tab.
If you need to find a Stop Code in order to add it your import, please see the Stop Codes screen.
Control > Commerce > Stop Codes
Did you find this content useful?
Thank you for your input
Thank you for your feedback
Driving business at some of the world's most forward thinking companies
Our Chosen Charity
Meetings:
Google Meet and Zoom
Venue:
Soho House, Soho Works +
Registered Office:
55 Bathurst Mews
London, UK
W2 2SB
© Affino 2024