JSON Schema
OpenAPI Spec (POST)
OpenAPI Spec (GET)
Sample Payload
{
"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": "ManufacturingPlant",
"identifier": "MC",
"name": "Mason City",
"location": {
"identifier": "7685",
"postalAddress": {
"typeCode": "BranchPlant",
"addressLine": [
"123 Example Street"
],
"cityName": "Mason City",
"countrySubDivisionCode": [
{
"content": "IA",
"typeCode": "State"
}
],
"countryCode": "USA",
"postalCode": "30316"
},
"glnid": "NA"
}
},
"carrierParty": {
"typeCode": "Contract",
"scacid": "RUAN",
"name": "Ruan Transportation"
},
"supplierParty": {
"identifier": "123454321",
"name": "SmallBusinessA"
},
"soldToParty": {
"typeCode": "Customer",
"identifier": "58885",
"accountIdentifier": "ACCOUNT-58885",
"name": "Happy Dairy Farm"
},
"shipToParty": {
"identifier": "58885",
"name": "Happy Dairy Farm",
"location": {
"identifier": "Location1232321",
"coordinate": {
"verticalMeasure": "15Z",
"latitudeMeasure": 43.580301503358996,
"longitudeMeasure": -92.57476726492425
},
"physicalAddress": {
"addressLine": [
"12345 Co Hwy 8"
],
"buildingNumber": "2",
"buildingName": "Storage Bin B",
"cityName": "Le Roy",
"countrySubDivisionCode": [
{
"content": "MN",
"typeCode": "State"
}
],
"countryCode": "USA",
"postalCode": "55951-1234"
},
"glnid": "123456789"
},
"contact": {
"typeCode": "Owner",
"personName": {
"formattedName": "Mabel E. Farmer "
},
"telephoneCommunication": [
{
"typeCode": "Mobile",
"identifier": "01.507.555.1234"
}
],
"emailAddressCommunication": {
"identifier": "mabel.e.farmer@email.com"
}
}
},
"declaredValueAmount": {
"content": 8400,
"currencyCode": "USD"
},
"freightChargeAmount": {
"content": 590.5,
"currencyCode": "USD"
}
},
"shipmentUnit": [
{
"typeCode": "Semi-Trailer",
"identifier": "3243243243434",
"trackingIdentifier": "4157451521254",
"proNumberIdentifier": "4157451521254",
"containerGroupIdentifier": "NA",
"containerIdentifier": "C-12312323",
"rfid": "0000000000000001",
"sealIdentifier": "4157451521254",
"containsHazardousMaterialIndicator": "N",
"scheduledDeliveryDateTime": "2020-03-20T08:00:45.456-05:00",
"tareWeightMeasure": {
"content": 35000,
"unitCode": "LBS"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LBS"
},
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LBS"
},
"shipmentUnitContainer": [
{
"typeCode": "Semi-Trailer",
"containerIdentifier": "C-12312323",
"rfid": "0000000000000001",
"sealIdentifier": "4157451521254",
"containerGroupIdentifier": "NA",
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LBS"
},
"packingMaterial": {
"typeCode": "NA",
"description": "NA"
},
"shippingMaterial": {
"typeCode": "NA",
"description": "NA"
},
"quantity": {
"content": 1,
"unitCode": "TL"
},
"shipmentUnitItem": [
{
"typeCode": "MedicatedFeed",
"identifier": "1",
"customerItemIdentification": {
"identifier": "091818"
},
"manufacturerItemIdentification": {
"typeCode": "SKU",
"identifier": "1213579"
},
"supplierItemIdentification": {
"typeCode": "SKU",
"identifier": "1213579"
},
"gtinid": "NA",
"uid": "NA",
"rfid": [
"NA"
],
"serialNumberIdentifier": [
"NA"
],
"lot": {
"typeCode": "Batch",
"identifier": "d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"
},
"description": "Custom Feed Blend - Derived from Milk Max Plus Basic",
"specification": {
"identifier": {
"content": "4FDCA",
"typeCode": "FormulationCode"
},
"property": [
{
"nameValue": {
"content": 55.24,
"name": "Protein",
"typeCode": "NutrientValue",
"unitCode": "PCT",
"unitCodeListVersionIdentifier": "UNRec20"
},
"description": "Protein"
}
]
},
"countryOfOriginCode": "USA",
"manufacturingParty": {
"identifier": "MC",
"name": "Mason City"
},
"bestUsedByDate": "2022-01-05",
"containsHazardousMaterialIndicator": "N",
"hazardousMaterialCodes": {
"code": {
"content": "NA",
"listIdentifier": "Hazard",
"listAgencyIdentifier": "USDOT"
}
},
"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"
}
}
]
}
}
}
}
Minimal Viable Product
OpenAPI POST
JSON Schema
Example Payload
The following is the MVP when two parties are ‘connected’ and ‘configured’ to exchange data.
{
"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": {
"identifier": "21231232-OD-00651",
"typeCode": "PurchaseOrder"
},
"status": {
"code": "ShipConfirm",
"reasonCode": "NA",
"reason": "NA"
},
"actualShipDateTime": "2021-03-04T08:33:00-05:00",
"tareWeightMeasure": {
"content": 35000,
"unitCode": "LB"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LB"
},
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LB"
},
"transportationMethodCode": "TL",
"estimatedArrivalDateTime": "2021-03-04T12:45:00-05:00",
"shipFromParty": {
"typeCode": "ManufacturingPlant",
"identifier": "MC"
},
"carrierParty": {
"typeCode": "Contract",
"scacid": "RUAN",
"name": "Ruan Transportation"
},
"supplierParty": {
"identifier": "123454321"
},
"soldToParty": {
"typeCode": "Customer",
"identifier": "58885",
"accountIdentifier": "ACCOUNT-58885"
},
"shipToParty": {
"location": {
"identifier": "58885",
"name": "Happy Dairy Farm",
"physicalAddress": {
"addressLine": [
"12345 Co Hwy 8"
],
"cityName": "Le Roy",
"countrySubDivisionCode": [
{
"content": "MN",
"typeCode": "State"
}
],
"countryCode": "USA",
"postalCode": "55951-1234"
},
"glnid": "123456789"
}
}
},
"shipmentUnit": [
{
"typeCode": "Semi-Trailer",
"identifier": "3243243243434",
"trackingIdentifier": "3243243243434",
"containerIdentifier": "C-12312323",
"sealIdentifier": "4157451521254",
"scheduledDeliveryDateTime": "2020-03-20T08:00:45.456-05:00",
"tareWeightMeasure": {
"content": 35000,
"unitCode": "LBS"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LBS"
},
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LBS"
},
"shipmentUnitContainer": [
{
"typeCode": "Semi-Trailer",
"containerIdentifier": "C-12312323",
"sealIdentifier": "4157451521254",
"grossWeightMeasure": {
"content": 36800,
"unitCode": "LBS"
},
"quantity": {
"content": 1,
"unitCode": "TL"
},
"shipmentUnitItem": [
{
"typeCode": "MedicatedFeed",
"identifier": "1",
"customerItemIdentification": {
"identifier": "091818"
},
"description": "Custom Feed Blend - Derived from Milk Max Plus Basic",
"specification": {
"identifier": {
"content": "4FDCA",
"typeCode": "FormulationCode"
}
},
"bestUsedByDate": "2022-01-05",
"orderQuantity": {
"content": 2000,
"unitCode": "LBS"
},
"shippedQuantity": {
"content": 1800,
"unitCode": "LBS"
},
"backOrderedQuantity": {
"content": 200,
"unitCode": "LBS"
},
"netWeightMeasure": {
"content": 1800,
"unitCode": "LBS"
},
"purchaseOrderReference": {
"typeCode": "DirectShip",
"lineNumberIdentifier": "21231232-OD-00651-00100"
}
}
]
}
],
"containerQuantity": 1
}
]
}
}
}
}