JSON Schema
OpenAPI Spec (POST)
OpenAPI Spec (GET)
Sample Payload
seemed to have lost all the AgGateway example data.
...
| Include Page | ||||
|---|---|---|---|---|
|
Sample JSON instance (message payload)
| Code Block | ||
|---|---|---|
| ||
{
"notifyShipment": {
"releaseIdentifier": "string10.7",
"versionIdentifier": "1.0",
"applicationArea": {
"systemEnvironmentCodecreationDateTime": "QA"2019-06-12T05:04:30-06:00"
},
"applicationAreadataArea": {
"sendernotify": {
"identifierrecordSetTotalNumber": "RetailerID-234343"1
},
"intermediaryshipment": {
"partyRoleCodetypeCode": "CloudSystemBulk",
"identifieractionCode": "RetailerCloud-12323r433Original"
,
}, "receivershipmentHeader": {
"identifier": "GrowerID-243532423"
2130948342",
}, "creationDateTimelastModificationDateTime": "20192020-0603-12T0519T22:0450:3045.456-0605:00",
"scenarioIdentifier": "string", "correlationIdentifierdocumentDateTime": "02020-539f82b1-df6e-11e9-b486-5ce0c51e62ce"03-19T22:50:45.456-05:00",
}, "dataAreadocumentReference": {
"notify": {}, "identifier": "shipment": {21231232",
"typeCode": "stringPurchaseOrder",
"actionCode": "Original", },
"shipmentHeaderattachment": [
{ {
"identifier": "2130948342", "lastModificationDateTimetypeCode": "stringBillOfLading",
"documentDateTimeuri": "stringhttp://smallbusinessa.com/billingOfLading/2130948342",
"attachment": [ {"fileName": "billoflading_2130948342.pdf",
"typeCodedocumentDateTime": "BillOfLading2020-03-19T17:00:45.456-05:00",
"embeddedDataBinaryObjectdescription": "string",
"uri": "string",
"fileName": "billoflading_2130948342.pdf",
"description": "BillBill of Lading"
}
],
"status": {
"code": "stringShipConfirm",
"reasonCode": "stringNA",
"reason": ["NA"
},
"string" ]"actualShipDateTime": "2021-03-04T08:33:00-05:00",
"scheduledDeliveryDateTime": "2021-03-04T13:00:00-05:00",
"tareWeightMeasure": {
}, "actualShipDateTimecontent": "string35,000",
"scheduledDeliveryDateTimeunitCode": "string"LB"
},
"netWeightMeasure": {
"content": 481800,
"unitCode": "LB"
},
"grossWeightMeasure": {
"content": 50"36,800",
"unitCode": "LB"
},
"transportationMethodCode": "LTLTL",
"estimatedDepartureDateTime": "string2021-03-04T1315:00-05:00",
"estimatedArrivalDateTime": "string2021-03-04T12:45:00-05:00",
"shipFromParty": {
"typeCode": "stringManufacturingPlant",
"identifier": "stringMC",
"name": "stringMason City",
"location": {
"postalAddressidentifier": {
"addressLine": [
"7685",
"stringpostalAddress": {
],
"cityName"typeCode": "stringBranchPlant",
"countrySubDivisionCodeaddressLine": [
"string123 Example Street"
],
"countryCodecityName": "stringMason City",
"postalCodecountrySubDivisionCode": "string"[
}, {
"glnid "content": "stringIA",
} },"typeCode": "State"
"carrierParty": { }
"identifier": "string", ],
"scacid": "string", "namecountryCode": "stringUSA",
}, "soldToParty": {"postalCode": "30316"
"typeCode": "string" },
"identifierglnid": "stringNA",
"name": "string",}
},
"location": { "postalAddress"carrierParty": {
"identifiertypeCode": "stringContract",
"namescacid": "stringRUAN",
"name": "Ruan Transportation"
"addressLine": [ },
"stringsupplierParty": {
]"identifier": "123454321",
"cityNamename": "stringSmallBusinessA",
},
"countrySubDivisionCode": [ "soldToParty": {
"stringtypeCode": "Customer",
]"identifier": "58885",
"countryCodeaccountIdentifier": "stringACCOUNT-58885",
"postalCodename": "string"Happy },
"glnid": "string"Dairy Farm"
}
},
"shipToParty": {
"identifier": "string58885",
"name": "stringHappy Dairy Farm",
"location": {
"identifier": "stringLocation1232321",
"namecoordinate": "string", {
"physicalAddressverticalMeasure": {"15Z",
"identifierlatitudeMeasure": "string"43.580301503358996,
"namelongitudeMeasure": -92.57476726492425
"string",},
"physicalAddress": {
"addressLine": [
"string12345 Co Hwy 8"
],
"buildingNumber": "string2",
"buildingName": "stringStorage Bin B",
"cityName": "stringLe Roy",
"countrySubDivisionCode": [
{
"string" ]"content": "MN",
"countryCodetypeCode": "stringState",
"postalCode": "string", }
"geographicalCoordinate": { ],
"latitudeMeasurecountryCode": 0"USA",
"longitudeMeasurepostalCode": 0"55951-1234"
},
},
"glnid": "123456789"
"glnid": "string",
},
"locationAreacontact": {
"typeCode": "stringOwner",
"identifierpersonName": [
{
"stringformattedName": "Mabel E. Farmer "
], },
"nametelephoneCommunication": [
"string", {
"platIdentifier": "string", "commonLandUnitIdentifiertypeCode": "stringMobile",
"geospatialPolygonValueidentifier": ["01.507.555.1234"
}
{ ],
"content": "string", "emailAddressCommunication": {
"formatCodeidentifier": "string"mabel.e.farmer@email.com"
}
} }
]},
"declaredValueAmount": {
} "content": 8400,
} },
"currencyCode": "USD"
"declaredValueAmount": 0},
"freightChargeAmount": 0{
}, "shipmentUnitcontent": [590.5,
{ "typeCode"currencyCode": "stringUSD",
}
"identifier": "string", },
"trackingIdentifiershipmentUnit": [
{
"string" ]"typeCode": "Semi-Trailer",
"proNumberIdentifieridentifier": "string3243243243434",
"containerGroupIdentifiertrackingIdentifier": "string4157451521254",
"containerIdentifierproNumberIdentifier": "string4157451521254",
"rfidcontainerGroupIdentifier": "stringNA",
"sealIdentifiercontainerIdentifier": "stringC-12312323",
"containsHazardousMaterialIndicatorrfid": true"0000000000000001",
"shipmentUnitContainersealIdentifier": ["4157451521254",
{
"containsHazardousMaterialIndicator": "N",
"typeCodescheduledDeliveryDateTime": "string",2020-03-20T08:00:45.456-05:00",
"tareWeightMeasure": {
"identifiercontent": "string"35000,
"rfidunitCode": "string",LBS"
},
"packingMaterialnetWeightMeasure": {
"typeCodecontent": "string",
1800,
"descriptionunitCode": "ShrinkWrappedLBS"
},
"shippingMaterialgrossWeightMeasure": {},
"quantitycontent": 136800,
"shipmentUnitItemunitCode": ["LBS"
},
{ "shipmentUnitContainer": [
"typeCode": "string",
{
"identifiertypeCode": "stringSemi-Trailer",
"variationIdentifiercontainerIdentifier": "stringC-12312323",
"customerItemIdentificationrfid": {
"0000000000000001",
"identifiersealIdentifier": "string4157451521254",
},
"containerGroupIdentifier": "NA",
"manufacturerItemIdentificationgrossWeightMeasure": {
"identifiercontent": 36800,
"string" "unitCode": "LBS"
}, },
"supplierItemIdentification": { "packingMaterial": {
"identifier": "string" "typeCode": "NA",
}, "description": "NA"
"upcid": "string",
},
"gtinidshippingMaterial": "string",{
"uidtypeCode": "stringNA",
"description": "lot": {NA"
},
"typeCode": "string", "quantity": {
"identifiercontent": "string"1,
"unitCode": "TL"
"effectiveTimePeriod": { },
"endDateTimeshipmentUnitItem": "string"[
{
} }"typeCode": "MedicatedFeed",
"descriptionidentifier": "string1",
"specificationcustomerItemIdentification": {
"propertyidentifier": ["091818"
{},
"nameValue"manufacturerItemIdentification": {
"content"typeCode": "stringSKU",
"nameidentifier": "string1213579",
},
"typeCode": "string", "supplierItemIdentification": {
"unitCode": "string" "typeCode": "SKU",
} "identifier": "1213579"
},
"gtinid": "NA",
] }"uid": "NA",
"packagingrfid": [
{"NA"
],
"description": [ "serialNumberIdentifier": [
"string" "NA"
], ],
"dimensions": [ "lot": {
{ "typeCode": "Batch",
"widthMeasureidentifier": {
"d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"
},
"content": 0, "description": "Custom Feed Blend - Derived from Milk Max Plus Basic",
"unitCode": "string" "specification": {
}, "identifier": {
"lengthMeasurecontent": {"4FDCA",
"typeCode": "FormulationCode"
"content": 0, },
"unitCode": "string" "property": [
}, {
"heightMeasurenameValue": {
"content": 055.24,
"unitCodename": "stringProtein",
}"typeCode": "NutrientValue",
"descriptionunitCode": "stringPCT",
"netVolumeMeasureunitCodeListVersionIdentifier": {"UNRec20"
"content": 0,
},
"unitCodedescription": "stringProtein"
}
}, ]
"grossVolumeMeasure": { },
"contentcountryOfOriginCode": 0,"USA",
"manufacturingParty": {
"unitCodeidentifier": "stringMC",
"name": "Mason City"
}, },
"netWeightMeasure": { "bestUsedByDate": "2022-01-05",
"contentcontainsHazardousMaterialIndicator": 0"N",
"hazardousMaterialCodes": {
"unitCode": "string" "code": {
}, "content": "NA",
"grossWeightMeasurelistIdentifier": {"Hazard",
"listAgencyIdentifier": "USDOT"
"content": 0, }
"unitCode": "string" },
"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": { "identifier": "21231232-OD-00651", "typeCode": "PurchaseOrder" }, "status": { "code": "ShipConfirm", "reasonCode": "NA", "reason": "NA" }, "actualShipDateTime": "2021-03-04T08:33:00-05:00", "tareWeightMeasure": { ], "content": 35000, "perPackageQuantityunitCode": {"LB" }, "contentnetWeightMeasure": 0,{ "content": 1800, "unitCode": "stringLB" }, "grossWeightMeasure": { }, "content": 36800, "capacityPerPackageQuantityunitCode": {"LB" }, "transportationMethodCode": "TL", "contentestimatedArrivalDateTime": 0"2021-03-04T12:45:00-05:00", "shipFromParty": { "unitCodetypeCode": "stringManufacturingPlant", "identifier": "MC" }, "carrierParty": { "quantitytypeCode": ["Contract", "scacid": "RUAN", { "name": "Ruan Transportation" }, "contentsupplierParty": 0, { "unitCodeidentifier": "string123454321" }, "soldToParty": { } "typeCode": "Customer", "identifier": "58885", ] "accountIdentifier": "ACCOUNT-58885" }, "shipToParty": { ], "location": { "countryOfOriginCodeidentifier": "string58885", "containsHazardousMaterialIndicatorname": true,"Happy Dairy Farm", "hazardousMaterialCodesphysicalAddress": { "addressLine": [ "code": [ "12345 Co Hwy 8" { ], "contentcityName": "stringLe Roy", "countrySubDivisionCode": [ "listIdentifier": "string", { "listAgencyIdentifiercontent": "stringMN", "typeCode": "State" "typeCode": "string" } } ], "countryCode": "USA", ] "postalCode": "55951-1234" }, }, "orderQuantity": { "glnid": "123456789" } "content": 0, } }, "unitCodeshipmentUnit": [ "string", { "typeCode": "stringSemi-Trailer", "identifier": "3243243243434", }, "trackingIdentifier": "3243243243434", "containerIdentifier": "shippedQuantityC-12312323":, { "sealIdentifier": "4157451521254", "contentscheduledDeliveryDateTime": 0"2020-03-20T08:00:45.456-05:00", "tareWeightMeasure": { "unitCode": "string", "content": 35000, "typeCodeunitCode": "string" "LBS" }, "netWeightMeasure": { "backOrderedQuantity": { "content": 1800, "contentunitCode": "LBS" 0, }, "unitCodegrossWeightMeasure": "string",{ "content": 36800, "typeCode": "string" "unitCode": "LBS" }, "shipmentUnitContainer": [ "netWeightMeasure": { { "contenttypeCode": 0"Semi-Trailer", "unitCode"containerIdentifier": "stringC-12312323", }, "sealIdentifier": "4157451521254", "grossWeightMeasure": { "content": 036800, "unitCode": "string"LBS" }, }, "quantity": { "purchaseOrderReference": { "content": 1, "identifierunitCode": "string",TL" }, "typeCodeshipmentUnitItem": "string"[ },{ "salesOrderReferencetypeCode": {"MedicatedFeed", "identifier": "string1", "typeCodecustomerItemIdentification": "string" { "identifier": "091818" }, }, "itemSubLine": [ "description": "Custom Feed Blend - Derived {from Milk Max Plus Basic", "typeCodespecification": "string", { "identifier": "string",{ "manufacturerItemIdentificationcontent": {"4FDCA", "typeCode": "string",FormulationCode" } "identifier": "string" }, }, "bestUsedByDate": "2022-01-05", "gtinidorderQuantity": "string", { "referenceDesignatorIdentifiercontent": "string"2000, "unitCode": "lot": {LBS" }, "typeCode": "Batch", "shippedQuantity": { "identifier": [ "content": 1800, "unitCode": "stringLBS" }, ] "backOrderedQuantity": { }, "content": 200, "quantity": { "unitCode": "LBS" "content": 0, }, "unitCodenetWeightMeasure": "string", { "typeCodecontent": "string"1800, "unitCode": "LBS" }, }, "description": "Seed Treatment Service Charge" "purchaseOrderReference": { } "typeCode": "DirectShip", ] "lineNumberIdentifier": "21231232-OD-00651-00100" } ] } } } ], "containerQuantity": {] "content": 0,} ], "unitCode": "string" }"containerQuantity": 1 } ] } } } } |