OLX Ship Confirmation Import v5.0

OLX Ship Confirmation Import v5.0

Info
Module: Imports
Path: Processing > Imports/Exports > Imports 
Topic: Ship Confirmation v5
Version(s): 5.1 & up 
Editions: All

What Is Ship Confirmation

The OLX Ship Confirmation Import v5.0 supports 3 different shipment confirmation scenarios:

1) Shipment complete for all items ordered 

The OLX system will:
  1. Reconcile the shipment transaction by applying the Tracking number(s) passed, the warehouse Shipping ID, the ship date and shipping carrier
  2. Update the Item Status of all Order Items attached to the shipment transaction
    1. These order items will be considered shipped and will have their status updated from “Item Awaiting Ship Confirm” to “Item Shipment Delivered” or “Shipped Awaiting Settlement”, depending on the way payments are/have collected for the given order.
    2. If Inventory records are assigned to the order items, those inventory items will be updated from, “Committed” to “Shipped”.
  3. If SHIPPING LINE INVENTORY RECORDS are present and they contain Lot # / Serial Number data
    1. Update the inventory item records to store the Lot # or Serial # and Expiration Date.

2) Shipment of one or more, but not all items 

The OLX system will:
  1. Reconcile the shipment transaction by apply the Tracking number(s) passed, the warehouse Shipping ID, the ship date and shipping carrier
  2. Update the Item Status of all Order Items
    1. For those that were specified to have the QUANTITY SHIPPED equal to the QUANTITY ORDERED in the SHIPPING LINE RECORD
      1. These order items will be considered shipped and will have their status updated from “Item Awaiting Ship Confirm” to “Item Shipment Delivered”or “Shipped Awaiting Settlement”, depending on the way payments are collected for the given order.
      2. If Inventory records are assigned to the order items, those inventory items will be updated from, “Committed” to “Shipped”.
    2. For those that were specified to have the QUANTITY SHIPPED equal to 0 in the SHIPPING LINE RECORD
      1. These order items will have their item status set back to “ITEM SHIP READY”.
      2. They will be removed from the reconciled shipment transaction and they will be eligible to be reshipped in a future shipment batch export.
    3. A note will be added to the customer record that a Shipment was “Short Shipped”.
  3. If SHIPPING LINE INVENTORY RECORDS are present and they contain Lot # / Serial Number data
    1. Update the inventory item records to store the Lot # or Serial # and Expiration Date.

3) Shipment of none of the items ordered

The OLX system will:
  1. DELETE the shipment transaction in OrderLogix
  2. Update the Item Status of all Order Items
    1. These order items will be considered not shipped and will have their status updated from “Item Awaiting Ship Confirm” to “Item Ship Ready”. Inventory, if used will be released and reallocated. If that process results in a backorder, the Item Status will be set to “Item Backorder”
    2. These items will be eligible to be reshipped in a future shipment batch export.
  3. If Inventory records are assigned to the order items, those inventory items will be released and then re-reserved, which might potentially put this item on backorder.
  4. A note will be added to the customer record that a Shipment was “Killed”.

Making The Connection

Where Will I See This Within OLX?

You will see effects of the Ship Confirm Import on the Order Detail Screen. Items in Awaiting Ship Confirm have not received a response from this import. Items in Shipment Delivered or Shipped Awaiting Settlement have received a response from this import.

What Reports Can Be Pulled?

What Imports/Exports Relate to xxxx

Trouble Shooting


Setup

Import Configuration

Navigate to Processing > Import/Export > Imports

  1. Category = Shipping Imports
  2. Import Type = OLX Ship Confirmation Import

Data Source

    1. Upload


      2. This will allow you to upload a file directly from the device you are working from
      3. 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

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      3. 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.
      4. 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.
      5. User Name - This is the user name for the remote server.
      6. Password - This is the password for the remote server.
      7. 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)

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      3. 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.
      4. 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.
      5. User Name - This is the user name for the remote server.
      6. Password - This is the password for the remote server.
      7. 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)

      2. Server Address - This is the host name of the server where files will be collected from. An IP address can also be used.
      3. 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.
      4. 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.
      5. User Name - This is the user name for the remote server.
      6. Password - This is the password for the remote server.
      7. 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
      2. Mail Server - The name of the email server you are using.
      3. Login - This is the user name for the mail server.
      4. Password - This is the password for the mail server.
      5. Server Port - Unless instructed otherwise this should be set to 110
      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)

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
  2. Adjust NextShipDates on autoship generated items.
    1. checked - next ship date has already been assigned a date on export, if this is selected on import the date is updated to reflect the date the shipment confirmation is received. 
      1. the ship date remains the same on the order
      2. ship confirm date is only used to adjust the future shipments.
    2. unchecked - next ship date is based off the date the order was exported to fulfillment center
Notes
Note: If the import file contains transactions that have already been imported the old results will be overwritten with what is in the file and this cannot be reverted.

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 something similar to what you displayed above or if there are errors it will display information about the error 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 record type, 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

OLX_Ship_Confirmations_<YYYMMDD>.csv

Import Definitions

Shipping Order Record Layout

Position
Field Name
Req.
Type
Max
Description
 1
RECORD TYPE
YES
Alpha

Record Type. 
For Shipment Confirmation Header Records, the type should be "O"
 2
OLX SHIPMENT ID
YES
Numeric

OrderLogix Assigned Shipment ID.
 3
WMS SHIPMENT ID
YES*
Alpha
255
Warehouse Assigned Shipment ID. 
* Leave Blank for Killed/Cancelled Shipments
 4
SHIPMENT DATE
YES*
Alpha
255
The date of the shipment.
Format: MM/DD/YYYY
* Pass Cancel Date for Killed/Cancelled Shipments
 5
CARRIER
YES*
Alpha
255
Shipping Carrier
* Leave Blank for Killed/Cancelled Shipments
 6
TRACKING NUMBER
YES*
Alpha
255
Carrier assigned package tracking number(s) for the entire shipment.  For multiple tracking numbers, list them all with a pipe character “|” between each tracking number.
* Leave Blank for Killed/Cancelled Shipments
 7
CLASS OF SERVICE
YES*
Alpha
255
Carrier Class of Service
* Leave Blank for Killed/Cancelled Shipments
 8
TOTAL ORDER LINES
YES
Numeric

Number of Order Lines for the Shipment
 9
TOTAL SHIPPED LINES
YES
Numeric

Number of Order Lines that fully shipped for the Shipment 
** NOTE: 
  1. If TOTAL SHIPPED LINES = TOTAL ORDER LINES, the order shipped complete. 
  2. If TOTAL SHIPPED LINES < TOTAL ORDER LINES but >= 1, the order partial shipped
  3. If TOTAL SHIPPED LINES = 0, the order did not ship.  
10
SHIPPING COST
NO
Numeric

Shipping Cost
11
SHIPPING NOTE
NO
Alpha
255
Shipping notes

Shipping Line Record Layout

Position
Field Name
Req.
Type
Max
Description
1
RECORD TYPE
YES
Alpha
1
Record Type. 
For Shipping Line Inventory Records, the type should be "L"
2
OLX SHIPMENT ID
YES
Numeric

OrderLogix Assigned Shipment ID.
3
WMS SHIPMENT ID
YES*
Alpha
255
Warehouse Assigned Shipment ID.
* Leave Blank for Killed/Cancelled Shipments
4
SHIPMENT DATE
YES*
Alpha
255
The date of the shipment.
Format: MM/DD/YYYY
* Pass Cancel Date for Killed/Cancelled Shipments
5
ITEM ID
YES
Numeric

OrderLogix Assigned Item ID (OrderDetailID).  
6
ORDER QUANTITY
YES
Numeric

Quantity Ordered of the Order Line
7
SHIPPED QUANTITY
YES
Numeric

Quantity Shipped of the Order Line
** NOTE: SHIPPED QUANTITY must be either ORDER QUANTITY or 0.  Cannot reconcile partial ORDER LINE Shipments.  Passing 0 will indicate that this order line did not ship. 
8
TRACKING NUMBER
YES*
Alpha
255
Carrier assigned package tracking number(s) for the shipping line.  For multiple tracking numbers, list them all with a pipe character “|” between each tracking number.

* Leave Blank for Killed/Cancelled Shipments

Shipping Line Inventory Record Layout

Position
Field Name
Req.
Type
Max
Description
 1
RECORD TYPE
YES
Alpha
1
Record Type. 
For Shipping Line Inventory Records, the type should be "I"
 2
OLX SHIPMENT ID
YES
Numeric

OrderLogix Assigned Shipment ID.
 3
WMS SHIPMENT ID
YES*
Alpha
255
Warehouse Assigned Shipment ID.
* Leave Blank for Killed/Cancelled Shipments
 4
SHIPMENT DATE
YES*
Alpha
255
The date of the shipment.
Format: MM/DD/YYYY
* Pass Cancel Date for Killed/Cancelled Shipments
 5
ITEM ID
YES
Numeric

OrderLogix Assigned Item ID (OrderDetailID).  
 6
ITEM INVENTORY ID
YES
Numeric

OrderLogix Assigned Item Inventory ID. 
 7
SKU
YES
Alpha
255
SKU of inventory component
 8
ORDER QUANTITY
YES
Numeric

Quantity Ordered of the inventory component
 9
SHIPPED QUANTITY
YES
Numeric

Quantity Shipped of the inventory component.
** NOTE: SHIPPED QUANTITY must equal either ORDER QUANTITY or 0. 
Cannot reconcile partial ORDER LINE Shipments.  Passing 0 will indicate that this inventory component did not ship.   All records containing the same ITEM ID must either ship complete or not ship at all.
10
TRACKING NUMBER
YES*
Alpha
255
Carrier assigned package tracking number(s) for the inventory component.  For multiple tracking numbers, list them all with a pipe character “|” between each tracking number.

* Leave Blank for Killed/Cancelled Shipments
11
LOT NUMBER
NO
Alpha
255
Lot # of inventory component
12
SERIAL NUMBER
NO
Alpha
255
Serial # of inventory component
13
EXPIRATION DATE
NO
Date

Expiration/Warrantee date of inventory component
Format: MM/DD/YYYY



Copyright 2019
Revised 12.04.2024

Attachments

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

    • Related Articles

    • OLX Ship Confirmation Import Spec v4.0

      The OLX Ship Confirmation Import allows for loading ship conformation information from a fulfillment center or shipping provider into the OrderLogix application for item status updates. File Format: ASCII text. The file must contain one line per ...

    • OLX Inventory Synchronization Import

      The OLX Inventory Synchronization Import allows for batch inventory amount adjustments in the OrderLogix application by providing amounts available to sell by SKU for every SKU in the warehouse.  These counts will be evaluated and the Inventory ...

    • OLX Inventory Adjustment Import

      Module: Imports Path: Processing > Imports/Exports > Imports Topic: OLX Inventory Adjustment Import Version(s): 5.1 & up Editions: Commerce, Call Center What Are OLX Inventory Adjustment Import The OLX Inventory Adjustment Import allows for batch ...

    • 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 ...

    • 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 ...