Insites Docs Instance EcommerceOrdersImporting and Exporting Orders

Importing and Exporting Orders

Last updated on August 01, 2024.

Insites enables you to import and export ecommerce orders using comma-separated value (CSV) files. This capability can be used to pass data to or from an external system that is not integrated with Insites.

For instance, if you require migrating order records from an external system to Insites, you can streamline the process by importing data from the external system into Insites. Doing things this way avoids the laborious task of manually re-inputting each order record.

The following topics are discussed in this document:

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

Importing orders

To import orders:

  1. Navigate to Ecommerce from the main menu.
  2. Select Orders.
  3. Select the ellipsis menu () beside the ADD ORDER button and choose Import.
  4. Select the CSV Template link on the 'Import Orders' modal 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' modal by executing steps #1 - #3.
  7. Use the clickable area on the modal to upload your CSV file.
  8. Select IMPORT ORDERS.

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

Column HeaderTypeRequiredDescription
UUID String No Universal Unique Identifier (UUID) of the order.
Order Number String No Order number that can be assigned to an order.
Order Reference String No Order reference that can be assigned to an order.
Date Time DateTime Yes Date and time the order was placed.
Order Status String Yes

The current status of the order. Options include:

  • Open
  • Processing
  • On Hold
  • Cancelled
  • Refunded
  • Completed
  • Subscription Active
  • Subscription Cancelled
  • Other

Using a value other than those specified above will lead to a malfunction in the status color codes in the user interface.
Order Payment Status String Yes

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 cause the payment status color codes in the user interface to malfunction.
Order Shipping Status String No

The shipping status of the order. Options include:

  • Not Applicable
  • Packed
  • Picked Up
  • In Transit
  • Delivered
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 Currency used by the order.
Subtotal Amount Float No Subtotal amount of the order.
Total Tax Amount Float No Tax amount applied to the order.
Total Amount Float No The total order amount, including shipping costs, taxes, and discounts.
Total Shipping Amount Float No Shipping costs applied to the order.
Total Amount Paid Float No The total amount paid for the order, inclusive of shipping costs, taxes, and discounts.
Total Discount Amount Float No The total amount of discounts applied to the order.
Is ScheduledBooleanNo Indicates if the order is scheduled. Options include:
  • TRUE
  • FALSE
Is RecurringBooleanNo Indicates if the order is recurring. Options include:
  • TRUE
  • FALSE
Recurring Group ID String No Stores an ID that can link multiple orders together.
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 country 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 Lattitude 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 tracking code for the order.
Shipping Instructions String No Shipping instructions concerning the order
Shipping Company UUID String No Univeresal 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

Adding or updating an order

You can use the import feature to add or update an order.

  • 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. Providing a UUID that does not exist causes an error.
Note

Importing images and files is not supported. You can access or download media content from the Insites Instance Admin.

Exporting orders

To export orders:

  1. Navigate to Ecommerce from the main menu.
  2. Select Orders.
  3. Select the ellipsis menu () beside the ADD ORDER button and choose Export.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.