Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

JSON Schema

OpenAPI Spec (POST)

OpenAPI Spec (GET)

Sample Payload

seemed to have lost all the AgGateway example data.

...

Include Page
SME Files
SME Files

Sample JSON instance (message payload)

Code Block
languagejson
{
  "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",
          "netWeightMeasuretareWeightMeasure": {
            "content": 1800"35,000",
            "unitCode": "LB"
          },
          "grossWeightMeasurenetWeightMeasure": {
            "content": 41241800,
            "unitCode": "LB"
          },
          "transportationMethodCodegrossWeightMeasure": "TL",{
            "estimatedDepartureDateTimecontent": "2021-03-04T1315:"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": {
              "postalAddressidentifier": {
 "7685",
              "addressLinepostalAddress": [
 {
                "stringtypeCode": "BranchPlant",
                "addressLine": [
                  "123 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"
          },
 "postalAddress": {        "shipToParty": {
            "identifier": "string58885",
  
             "name": "stringHappy Dairy Farm",

               "addressLinelocation": [{
                  "string""identifier": "Location1232321",
                ],"coordinate": {
                "cityNameverticalMeasure": "string15Z",
                "countrySubDivisionCodelatitudeMeasure": [
 43.580301503358996,
                "stringlongitudeMeasure": -92.57476726492425
               ]},
 
              "countryCodephysicalAddress": "string",{
                "postalCodeaddressLine": "string"[
              },    "12345 Co Hwy 8"
       "glnid": "string"        ],
     }           },"buildingNumber": "2",
                "shipToPartybuildingName": { "Storage Bin B",
                "identifiercityName": "58885Le Roy",
                "namecountrySubDivisionCode": [
 "Happy  Dairy Farm",             "location": {
                    "identifiercontent": "Location1232321MN",
              "coordinate      "typeCode": {"State"
                "verticalMeasure": "15Z", }
               "latitudeMeasure": 43.580301503358996 ],
                "longitudeMeasurecountryCode": -92.57476726492425"USA",
              },  "postalCode": "55951-1234"
           "physicalAddress": {  },
              "addressLineglnid": ["123456789"
            },
         "12345 Co Hwy 8"contact": {
               ]"typeCode": "Owner",
                "buildingNumberpersonName": "2",{
                "buildingNameformattedName": "Storage Bin B",Mabel E. Farmer "
                "cityName": "Le Roy",
},
               "countrySubDivisionCodetelephoneCommunication": [
 
                {

                   "contenttypeCode": "MNMobile",

                   "typeCodeidentifier": "State"
 01.507.555.1234"
                }
 
              ],
 
              "countryCodeemailAddressCommunication": "USA",{
                "postalCodeidentifier": "55951-1234mabel.e.farmer@email.com"
              },
            }
 "glnid": "123456789"
            },

           "contactdeclaredValueAmount": {
 
            "typeCodecontent": "Owner"8400,
             "currencyCode": "personNameUSD":
{          },
      "formattedName": "Mabel E. Farmer "freightChargeAmount": {
             },
 "content": 590.5,
            "telephoneCommunicationcurrencyCode": ["USD"
          }
     {   },
        "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": 0"N",
            "freightChargeAmountscheduledDeliveryDateTime": 0"2020-03-20T08:00:45.456-05:00",
          },  "tareWeightMeasure": {
     "shipmentUnit": [        "content": 35000,
 {             "typeCodeunitCode": "TrailerLBS",
            "identifier": "3243243243434"},
            "trackingIdentifiernetWeightMeasure": [{
              "4157451521254content": 1800,
           ],
   "unitCode": "LBS"
           "proNumberIdentifier": "4157451521254" },
            "containerGroupIdentifiergrossWeightMeasure": "5", {
              "containerIdentifiercontent": "3243243243434"36800,
              "rfidunitCode": "0000000000000001LBS",
            "sealIdentifier": "4157451521254"},
            "containsHazardousMaterialIndicatorshipmentUnitContainer": "N",[
              {
  "scheduledDeliveryDateTime": "2020-03-20T08:00:45.456-05:00",             "tareWeightMeasuretypeCode": {"Semi-Trailer",
                "contentcontainerIdentifier": 0,"C-12312323",
                "unitCoderfid": "LBS0000000000000001",
            },    "sealIdentifier": "4157451521254",
       "netWeightMeasure": {               "content"containerGroupIdentifier": 0"NA",
                "unitCodegrossWeightMeasure": "LBS"{
            },      "content": 36800,
     "grossWeightMeasure": {               "contentunitCode": 0,"LBS"
              "unitCode": "LBS"  },
          },      "packingMaterial": {
     "shipmentUnitContainer": [            "typeCode": "NA",
 {                 "typeCodedescription": "PalletNA",
                "identifier": "string"},
                "rfidshippingMaterial": {
"string",                  "sealIdentifiertypeCode": "stringNA",
                  "grossWeightMeasuredescription": {"NA"
                  "content": 0,
 },
                "unitCodequantity": "string"{
                },                 "packingMaterial"content": {1,
                  "typeCodeunitCode": "popcornTL",
                },
 "description": "NA"               "shipmentUnitItem": [
  },                {
"shippingMaterial": {                   "typeCode": "PlasticWrapMedicatedFeed",
                    "descriptionidentifier": "NA1",
                },    "customerItemIdentification": {
           "quantity": {          "identifier": "091818"
       "content": 1,            },
      "unitCode": "string"             "manufacturerItemIdentification": {
  },                    "shipmentUnitItemtypeCode": ["SKU",
                      {
"identifier": "1213579"
                   "typeCode": "string" },
                    "identifiersupplierItemIdentification": "1", {
                      "customerItemIdentificationtypeCode": {"SKU",
                      "identifier": "string1213579"
                    },
                    "manufacturerItemIdentificationgtinid": {"NA",
                      "identifieruid": "stringNA",
                    },
"rfid": [
                   "supplierItemIdentification": {  "NA"
                    "identifier": "string"],
                    "serialNumberIdentifier": [
},                     "gtinid": "stringNA",
                    "uid": "string"],
                    "rfidlot": [{
                      "typeCode": "NABatch",
                    ],  "identifier": "d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"
                 "serialNumberIdentifier": [  },
                    "stringdescription",: "Custom Feed Blend - Derived from Milk Max Plus Basic",
            "string"        "specification": {
           ],                     "lot"identifier": {
                        "typeCodecontent": "string4FDCA",
                        "identifiertypeCode": "stringFormulationCode",
                      "effectiveTimePeriod": {},
                         "endDateTimeproperty": [
"string"                       } {
                   },       "nameValue": {
            "description": "string",               "content": 55.24,
    "specification": {                       "identifiername": {"Protein",
                            "contenttypeCode": "4FDCANutrientValue",
                            "typeCodeunitCode": "FormulationCodePCT",
                      },      "unitCodeListVersionIdentifier": "UNRec20"
                "property":  [        },
                {          "description": "Protein"
               "nameValue": {        }
                    "content": "45", ]
                    },
      "name": "Protein",             "countryOfOriginCode": "USA",
              "typeCode": "NutrientValue",     "manufacturingParty": {
                      "unitCodeidentifier": "%MC",
                      "name": "Mason City"
 },                   },
       "description": "NA"            "bestUsedByDate": "2022-01-05",
           }         "containsHazardousMaterialIndicator": "N",
            ]        "hazardousMaterialCodes": {
           },           "code": {
        "packaging": [               "content": "NA",
      {                  "listIdentifier": "Hazard",
     "description": [                  "listAgencyIdentifier": "USDOT"
       "string"               }
         ],           },
             "dimensions": [      "orderQuantity": {
                   {   "content": 2000,
                        "widthMeasureunitCode": {"LBS"
                    },
         "content": 0,           "shippedQuantity": {
                      "unitCodecontent": "string"1800,
                      "unitCode": "LBS"
    },                },
            "lengthMeasure": {       "backOrderedQuantity": {
                      "content": 0200,
                              "unitCode": "stringLBS"
                    },
       },             "tareWeightMeasure": {
              "heightMeasure": {       "content": 35000,
                      "contentunitCode": 0,"LBS"
                    },
         "unitCode": "string"          "netWeightMeasure": {
                 },     "content": 1800,
                      "descriptionunitCode": "stringLBS",
                    },
       "netVolumeMeasure": {            "grossWeightMeasure": {
                      "content": 036800,
                      "unitCode": "LBS"
      "unitCode": "string"             },
               },     "purchaseOrderReference": {
                      "grossVolumeMeasuretypeCode": {"DirectShip",
                      "lineNumberIdentifier": "123232-001"
         "content": 0,          },
                    "unitCodesalesOrderReference": "string"{
                      "typeCode": "NA",
    },                  "lineNumberIdentifier": "NA"
         "netWeightMeasure": {          },
                    "contentitemSubLine": [
0,                      {
         "unitCode": "string"               "typeCode": "VFD",
               },         "identifier": "apramycin",
                  "grossWeightMeasure      "manufacturerItemIdentification": {
  
                           "contenttypeCode": 0,
   "SKU",
                          "unitCodeidentifier": "string3434343"
                        },
   }                     "referenceDesignatorIdentifier": {
    }                      "content": "VetId43434",
 ],                         "perPackageQuantityschemeIdentifier": {"VFD",
                          "contentschemeVersionIdentifier": 0"Guidance for Industry #120",
                          "unitCodeschemeAgencyIdentifier": "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
languagejson
{
  "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": {
            "capacityPerPackageQuantitycontent": {35000,
            "unitCode": "LB"
            "content": 0},
          "netWeightMeasure": {
              "unitCodecontent": "string"1800,
            "unitCode": "LB"
          },
          "grossWeightMeasure": {
            "quantitycontent": [36800,
            "unitCode": "LB"
          },
 {                 "transportationMethodCode": "TL",
           "contentestimatedArrivalDateTime": 0"2021-03-04T12:45:00-05:00",
          "shipFromParty":  {
               "unitCodetypeCode": "stringManufacturingPlant",
            "identifier": "MC"
          },
 }         "carrierParty": {
            "typeCode": "Contract",
]            "scacid": "RUAN",
         }   "name": "Ruan Transportation"
          },
    ],      "supplierParty":  {
            "countryOfOriginCodeidentifier": "string123454321",
          },
          "manufacturingPartysoldToParty": {
            "typeCode": "Customer",
            "identifier": "MC58885",
            "accountIdentifier": "ACCOUNT-58885"
        "name": "Mason City"},
          "shipToParty": {
        },    "location":  {
              "bestUsedByDateidentifier": "2021-12-0558885",
   
                "containsHazardousMaterialIndicatorname": "NHappy Dairy Farm",
  
                 "hazardousMaterialCodesphysicalAddress": {
                "addressLine": [
    "code": [             "12345 Co Hwy 8"
        {          ],
                "contentcityName": "NALe Roy",
                "countrySubDivisionCode": [
           "listIdentifier": "string",      {
                    "listAgencyIdentifiercontent": "stringMN",
                          "typeCode": "stringState"
                        }
                      ],
                "countryCode": "USA",
  },              "postalCode": "55951-1234"
     "orderQuantity": {        },
              "contentglnid": 2000,"123456789"
            }
          "unitCode": "LBS"}
        },
        "shipmentUnit": [
  },        {
            "shippedQuantitytypeCode": {
       "Semi-Trailer",
               "contentidentifier": 1800"3243243243434",
            "trackingIdentifier": "3243243243434",
            "unitCodecontainerIdentifier": "LBSC-12312323",
            "sealIdentifier": "4157451521254",
      },        "scheduledDeliveryDateTime": "2020-03-20T08:00:45.456-05:00",
            "backOrderedQuantitytareWeightMeasure": {
              "content": 35000,
      "content": 200,       "unitCode": "LBS"
            },
 "unitCode": "LBS"          "netWeightMeasure": {
         },     "content": 1800,
              "tareWeightMeasureunitCode": "stringLBS",
            },
       "netWeightMeasure": {    "grossWeightMeasure": {
                 "content": 180036800,
                      "unitCode": "LBS"
            },
            },
"shipmentUnitContainer": [
              {
    "grossWeightMeasure": {           "typeCode": "Semi-Trailer",
          "content": 0,     "containerIdentifier": "C-12312323",
                "unitCodesealIdentifier": "string4157451521254",
                "grossWeightMeasure": {
    },              "content": 36800,
     "purchaseOrderReference": {            "unitCode": "LBS"
         "typeCode": "string",      },
                "lineNumberIdentifierquantity": "023443--O2-00651-001"{
                    }"content": 1,
                   "unitCode": "salesOrderReferenceTL":
{                },
      "typeCode": "string",          "shipmentUnitItem": [
             "lineNumberIdentifier": [    {
                    "stringtypeCode": "MedicatedFeed",
                    "identifier": "1",
  "023443--S2-00651-001"                  "customerItemIdentification": {
     ]                 "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",
                   "gtinid": "stringorderQuantity",: {
                       "referenceDesignatorIdentifiercontent": "string"2000,
                      "unitCode":  "lotLBS":
   {                 },
         "typeCode": "Batch",          "shippedQuantity": {
               "identifier":  [     "content": 1800,
                      "stringunitCode": "LBS"
                    },
    ]                "backOrderedQuantity": {
       },               "content": 200,
        "quantity": {             "unitCode": "LBS"
            "content": 0,       },
                   "unitCode": "stringnetWeightMeasure",
 :  {
                      "typeCodecontent": "string"1800,
                      "unitCode": "LBS"
},                    },
    "description": "Seed Treatment Service Charge"            "purchaseOrderReference": {
         }             "typeCode": "DirectShip",
      ]                "lineNumberIdentifier": "21231232-OD-00651-00100"
 }                 ]  }
            }      }
      ],          ]
  "containerQuantity": {           }
   "content": 1,        ],
      "unitCode": "string"             }"containerQuantity": 1
          }
        ]
      }
    }
  }
}