JSON Schema
OpenAPI Spec (POST)
OpenAPI Spec (GET)
Sample Payload
...
| Include Page | ||||
|---|---|---|---|---|
|
Sample JSON instance (message payload)
| Code Block | ||
|---|---|---|
| ||
{
"notifyShipment": {
"releaseIdentifier": "10.7",
"versionIdentifier": "1.0",
"applicationArea": {
"creationDateTime": "2019-06-12T05:04:30-06:00"
},
"dataArea": {
"notify": {
"recordSetTotalNumber": 1
},
"shipment": {
"typeCode": "Bulk",
"actionCode": "Original",
"shipmentHeader": {
"identifier": "2130948342",
"lastModificationDateTime": "2020-03-19T22:50:45.456-05:00",
"documentDateTime": "2020-03-19T22:50:45.456-05:00",
"documentReference": {
"identifier": "21231232",
"typeCode": "PurchaseOrder"
},
"attachment": [
{
"typeCode": "BillOfLading",
"uri": "http://smallbusinessa.com/billingOfLading/2130948342",
"fileName": "billoflading_2130948342.pdf",
"documentDateTime": "2020-03-19T17:00:45.456-05:00",
"description": "Bill of Lading"
}
],
"status": {
"code": "ShipConfirm",
"reasonCode": "NA",
"reason": "NA"
},
"actualShipDateTime": "2021-03-04T08:33:00-05:00",
"scheduledDeliveryDateTime": "2021-03-04T13:00:00-05:00",
"tareWeightMeasure": {
"content": "35,000",
"unitCode": "LB"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LB"
},
"grossWeightMeasure": {
"content": "36,800",
"unitCode": "LB"
},
"transportationMethodCode": "TL",
"estimatedDepartureDateTime": "2021-03-04T1315:00-05:00",
"estimatedArrivalDateTime": "2021-03-04T12:45:00-05:00",
"shipFromParty": {
"typeCode": "stringManufacturingPlant",
"identifier": "stringMC",
"name": "stringMason City",
"location": {
"identifier": "7685",
"postalAddress": {
"typeCode": "BranchPlant",
"addressLine": [
"string123 Example Street"
],
"cityName": "stringMason City",
"countrySubDivisionCode": [
{
"content": "stringIA",
"typeCode": "State"
}
],
"countryCode": "stringUSA",
"postalCode": "string30316"
},
"glnid": "stringNA"
}
},
"carrierParty": {
"identifiertypeCode": "stringContract",
"scacid": "stringRUAN",
"name": "stringRuan Transportation"
},
"supplierParty": {
"identifier": "123454321",
"name": "stringSmallBusinessA"
},
"soldToParty": {
"typeCode": "stringCustomer",
"identifier": "string58885",
"nameaccountIdentifier": "stringACCOUNT-58885",
"locationname": {"Happy Dairy Farm"
},
"postalAddressshipToParty": {
"identifier": "string58885",
"name": "stringHappy Dairy Farm",
"addressLinelocation": [{
"identifier": "stringLocation1232321",
],"coordinate": {
"cityNameverticalMeasure": "string15Z",
"countrySubDivisionCodelatitudeMeasure": [
43.580301503358996,
"stringlongitudeMeasure": -92.57476726492425
]},
"countryCodephysicalAddress": "string",{
"postalCodeaddressLine": "string"[
}, "12345 Co Hwy 8"
"glnid": "string" ],
} }, "buildingNumber": "2",
"shipToParty": { "buildingName": "Storage Bin B",
"identifier": "58885", "namecityName": "HappyLe Dairy FarmRoy",
"locationcountrySubDivisionCode": [
{ "identifier": "Location1232321", {
"coordinate": { "verticalMeasure"content": "15ZMN",
"latitudeMeasuretypeCode": 43.580301503358996, "State"
}
"longitudeMeasure": -92.57476726492425 }],
"physicalAddresscountryCode": {"USA",
"addressLinepostalCode": "55951-1234"
[ },
"12345 Co Hwy 8" "glnid": "123456789"
], },
"buildingNumbercontact": "2",{
"buildingNametypeCode": "Storage Bin BOwner",
"cityNamepersonName": "Le{
Roy", "formattedName": "countrySubDivisionCode": [Mabel E. Farmer "
},
{ "telephoneCommunication": [
"content": "MN", {
"typeCode": "StateMobile",
}
"identifier": "01.507.555.1234"
], }
"countryCode": "USA",
],
"postalCodeemailAddressCommunication": "55951-1234"
{
}, "identifier": "mabel.e.farmer@email.com"
"glnid": "123456789" }
},
},
"contactdeclaredValueAmount": {
"typeCodecontent": "Owner"8400,
"currencyCode": "personNameUSD":
{ },
"formattedName": "Mabel E. Farmer "freightChargeAmount": {
}"content": 590.5,
"currencyCode": "telephoneCommunicationUSD":
[ }
{ },
"shipmentUnit": [
"typeCode": "Mobile", {
"identifiertypeCode": "01.507.555.1234"Semi-Trailer",
"identifier": "3243243243434",
} ],
"trackingIdentifier": "4157451521254",
"emailAddressCommunicationproNumberIdentifier": {
"4157451521254",
"identifiercontainerGroupIdentifier": "mabel.e.farmer@email.com"NA",
"containerIdentifier": }"C-12312323",
"rfid": "0000000000000001",
} }"sealIdentifier": "4157451521254",
"declaredValueAmountcontainsHazardousMaterialIndicator": {"N",
"contentscheduledDeliveryDateTime": 8400"2020-03-20T08:00:45.456-05:00",
"currencyCodetareWeightMeasure": "USD"{
},"content": 35000,
"freightChargeAmountunitCode": {"LBS"
"content": 2400},
"currencyCodenetWeightMeasure": "USD"{
} "content": 1800,
}, "shipmentUnitunitCode": "LBS"
[ {},
"typeCodegrossWeightMeasure": "Semi-Trailer", {
"identifiercontent": "3243243243434"36800,
"trackingIdentifierunitCode": "4157451521254LBS",
"proNumberIdentifier": "4157451521254"},
"containerGroupIdentifiershipmentUnitContainer": "A", [
{
"containerIdentifier": "3243243243434", "rfidtypeCode": "0000000000000001Semi-Trailer",
"sealIdentifiercontainerIdentifier": "4157451521254C-12312323",
"containsHazardousMaterialIndicatorrfid": "N0000000000000001",
"scheduledDeliveryDateTimesealIdentifier": "2020-03-20T08:00:45.456-05:004157451521254",
"tareWeightMeasure": { "containerGroupIdentifier": "NA",
"grossWeightMeasure": {
"content": 3500036800,
"unitCode": "LBS"
},
"netWeightMeasurepackingMaterial": {
"contenttypeCode": 1800"NA",
"unitCodedescription": "LBSNA"
},
"grossWeightMeasureshippingMaterial": {
"contenttypeCode": 36800,"NA",
"unitCodedescription": "LBSNA"
}, },
"shipmentUnitContainer": [ "quantity": {
{ "typeCodecontent": "Semi-Trailer",1,
"containerIdentifierunitCode": ["TL"
},
"string", "shipmentUnitItem": [
"4157451521254" {
], "rfidtypeCode": "0000000000000001MedicatedFeed",
"sealIdentifieridentifier": "string1",
"grossWeightMeasurecustomerItemIdentification": {
"contentidentifier": 36800,"091818"
"unitCode": "LBS" },
}, "manufacturerItemIdentification": {
"packingMaterial": { "typeCode": "NASKU",
"descriptionidentifier": "NA1213579"
},
"shippingMaterialsupplierItemIdentification": {
"typeCode": "NASKU",
"descriptionidentifier": "NA1213579"
},
"quantitygtinid": {"NA",
"contentuid": 1"NA",
"unitCoderfid": "TL"[
}, "NA"
"shipmentUnitItem": [ ],
{ "serialNumberIdentifier": [
"typeCode": "stringNA",
"identifier": "1"],
"customerItemIdentificationlot": {
"identifiertypeCode": "091818Batch",
}, "identifier": "d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"
"manufacturerItemIdentification": { },
"typeCodedescription": "SKU",Custom Feed Blend - Derived from Milk Max Plus Basic",
"identifier": "1213579" "specification": {
}, "identifier": {
"supplierItemIdentification": { "typeCode""content": "SKU4FDCA",
"identifiertypeCode": "1213579FormulationCode"
},
"gtinidproperty": "NA",[
"uid": "NA", {
"rfid": [ "nameValue": {
"NA" "content": 55.24,
], "serialNumberIdentifiername": ["Protein",
"string", "typeCode": "NutrientValue",
"NA" "unitCode": "PCT",
], "lotunitCodeListVersionIdentifier": {"UNRec20"
"typeCode": "Batch", },
"identifierdescription": "d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"Protein"
}, }
"description": "string", ]
"specification": { },
"identifiercountryOfOriginCode": {"USA",
"contentmanufacturingParty": "4FDCA",{
"typeCodeidentifier": "FormulationCodeMC",
},
"name": "Mason City"
"property": [},
"bestUsedByDate": "2022-01-05",
{ "containsHazardousMaterialIndicator": "N",
"nameValue": { "hazardousMaterialCodes": {
"content": 55.24, "code": {
"namecontent": "ProteinNA",
"typeCodelistIdentifier": "NutrientValueHazard",
"unitCodelistAgencyIdentifier": "PCT",USDOT"
}
},
"unitCodeListVersionIdentifier": "UNRec20" "orderQuantity": {
} "content": 2000,
"unitCode": "LBS"
},
"shippedQuantity": {
"content": 1800,
"unitCode": "LBS"
},
"backOrderedQuantity": {
"content": 200,
"unitCode": "LBS"
},
"tareWeightMeasure": {
"content": 35000,
"unitCode": "LBS"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LBS"
},
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LBS"
},
"purchaseOrderReference": {
"typeCode": "DirectShip",
"lineNumberIdentifier": "123232-001"
},
"salesOrderReference": {
"typeCode": "NA",
"lineNumberIdentifier": "NA"
},
"itemSubLine": [
{
"typeCode": "VFD",
"identifier": "apramycin",
"manufacturerItemIdentification": {
"typeCode": "SKU",
"identifier": "3434343"
},
"referenceDesignatorIdentifier": {
"content": "VetId43434",
"schemeIdentifier": "VFD",
"schemeVersionIdentifier": "Guidance for Industry #120",
"schemeAgencyIdentifier": "FDA"
},
"lot": {
"typeCode": "Batch",
"identifier": "AP-20210228-232"
},
"quantity": {
"content": 0.45,
"unitCode": "PCT",
"typeCode": "Prescribed"
},
"status": {
"code": "Active",
"effectiveTimePeriod": {
"startDateTime": "2021-01-01",
"endDateTime": "2021-12-31"
}
},
"description": "apramycin"
}
]
}
]
}
],
"containerQuantity": {
"content": 1,
"unitCode": "string"
}
}
]
}
}
}
} |
Sample JSON instance (message payload)
The following is the MVP when two parties are ‘connected’ and ‘configured’ to exchange data.
| Code Block | ||
|---|---|---|
| ||
{ "notifyShipment": { "releaseIdentifier": "OAGIS_10.7", "versionIdentifier": "1.0", "applicationArea": { "sender": { "identifier": "NB" }, "receiver": { "identifier": "FD" }, "creationDateTime": "2019-06-12T05:04:30-06:00", "correlationIdentifier": "0-539f82b1-df6e-11e9-b486-5ce0c51e62ce" }, "dataArea": { "notify": { "recordSetTotalNumber": 1 }, "shipment": { "typeCode": "Bulk", "actionCode": "Original", "shipmentHeader": { "identifier": "2130948342", "lastModificationDateTime": "2020-03-19T22:50:45.456-05:00", "documentDateTime": "2020-03-19T22:50:45.456-05:00", "documentReference": { "descriptionidentifier": "Protein21231232-OD-00651", "typeCode": "PurchaseOrder" }, "status": { ] "code": "ShipConfirm", "reasonCode": "NA", }, "reason": "NA" "countryOfOriginCode": "USA"}, "actualShipDateTime": "2021-03-04T08:33:00-05:00", "manufacturingPartytareWeightMeasure": { "content": 35000, "identifierunitCode": "MCLB", }, "namenetWeightMeasure": "Mason{ City" "content": 1800, }, "unitCode": "LB" }, "bestUsedByDate": "2022-01-05", "grossWeightMeasure": { "containsHazardousMaterialIndicatorcontent": "N"36800, "unitCode": "LB" "hazardousMaterialCodes": { }, "transportationMethodCode": "TL", "estimatedArrivalDateTime": "code": {2021-03-04T12:45:00-05:00", "shipFromParty": { "contenttypeCode": "NAManufacturingPlant", "identifier": "MC" "listIdentifier": "Hazard"}, "carrierParty": { "listAgencyIdentifiertypeCode": "USDOTContract", "scacid": "RUAN", } "name": "Ruan Transportation" }, }, "supplierParty": { "orderQuantityidentifier": {"123454321" }, "contentsoldToParty": 2000,{ "typeCode": "Customer", "unitCode": "LBS" "identifier": "58885", "accountIdentifier": },"ACCOUNT-58885" }, "shippedQuantityshipToParty": { "location": { "content": 1800, "identifier": "58885", "unitCodename": "LBSHappy Dairy Farm", "physicalAddress": { }, "addressLine": [ "backOrderedQuantity": { "12345 Co Hwy 8" "content": 200, ], "unitCodecityName": "LBSLe Roy", }, "countrySubDivisionCode": [ "tareWeightMeasure": { "content": "stringMN", "unitCodetypeCode": "LBS"State" } }, ], "netWeightMeasurecountryCode": {"USA", "postalCode": "55951-1234" "content": 1800, }, "unitCodeglnid": "LBS123456789" } }, } }, "grossWeightMeasureshipmentUnit": [ { { "contenttypeCode": 36800,"Semi-Trailer", "identifier": "3243243243434", "unitCodetrackingIdentifier": "LBS3243243243434", "containerIdentifier": "C-12312323", }, "sealIdentifier": "4157451521254", "purchaseOrderReferencescheduledDeliveryDateTime": {"2020-03-20T08:00:45.456-05:00", "tareWeightMeasure": { "typeCode": "DirectShip", "content": 35000, "lineNumberIdentifierunitCode": "123232-001LBS" }, }, "netWeightMeasure": { "salesOrderReferencecontent": { 1800, "typeCodeunitCode": "NA","LBS" }, "lineNumberIdentifiergrossWeightMeasure": [{ "content": 36800, "unitCode": "stringLBS", }, "NAshipmentUnitContainer": [ { ] "typeCode": "Semi-Trailer", }, "containerIdentifier": "C-12312323", "itemSubLinesealIdentifier": ["4157451521254", "grossWeightMeasure": { { "content": 36800, "typeCode": "VFD", "unitCode": "LBS" }, "identifier": "apramycin", "quantity": { "manufacturerItemIdentification": { "content": 1, "typeCodeunitCode": "SKUTL", }, "identifier": "3434343" "shipmentUnitItem": [ }, { "referenceDesignatorIdentifiertypeCode": {"MedicatedFeed", "content"identifier": "VetId434341", "schemeIdentifiercustomerItemIdentification": "VFD", { "schemeVersionIdentifieridentifier": "Guidance for Industry #120",091818" }, "schemeAgencyIdentifier": "FDA" "description": "Custom Feed Blend - Derived from Milk Max Plus }Basic", "lotspecification": { "identifier": { "typeCode": "Batch", "content": "4FDCA", "identifier": [ "typeCode": "FormulationCode" "AP-20210228-232" } ] }, }, "bestUsedByDate": "2022-01-05", "quantityorderQuantity": { { "content": 0.452000, "unitCode": "PCT",LBS" }, "typeCodeshippedQuantity": "Prescribed"{ }"content": 1800, "unitCode": "statusLBS": { }, "code": "string", "backOrderedQuantity": { "effectiveTimePeriod": { "content": 200, "startDateTimeunitCode": "stringLBS", }, "endDateTime": "2021-12-31" "netWeightMeasure": { } "content": 1800, }, "unitCode": "LBS" "description": "apramycin" }, } "purchaseOrderReference": { ] "typeCode": "DirectShip", } "lineNumberIdentifier": "21231232-OD-00651-00100" ] } ], } "containerQuantity": { ] "content": 1, } "unitCode": "string"], "containerQuantity": }1 } ] } } } } |