Versions Compared

Key

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

JSON Schema

OpenAPI Spec (POST)

OpenAPI Spec (GET)

Sample Payload

...

Include Page
SME Files
SME Files

Sample JSON instance (message payload)

Code Block
languagejson
{
  "receiveDelivery": {
    "receiveDeliveryHeader": {
      "identifier": "string2130948342",
      "lastModificationDateTime": "2020-03-20T07:50:45.456-05:00",
      "documentDateTime": "2020-03-20T07:50:45.456-05:00",
      "note": "string",
      "documentReference": [
 {
        "identifier": "21231232",
       { "typeCode": "PurchaseOrder",
        "identifierdocumentDateTime": "21231232",
 2020-03-15T15:45:17.456-06:00"
      },
      "status": {
        "typeCodecode": "PurchaseOrder"received"
      },
      "billOfLadingReference": {
        "identifier": "string",
        "documentDateTime": "2020-03-15T1519T17:00:45:17.456-0605:00"
      },
      "contractReference": {
        "identifier": "contract123232"
      },
      "actualDeliveryDateTime": "2021-03-04T12:48:00-05:00",
      ],"tareWeightMeasure": {
        "content": 35000,
        "statusunitCode": "LB"
  [    },
      "netWeightMeasure": {
        "content": 1800,
        "codeunitCode": "receivedLB"
      },
 }     "grossWeightMeasure": {
        "content": ]36800,
        "carrierRouteReferenceunitCode": ["LB"
      },
   {   "transportationMethodCode": "TL",
      "identifierdockIdentifier": "stringD-123232",
      "carrierParty": {
 }        ],"scacid": "RUAN",
        "contractReferencename": ["Ruan Transportation",
        "contact": {
          "identifier": "C-12312323Badge1234",
          "jobTitle": "Driver"
        }
      ]},
      "tareWeightMeasuresupplierParty": {
        "contentidentifier": 0"123454321",
        "unitCodename": "stringSmallSupplierA"
      },
      "netWeightMeasureshipToParty": {
        "contentidentifier": 0"58885",
        "unitCodename": "Happy "string"
Dairy Farm",
        "location": {
          },"identifier": "Location1232321",
          "grossWeightMeasurecoordinate": {
            "contentverticalMeasure": 015,
            "unitCodelatitudeMeasure": "string"
43.580301503358996,
            "longitudeMeasure": -92.57476726492425
          },
          "physicalAddress": {
      "dockIdentifier": "D-123232"      "addressLine": [
              "12345 Co Hwy 8"
            ],
      "carrierParty      "buildingNumber": {"2",
            "scacidbuildingName": "RUAN"Storage Bin B",
           },  "cityName": "Le Roy",
            "shipToPartycountrySubDivisionCode": [
              {
                "identifiercontent": [ "MN",
                "string"typeCode": "State"
              }
            ],
            "countryCode": "USA",
            "postalCode": "55951-1234"
          },
          "glnid": "123456789"
        },
        "contact": {
          "typeCode": "Owner",
          "personName": {
            "containerQuantityformattedName": 1 "Mabel E. Farmer "
          },
    "receiveDeliveryUnit      "telephoneCommunication": [
            {
              "typeCode": "PalletMobile",
              "identifier": "01.507.555.1234"
            }
          ],
          "emailAddressCommunication": {
[            "identifier": "3243243243434"mabel.e.farmer@email.com"
          ],
 }
        }
      },
      "containerQuantity": 1,
      "trackingIdentifier": "string"
    },
    "receiveDeliveryUnit": [
      {
        "typeCode": "Trailer",
        "identifier": "3243243243434",
        "trackingIdentifier": "4157451521254",
        "proNumberIdentifier": "4157451521254",
    ]    "containerGroupIdentifier": "5",
        "proNumberIdentifiercontainerIdentifier": "stringC-12312323",
        "rfid": "0000000000000001",
        "sealIdentifier": "string4157451521254",
        "notecontainsHazardousMaterialIndicator": "string",
        "actualDeliveryDateTime": "2020-03-20T07:50:45.456-05:00",
        "tareWeightMeasure": "string",
        "netWeightMeasure": 0,
        "grossWeightMeasure": "string",
        "receiveDeliveryUnitItem": [
          {
            "identifier": "1",
            "customerItemIdentification": {
              "identifier": "string"091818"
            },
            "manufacturerItemIdentification": {
              "typeCode": "SKU",
              "identifier": "2343434343"1213579"
            },
            "supplierItemIdentification": {
              "identifier": "1213579"
            },
            "upcid": "stringNA",
            "gtinid": "stringNA",
            "uid": "string34343243434343",
            "serialNumberIdentifier": [
              "stringNA"
            ],
            "lot": {
              "typeCode": "batch",
              "identifier": "d6a6c7f0-3e07-4885-b4b8-f9b0d7a1ece9"
            },
            "attachment": [
              {
                "typeCodefileName": "LOTrodents.jpg",
                "identifierdocumentDateTime": ["2020-03-20T07:50:45.456-05:00",
                 "fileTypeCode": "234415989application/peg",
                "fileSizeQuantity": ]4343433
              }
            ],
            "quantitycountryOfOriginCode": {
              "content": 0"USA",
              "listIdentifier": "3166-3",
              "unitCodelistAgencyIdentifier": "stringISO"
            },
            "hazardousMaterial": {"results": {
              "qualitative": [
                {
                  "identifierresultValue": [
                    {
                "string      "content": "A lot of broken pellets",
                      "name": "Pellet Consistency"
                    }
                  ]
                }
              ],
            "countryOfOriginCode  "quantitative": [
                {
                  "name": "stringMoisture",
                  "orderQuantitysignificantDigitsNumber": 5,
              "shippedQuantity": 5,    "measurement": [
                    {
                      "dateTime": "2021-06-18T15:59:44.655Z",
                      "backOrderedQuantitymeasure": 0,11.23434,
                      "requisitionReferenceunitCode": [ "PCT"
                    }
                  ]
                }
              ]
            },
            "orderQuantity": {
              "content": 2000,
 "identifier             "unitCode": "8999879877"LB"
            },
           } "shippedQuantity": {
              ]"content": 1800,
              "purchaseOrderReferenceunitCode": [
"LB"
            },
            "backOrderedQuantity": {
              "content": 200,
              "identifierunitCode": "8897988622"
LB"
            },
            "purchaseOrderReference": {
             } "lineNumberIdentifier": "123232-001"
            ]},
            "status": {
              "code": "Received",
              "reasonCode": "NA",
              "reason": "stringNA"
            },
            "receivedQuantity": {
              "content": 41800,
              "unitCode": "stringLB"
            },
            "returnedQuantity": {
              "content": 10,
              "unitCode": "stringLB"
            },
            "receiptDiscrepancy": {
              "reasonCode": "Damaged",NA",
              "itemQuantity": {
                "content": 0,
                "unitCode": "LB"
              },
              "note": {
                "content": "I saw a few rodents in the trailer, but no droppings in the bulk boxes",
                "author": "damaged by carrier equipmentMabel",
                "entryDateTime": "2020-03-20T07:50:45.456-05:00"
              }
            }
          }
        ]
      }
    ]
  }
}