Trading partner import/export JSON format
Introduction
This page shows the JSON format used to export and or import trading partners.
Caution
The primary use case for this format is to copy trading partner definitions from one environment to another. While it is possible for you to write a trading partner JSON file by hand, Jitterbit can't support you with any issues importing it.
Trading partners JSON schema
{
"partners": [
{
"name": "string",
"displayName": "string",
"ids": [
"string"
],
"preferredPartnerID": "string",
"send997": true,
"send997Type": "string",
"purgePIIOnArchive": false,
"userCreated": false,
"logo": "string",
"controlNumber": 0,
"groupID": "string",
"groupName": "string",
"envelope": {
"standard": "string",
"section": [
{
"name": "string",
"fields": [
{
"configname": "string",
"value": "string"
}
]
}
]
},
"udfs": [
{
"name": "string",
"value": "string"
}
],
"documents": [
{
"partnername": "string",
"direction": "Inbound",
"document": "string",
"mapProcessing": "XCBL",
"ediStandard": "string",
"documentVersion": "string",
"map": 0,
"active": true,
"testmode": false,
"debug": false,
"validateEdi": false,
"ack": false
}
],
"archiveSettings": {
"name": "string",
"archiveDays": 30,
"documents": [
{
"name": "string",
"archiveDays": 30
}
]
}
}
]
}
Example trading partner export file
{
"partners": [
{
"name": "ADI",
"displayName": "",
"ids": [
"ZZ-ADI",
"ZZ-ADITEST",
"ZZ-TST1ADI"
],
"preferredPartnerID": "",
"send997": true,
"send997Type": "Document",
"purgePIIOnArchive": false,
"userCreated": false,
"logo": "",
"controlNumber": 1000,
"groupID": "",
"groupName": "",
"envelope": {
"standard": "X12",
"section": [
{
"name": "Interchange",
"fields": [
{
"configname": "Authorization_Information_Qualifier",
"value": "00"
},
{
"configname": "Authorization_Information",
"value": ""
},
{
"configname": "Security_Information_Qualifier",
"value": "00"
},
{
"configname": "Security_Information",
"value": ""
},
{
"configname": "ISA_Standard_ID",
"value": ""
},
{
"configname": "Document_Version",
"value": ""
},
{
"configname": "Acknowledgement_Requested",
"value": ""
},
{
"configname": "Test_Indicator",
"value": ""
}
]
},
{
"name": "Functional Group",
"fields": [
{
"configname": "Responsible_Agency_Code",
"value": ""
},
{
"configname": "GS_Version",
"value": ""
}
]
},
{
"name": "Separators",
"fields": [
{
"configname": "Segment_Component",
"value": ""
},
{
"configname": "Element_Separator",
"value": ""
},
{
"configname": "Segment_Separator",
"value": ""
}
]
}
]
},
"udfs": [],
"documents": [
{
"partnername": "ADI",
"direction": "Inbound",
"document": "753",
"mapProcessing": "EDIXml",
"ediStandard": "X12",
"documentVersion": "4040",
"map": 0,
"active": false,
"testmode": false,
"debug": false,
"validateEdi": false,
"ack": true
}
],
"archiveSettings": {
"name": "ADI",
"archiveDays": 30,
"documents": []
}
}
]
}