Importing and Exporting Orders

For example, if you need to migrate order records from an external system to Insites, you can streamline the process by importing data from the external system into Insites. Importing data enables you to avoid the laborious task of manually re-inputting each order record.

The following topics are discussed in this document:

• Importing orders
• Importing payments
• Exporting orders
• Exporting payments
• Adding or updating an order or payment

Importing orders

To import orders:

1. Navigate to Ecommerce from the main menu.
2. Select Orders.
3. Select the overflow menu (), then select Import Orders.
4. Select the CSV Template link on the 'Import Orders' drawer to download the import template.
5. Use the CSV Template as a guide for creating an import file that matches the input requirements in Insites.
6. When your CSV file is ready, return to the 'Import Orders' drawer by executing steps #1 - #3.
7. Use the clickable area on the drawer to upload your CSV file.
8. Select IMPORT ORDERS.

The following table displays the input requirements and descriptions for importing orders into an Instance:

Input Label	Type	Required	Description
UUID	String	No	Universal Unique Identifier (UUID) of the order.
Order Number	String	No	The primary display code assigned to the order.
Order Reference	String	Yes	An internal reference or secondary ID for tracking.
Date Time	DateTime	No	Timestamp of when the order was officially placed.
Order Status	String	No	The current status of the order. Must match one of the below predefined status strings to ensure consistency. Options include: Back Ordered Cancelled Completed Deleted For Collection For Delivery Open On Hold Other Parked Placed Processing Refunded Subscription Active Subscription Cancelled Using a value other than those specified above will cause the status codes in the user interface to malfunction.
Payment Status	String	No	The payment status of the order. Options include: Unpaid Paid Part Paid No Charge Failed Refunded Other Using a value other than those specified above will break UI color coding.
Shipping Status	String	No	The shipping status of the order. Options include: Not Applicable Packed Picked Up In Transit Delivered Using a value other than those specified above will break UI color coding.
Order Company UUID	String	No	Universal Unique Identifier of the company associated with the order.
Order Company Name	String	No	Name of the company associated with the order.
Order Company Email	String	No	Email address of the company associated with the order.
Order Company Phone Country Code	String	No	Country code of the company's phone number associated with the order.
Order Company Phone Number	String	No	Phone number of the company associated with the order.
Order Contact UUID	String	No	Universal Unique Identifier of the contact associated with the order.
Order Contact First Name	String	No	First name of the contact associated with the order.
Order Contact Last Name	String	No	Last name of the contact associated with the order.
Order Contact Email	String	No	Email address of the contact associated with the order.
Order Contact Phone Country Code	String	No	Country code of the contact's phone number associated with the order.
Order Contact Phone Number	String	No	Phone number of the contact associated with the order.
Currency	String	No	The ISO currency code used for all financial fields (e.g., USD, EUR).
Subtotal Amount	Float	No	Total cost of items before taxes, shipping, or fees.
Total Tax Amount	Float	No	Cumulative tax applied to the order.
Processing Fee	Float	No	Additional service or handling charges.
Is Percentage Processing Fee	Boolean	No	Options are TRUE and FALSE. TRUE means the Processing Fee is a percentage of the order amount. FALSE means it is a fixed amount.
Order Total	Float	No	Final gross amount, including shipping costs, taxes, and discounts.
Total Shipping Amount	Float	No	Total cost charged for delivery services.
Total Amount Paid	Float	No	The actual balance received from the customer.
Total Discount Amount	Float	No	Total value deducted via coupons or promotions.
Is Scheduled	Boolean	No	Indicates if the order is set for a future fulfillment date. Options include: TRUE FALSE
Is Recurring	Boolean	No	Indicates if the order is recurring. Options include: TRUE FALSE
Recurring Group ID	String	No	A shared ID used to link related orders within a subscription series.
Billing Address 1	String	No	Address (line 1) of the order's billing address.
Billing Address 2	String	No	Address (line 2) of the order's billing address.
Billing Address 3	String	No	Address (line 3) of the order's billing address.
Billing City	String	No	The city where the order's billing address is located.
Billing County	String	No	The county where the order's billing address is located.
Billing District	String	No	The district where the order's billing address is located.
Billing Suburb	String	No	The suburb where the order's billing address is located.
Billing State	String	No	The state where the order's billing address is located.
Billing Country	String	No	The country where the order's billing address is located.
Billing Country Code	String	No	The country code of the order's billing address.
Billing Postcode	String	No	The postcode of the order's billing address.
Billing Latitude	String	No	The latitude of the order's billing address.
Billing Longitude	String	No	The longitude of the order's billing address.
Billing GeoJSON	String	No	GeoJSON of the order's billing address.
Billing Company UUID	String	No	Universal Unique Identifier of the billing company.
Billing Company Name	String	No	Name of the billing company.
Billing Company Email	String	No	Email address of the billing company.
Billing Company Phone Country Code	String	No	Country code of the billing company's phone number.
Billing Company Phone Number	String	No	Phone number of the billing company.
Billing Contact UUID	String	No	Universal Unique Identifier of the billing contact.
Billing Contact First Name	String	No	First name of the billing contact.
Billing Contact Last Name	String	No	Last name of the billing contact.
Billing Contact Email	String	No	Email address of the billing contact.
Billing Contact Phone Country Code	String	No	Country code of the billing contact's phone number.
Billing Contact Phone Number	String	No	Phone number of the billing contact.
Shipping Address 1	String	No	Address (line 1) of the order's shipping address.
Shipping Address 2	String	No	Address (line 2) of the order's shipping address.
Shipping Address 3	String	No	Address (line 3) of the order's shipping address.
Shipping City	String	No	The city where the order is being shipped.
Shipping County	String	No	The county where the order is being shipped.
Shipping District	String	No	The district where the order is being shipped.
Shipping Suburb	String	No	The suburb where the order is being shipped.
Shipping State	String	No	The state where the order is being shipped.
Shipping Country	String	No	The country where the order is being shipped.
Shipping Country Code	String	No	The country code of the order's shipping address.
Shipping Postcode	String	No	The postal code of the address where the order is being shipped.
Shipping Latitude	String	No	The latitude of the address where the order is being shipped.
Shipping Longitude	String	No	The longitude of the address where the order is being shipped.
Shipping GeoJSON	String	No	GeoJSON of the order's shipping address.
Shipping Tracking Code	String	No	The carrier-provided string used to track the shipment.
Shipping Instructions	String	No	Shipping instructions concerning the order
Shipping Company UUID	String	No	Universal Unique Identifier of the shipping company.
Shipping Company Name	String	No	Name of the shipping company.
Shipping Company Email	String	No	Email address of the shipping company.
Shipping Company Phone Country Code	String	No	Country code of the shipping company's phone number.
Shipping Company Phone Number	String	No	Phone number of the shipping company.
Shipping Contact UUID	String	No	Universal Unique Identifier of the shipping contact.
Shipping Contact First Name	String	No	First name of the shipping contact.
Shipping Contact Last Name	String	No	Last name of the shipping contact.
Shipping Contact Email	String	No	Email address of the shipping contact.
Shipping Contact Phone Country Code	String	No	Country code of the shipping contact's phone number.
Shipping Contact Phone Number	String	No	Phone number of the shipping contact.
Opportunity UUID	String	No	Universal Unique Identifier of the opportunity associated with the order.
Notes	String	No	General internal comments or customer-facing remarks.

Importing payments

To import payments:

1. Navigate to Ecommerce from the main menu.
2. Select Orders.
3. Select the overflow menu (), then select Import Payments.
4. Select the CSV Template link on the 'Import Payments' drawer to download the import template.
5. Use the CSV Template as a guide for creating an import file that matches the input requirements in Insites.
6. When your CSV file is ready, return to the 'Import Payments' drawer by executing steps #1 - #3.
7. Use the clickable area on the drawer to upload your CSV file.
8. Select IMPORT PAYMENTS.

The following table displays the input requirements and descriptions for importing payments into an Instance:

Input Label	Type	Required	Description
UUID	String	No	Universal Unique Identifier of the order payment.
Order UUID	String	Yes	Universal Unique Identifier of the order associated with the payment.
Order Reference Number	String	No	Reference number of the order associated with the order payment.
Source	String	Yes	The payment source. Options include the following: BPAY Cash Cheque Credit Card Crypto Currency EFT On Account Other Payment Gateway Paypal Premium Funding
Status	String	Yes	The status of the order payment. Options include the following: Paid No Charge Pending Funds Declined Refunded Failed Other
Amount	Float	Yes	Amount of the order payment.
Notes	String	No	Notes about the order payment.
Date Time	String	No	Date and time the order payment was processed.
Payment Gateway Details	String	No	Details of the payment gateway used to process the payment.
Payment Gateway Name	String	No	Name of the payment gateway used to process the payment.
Card Last Four Digits	Integer	No	Last four digits of the card used to process the payment
Card Brand	String	No	Brand of the card used for the payment.
Card Expiry Month	String	No	Expiry month of the card used for the payment.
Card Expiry Year	String	No	Expiry year of the card used for the payment.
Currency	String	No	Currency used for the payment.
Bank Name	String	No	Name of the bank used to process the payment.
Bank BSB	String	No	BSB code of the bank used for Australian bank transactions.
Payment Method Name	String	No	Name of the payment method used in the transaction.

Exporting orders

To export orders:

1. Navigate to Ecommerce from the main menu.
2. Select Orders.
3. Select the overflow menu (), then select Export Orders.

Exporting payments

To export payments:

1. Navigate to Ecommerce from the main menu.
2. Select Orders.
3. Select the overflow menu (), then select Export Payments.

Adding or updating an order

You can add or update an order using the import feature.

• To ADD an order: Leave the 'UUID' column empty. A new order is created and automatically assigned a new and unique UUID.
• To UPDATE an order: Provide the 'UUID' of an existing order. If no order has that UUID, Insites creates a new order with the UUID you provided. It does not raise an error.