{ "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_479": { "enum": [ "AA", "AB", "AC", "AD", "AE", "AF", "AG", "AH", "AI", "AK", "AL", "AM", "AN", "AO", "AP", "AQ", "AR", "AS", "AT", "AU", "AV", "AW", "AX", "AY", "AZ", "BA", "BB", "BC", "BD", "BE", "BF", "BG", "BL", "BS", "CA", "CB", "CC", "CD", "CE", "CF", "CH", "CI", "CJ", "CK", "CL", "CM", "CN", "CO", "CP", "CQ", "CR", "CS", "CT", "CU", "CV", "CW", "D3", "D4", "D5", "DA", "DD", "DF", "DI", "DM", "DS", "DX", "EC", "ED", "EI", "EN", "EO", "EP", "ER", "ES", "EV", "EX", "FA", "FB", "FC", "FG", "FR", "FT", "GC", "GE", "GF", "GL", "GP", "GR", "GT", "HB", "HC", "HI", "HN", "HP", "HR", "HS", "HU", "HV", "IA", "IB", "IC", "ID", "IE", "IF", "IG", "IH", "IJ", "IM", "IN", "IO", "IR", "IS", "JB", "KM", "LA", "LB", "LI", "LN", "LR", "LS", "LT", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MI", "MJ", "MK", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MV", "MW", "MX", "MY", "MZ", "NC", "NL", "NP", "NR", "NT", "OC", "OG", "OR", "OW", "PA", "PB", "PC", "PD", "PE", "PF", "PG", "PH", "PI", "PJ", "PK", "PL", "PN", "PO", "PQ", "PR", "PS", "PT", "PU", "PV", "PW", "PY", "QG", "QM", "QO", "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", "SA", "SB", "SC", "SD", "SE", "SF", "SH", "SI", "SJ", "SL", "SM", "SN", "SO", "SP", "SQ", "SR", "SS", "ST", "SU", "SV", "SW", "TA", "TB", "TD", "TE", "TF", "TI", "TJ", "TM", "TN", "TO", "TP", "TR", "TT", "TU", "TX", "UA", "UB", "UC", "UD", "UI", "UP", "UW", "VA", "VB", "VC", "VD", "VE", "VH", "VI", "VS", "WA", "WB", "WG", "WI", "WL", "WR", "WT" ], "type": "string", "format": "X12_ID_479" }, "AK1": { "required": [ "FunctionalIdentifierCode_01" ], "type": "object", "properties": { "FunctionalIdentifierCode_01": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_479" } ], "x-openedi-element-id": "479" }, "GroupControlNumber_02": { "maxLength": 9, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "28" }, "VersionReleaseIndustryIdentifierCode_03": { "type": "string", "format": "X12_AN", "x-openedi-element-id": "480" } }, "x-openedi-segment-id": "AK1" }, "X12_ID_143": { "enum": [ "100", "101", "102", "103", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "120", "121", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "135", "138", "139", "140", "141", "142", "143", "144", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "157", "158", "159", "160", "161", "163", "170", "175", "176", "179", "180", "185", "186", "187", "188", "189", "190", "191", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "210", "211", "212", "213", "214", "215", "216", "217", "219", "220", "222", "223", "224", "225", "227", "228", "240", "242", "244", "245", "248", "249", "250", "251", "252", "255", "256", "259", "260", "261", "262", "263", "264", "265", "266", "267", "268", "269", "270", "271", "272", "273", "274", "275", "276", "277", "278", "280", "283", "284", "285", "286", "288", "290", "300", "301", "303", "304", "309", "310", "311", "312", "313", "315", "317", "319", "322", "323", "324", "325", "326", "350", "352", "353", "354", "355", "356", "357", "358", "359", "361", "362", "404", "410", "412", "414", "417", "418", "419", "420", "421", "422", "423", "424", "425", "426", "429", "431", "432", "433", "434", "435", "436", "437", "440", "451", "452", "453", "455", "456", "460", "463", "466", "468", "470", "475", "485", "486", "490", "492", "494", "500", "501", "503", "504", "511", "517", "521", "527", "536", "540", "561", "567", "568", "601", "603", "620", "625", "650", "715", "753", "754", "805", "806", "810", "811", "812", "813", "814", "815", "816", "818", "819", "820", "821", "822", "823", "824", "826", "827", "828", "829", "830", "831", "832", "833", "834", "835", "836", "837", "838", "839", "840", "841", "842", "843", "844", "845", "846", "847", "848", "849", "850", "851", "852", "853", "854", "855", "856", "857", "858", "859", "860", "861", "862", "863", "864", "865", "866", "867", "868", "869", "870", "871", "872", "873", "874", "875", "876", "877", "878", "879", "880", "881", "882", "883", "884", "885", "886", "887", "888", "889", "890", "891", "893", "894", "895", "896", "920", "924", "925", "926", "928", "940", "943", "944", "945", "947", "980", "990", "993", "996", "997", "998", "999" ], "type": "string", "format": "X12_ID_143" }, "AK2": { "required": [ "TransactionSetControlNumber_02", "TransactionSetIdentifierCode_01" ], "type": "object", "properties": { "TransactionSetIdentifierCode_01": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_143" } ], "x-openedi-element-id": "143" }, "TransactionSetControlNumber_02": { "maxLength": 9, "minLength": 4, "type": "string", "format": "X12_AN", "x-openedi-element-id": "329" }, "ImplementationConventionReference_03": { "maxLength": 35, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "1705" } }, "x-openedi-segment-id": "AK2" }, "X12_ID_620": { "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "I4", "I6", "I7", "I8", "I9" ], "type": "string", "format": "X12_ID_620" }, "IK3": { "required": [ "SegmentIDCode_01", "SegmentPositioninTransactionSet_02" ], "type": "object", "properties": { "SegmentIDCode_01": { "maxLength": 3, "minLength": 2, "type": "string", "format": "X12_AN", "x-openedi-element-id": "721" }, "SegmentPositioninTransactionSet_02": { "maxLength": 10, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "719" }, "LoopIdentifierCode_03": { "maxLength": 4, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "447" }, "ImplementationSegmentSyntaxErrorCode_04": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_620" } ], "x-openedi-element-id": "620" } }, "x-openedi-segment-id": "IK3" }, "C998": { "required": [ "ContextName_01" ], "type": "object", "properties": { "ContextName_01": { "maxLength": 35, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "9999" }, "ContextReference_02": { "maxLength": 35, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "9998" } }, "x-openedi-composite-id": "C998" }, "C030": { "required": [ "ElementPositioninSegment_01" ], "type": "object", "properties": { "ElementPositioninSegment_01": { "type": "string", "format": "X12_N0", "x-openedi-element-id": "722" }, "ComponentDataElementPositioninComposite_02": { "type": "string", "format": "X12_N0", "x-openedi-element-id": "1528" }, "RepeatingDataElementPosition_03": { "type": "string", "format": "X12_N0", "x-openedi-element-id": "1686" } }, "x-openedi-composite-id": "C030" }, "C999": { "required": [ "DataElementReferenceNumber_01" ], "type": "object", "properties": { "DataElementReferenceNumber_01": { "type": "string", "format": "X12_N0", "x-openedi-element-id": "725" }, "DataElementReferenceNumber_02": { "type": "string", "format": "X12_N0", "x-openedi-element-id": "725" } }, "x-openedi-composite-id": "C999" }, "CTX": { "required": [ "ContextIdentification_01" ], "type": "object", "properties": { "ContextIdentification_01": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/C998" } }, "SegmentIDCode_02": { "maxLength": 3, "minLength": 2, "type": "string", "format": "X12_AN", "x-openedi-element-id": "721" }, "SegmentPositioninTransactionSet_03": { "maxLength": 10, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "719" }, "LoopIdentifierCode_04": { "maxLength": 4, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "447" }, "PositioninSegment_05": { "$ref": "#/components/schemas/C030" }, "ReferenceinSegment_06": { "$ref": "#/components/schemas/C999" } }, "x-openedi-segment-id": "CTX" }, "X12_ID_621": { "enum": [ "1", "10", "12", "13", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "I10", "I11", "I12", "I13", "I6", "I9" ], "type": "string", "format": "X12_ID_621" }, "IK4": { "required": [ "ImplementationDataElementSyntaxErrorCode_03", "PositioninSegment_01" ], "type": "object", "properties": { "PositioninSegment_01": { "$ref": "#/components/schemas/C030" }, "DataElementReferenceNumber_02": { "maxLength": 4, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "725" }, "ImplementationDataElementSyntaxErrorCode_03": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_621" } ], "x-openedi-element-id": "621" }, "CopyofBadDataElement_04": { "maxLength": 99, "minLength": 1, "type": "string", "format": "X12_AN", "x-openedi-element-id": "724" } }, "x-openedi-segment-id": "IK4" }, "TS999_IK4Loop1": { "type": "object", "properties": { "IK4": { "$ref": "#/components/schemas/IK4", "description": "Implementation Data Element Note" }, "CTX": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CTX" }, "description": "Element Context" } }, "x-openedi-loop-id": "IK4" }, "TS999_IK3Loop1": { "type": "object", "properties": { "IK3": { "$ref": "#/components/schemas/IK3", "description": "Error Identification" }, "CTX": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/CTX" }, "description": "Segment Context or Business Unit Identifier" }, "IK4Loop1": { "type": "array", "items": { "$ref": "#/components/schemas/TS999_IK4Loop1" } } }, "x-openedi-loop-id": "IK3" }, "X12_ID_717": { "enum": [ "A", "E", "M", "R", "W", "X" ], "type": "string", "format": "X12_ID_717" }, "X12_ID_618": { "enum": [ "1", "10", "11", "12", "13", "15", "16", "17", "18", "19", "2", "23", "24", "25", "26", "27", "3", "4", "5", "6", "7", "8", "9", "I5", "I6" ], "type": "string", "format": "X12_ID_618" }, "IK5": { "required": [ "TransactionSetAcknowledgmentCode_01" ], "type": "object", "properties": { "TransactionSetAcknowledgmentCode_01": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_717" } ], "x-openedi-element-id": "717" }, "ImplementationTransactionSetSyntaxErrorCode_02": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_618" } ], "x-openedi-element-id": "618" }, "ImplementationTransactionSetSyntaxErrorCode_03": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_618" } ], "x-openedi-element-id": "618" }, "ImplementationTransactionSetSyntaxErrorCode_04": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_618" } ], "x-openedi-element-id": "618" }, "ImplementationTransactionSetSyntaxErrorCode_05": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_618" } ], "x-openedi-element-id": "618" }, "ImplementationTransactionSetSyntaxErrorCode_06": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_618" } ], "x-openedi-element-id": "618" } }, "x-openedi-segment-id": "IK5" }, "TS999_AK2Loop1": { "required": [ "IK5" ], "type": "object", "properties": { "AK2": { "$ref": "#/components/schemas/AK2", "description": "Transaction Set Response Header" }, "IK3Loop1": { "type": "array", "items": { "$ref": "#/components/schemas/TS999_IK3Loop1" } }, "IK5": { "$ref": "#/components/schemas/IK5", "description": "Transaction Set Response Trailer" } }, "x-openedi-loop-id": "AK2" }, "X12_ID_715": { "enum": [ "A", "E", "M", "P", "R", "W", "X" ], "type": "string", "format": "X12_ID_715" }, "X12_ID_716": { "enum": [ "1", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "2", "23", "24", "25", "26", "3", "30", "31", "4", "5", "6", "7", "8", "9" ], "type": "string", "format": "X12_ID_716" }, "AK9": { "required": [ "FunctionalGroupAcknowledgeCode_01", "NumberofAcceptedTransactionSets_04", "NumberofReceivedTransactionSets_03", "NumberofTransactionSetsIncluded_02" ], "type": "object", "properties": { "FunctionalGroupAcknowledgeCode_01": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_715" } ], "x-openedi-element-id": "715" }, "NumberofTransactionSetsIncluded_02": { "maxLength": 6, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "97" }, "NumberofReceivedTransactionSets_03": { "maxLength": 6, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "123" }, "NumberofAcceptedTransactionSets_04": { "maxLength": 6, "minLength": 1, "type": "string", "format": "X12_N0", "x-openedi-element-id": "2" }, "FunctionalGroupSyntaxErrorCode_05": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_716" } ], "x-openedi-element-id": "716" }, "FunctionalGroupSyntaxErrorCode_06": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_716" } ], "x-openedi-element-id": "716" }, "FunctionalGroupSyntaxErrorCode_07": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_716" } ], "x-openedi-element-id": "716" }, "FunctionalGroupSyntaxErrorCode_08": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_716" } ], "x-openedi-element-id": "716" }, "FunctionalGroupSyntaxErrorCode_09": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/X12_ID_716" } ], "x-openedi-element-id": "716" } }, "x-openedi-segment-id": "AK9" }, "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" }, "TS999": { "required": [ "AK1", "AK9", "SE", "ST" ], "type": "object", "properties": { "ST": { "$ref": "#/components/schemas/ST", "description": "Transaction Set Header" }, "AK1": { "$ref": "#/components/schemas/AK1", "description": "Functional Group Response Header" }, "AK2Loop1": { "type": "array", "items": { "$ref": "#/components/schemas/TS999_AK2Loop1" } }, "AK9": { "$ref": "#/components/schemas/AK9", "description": "Functional Group Response Trailer" }, "SE": { "$ref": "#/components/schemas/SE", "description": "Transaction Set Trailer" } }, "x-openedi-message-id": "999", "x-openedi-message-standard": "X12" } } } }