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.

Code Block
{
  "notifyShipment": {
    "releaseIdentifier": "string",
    "versionIdentifier": "1.0",
    "systemEnvironmentCode": "QA",
    "applicationArea": {
      "sender": {
        "identifier": "RetailerID-234343"
      },
      "intermediary": {
        "partyRoleCode": "CloudSystem",
        "identifier": "RetailerCloud-12323r433"
      },
      "receiver": {
        "identifier": "GrowerID-243532423"
      },
      "creationDateTime": "2019-06-12T05:04:30-06:00",
      "scenarioIdentifier": "string",
      "correlationIdentifier": "0-539f82b1-df6e-11e9-b486-5ce0c51e62ce"
    },
    "dataArea": {
      "notify": {},
      "shipment": {
        "typeCode": "string",
        "actionCode": "Original",
        "shipmentHeader": {
          "identifier": "2130948342",
          "lastModificationDateTime": "string",
          "documentDateTime": "string",
          "attachment": [
            {
              "typeCode": "BillOfLading",
              "embeddedDataBinaryObject": "string",
              "uri": "string",
              "fileName": "billoflading_2130948342.pdf",
              "description": "Bill of Lading"
            }
          ],
          "status": {
            "code": "string",
            "reasonCode": "string",
            "reason": [
              "string"
            ]
          },
          "actualShipDateTime": "string",
          "scheduledDeliveryDateTime": "string",
          "netWeightMeasure": {
            "content": 48,
            "unitCode": "LB"
          },
          "grossWeightMeasure": {
            "content": 50,
            "unitCode": "LB"
          },
          "transportationMethodCode": "LTL",
          "estimatedDepartureDateTime": "string",
          "estimatedArrivalDateTime": "string",
          "shipFromParty": {
            "typeCode": "string",
            "identifier": "string",
            "name": "string",
            "location": {
              "postalAddress": {
                "addressLine": [
                  "string"
                ],
                "cityName": "string",
                "countrySubDivisionCode": [
                  "string"
                ],
                "countryCode": "string",
                "postalCode": "string"
              },
              "glnid": "string"
            }
          },
          "carrierParty": {
            "identifier": "string",
            "scacid": "string",
            "name": "string"
          },
          "soldToParty": {
            "typeCode": "string",
            "identifier": "string",
            "name": "string",
            "location": {
              "postalAddress": {
                "identifier": "string",
                "name": "string",
                "addressLine": [
                  "string"
                ],
                "cityName": "string",
                "countrySubDivisionCode": [
                  "string"
                ],
                "countryCode": "string",
                "postalCode": "string"
              },
              "glnid": "string"
            }
          },
          "shipToParty": {
            "identifier": "string",
            "name": "string",
            "location": {
              "identifier": "string",
              "name": "string",
              "physicalAddress": {
                "identifier": "string",
                "name": "string",
                "addressLine": [
                  "string"
                ],
                "buildingNumber": "string",
                "buildingName": "string",
                "cityName": "string",
                "countrySubDivisionCode": [
                  "string"
                ],
                "countryCode": "string",
                "postalCode": "string",
                "geographicalCoordinate": {
                  "latitudeMeasure": 0,
                  "longitudeMeasure": 0
                }
              },
              "glnid": "string",
              "locationArea": {
                "typeCode": "string",
                "identifier": [
                  "string"
                ],
                "name": "string",
                "platIdentifier": "string",
                "commonLandUnitIdentifier": "string",
                "geospatialPolygonValue": [
                  {
                    "content": "string",
                    "formatCode": "string"
                  }
                ]
              }
            }
          },
          "declaredValueAmount": 0,
          "freightChargeAmount": 0
        },
        "shipmentUnit": [
          {
            "typeCode": "string",
            "identifier": "string",
            "trackingIdentifier": [
              "string"
            ],
            "proNumberIdentifier": "string",
            "containerGroupIdentifier": "string",
            "containerIdentifier": "string",
            "rfid": "string",
            "sealIdentifier": "string",
            "containsHazardousMaterialIndicator": true,
            "shipmentUnitContainer": [
              {
                "typeCode": "string",
                "identifier": "string",
                "rfid": "string",
                "packingMaterial": {
                  "typeCode": "string",
                  "description": "ShrinkWrapped"
                },
                "shippingMaterial": {},
                "quantity": 1,
                "shipmentUnitItem": [
                  {
                    "typeCode": "string",
                    "identifier": "string",
                    "variationIdentifier": "string",
                    "customerItemIdentification": {
                      "identifier": "string"
                    },
                    "manufacturerItemIdentification": {
                      "identifier": "string"
                    },
                    "supplierItemIdentification": {
                      "identifier": "string"
                    },
                    "upcid": "string",
                    "gtinid": "string",
                    "uid": "string",
                    "lot": {
                      "typeCode": "string",
                      "identifier": "string",
                      "effectiveTimePeriod": {
                        "endDateTime": "string"
                      }
                    },
                    "description": "string",
                    "specification": {
                      "property": [
                        {
                          "nameValue": {
                            "content": "string",
                            "name": "string",
                            "typeCode": "string",
                            "unitCode": "string"
                          }
                        }
                      ]
                    },
                    "packaging": [
                      {
                        "description": [
                          "string"
                        ],
                        "dimensions": [
                          {
                            "widthMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "lengthMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "heightMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "description": "string",
                            "netVolumeMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "grossVolumeMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "netWeightMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            },
                            "grossWeightMeasure": {
                              "content": 0,
                              "unitCode": "string"
                            }
                          }
                        ],
                        "perPackageQuantity": {
                          "content": 0,
                          "unitCode": "string"
                        },
                        "capacityPerPackageQuantity": {
                          "content": 0,
                          "unitCode": "string"
                        },
                        "quantity": [
                          {
                            "content": 0,
                            "unitCode": "string"
                          }
                        ]
                      }
                    ],
                    "countryOfOriginCode": "string",
                    "containsHazardousMaterialIndicator": true,
                    "hazardousMaterialCodes": {
                      "code": [
                        {
                          "content": "string",
                          "listIdentifier": "string",
                          "listAgencyIdentifier": "string",
                          "typeCode": "string"
                        }
                      ]
                    },
                    "orderQuantity": {
                      "content": 0,
                      "unitCode": "string",
                      "typeCode": "string"
                    },
                    "shippedQuantity": {
                      "content": 0,
                      "unitCode": "string",
                      "typeCode": "string"
                    },
                    "backOrderedQuantity": {
                      "content": 0,
                      "unitCode": "string",
                      "typeCode": "string"
                    },
                    "netWeightMeasure": {
                      "content": 0,
                      "unitCode": "string"
                    },
                    "grossWeightMeasure": {
                      "content": 0,
                      "unitCode": "string"
                    },
                    "purchaseOrderReference": {
                      "identifier": "string",
                      "typeCode": "string"
                    },
                    "salesOrderReference": {
                      "identifier": "string",
                      "typeCode": "string"
                    },
                    "itemSubLine": [
                      {
                        "typeCode": "string",
                        "identifier": "string",
                        "manufacturerItemIdentification": {
                          "typeCode": "string",
                          "identifier": "string"
                        },
                        "gtinid": "string",
                        "referenceDesignatorIdentifier": "string",
                        "lot": {
                          "typeCode": "Batch",
                          "identifier": [
                            "string"
                          ]
                        },
                        "quantity": {
                          "content": 0,
                          "unitCode": "string",
                          "typeCode": "string"
                        },
                        "description": "Seed Treatment Service Charge"
                      }
                    ]
                  }
                ]
              }
            ],
            "containerQuantity": {
              "content": 0,
              "unitCode": "string"
            }
          }
        ]
      }
    }
  }
}