Importing Orders into Remarkety using SFTP

Remarkety allows you to import orders from an external source (Point of Sale, CRM, etc.) using an automated process with SFTP.

To get SFTP credentials please contact your account manager or support@remarkety.com

File Name

File should be named with a prefix: orders_<YYYYMMDD_HHMMSS>.csv ( where YYYYMMDD_HHMMSS should specify the export date of this data ).

File Format

  • UTF-8 encoded CSV file
  • Data in columns can be quoted with double quotes
  • First line in the file should be a header row containing the column names. Names should be exactly as specified below (“Column header”) so that the system can match the information without a mapping configuration.

Multiple Order Items

If an order has multiple items, the CSV file should have a single line for every item, with the same general order details (id, creation date, shopper email).

Columns

  • Yes* - At least one of the “identifying attributes” fields is required
  • datetime - Should be in ISO 8601 format that includes the correct time zone. For example:
    2020-01-08T13:49:06+02:00
  • To download a sample CSV file please click here.

Column header

Type

Mandatory?

Explanation

Order Info (repeats for each order item)

order_id

string

Yes

The order ID in the exporting system. It’s the integrator’s responsibility to ensure that various order id’s from othere systems don’t overlap.

order_created_at

datetime

Yes

The datetime in which the order was originally created

order_status

string

Yes

Order status code

order_financial_status

string

 

Order financial status code

order_modified_at

datetime

 

The last modification time of the order

order_currency

string

 

3-letter currency code. If not available, we will use the store’s default currency when importing

order_subtotal

numeric

 

Subtotal of the order, before shipping, discounts and taxes

order_shipping

numeric

 

The shipping costs

order_discount

numeric

 

Discounts applied to the order

order_tax

numeric

 

Taxes associated with the order

order_total

numeric

Yes

The order total including shipping, discounts, and taxes

order_payment_method

string

 

Payment method used. For example: PayPal, Credit Card, Cash.

order_channel

string

 

What channel the order was placed in, must be one of the following: online, pos, manual.
Defaults to "online".

order_<custom_field_name>

string

 

Custom fields. Any field that starts with order_* should be added to the order as a custom field.

Shopper Info (repeats for each order item)

shopper_pos_id

string

Yes*

The shopper ID in the POS system

shopper_store_id

string

Yes*

The shopper ID in the eCommerce system

shopper_email

string

Yes*

Shopper email address

shopper_first_name

string

   

shopper_last_name

string

   

shopper_phone

string

 

Shopper phone/SMS number

shopper_accepts_marketing

boolean (1/0)

 

Is the shopper opted-in for email marketing?
Defaults to "Unknown". Emails will be sent based on account settings.

shopper_*

string

 

Custom fields. Any field added to the shopper should be added as a custom field.

Order Item

orderitem_product_id

string

 

The product ID. This should be the same as in the eCommerce product ID.

orderitem_sku

string

Yes

SKU

orderitem_quantity

numeric

Yes

Quantity of item(s) in this order

orderitem_price

numeric

Yes

Payed price in order currency

orderitem_price_full

numeric

 

Product’s full price (MSRP)

orderitem_title

string

 

If the product does not exists in Remarkety we will use this field as the product title (if exists in the file).

orderitem_vendor

string

 

The vendor of the product.

orderitem_*

string

 

Line item custom field

Missing Products

When a product does not already exist (searches by SKU), then:

  • Create the product with all information from the order.
  • Mark it as "not valid for recommendations" (disabled product).
Have more questions? Submit a request

0 Comments

Article is closed for comments.