Transferring order line status data

The order line status data type includes details for e-com ordered. The ongoing order line status data feed is used to compute the node capacity backlog for shipping cost and node balancing optimization. Order line status data is required for Stockout Avoidance and Markdown Avoidance.

1. To create the orderline.csv files, specify the following details.
   1. For the file name, use OL_[CUSTOMER NAME]_YYYYMMDDHHMISS.csv format.
   2. For the separator, use comma (,).
   3. Upload multiple .csv files by compressing them into a tar.gz file.
2. You must follow the order of the fields shown in the data type table by matching the same order for the fields in the column in the CSV file. For example, if Item ID is the first field that is defined in the data type table, it must follow the same order in the column in the CSV file. Review the following fields and descriptions for the order line status log data:

   Table 1. Order line status data descriptions

   Sequence	Field Name	Required	Type	Description
   1.	Item ID	Yes	STRING	The item identifier for availability.
   2.	Item UOM	No	STRING	The unit of measure for an item. The valid values are Each, Pallet and Pound. The default unit of measure is Each.
   3.	Item class	No	STRING	The class of an item.
   4.	Ship node	Yes	STRING	A store or a distribution center (DC) where the item is available.
   5.	Order key	Yes	STRING	The static order key that encompasses all order lines. This attribute is used to link multiple products together from your order management system.
   6.	Order line key	Yes	STRING	The key for individual products in an order from your order management system.
   7.	Order release key	Yes	STRING	An attribute from your order management system. There can be multiple releases on a single order line.
   8.	Order ID	Yes	STRING	The order identifier of specific order.
   9.	Order date	Yes	STRING	The date on which the order is placed. The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.
   10.	Order quantity	Yes	DOUBLE	The number of items in an order.
   11.	Order total amount	No	DOUBLE	The total cost of the order.
   12.	Order line prime number	No	DOUBLE	The prime number of an order line.
   13.	Order line sub line number	No	DOUBLE	The sub line number of an order line.
   14.	Order line status quantity	No	DOUBLE	The quantity on the status of the order line.
   15.	Order line total amount	No	DOUBLE	The total cost of the order line.
   16.	Order line status date	Yes	STRING	Order line status, in the following format, YYYY-MM-DDTHH:MI:SS. The Date Timestamp should be in the ISO 8601 date time format.
   17.	Order line status	Yes	STRING	The status of the order line.
   18.	Order line status description	Yes	STRING	The order line status description is the status of the order line release.
   19.	Order line requested ship date	No	STRING	The date that is requested for an item on the order line to be shipped.
   20.	Order line requested delivery date	No	STRING	The date that is requested for an item on the order line to be delivered.
   21.	Shipment release ID	No	STRING	The Shipment release ID 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.
   22.	Ship to postal code	Yes	STRING	The postal code to which the order is to be shipped.
   23.	Enterprise code	No	STRING	The identifier code of a store or distribution center (DC).
   24.	Seller code	No	STRING	The identifier code of an organization to which the order line or the ship node belongs to.
   25.	Delivery method	No	STRING	The delivery method for a node. The delivery method can be SHIP or PICK.
   26.	Short pick reason	No	STRING	If a product is not available to be picked from a node, the short pick reason attribute is set as a string value.
   27.	Document type	No	STRING	The type of order. For example, sales order, purchase order. Note: Only sales orders are accepted currently. The document type for a sales order is 0001.
   28.	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.

3. Review the following sample .csv file:

   item_id,item_uom,item_class,ship_node,order_header_key,order_line_key,order_release_key,order_no,order_date,ordered_qty,order_total_amount,order_line_prime_no,order_line_sub_line_no,ol_status_qty,ol_status_date,ol_status,ol_status_description,req_ship_date,req_del_date,release_no,ship_to_zip_cde,enterprise,seller,delivery_method,short_pick_reason,doc_type,currency
   100001,EACH,GOOD,SR1,2021051914113319388,2021051914115419394,RK21,2023-10-17-external-46,2021-05-19T00:41:33-0500,12,1499.98,1,,2,2021-05-19T03:42:03-0500,1100,1100,,,DC01,1234,ent4,s01,SHP,,1,USD
   100002,EACH,GOOD,SR1,2021051914113319388,2021051914115419394,RK21,2023-10-17-external-46,2021-05-19T00:41:33-0500,12,1499.98,1,,2,2021-05-19T03:42:03-0500,1100,1100,,,DC01,1234,ent4,s01,SHP,,1,USD
   100003,EACH,GOOD,SR1,2021051914113319388,2021051914115419394,RK21,2023-10-17-external-46,2021-05-19T00:41:33-0500,12,1499.98,1,,2,2021-05-19T03:42:03-0500,1100,1100,,,DC01,1234,ent4,s01,SHP,,1,USD

4. Complete one of the following steps:
   • Upload a single file to the <Input_Prefix>/UPLOAD/OL/ virtual folder on IBM Cloud® Object Storage.
   • Upload all files from a local directory to the <Input_Prefix>/UPLOAD/OL/ virtual folder on IBM Cloud Object Storage.
5. Familiarize yourself with the file format, for example:
   • If the original file is called 2024-01-01-10-59-00.0000-3423-Availability.csv, for simplicity, you might call this file <myfilename>.csv.
   • If the data row fails to process, you receive the following error row.csv and the error summary.txt files:

     <myfilename>_file_failed_row.csv. for the error rows only (all successful are not present here)
     <myfilename>_file_failure_reason.txt are the summary file which provide the error codSterling Intelligent Promising automatically create prefix to store processed files based on their current state which includes:

     The error row.csv file is the original ingest record that can't be processed. The error summary.txt file provides the reason for the processing failure.
6. Understand the prefix that is created automatically by Sterling Intelligent Promising to store processed files that are based on the following current states:

   /completed

   All files that completed processing. It is important to clean up the completed files routinely to minimize the storage requirements on IBM Cloud Object Storage.

   /summary

   A data ingest summary file that describes the error that occurred during execution. This summary file can be used in conjunction with the files that failed to process to help to understand the error code and the reason for failure.