{"openapi":"3.0.1","info":{"title":"EdiNation API","version":"2"},"paths":{},"components":{"schemas":{"ST":{"required":["TransactionSetControlNumber_02","TransactionSetIdentifierCode_01"],"type":"object","properties":{"TransactionSetIdentifierCode_01":{"maxLength":3,"minLength":3,"type":"string","format":"X12_AN","x-openedi-element-id":"143"},"TransactionSetControlNumber_02":{"maxLength":9,"minLength":4,"type":"string","format":"X12_AN","x-openedi-element-id":"329"},"ImplementationConventionPreference_03":{"maxLength":35,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"1705"}},"x-openedi-segment-id":"ST"},"X12_ID_692":{"enum":["1","2","A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","Y","Z"],"type":"string","format":"X12_ID_692"},"X12_ID_693":{"enum":["C","D","G","M","P","S","T"],"type":"string","format":"X12_ID_693"},"DK":{"required":["ConveyanceCode_05","DocketControlNumber_02","DocketIdentification_03","DocketTypeCode_06","RevisionNumber_04","StandardCarrierAlphaCode_01"],"type":"object","properties":{"StandardCarrierAlphaCode_01":{"maxLength":4,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"140"},"DocketControlNumber_02":{"maxLength":7,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"697"},"DocketIdentification_03":{"maxLength":11,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"690"},"RevisionNumber_04":{"maxLength":4,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"691"},"ConveyanceCode_05":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_692"}],"x-openedi-element-id":"692"},"DocketTypeCode_06":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_693"}],"x-openedi-element-id":"693"},"Date_07":{"maxLength":6,"minLength":6,"type":"string","format":"X12_DT","x-openedi-element-id":"373"},"Date_08":{"maxLength":6,"minLength":6,"type":"string","format":"X12_DT","x-openedi-element-id":"373"}},"x-openedi-segment-id":"DK"},"X12_ID_436":{"enum":["BR","DR","GR","OP","RR","TP"],"type":"string","format":"X12_ID_436"},"X12_ID_128":{"enum":["01","02","03","04","05","06","07","09","10","11","12","13","14","15","1A","1B","1C","1D","1E","1F","1G","1H","1J","1K","1L","1N","1S","1T","1U","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","51","52","53","54","61","62","63","64","65","95","96","A1","A3","AA","AB","AC","AD","AE","AF","AG","AH","AI","AJ","AK","AL","AM","AN","AO","AP","AR","AS","AT","AU","AW","AX","AY","B1","B4","BC","BD","BG","BH","BI","BJ","BK","BL","BM","BN","BO","BR","BS","BT","BU","BV","BW","BX","BY","BZ","C1","C2","C3","C4","C5","C6","C7","C8","C9","CA","CB","CC","CD","CE","CF","CG","CH","CI","CJ","CK","CL","CM","CN","CO","CP","CQ","CR","CS","CT","CU","CV","CW","CX","CY","CZ","D1","D2","D4","D5","DB","DC","DD","DE","DF","DG","DH","DI","DJ","DK","DL","DN","DO","DP","DQ","DR","DS","DT","DV","DW","DX","DY","EB","ED","EF","EG","EI","EL","EM","EN","EP","EQ","ER","ES","ET","EU","EZ","FA","FB","FC","FD","FE","FG","FI","FK","FM","FN","FP","FR","FS","FT","FU","FX","GA","GB","GC","GE","GG","GP","GR","GS","GT","HB","HC","HD","HE","HI","HN","HO","HP","HS","HW","I2","IA","IB","IC","ID","IE","IF","IG","II","IL","IM","IN","IO","IP","IR","IS","IT","IV","IX","JA","JB","JE","JS","KB","KE","KG","KH","KI","KJ","KM","L1","LA","LB","LC","LD","LF","LG","LI","LM","LN","LO","LP","LS","LT","LV","LW","M1","M2","M4","M5","MA","MB","MC","MD","ME","MF","MG","MH","MI","MJ","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MY","N0","NA","NB","NC","ND","NG","NN","NO","NP","NR","NS","NX","O5","OB","OC","OI","OM","ON","OP","OR","OS","OT","OW","P1","P2","P3","P4","P5","P6","P7","P8","P9","PA","PB","PC","PD","PE","PF","PG","PH","PI","PJ","PK","PL","PM","PN","PO","PP","PQ","PR","PS","PT","PU","PV","PW","PX","PY","PZ","Q1","Q2","Q3","QA","QB","QC","QD","QE","QF","QI","QM","QN","QR","QY","R1","R2","R3","R4","R5","R6","R7","R8","R9","RA","RB","RC","RD","RE","RF","RG","RH","RI","RJ","RK","RL","RM","RN","RO","RP","RQ","RR","RS","RT","RU","RV","RW","RX","RY","RZ","S1","S2","S3","S4","S6","S7","S8","S9","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SP","SQ","SR","SS","ST","SV","SW","SX","SY","SZ","T1","T2","T3","T4","T5","TA","TB","TC","TE","TF","TG","TH","TI","TJ","TK","TL","TM","TN","TO","TP","TQ","TR","TS","TT","TX","UB","UD","UG","UN","UP","US","UT","V1","V3","VA","VB","VC","VD","VN","VP","VR","VS","VT","VV","VX","WM","WN","WO","WP","WR","WS","WY","XC","XP","XX","ZA","ZB","ZC","ZZ"],"type":"string","format":"X12_ID_128"},"PRI":{"required":["ReferenceUsageCode_01","TariffAgencyCode_02","TariffNumber_03"],"type":"object","properties":{"ReferenceUsageCode_01":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_436"}],"x-openedi-element-id":"436"},"TariffAgencyCode_02":{"maxLength":4,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"168"},"TariffNumber_03":{"maxLength":7,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"171"},"TariffNumberSuffix_04":{"maxLength":2,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"493"},"TariffSupplementIdentifier_05":{"maxLength":4,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"173"},"TariffSection_06":{"maxLength":2,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"172"},"TariffItemNumber_07":{"maxLength":16,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"169"},"ReferenceNumberQualifier_08":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_128"}],"x-openedi-element-id":"128"},"ReferenceNumber_09":{"maxLength":30,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"127"},"StandardCarrierAlphaCode_10":{"maxLength":4,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"140"},"DocketControlNumber_11":{"maxLength":7,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"697"},"DocketIdentification_12":{"maxLength":11,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"690"},"RevisionNumber_13":{"maxLength":4,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"691"},"GroupTitle_14":{"maxLength":30,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"260"}},"x-openedi-syntax":["P0809","P101112"],"x-openedi-segment-id":"PRI"},"X12_ID_353":{"enum":["00","01","02","03","04","05","06","07","08","10","11","12","13","14","15","16","17","18","19","20","21","22","25","26","27","28","30","31","32","33","34","35","36","37","38","ZZ"],"type":"string","format":"X12_ID_353"},"GH":{"required":["Date_02","TransactionSetPurposeCode_01"],"type":"object","properties":{"TransactionSetPurposeCode_01":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_353"}],"x-openedi-element-id":"353"},"Date_02":{"maxLength":6,"minLength":6,"type":"string","format":"X12_DT","x-openedi-element-id":"373"},"ExpirationDate_03":{"maxLength":6,"minLength":6,"type":"string","format":"X12_DT","x-openedi-element-id":"255"},"GroupTitle_04":{"maxLength":30,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"260"},"NumberofLineItems_05":{"maxLength":6,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"354"}},"x-openedi-segment-id":"GH"},"TT":{"required":["AssignedNumber_01","FixedFormatInformation_02"],"type":"object","properties":{"AssignedNumber_01":{"maxLength":6,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"554"},"FixedFormatInformation_02":{"maxLength":80,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"449"}},"x-openedi-segment-id":"TT"},"X12_ID_262":{"enum":["A","B","D","F","L","O","P","T","U"],"type":"string","format":"X12_ID_262"},"X12_ID_699":{"enum":["M","P"],"type":"string","format":"X12_ID_699"},"X12_ID_309":{"enum":["AC","AR","BS","CA","CC","CD","CI","CL","CO","CS","CY","D","DC","DE","FA","FE","FF","FI","FV","IM","IP","K","MI","NS","OA","OL","OP","OR","OV","PA","PE","PL","PP","PQ","PR","PS","PT","PU","RL","RS","RT","SB","SC","SL","SN","SP","SW","TC","TL","TN","TR","TX","UR","VS","W","WH","ZZ"],"type":"string","format":"X12_ID_309"},"X12_ID_259":{"enum":["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","T","W","X"],"type":"string","format":"X12_ID_259"},"GY":{"required":["CommodityGeographicLogicalConnectorCode_02","GeographyQualifierCode_01"],"type":"object","properties":{"GeographyQualifierCode_01":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_262"}],"x-openedi-element-id":"262"},"CommodityGeographicLogicalConnectorCode_02":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_699"}],"x-openedi-element-id":"699"},"LocationQualifier_03":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_309"}],"x-openedi-element-id":"309"},"StateorProvinceCode_04":{"maxLength":2,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"156"},"LocationIdentifier_05":{"maxLength":25,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"310"},"LocationIdentifier_06":{"maxLength":25,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"310"},"StandardCarrierAlphaCode_07":{"maxLength":4,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"140"},"ChangeTypeCode_08":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_259"}],"x-openedi-element-id":"259"}},"x-openedi-syntax":["C0503","C0605"],"x-openedi-segment-id":"GY"},"Loop_GY_490":{"required":["GY"],"type":"object","properties":{"GY":{"$ref":"#/components/schemas/GY","description":"Geography"},"PRI":{"$ref":"#/components/schemas/PRI","description":"External Reference Identifier"}},"x-openedi-loop-id":"GY"},"X12_ID_23":{"enum":["2","A","B","C","D","E","F","G","H","I","J","K","L","N","P","Q","S","T","U","Z"],"type":"string","format":"X12_ID_23"},"PR":{"required":["CommodityGeographicLogicalConnectorCode_01"],"type":"object","properties":{"CommodityGeographicLogicalConnectorCode_01":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_699"}],"x-openedi-element-id":"699"},"CommodityCodeQualifier_02":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_23"}],"x-openedi-element-id":"23"},"CommodityCode_03":{"maxLength":16,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"22"},"CommodityCode_04":{"maxLength":16,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"22"},"ChangeTypeCode_05":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_259"}],"x-openedi-element-id":"259"}},"x-openedi-syntax":["C0302","C0402"],"x-openedi-segment-id":"PR"},"Loop_PR_490":{"required":["PR"],"type":"object","properties":{"PR":{"$ref":"#/components/schemas/PR","description":"Product (Commodity)"},"PRI":{"$ref":"#/components/schemas/PRI","description":"External Reference Identifier"}},"x-openedi-loop-id":"PR"},"X12_ID_98":{"enum":["01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","1P","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","AA","AB","AC","AD","AE","AF","AG","AI","AK","AL","AO","AP","AQ","AR","BF","BG","BK","BL","BN","BO","BS","BT","BU","BW","BY","C1","C2","C3","CA","CB","CC","CD","CE","CF","CG","CH","CI","CL","CM","CN","CO","CP","CQ","CR","CS","CT","CV","DA","DB","DC","DE","DF","DL","DM","DP","DR","DS","DT","DU","DV","EB","EC","EE","EM","EN","EP","EX","FB","FH","FR","FS","FW","GP","IA","IC","II","IK","IL","IM","IN","IS","IT","IU","LB","LC","LE","LG","LL","LN","LO","LP","LS","M1","M2","M3","M4","M6","M7","M8","MA","MB","MC","MD","ME","MF","MG","MH","MI","MJ","MK","ML","MP","MQ","N1","N2","ND","NP","OB","OC","OI","OM","OO","OP","OR","OT","OU","OV","OW","PA","PB","PC","PD","PE","PF","PG","PH","PI","PJ","PK","PL","PM","PN","PO","PP","PQ","PR","PS","PT","PU","PV","PW","PY","PZ","QR","RA","RB","RC","RD","RE","RF","RG","RH","RI","RJ","RL","RM","RO","RP","RQ","RR","RS","RU","RY","S1","S2","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SM","SN","SO","SP","SR","SS","ST","SU","SW","T1","T2","TC","TF","TH","TI","TO","TR","TS","TT","UC","UP","VN","WF","WH","ZZ"],"type":"string","format":"X12_ID_98"},"PT":{"required":["ConditionSegmentLogicalConnector_01"],"type":"object","properties":{"ConditionSegmentLogicalConnector_01":{"maxLength":3,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"495"},"EntityIdentifierCode_02":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_98"}],"x-openedi-element-id":"98"},"NameCharacterFormat_03":{"maxLength":30,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"459"},"StandardCarrierAlphaCode_04":{"maxLength":4,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"140"},"ReferenceNumber_05":{"maxLength":30,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"127"},"ChangeTypeCode_06":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_259"}],"x-openedi-element-id":"259"}},"x-openedi-segment-id":"PT"},"N3":{"required":["AddressInformation_01"],"type":"object","properties":{"AddressInformation_01":{"maxLength":35,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"166"},"AddressInformation_02":{"maxLength":35,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"166"}},"x-openedi-segment-id":"N3"},"N4":{"type":"object","properties":{"CityName_01":{"maxLength":19,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"19"},"StateorProvinceCode_02":{"maxLength":2,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"156"},"PostalCode_03":{"maxLength":9,"minLength":4,"type":"string","format":"X12_AN","x-openedi-element-id":"116"},"CountryCode_04":{"maxLength":2,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"26"},"LocationQualifier_05":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_309"}],"x-openedi-element-id":"309"},"LocationIdentifier_06":{"maxLength":25,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"310"}},"x-openedi-syntax":["R0105","P0506"],"x-openedi-segment-id":"N4"},"Loop_PT_490":{"required":["PT"],"type":"object","properties":{"PT":{"$ref":"#/components/schemas/PT","description":"Patron"},"PRI":{"$ref":"#/components/schemas/PRI","description":"External Reference Identifier"},"N3":{"$ref":"#/components/schemas/N3","description":"Address Information"},"N4":{"$ref":"#/components/schemas/N4","description":"Geographic Location"}},"x-openedi-loop-id":"PT"},"CD":{"required":["ConditionCode_02","ConditionSegmentLogicalConnector_01"],"type":"object","properties":{"ConditionSegmentLogicalConnector_01":{"maxLength":3,"minLength":2,"type":"string","format":"X12_AN","x-openedi-element-id":"495"},"ConditionCode_02":{"maxLength":4,"minLength":4,"type":"string","format":"X12_AN","x-openedi-element-id":"498"},"ConditionValue_03":{"maxLength":10,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"499"},"ConditionValue_04":{"maxLength":10,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"499"},"ConditionValue_05":{"maxLength":10,"minLength":1,"type":"string","format":"X12_AN","x-openedi-element-id":"499"},"AssignedNumber_06":{"maxLength":6,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"554"},"ChangeTypeCode_07":{"type":"string","allOf":[{"$ref":"#/components/schemas/X12_ID_259"}],"x-openedi-element-id":"259"}},"x-openedi-segment-id":"CD"},"Loop_CD_490":{"required":["CD"],"type":"object","properties":{"CD":{"$ref":"#/components/schemas/CD","description":"Shipment Conditions"},"PRI":{"$ref":"#/components/schemas/PRI","description":"External Reference Identifier"}},"x-openedi-loop-id":"CD"},"SE":{"required":["NumberofIncludedSegments_01","TransactionSetControlNumber_02"],"type":"object","properties":{"NumberofIncludedSegments_01":{"maxLength":10,"minLength":1,"type":"string","format":"X12_N0","x-openedi-element-id":"96"},"TransactionSetControlNumber_02":{"maxLength":9,"minLength":4,"type":"string","format":"X12_AN","x-openedi-element-id":"329"}},"x-openedi-segment-id":"SE"},"TS490":{"required":["DK","GH","PRI"],"type":"object","properties":{"ST":{"$ref":"#/components/schemas/ST"},"DK":{"$ref":"#/components/schemas/DK","description":"Docket Header"},"PRI":{"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/PRI"},"description":"External Reference Identifier"},"GH":{"$ref":"#/components/schemas/GH","description":"Group Header"},"PRI2":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/PRI"}},"TT":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/TT"},"description":"Term Text"},"GYLoop":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/Loop_GY_490"}},"PRLoop":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/Loop_PR_490"}},"PTLoop":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/Loop_PT_490"}},"CDLoop":{"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/Loop_CD_490"}},"SE":{"$ref":"#/components/schemas/SE"}},"x-openedi-message-id":"490","x-openedi-message-standard":"X12"}}}}