OLX Autoship Sequence Import Spec

OLX Autoship Sequence Import Spec

Module: Imports
Path: Processing > Imports/Exports > Imports
Topic: OLX Autoship Sequence Import Spec
Version(s):  5.1 & up
Editions: Commerce, Call Center


What Is OLX Autoship Sequence Import

The OLX Autoship Sequence Import automates the functionality found within the application for manually creating Autoship Sequences (Products > Product Data > Autoship Sequences in the new Autoship Sequence Manager window). This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with the required autoship sequence information. This document will cover in detail, the specifications needed to create a valid file that OrderLogix can successfully import.


Making The Connection

Where Will I See This Within OLX?

This import is used to setup continuity on your product offers that will display on the customer record when the offer is sold.

What Reports Can Be Pulled?

What Imports/Exports Relate to xxxx


Trouble Shooting

  1. Import failed- Reason:Conversion from string "" to type 'Double' is not valid. Error in onStart():Import failed.

    1. make sure column A is filled in on sequence row(s)
  2. ERROR: Subsequent item could not be added due to error with base/previous subsequent item

    1. the import will only create a new continuity with sequences at the same time. You cannot add sequences after a continuity has been created

Setup

Import Configuration

Navigate to Processing > Import/Export > Imports


  1. Category = Other
  2. Import Type = OLX Autoship Sequence Import

Data Source

    1. Upload

      1. This will allow you to upload a file directly from the device you are working from
      2. Select Choose File to initiate a file window popup that will allow you to navigate to the specific file you are trying to upload
    2. FTP

      1. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      2. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      3. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      4. User Name - This is the user name for the remote server.
      5. Password - This is the password for the remote server.
      6. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    3. SFTP (SSH)

      1. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      2. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      3. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      4. User Name - This is the user name for the remote server.
      5. Password - This is the password for the remote server.
      6. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    4. FTPS (SSL)

      1. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      2. Server Port - This indicates the specific FTP/SFTP port to use. This is an advanced feature and should be left at (default) unless the FTP operator indicates that it should be something different.
      3. Folder - This indicates the relative folder on the remote server where the files should be gathered from. If this is unknown, the default of “/” should be used.
      4. User Name - This is the user name for the remote server.
      5. Password - This is the password for the remote server.
      6. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)
    5. Email
      1. Mail Server - The name of the email server you are using.
      2. Login - This is the user name for the mail server.
      3. Password - This is the password for the mail server.
      4. Server Port - Unless instructed otherwise this should be set to 110
      5. Pattern - Use the pattern field to specify which files are to be collected. Use the * (asterisk) as a wildcard to indicate any character or group of characters in the file name. For example, if the file to be collected is named “Acme_01-31-2012.PGP”, you could specify the pattern “Acme*.PGP”. This will attempt to collect all files that begin with “Acme” and end with “.PGP”. You may only use one * in the pattern field. The pattern must end in either .PGP or .GPG if the data being transferred is of a sensitive nature (as indicated by the selected imports specification)

Configuration Tab

  1. File Includes Header Row
    1. checked - the first row will be ignored for data
    2. unchecked - first row will be reviewed for data

Decryption Tab

  1. None
    1. no decryption method will be used


  2. Zip 
    1. the password entered here is the password needed to unzip the file and pull the information into the system

  3. PGP
    1. PGP Key Option - select the PGP from the drop down
    2. Verify passphrase - this must match the passphrase associated to the selected PGP above


Results Tab



The Results tab will display a summary of information imported or information about any potential error(s) to help you resolve and try again.




Spec

File Format

ASCII text (standard US-English letters, numbers and keyboard characters). The file must contain one line per addition, with each field enclosed in double quotes and comma separated, ending with a Carriage Return (↵) <CR>. All unused fields will be left blank and remain separated by a single comma.

File Naming

<Organization Identifier><YYYYMMDD>.csv

Import Definitions

  1. #
    1. position the field is required to be listed in when importing the file
  2. Field Names 
    1. A list of passable import fields, which can be transposed (viewed horizontally, instead of vertically) into the columns of a header row.
  3. Required 
    1. Defines if information must be provided for the field or not.  
  4. Type 
    1. Defines the character type (what keyboard characters are allowed in the field): 
      1. Alpha – letters, numbers and simple symbols (ex. @, -, / or &) 
      2. Numeric – numbers only 
      3. Date – format shown in Field Description (ex. MM/DD/YYYY) 
      4. Boolean – 1 for True or 0 for False
  5. Max
    1. The maximum amount of the Type characters that can be passed for the field. 
  6. Field Description
    1. Notes, examples and formatting

For visual purposes the spec is broken into 2 separate groups, with one important Boolean modifier.  The first group (positions 1-12) in light blue refers to the general autoship sequence information.  The position 13 Boolean, “NEW AUTOSHIP” requires a 1 if the autoship exists in the system and the information being provided is being used to update it, or a 0 if the autoship is to be created. The second group (position 14-21) in light orange refers to subsequent sequences for the autoshipment. 

  1. If the user wished to add a new autoshipment with 3 sequences,
    1. the first line of the file would fill out the
      1. position 1
      2. and positions 2- 12, according to the requirements and descriptions,
      3. with position 13 set to 1,
      4. and leave positions 14 through 21 blank.
    2. The following three lines would fill in
      1. position 1 with same value passed on the first line,
      2. with position 13 set to 0,
      3. and positions 14 through 21 filled in with the sequence information.

Warning
the import only works when you are creating a new continuity, (row 1 position 13 must =1)


TestA,ALL ORDERS,CTY,TestA description,100,21,0,0,0,0,1,,1,
TestA,,,,,,,,,,,,0,1,TestB-CTY,1,29.95,0,0,30,0
TestA,,,,,,,,,,,,0,2,TestC-CTY,1,29.95,0,0,30,0


#

Field Name

Req.

Type

Max

Field Description

1

STARTING OFFER NAME

YES

Alpha

255

Product offer name for the base autoship

2

PAY PREFERENCE

For Seq.

Alpha

255

Commission payment preference.
(Ex. All Orders, Approved Sales or Net Orders)

3

ITEM TYPE

For Seq.

Alpha

50

Item type for the autoship offers.
(Ex. ORD, CTY, RSH, ADD, XSL or USL)

4

DESCRIPTION

NO

Alpha

100

Sequence description.

5

MAX DISCOUNT

NO

Numeric

3

Maximum discount percentage for autoship offers between 0-100.

6

INITIAL DELAY DAYS

For Seq.

Numeric

8

Number of days between the base order and the first autoshipment.

7

USE BASE ITEM COMMISSION

For Seq.

Boolean

1

Use the base autoship offer commission and pay preference settings for the subsequent autoship offers.

8

TAKE BACK COMMISSION

For Seq.

Boolean

1

Take back paid commissions on subsequent autoship offers.

9

USE QTY FROM INITIAL ORD

For Seq.

Boolean

1

Use the quantity from the initial order for subsequent offers (1) or use the quantity set in the subsequent offer (0).

10

ADD CYCLE DAYS TO ORD DATE

For Seq.

Boolean

1

Use the next ship date off of the order date (1) or the shipment date (0).

11

USE BASE SHIP METHOD

For Seq.

Boolean

1

Use the ship method of the base order.

12

SHIP METHOD

NO

Alpha

255

If not using the base ship method, specify a ship charge profile name to use for the autoship generated orders.

13

NEW AUTOSHIP?

YES

Boolean

1

1 = New autoship, 0 = Update existing.

14

SEQUENCE #

For Prod

Numeric

8

Sequence number for the autoship offer, starting with 1.

15

OFFER NAME

For Prod

Alpha

255

Product offer name for the autoship offer.

16

QUANTITY

For Prod

Numeric

8

Quantity of the autoship offer.

17

UNIT PRICE

For Prod

Numeric

9

Unit price of the autoship offer.

18

SHIPPING

For Prod

Numeric

9

Shipping of the autoship offer.

19

RUSH

For Prod

Numeric

9

Rush of the autoship offer.

20

CYCLE DAYS

For Prod

Numeric

8

Number of days between the shipments.

21

REPEAT COUNT

For Prod

Numeric

8

Number of recurring shipments for the autoship offer.
IMPORTANT:  0 for infinite recurrence.



Attachments

The attached documentation includes the Spec, Template, and Example.


Copyright 2019
Revised 2.05.2025


    • Related Articles

    • OLX Campaign Setup Import Spec

      Module: Import Path: Processing > Import/Export > Import Topic: OLX Campaign Setup Import Version(s): 5.1 & up Editions: All What Is OLX Campaign Setup Import The OLX Campaign Setup Import is a powerful and robust import that can create and update ...
    • OLX Lead Import Spec

      The OLX Lead Import allows for loading contact information from an internal dataset or 3rd party source, into existing call notification queues in the OrderLogix application. File Format: ASCII text. The file must contain one line per addition, with ...
    • OLX Station Import Spec

      The OLX Station Import allows for loading media stations for media buy assignments and distance based sourcing into the OrderLogix application for reporting purposes. File Format: ASCII text. The file must contain one line per addition, with each ...
    • OLX Campaign Import Spec

      The OLX Campaign Import allows for loading campaign information and projected performance details into the OrderLogix application for connection to media buys and reporting purposes. File Format: ASCII text. The file must contain one line per ...
    • OLX Telemarketing Import Spec

      The OLX Telemarketing Import Spec is a 121 column order import used to bring outside calls and orders into the OrderLogix application. This is accomplished by creating a CSV (a file with information fields, each separated by a single comma) with all ...