...
OpenAPI Spec (GET)
Sample Payload
Code Block |
---|
{ "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", "netWeightMeasure": { "content": 1800, "unitCode": "LB" }, "grossWeightMeasure": { "content": 4124, "unitCode": "LB" }, "transportationMethodCode": "TL", "estimatedDepartureDateTime": "2021-03-04T1315:00-05:00", "estimatedArrivalDateTime": "2021-03-04T12:45:00-05:00", "shipFromParty": { "typeCode": "string", "identifier": "string", "name": "string", "location": { "postalAddress": { "addressLine": [ "string" ], "cityName": "string", "countrySubDivisionCode": [ { "content": "string", "typeCode": "State" } ], "countryCode": "string", "postalCode": "string" }, "glnid": "string" } }, "carrierParty": { "identifier": "string", "scacid": "string", "name": "string" }, "supplierParty": { "identifier": "123454321", "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": "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": 0, "freightChargeAmount": 0 }, "shipmentUnit": [ { "typeCode": "Trailer", "identifier": "3243243243434", "trackingIdentifier": [ "4157451521254" ], "proNumberIdentifier": "4157451521254", "containerGroupIdentifier": "5", "containerIdentifier": "3243243243434", "rfid": "0000000000000001", "sealIdentifier": "4157451521254", "containsHazardousMaterialIndicator": "N", "scheduledDeliveryDateTime": "2020-03-20T08:00:45.456-05:00", "tareWeightMeasure": { "content": 0, "unitCode": "LBS" }, "netWeightMeasure": { "content": 0, "unitCode": "LBS" }, "grossWeightMeasure": { "content": 0, "unitCode": "LBS" }, "shipmentUnitContainer": [ { "typeCode": "Pallet", "identifier": "string", "rfid": "string", "sealIdentifier": "string", "grossWeightMeasure": { "content": 0, "unitCode": "string" }, "packingMaterial": { "typeCode": "popcorn", "description": "NA" }, "shippingMaterial": { "typeCode": "PlasticWrap", "description": "NA" }, "quantity": { "content": 1, "unitCode": "string" }, "shipmentUnitItem": [ { "typeCode": "string", "identifier": "1", "customerItemIdentification": { "identifier": "string" }, "manufacturerItemIdentification": { "identifier": "string" }, "supplierItemIdentification": { "identifier": "string" }, "gtinid": "string", "uid": "string", "rfid": [ "NA" ], "serialNumberIdentifier": [ "string", "string" ], "lot": { "typeCode": "string", "identifier": "string", "effectiveTimePeriod": { "endDateTime": "string" } }, "description": "string", "specification": { "identifier": { "content": "4FDCA", "typeCode": "FormulationCode" }, "property": [ { "nameValue": { "content": "45", "name": "Protein", "typeCode": "NutrientValue", "unitCode": "%" }, "description": "NA" } ] }, "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", "manufacturingParty": { "identifier": "MC", "name": "Mason City" }, "bestUsedByDate": "2021-12-05", "containsHazardousMaterialIndicator": "N", "hazardousMaterialCodes": { "code": [ { "content": "NA", "listIdentifier": "string", "listAgencyIdentifier": "string", "typeCode": "string" } ] }, "orderQuantity": { "content": 2000, "unitCode": "LBS" }, "shippedQuantity": { "content": 1800, "unitCode": "LBS" }, "backOrderedQuantity": { "content": 200, "unitCode": "LBS" }, "tareWeightMeasure": "string", "netWeightMeasure": { "content": 1800, "unitCode": "LBS" }, "grossWeightMeasure": { "content": 0, "unitCode": "string" }, "purchaseOrderReference": { "typeCode": "string", "lineNumberIdentifier": "023443--O2-00651-001" }, "salesOrderReference": { "typeCode": "string", "lineNumberIdentifier": [ "string", "023443--S2-00651-001" ] }, "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": 1, "unitCode": "string" } } ] } } } } fgfg |