File descriptions

General

Since the export functionality is shared with the Tulo Engage Data Platform (TEDP), it means that the export you will receive can get new features added to TEDP to your export as well. This could be new data in the form of new columns for specific collections or entirely new collections.

The export program doesn't automatically add new columns or new files to your specific export since your import-routines might not be ready for this. We will inform you when new data is available and you can then decide if you want to add this to your export when you are ready to receive it.

Files

Collection Filename Comment
accounts accounts.csv All accounts
orders orders.csv All orders
order_addresses order_addresses.csv Delivery addresses for orders
object_properties object_properties.csv Object properties for products and campaigns
package_sharings package_sharings.csv All shared subscriptions
payments payments.csv All payments
products products.csv All products in Payway, a product can be a "package" containing other products as well as a "campaign" based on a "package".
product_descriptions product_descriptions.csv The long product description for products and campaigns
product_relations product_relations.csv Contains information about which products are included in packages
product_tags product_tags.csv All tags registered on products or campaigns
tags tags.csv All tags
titles titles.csv All titles
user_products user_products.csv All user-products (subscriptions) for accounts

Details

  • All "timestamps" are exported in UTC-format.
  • Data is UTF-8 encoded
  • Columns are separated with a ^ character.

accounts

column type description
id string account id
organisation_id string id of organisation
email string email address
first_name string
last_name string
birth_date timestamp
ssn string social security number
crn string company registration number
company_name string
alias string
mobile_number string
customer_number string
loyalty_card_number string if using Tulo Loyalty with Payway
account_origin string account origin if collected
age int
gender string M/F
street string
building string
staircase string
floor string
apartment string
zip int zip_code
city string
country string
status string account status: created, active, frozen, archived
created_from string from where was the account created? possible values include: activation, registration. external_api, migration, admin, purchase
marketing_permissions string comma-separated list of marketing acceptance
authentication_frozen_until timestamp if account is frozen it is frozen to this timestamp
last_unfreeze timestamp when account was last unfrozen
created timestamp
updated timestamp
exported_at timestamp

orders

column type description
id string account id
parent_order_id string if order has a parent it has a parent_order_id, typically an order created through a campaign transformation.
organisation_id string id of organisation
order_id string Payway human readable order-id, consists of organisation id followed by a sequence number (XXX-nnn).
account_id string
product_id string
product_code string
campaign_package_id string if order is campaign, this identifies the package the campaign is based on.
purchase_type string possible values: recurring, limited
payment_method string possible values: invoice, autogiro, directdebit, directdebit_recurring, creditcard, free, klarna, klarna_payments
traffic_source string
title_code string
vat_code int
period_type string possible values: day, week, month, year, unlimited
period_length int
period_iterations int number of period-iterations the subscription will live before it is transformed into ordinary subscription if order is campaign. A value of -1 indicates it's no campaign order, if 0 it indicates a limited subscription.
period_price numeric not available for customers in Finland at the moment.
subscription_start_date timestamp the date the subscription will start if purchase was made with a future startdate.
status string possible values: created, closed. Only "closed" are successful.
created timestamp
updated timestamp
exported_at timestamp

order_addresses

column type description
id string the order id this address belongs to
organisation_id string id of organisation
first_name string
last_name string
street string
building string
staircase string
floor string
apartment string
zip int
city string
country string
exported_at timestamp

object_properties

column type description
organisation_id string id of organisation
object_type string indicates what kind of property this is. For now only product_id is used, meaning that the property is connected to a product.
object_id string the object id. If type is product_id, the id points to the product.
key string name of property
value string value of property
exported_at timestamp

package_sharings

column type description
id string sharing id
organisation_id string id of organisation
user_product_id string id of user_product (subscription) involved in the share
account_id_sharer string id of account that is sharing user_product
account_id_receiver string id of account that is receiving the user_product
status string possible values inactive - inactivated share, active - active share, pending - waiting for receiver to accept invitation.
created timestamp
updated timestamp
exported_at timestamp

payments

column type description
id string payment id
organisation_id string id of organisation
order_id string
product_id string
user_product_id string
payment_method string same as on "orders"
payment_type string normal - the first normal payment on an order, credit - credit payment, autopay - recurring automatic payments provided by Payway payment engine, payment_profile_update - when a creditcard payment fails the customer has made a new payment from "my account".
amount numeric
product_code string
campaign_package_id string if payment is for a campaign, this identifies the package the campaign is based on.
title_code string
status string possible values: created, payment_pending, closed, failed, cancelled. only closed payments are successful. if payment is failed, the reason can usually be found in error_code.
error_code string error from payment provider
created timestamp
updated timestamp
exported_at timestamp

products

column type description
id string payment id
organisation_id string id of organisation
name string name of product
product_code string the product code, usually part of a purchase-url if package or campaign
integration_code string a code that is used when mapping a package or a campaign with the subscription system
campaign_package_id string if present, the product is a campaign and the value indicates which product (package) the campaign is based upon.
package bool indicates if this product is a "package"
transforms bool indicates if this product transforms into a normal package when it's time to renew the subscription
title_code string
valid_from timestamp from when is this package/campaign valid for purchase. only applies to packages and campaigns
valid_to timestamp this package/campaign is valid for purchase up to this time. only applies to packages and campaigns
created timestamp
updated timestamp
exported_at timestamp

product_descriptions

column type description
product_id string product id
organisation_id string id of organisation
description string

product_relations

column type description
product_id string product id
organisation_id string id of organisation
included_product_id string the if of the product included

product_tags

column type description
id string product id with tag
organisation_id string id of organisation
tag_id string tag_id of tag.
exported_at timestamp

tags

column type description
id string product id with tag
organisation_id string id of organisation
name string name of tag.
exported_at timestamp

titles

column type description
id string product id with tag
organisation_id string id of organisation
code string title code
name string title name
exported_at timestamp

user_products

The user subscriptions.

column type description
id string id of user_product
organisation_id string id of organisation
account_id string
product_id string id of product subscription is based on
product_code string code for product subscription is based on
order_id string order id for the subscription if applicable
campaign_package_id string
valid_from timestamp subscription valid from datetime
valid_to timestamp subscription valid to datetime
cancellation_date timestamp if subscription was cancelled
cancellation_reason string if subscription was cancelled
deactivation_date timestamp if subscription was deactivated
deactivation_reason string the reason for the deactivation: transformation - campaign transformed into normal subscription, upgrade - subscription was "upgraded" to other subscription, downgrade - subscription was "downgraded" to other subscription, third_party - deactivated by third-party, usually through API, expired - expired subscription, passive - when a subscription has been frozen and the customer has not payed until grace-period has expired, manual - manual deactivation, customer_cancel - customer cancelled subscription,customer_deactivation - customer cancelled subscription, subscription_system_stop - subscription system stopped the subscription, subscription_system_change_product - subscription system changed to another subscription, subscription_system_duplicate - deactivated due to duplicate subscription, subscription_system_no_customer_number - deactivated by subscription system sync due to no customer number on account, subscription_system_sync - deactivated by subscription system sync, subscription_system_change_payment_method - subscription system changed payment method and deactivated subscription
grace_period_to timestamp if subscription is temporarily frozen due to payment problems, will be deactivated if it passes this datetime without intervention.
provision_service string system responsible for the subscription lifecycle
subscription_number string subscription number in subscription system
title_code string
days_active_until_cancelled int
created_from string indicates if this subscription was created through a specific operation, such as a "campaign_transformation".
status string possible values: activated, deactivated, cancelled, pending, frozen
created timestamp
updated timestamp
exported_at timestamp timestamp when the row was exported

Supported transfer methods

Currently files can be transferred to Azure cloud storage and AWS S3, if you have other requirements please contact us for a quote.

Details

  • Files can be transferred as one compressed package (zip or tgz) or as individually compressed files.
  • In the case where they are transferred as individually compressed files, a sub-directory is created with the date for the export and the files will be place there.
  • If files are transferred as one compressed package, the export-file will have the date of the export in the filename.