Transferring supply plan data

The supply plan data type is used to determine the replenishment possibilities. This data type is used to determine when the inventory will be replenished and will the inventory replenishment avoid stockout.

{
"supplies": [
{ "itemId": "SKU1024", "unitOfMeasure": "EACH", "productClass": "NEW", "type": "PLAN", "shipNode": "00012", "tagNumber": " ", "segment": "", "segmentType": "", "eta": "2025-03-01T00:00:00Z", "shipByDate": "2500-01-01T00:00:00Z", "referenceType": "0006", "reference": "Y10000101", "lineReference": "Y10000101-1", "quantity": 100, "sourceTs": "2025-01-15T17:14:37Z" }
]
}

1. To create the supply.csv files, specify the following details.
   1. For the file name, use SUPPLY_[CUSTOMER NAME]_YYYYMMDDHHMISS.csv format.
   2. For the separator, use the 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 supply plan data:

   Table 1. Supply plan data descriptions

   Sequence	Field Name	Required	Type	Description
   1.	Item ID	Yes	STRING	The identifier of an item that is to be supplied or replenished.
   2.	Item UOM	No	STRING	The unit of measure for an item that is to be supplied or replenished. 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 that is to be supplied or replenished.
   4.	Ship node	Yes	STRING	The ship node is a store or distribution center (DC) where an item is to be supplied or replenished.
   5.	Segment	No	STRING	The specific segment under the segment type on which the item is categorized.
   6.	Segment type	No	STRING	The type of the item's segment based on which the item is categorized.
   7.	Reference	Yes	STRING	Reference is an attribute of a supply that is defined as identifiers for the records. Reference can be the order number that is associated with the supply.
   8.	Line reference	No	STRING	The line reference of the supply.
   9.	Reference type	No	STRING	The reference type of the supply. This can be any string value that represents the type of value that is passed as reference. For example, it can be the order type.
   10.	Tag ID	No	STRING	The tag identifier of the supply. The tag identifier is categorized as lot number, batch number, and revision number.
   11.	Supply base type	Yes	STRING	The type of supply for an item. The possible supply base types are ONHAND, PO_PLACED, and INTRANSIT.
   12.	Supply type	No	STRING	The customized supply type that can be defined for an item.
   13.	Supply quantity	Yes	DOUBLE	The number of items supplied.
   14.	Supply changed quantity	No	DOUBLE	The quantity of supply that is changed.
   15.	Supply date	Yes	STRING	The date on which the item is supplied or replenished. The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.
   16.	Supply expiry date	No	STRING	The date on which the supply ends. The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.
   17.	Supply adjustment reason	No	STRING	The reason for adjustment of supply.
   18.	Supply updated timestamp	No	STRING	The timestamp at which the supply plan is updated. The timestamp uses the ISO 8601 standard format, YYYY-MM-DDTHH:MM:SS.000Z.

3. Review the following sample .csv file:

   item_id,item_uom,item_class,ship_node,segment,segment_type,reference,line_reference,reference_type,tag_no,supply_base_type,supply_type,supply_qty,supply_changed_qty,supply_date,supply_expiry_date,adjustment_reason,supply_updated_ts
   I1,EACH,CLASS1,intNode1,MERCH,ONLINE,101,,,,PO_PLACED,PO_PLACED,50.0,10.0,2024-10-02T00:00:00.000Z,2500-01-01T00:00:00.000Z,,2024-07-17T15:43:19.473Z
   I2,EACH,CLASS1,intNode1,MERCH,ONLINE,102,,,,PO_PLACED,PO_PLACED,60.0,10.0,2024-10-02T00:00:00.000Z,2500-01-01T00:00:00.000Z,,2024-07-17T15:43:23.041Z
   I3,EACH,CLASS1,intNode1,MERCH,ONLINE,103,,,,ONHAND,ONHAND,60.0,10.0,1900-01-01T00:00:00.000Z,2500-01-01T00:00:00.000Z,,2024-07-17T15:43:23.041Z

4. Complete one of the following steps:
   • Upload a single file to the <Input_Prefix>/UPLOAD/SUPPLY/ virtual folder on IBM Cloud® Object Storage.
   • Upload all files from a local directory to the <Input_Prefix> 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: The error row.csv file is the original ingestion 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:

   /failed

   Any CSV row that fails to process is placed in a file for download and review. As part of the monitoring process, you should review any files that are placed in this prefix. Then, you must rectify the failure and resubmit the CSV rows for reprocessing in the input stream.

   /reprocessed

   Any files that are in a queue for reprocessing due to connectivity issues. No actions are required for this prefix. Any files that are stored in the reprocessing prefix temporarily are retired automatically in Sterling Intelligent Promising. More actions are not required to handle the data.

   /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 ingestion 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.