Order line status data type (OL)

The order line status data type includes details for E-COM orders.

The ongoing order line status data feed is used to compute the node capacity backlog for optimization of shipping cost and node balancing optimization. Order line status historical data is required for Stockout Avoidance and Markdown Avoidance.

Note: If you have enabled integration with IBM® Sterling Order Management System, this data set is available as an event. For more information, see Transferring data through events from IBM Sterling Order Management System.

File name and separator

This data type uses the comma (,) separator.

The recommended format for the file name is: OL_[CUSTOMER NAME]_YYYYMMDDHHMISS.csv

Note: Duplicate file names are not allowed.

Fields

Table 1. Fields of the order line status data type
Field Name Required Type Description
Order Header Key Yes STRING The Order Header Key attribute is the static order key that encompasses all order lines. This attribute is used to link multiple products together from your order management system.
Order Line Key Yes STRING The Order Line Key attribute is the key for individual products in a order from your order management system.
Order Release Key Yes STRING The Order Release Key attribute is from your order management system. There can be multiple releases on a single order line.
Order Number Yes STRING The E-COM Order Number attribute for a specific order.

For example: A123456
Order DateTime Yes DATE TIMESTAMP The E-COM order data and timestamp, in the following format:

YYYY-MM-DDTHH:MI:SS

The Date TimeStamp should be in the ISO 8601 date time format.
Shipment Release Number No STRING The Shipment Release Number corresponds to the release for an order line. Sometimes, there are multiple releases for a single order, and the release number identifies the different releases.
Order Line Number Yes INT The Order Line Number attribute is the e-commerce order line number that matches the product to the order in which it belongs. This attribute helps avoid confusion for order fulfillment and scheduling.
SKU Number Yes STRING The SKU Number attribute is the SKU number of the product in the order.
Order Quantity Yes INT The Order Quantity attribute is an integer value of the quantity of orders.
External Category Fulfillment No STRING External category fulfillment
Ship to Postal Code Yes STRING The Ship To Postal Code is the postal code to which an order is being shipped.

For example: 02108
Node Key Yes STRING The Node Key corresponds to the type of node, such as store, distribution center, 3rd party vendor, etc. The Node Key must match the data that was entered in the Fulfillment Network Data Type.
Order Line Status Date Time Yes DATE TIMESTAMP Order line status, in the following format:

YYYY-MM-DDTHH:MI:SS

The Date TimeStamp should be in the ISO 8601 date time format.
Order Status Type Code Yes STRING The status of the number of units on an order line.
  • 1100 = Created
  • 1200 = Reserved
  • 1200.X = ON_HOLD
  • 1300 = Back ordered
  • 1400 = Back ordered from node
  • 1500 = Scheduled
  • 3200 = Release
  • 3350 = Pick
  • 3700 = Shipped
  • 9000 = Cancel
Order Status Description Yes STRING The Order Status Description is the status of the order release.
Order Line Status Quantity Yes INT The Order Line Status Quantity filed contains the quantity on the status of the order line.
Short Pick Reason No STRING If a product is unavailable to be picked from a node, the Short Pick Reason attribute is set as a string value.
Deliver method No STRING The deliver method.
  • SHIP
  • PICK
  • DEL
Document type No STRING The type of order. For example, sales order, purchase order an so on.
Note: Only sales orders are accepted at this time. The document type for a sales order is 0001.
Required ship date No STRING The date on which shipment is planned or requested.
Required delivery date No STRING The date on which delivery is planned or requested.
UOM No STRING Unit of measure for the order line item.
Product class No STRING The product group that the item/SKU belongs to.
Enterprise No STRING The top most hierarchy or the enterprise that the order line or the ship node belongs to.
Seller No STRING The Seller organization for the order line.
Total amount No DOUBLE The total cost of the order.
Currency No STRING The currency that is associated with the total amount of the order. This value needs to be in the ISO three letter currency format. For example, USD, GBP, or EUR.

Sample for OL_[CUSTOMER NAME]_YYYYMMDDHHMISS.csv

order_header_key,order_line_key,order_release_key,order_no,order_date,release_no,prime_line_no,item_id,ordered_qty,extn_ocf,ship_to_zip_code,ship_node,status_date,

status,status_description,status_qty,short_pick_reason,delivery_method,doc_type,req_ship_date,req_del_date,UOM,product_class,enterprise,seller, totalAmount,currency

Order20180417111111,2018041011133226897,testing1_07326,123,2018-05-19T23:13:32-0500,datacollectqadev1212,1,Item1234,1,,66667,,2018-05-10T06:13:32-0500,1100,Created_Status,1,,SHIP,0001,2018-08-21T19:02:43,2018-08-21T19:02:43,EACH,Good,ABC Inc,Node12,1.0,USD

Order20180417111111,2018041011133226897,testing1_26613,123,2018-05-19T23:13:32-0500,datacollectqadev1212,1,Item1234,1,,66667,,2018-05-10T06:13:32-0500,1100,Created_Status,1,,SHIP,0001,2018-08-21T19:02:43,2018-08-21T19:02:43,EACH,Good,ABC Inc,Node12,2.0,GBP

Order20180417111111,2018041011133226897,testing1_05384,123,2018-05-19T23:13:32-0500,datacollectqadev1212,1,Item1234,1,,66667,,2018-05-10T06:13:32-0500,1100,Created_Status,1,,SHIP,0001,2018-08-21T19:02:43,2018-08-21T19:02:43,EACH,Good,ABC Inc,Node12,3.0,AED

Order20180417111111,2018041011133226897,testing1_70261,123,2018-05-19T23:13:32-0500,datacollectqadev1212,1,Item1234,1,,66667,,2018-05-10T06:13:32-0500,1100,Created_Status,1,,SHIP,0001,2018-08-21T19:02:43,2018-08-21T19:02:43,EACH,Good,ABC Inc,Node12,4.0,ALL

Order20180417111111,2018041011133226897,testing1_70261,123,2018-05-19T23:13:32-0500,datacollectqadev1212,1,Item1234,1,,66667,,2018-05-10T06:13:32-0500,1100,Created_Status,1,,SHIP,0001,2018-08-21T19:02:43,2018-08-21T19:02:43,EACH,Good,ABC Inc,Node12,5.0,USD

Sample script to upload data by using the file adapter

/<Install_dir>//AsperaClientLinuxDist/asperaTransferClient.sh -jobname OLPush 
-contentType OL -server -userid -password -op UPLOAD -src -dest/OL 
-conf /<Install_dir>//AsperaLinuxDist/asperaTransferOption.properties