Table of contents
Forecasting APIs allow companies to exchange data about anticipated product demand and supply availability with downstream supply chain Partners without giving these Partners access to their serialization system of record. These Forecasts Plan Response are used by suppliers to inform their Partners about their ability to meet the Partners' anticipated demand for specific products and quantities.
The Forecast Plan X12 message is sent from the supplier to the buyer and communicates the supplier's ability to meet the buyers' anticipated product quantity needs for an upcoming period of time.
Contact your TraceLink Services representative for more information about integrating with this message.
- Message Type: MPC_FORECAST_PLAN_RESPONSE (Forecast Plan Response)
- X12 Format: 830
- Transform Names:
- B2B_EDI_X12_830_ForecastPlanResponse_IB_V1
- B2B_EDI_X12_830_ForecastPlanResponse_OB_V1

Input Element | Occurs | Length | Description | Example | |||
---|---|---|---|---|---|---|---|
ISA | - | Required. ISA interchange envelope. | - | ||||
ISA01 | 2/2 | Required. Qualifier for authorization control number in ISA02. | 00 | ||||
ISA02 | 10/10 | Required. Information used for additional identification or authorization of the interchange sender or the data in the interchange/ 10 spaces a valid entry. | - | ||||
ISA03 | 2/2 | Required. Qualifier for security information in ISA04. | 00 | ||||
ISA04 | 10/10 | Required. Identifies security information about the interchange sender or data. | - | ||||
ISA05 | 2/2 | Required. Interchange sender partner ID qualifier. Valid values:
| 07 | ||||
ISA06 | 15/15 | Required. Interchange sender identification mapping to fileSenderNumber with party type defined in ISA05. | 7777776067344 | ||||
ISA07 | 2/2 | Required. Interchange receiver partner ID qualifier. Valid values:
| 01 | ||||
ISA08 | 1/15 | Required. Interchange receiver identification mapping to ediInterchangePartyValue for receiver in X12 control file header. | 888888404358877 | ||||
ISA09 | 6/6 | Required. Interchange date in 6 char YYMMDD format. | 231020 | ||||
ISA10 | 4/4 | Required. Interchange time in 4 char HHMM format. | 1420 | ||||
ISA11 | 1/1 | Required. X12 version 4020 and greater use this field to store the repetition separator: A delimiter that separates repeated occurrences of a data element or composite data structure. Must be different than the data element separator, component separator, and segment terminator. X12 versions 4012 and earlier use U in this field. | ^ | ||||
ISA12 | 5/5 | Required. Interchange control version number. Valid value is “00501” . | 00501 | ||||
ISA13 | 9/9 | Required. Interchange control number mapping to file control header. | 0000000000619827 | ||||
ISA14 | 1/1 | Required. Interchange level acknowledgement requested. Valid values:
| 0 | ||||
ISA15 | 1/1 | Required. Indicates whether the interchange is for production, test, or information purposes. Valid values:
| P | ||||
ISA16 | 1/1 | Required. Component element separator. Delimiter that separates data elements within a composite data structure. Must be different than the data element separator and segment terminator. | > | ||||
GS | - | Required. GS group functional envelope. Child of ISA. Only one GS group expected per interchange. | - | ||||
GS01 | 2/2 | Required. GS group function code. Valid value is | RE | ||||
GS02 | 2/15 | Required. Application Sender's Code. | 2222224043588 | ||||
GS03 | 2/15 | Required. Application Receiver's Code. | TRACELINK | ||||
GS04 | 8/8 | Required. Current date stamp in 8 char X12 date format YYYYMMDD. | 20301020 | ||||
GS05 | 4/8 | Required. Current time stamp in 6 char X12 time format HHMMSS. | 142000 | ||||
GS06 | 1/9 | Required. Group Control ID Number. | 619827 | ||||
GS07 | 1/2 | Required. Responsible Agency Code. Valid values:
| X | ||||
GS08 | 1/12 | Required. X12 message version code. Valid value is 005010. | 005010 | ||||
ST | - | Required. ST transaction set envelope. Child of GS group. Only one ST transaction expected. | - | ||||
ST01 | 3/3 | Required. Transaction set identifier code. | 944 | ||||
ST02 | 4/9 | Required. Transaction set ID number. Counter for each ST segment beginning with 1. | 0001 | ||||
BFR | - | Required. Sales forecast/planning schedule beginning segment. | - | ||||
BFR01 | 2/2 | Required. Processing function code, transaction set purpose code. Valid values:
| 00 | ||||
BFR02 | 0…1 | 1/80 | Reference identification: TL forecast plan identifier. | 4500003288 | |||
BFR03 | 0…1 | 1/30 | Release number identifying a release against a Purchase Order previously placed by the parties involved in the transaction. | 4 | |||
BFR04 | 2/2 | Required. Forecast schedule type qualifier. Valid values:
| BB | ||||
BFR05 | 1/1 | Required. Schedule quantity qualifier identifying the type of quantities used when defining a schedule or forecast. Valid values:
| A | ||||
BFR06 | 8/8 | Required. Start Date for forecast plan or reference document. Required value. Note: there are three other optional Date field: BFR07, BFR08, BFR09. The standard does not specify what these dates are for. But research in multiple company 830 guidelines show that these are used in different ways by different companies, if used. | 20240329 | ||||
BFR07 | 8/8 | End Date [YYYYMMDD] . | 20240629 | ||||
BFR08 | 8/8 | Required. Document Date [YYYYMMDD], "Forecast generation date. | 20240212 | ||||
BFR09 | 8/8 | Not used. Date [YYYYMMDD] | 20240329 | ||||
BFR10 | 1/30 | Contract identifier for underlying customer purchase order. | 000458712 | ||||
BFR11 | 1/22 | Purchase order number identifying customer or purchaser PO. | 000458712 | ||||
DTM | - | DTM header level dates. | - | ||||
DTM01 | 3/3 | Required. Date type. The valid value is 067 - SCHEDULEDDELIVERY | 067 | ||||
DTM02 | 8/8 | Date value in date format YYYYMMDD. | 20240329 | ||||
DTM03 | 4/8 | Time in time format HHMMSS. | 092413 | ||||
N1 | - | N1: Name segment loop for:
| - | ||||
N101 | 2/3 | Required. Entity identifier code for party identifier and address information for sold to party (customert). Valid values:
| BY | ||||
N102 | 1/60 | Required. Name. | Wholesale Inc | ||||
N103 | 1/2 | Required. Identifier code qualifier. ![]()
| UL | ||||
N104 | 2/80 | Required. Buyer party identifier, as qualified by N103. | 3333331013655 | ||||
N3 | - | N3: Address: Child of buyer party N1 name segment. | - | ||||
N301 | 1/55 | Required. Street address 1. | 555 Neelan Road | ||||
N302 | 1/55 | Street address 2. | Suite 123 | ||||
N4 | - | N4: Geographic Location. Child of buyer party N1 name segment. | - | ||||
N401 | 2/30 | Required. City name. | Sacramento | ||||
N402 | 2/2 | Required. State or province code. Code (Standard state/province) as defined by appropriate government agency. | CA | ||||
N403 | 3/15 | Required. Postal code. Code defining international postal zone code excluding punctuation and blanks. | 95833 | ||||
N404 | 2/3 | Required. Country code. | US | ||||
PER | - | Administrative Communications Contact.
| - | ||||
PER01 | 2/2 | Required. Contact Function Code. Valid Enum is | AJ | ||||
PER02 | 1/60 | Name. | ContactName | ||||
PER03 | 2/2 | Communication Qualifier. | TE | ||||
PER04 | 1/60 | Communication Data. | ContactNumber | ||||
PER05 | 2/2 | Communication Qualifier. | EM | ||||
PER06 | 1/256 | Communication Data. | ContactEmail | ||||
LIN | - | Required. Transaction set line item details. At least one valid LIN syntax pair for product identifier and type is required. | - | ||||
LIN01 | 1/20 | Line item number. | 000010 | ||||
LIN02 | 2/2 | Required. Product/Service ID Qualifier. Valid Values:
| BP | ||||
LIN03 | 1/80 | Required. Product/service identifier value as qualifier by LIN02. | 100021 | ||||
LIN04 | 2/2 | Product/Service ID Qualifier. Valid Values:
| VN | ||||
LIN05 | 1/80 | Product/service identifier value as qualifier by LIN04. | 1000818 | ||||
LIN06 | 2/2 | Product/Service ID Qualifier. Valid Values:
| UK | ||||
LIN07 | 1/80 | Product/service identifier value as qualifier by LIN06. | 00002541789536 | ||||
LIN08 | 2/2 | Product/Service ID Qualifier. Valid Values:
| SK | ||||
LIN09 | 1/80 | Product/service identifier value as qualifier by LIN08. | 000025417895 | ||||
LIN10 | 2/2 | Product/Service ID Qualifier. Valid Values:
| UX | ||||
LIN11 | 1/80 | Product/service identifier value as qualifier by LIN10. | 100021 | ||||
LIN12 | 2/2 | Product/Service ID Qualifier. Valid Values:
| N1 | ||||
LIN13 | 1/80 | Product/service identifier value as qualifier by LIN12. | 100021 | ||||
LIN14 | 2/2 | Product/Service ID Qualifier. Valid Values:
| N2 | ||||
LIN15 | 1/80 | Product/service identifier value as qualifier by LIN14. | 100021 | ||||
LIN16 | 2/2 | Product/Service ID Qualifier. Valid Values:
| N2 | ||||
LIN17 | 1/80 | Product/service identifier value as qualifier by LIN16. | 100021 | ||||
LIN18 | 2/2 | Product/Service ID Qualifier. Valid Values:
| N3 | ||||
LIN19 | 1/80 | Product/service identifier value as qualifier by LIN18. | 100021 | ||||
LIN20 | 2/2 | Product/Service ID Qualifier. Valid Values:
| N4 | ||||
LIN21 | 1/80 | Product/service identifier value as qualifier by LIN20. | 100021 | ||||
UIT | - | Required. UIT: Unit item details … base unit of measure for line item. | - | ||||
UIT01.1 | 2/2 | Required. Quantity unit of measure for UIT01. ![]()
| EA | ||||
DTM | - | DTM: Dates at the line item level. | - | ||||
DTM01 | 3/3 | Required. Date type. The valid value is | 036 | ||||
DTM02 | 8/8 | Required. Date value in date format YYYYMMDD. | 20240329 | ||||
DTM03 | 4/8 | Time in time format HHMMSS. | 092413 | ||||
PID | - | PID: Product/item description. | - | ||||
PID01 | 1/1 | Item description type. The valid value is F - Free form text. | F | ||||
PID05 | 1/80 | Product description. | - | ||||
REF | - | REF segment mapping to plant identifier. | - | ||||
REF01 | 2/3 | Reference identifier type. The valid value is PE - Plant identifier. | F | ||||
REF02 | 1/80 | Plant identifier. | 012547 | ||||
REF | - | REF: Additional reference info, Forecast Version. | - | ||||
REF01 | 2/3 | Reference identifier type. The valid value is V0 - Version. | F | ||||
REF02 | 1/80 | Forecast Plan Version. | 1 | ||||
QTY | - | QTY: Quantities at item level for sales forecast. | - | ||||
QTY01 | 2/2 | Required. Quantity type. Valid values:
| 45 | ||||
QTY02 | 1/15 | Required. Quantity value. | 200 | ||||
QTY03-01 | 2/2 | Required. Unit of measure for quantity. Quantity UOM's: ![]()
| EA | ||||
FST | - | FST: Forecast schedule loop. At least one occurrence of segment FST is required. | - | ||||
FST01 | 1/15 | Required. Quantity for current forecast schedule loop. | 125 | ||||
FST02 | 1/1 | Required. Forecast qualifier specifying the sender's confidence level of the forecast data or an action associated with a forecast. | D | ||||
FST03 | 1/1 | Required. Forecast timing qualifier. Valid values:
| M | ||||
FST04 | 8/8 | Required. Forecast schedule line date in date format YYYYMMDD. (From Date) | 20240329 | ||||
FST05 | 8/8 | Date. (To Date) | 20240429 | ||||
FST06 | 3/3 | Required. Not used. Date qualifier for FST04. | - | ||||
FST11 | - | Required. Quantity type for FST01 quantity for current forecast schedule loop. Valid values:
| 01 | ||||
CTT | - | CTT-Transaction Totals | - | ||||
CTT01 | 1/6 | Required. Total number of line items in the transaction set | 15 | ||||
SE | - | Required. ST … SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected. | - | ||||
SE01 | 1/10 | Required. Total count of segments in ST … SE transaction set including ST and SE segments. | 10 | ||||
SE02 | 4/9 | Required. Transaction set control number. | 1 | ||||
GE | - | Required. GS … GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected. | - | ||||
GE01 | 1/6 | Required. Number of transaction sets in functional group. | 5 | ||||
GE02 | 1/9 | Required. Functional group control number. | 619827 | ||||
IEA | - | Required. ISA … IEA interchange control trailer envelope. Only one interchange expected per transmission. | - | ||||
IEA01 | 1/5 | Required. Number of functional groups in interchange. | 1 | ||||
IEA02 | 9/9 | Required. Interchange control number. | 0000000000619827 |

ISA*00* *00* *20*Sender *ZZ*Receiver *240129*1050*^*s10ss*11 *s*s*:~
GS*s1*s16*s17*20240129*1050*12345*X*005010~
ST*110*0010~
BFR*11*SF52365*REL# 253*RD*D*20240920*20240919*20240918*20240917*8196733288*PO8452*AA*00~
DTM*067*20240607~
N1*BY*Buyer*1*001000286~
N3*Buyer Street1*Street2~
N4*Buyer City*PR*111111*US~
PER*AJ*BYPERName*TE*TEL1111*EM*BY_email@corp.com~
N1*ST*ShipTo*91*ST001000286~
N3*ShipTo Street1*STStreet2~
N4*ShipTo City*PR*111111*US~
N1*SU*SUPPLIER*92*COMPANYSITEID~
N3*SUPPLIER Address 1*ShipTo Address 2~
N4*SUPPLIER City*YY*ST4545*JP~
PER*AJ*SUPERName*TE*TELShipTo*EM*ST_email@corp.com~
N1*SF*ShipFrom*91*257785475~
N3*SF Stree1*SF Steert2~
N4*SF City*SF*4444*US~
PER*AJ*SFPERName*TE*TELFrom*EM*SF_email@corp.com~
LIN*000010*PI*Customer*VN*Supplier*UK*GTIN14*UP*UPC*MF*Manufacturer*FV*CA_DIN*SK*SKU*BP*CUSTOMER*LT*Lot55787~
UIT*YR~
DTM*036*20240512*~
PID*F*01*10*D*DESC~
PID*F*02*11*D2*DESC2~
REF*V0*REF-V0~
REF*PE*Plant~
QTY*87*8787780*BG~
QTY*VJ*11111*ST~
QTY*00*5550*EA~
FST*66*E*C*20240129*20240129*001*1212*00*SA*AA*01*00*ABC~
CTT*47~
SE*2*1245~
GE*21*22~
IEA*23*241111111~
