POST ScaleInterface/PostGrainScaleInterfaceShipment

Creates an outbound shipment scale interface record

Request Information

URI Parameters

Body Parameters

The request object used to create the database entry.

Name	Description	Type	Additional Information
Details	The list of split details for the scale interface shipment record to be created	Collection of ClsGrainScaleInterfaceShipmentDetail	Required List cannot be empty
TicketGUID	The GUID of the Scale Interface Tranaction.	globally unique identifier
TicketNum	The ticket number that displayed throughout Agvance	string	Required Max length: 10
LocationId	The Location ID of the transaction	string	Required Max length: 6
CommodityId	The Commodity ID of the transaction	string	Required Max length: 6
TicketDate	The date of the scale ticket transaction (Date portion only)	date	Required
CustomerId	The ID of the Customer	string	Required Max length: 6
CashPrice	Spot cash price for the ticket	decimal number	Cannot be negative Max of 4 decimal places
GrossWeight	Gross Weight	integer	Required Cannot be negative
GrossWeightCaptureDateTime	The local date and time that the Gross Weight was captured	date
TareWeight	Tare Weight	integer	Required Cannot be negative
TareWeightCaptureDateTime	The local date and time that the Tare Weight was captured	date
NetWeight	Net Weight	integer	Required Cannot be negative
GrossUnits	Gross amount in commodity units	decimal number	Required Cannot be negative Max of 4 decimal places
DockUnits	Dockage amount in commodity units	decimal number	Required Cannot be negative Max of 4 decimal places
ShrinkUnits	Shrink amount in commodity units	decimal number	Required Cannot be negative Max of 4 decimal places
NetUnits	Net amount in commodity units	decimal number	Required Cannot be negative Max of 4 decimal places
Comment	Comments for the ticket	string	Max length: 60
BinId	The ID of the bin for the ticket	string	Max length: 10
DriverOn	Indication of the driver being on the scale when it was weighed	boolean	Must be 0, 1, True, or False
VehicleDescription	The description of the vehicle that is delivering the commodity	string	Max length: 30
Axles	The number of axles of the vehicle delivering the commodity	integer	Cannot be negative
WeighMaster	Weighmaster of the ticket	string	Max length: 20
WeighMasterLicenseNumber	The license number of the Weighmaster	string	Max length: 10
FreightVendorId	The ID of the Freight Vendor	string	Max length: 10
FreightVendorName	The Name of the Freight Vendor - Allowed to exist without the FreightVendorId populated	string	Max length: 50
BillOfLadingNumber	BOL Number	string	Max length: 15
ReadyForTransfer	Ready for Transfer	boolean	Must be 0, 1, True, or False
MoistureTesterCalibrationNumber	Moisture tester calibration number	string	Max length: 20
IsApproximatedTestWeight	Indication of if the test weight value is an approximate test weight or not	boolean	Must be 0, 1, True, or False
CommodityVariety	The commodity variety of the commodity	string	Max length: 50
BolTruckLicenseNum	BOL Truck Plate #	string	Max length: 20
BolTrailerLicenseNum	BOL Trailer Plate #	string	Max length: 20
BolLastHauledCommodityName	BOL Last Hauled Commodity	string	Max length: 50
BolLastCleanoutDate	BOL Cleanout Date (Date portion only)	date
GradeFactors	List of grade factors for the ticket	Collection of ClsGrainScaleInterfaceGradeFactorApi
FreightCharges	List of freight charges for the ticket	Collection of ClsGrainScaleInterfaceFrtChargeApi

Request Formats

application/json, text/json

Sample:

{
  "Details": [
    {
      "SplitQuantity": 1.1,
      "SalesContractId": "sample string 2",
      "SalesContractLocationId": "sample string 3",
      "Redeposited": true
    },
    {
      "SplitQuantity": 1.1,
      "SalesContractId": "sample string 2",
      "SalesContractLocationId": "sample string 3",
      "Redeposited": true
    }
  ],
  "TicketGUID": "87ab6126-fe43-4cd1-96da-132cb3165377",
  "TicketNum": "sample string 5",
  "LocationId": "sample string 6",
  "CommodityId": "sample string 7",
  "TicketDate": "2024-11-21T09:30:01.9679653+00:00",
  "CustomerId": "sample string 8",
  "CashPrice": 10.1,
  "GrossWeight": 11,
  "GrossWeightCaptureDateTime": "2024-11-21T09:30:01.9679653+00:00",
  "TareWeight": 13,
  "TareWeightCaptureDateTime": "2024-11-21T09:30:01.9679653+00:00",
  "NetWeight": 15,
  "GrossUnits": 16.1,
  "DockUnits": 17.1,
  "ShrinkUnits": 18.1,
  "NetUnits": 19.1,
  "Comment": "sample string 20",
  "BinId": "sample string 21",
  "DriverOn": true,
  "VehicleDescription": "sample string 23",
  "Axles": 24,
  "WeighMaster": "sample string 25",
  "WeighMasterLicenseNumber": "sample string 26",
  "FreightVendorId": "sample string 27",
  "FreightVendorName": "sample string 28",
  "BillOfLadingNumber": "sample string 29",
  "ReadyForTransfer": true,
  "MoistureTesterCalibrationNumber": "sample string 32",
  "IsApproximatedTestWeight": true,
  "CommodityVariety": "sample string 34",
  "BolTruckLicenseNum": "sample string 35",
  "BolTrailerLicenseNum": "sample string 36",
  "BolLastHauledCommodityName": "sample string 37",
  "BolLastCleanoutDate": "2024-11-21T09:30:01.9689644+00:00",
  "GradeFactors": [
    {
      "GradeFactorId": "sample string 2",
      "Value": 1.1
    },
    {
      "GradeFactorId": "sample string 2",
      "Value": 1.1
    }
  ],
  "FreightCharges": [
    {
      "FreightVendorId": "sample string 2",
      "FreightVendorName": "sample string 3",
      "Rate": 1.1,
      "UseGrossUnits": true
    },
    {
      "FreightVendorId": "sample string 2",
      "FreightVendorName": "sample string 3",
      "Rate": 1.1,
      "UseGrossUnits": true
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'FreightVendorNameReadOnly' in type 'SSI.clsSIScaleTicket+ClsGrainScaleInterfaceApi+ClsGrainScaleInterfaceFrtChargeApi'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'FreightVendorNameReadOnly' in type 'SSI.clsSIScaleTicket+ClsGrainScaleInterfaceApi+ClsGrainScaleInterfaceFrtChargeApi'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsGrainScaleInterfaceShipment'.

Response Information

Resource Description

Creates an outbound shipment scale interface record

AgvScaleInterfaceShipment

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
ErrorList	List of error messages of the API call.	Collection of string
WarningList	List of warning messages of the API call.	Collection of string
Count	Number of results returned.	string
Data	List of Properties and Values returned for each commodity transfer scale interface record that matches the request.	Collection of ClsGrainScaleInterfaceShipment

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Data": [
    {
      "Details": [
        {
          "SplitQuantity": 1.1,
          "SalesContractId": "sample string 2",
          "SalesContractLocationId": "sample string 3",
          "Redeposited": true
        },
        {
          "SplitQuantity": 1.1,
          "SalesContractId": "sample string 2",
          "SalesContractLocationId": "sample string 3",
          "Redeposited": true
        }
      ],
      "TicketGUID": "b58995fe-bc51-4db2-92dc-aaa6c8720b24",
      "TicketNum": "sample string 5",
      "LocationId": "sample string 6",
      "CommodityId": "sample string 7",
      "TicketDate": "2024-11-21T09:30:02.0049639+00:00",
      "CustomerId": "sample string 8",
      "CashPrice": 10.1,
      "GrossWeight": 11,
      "GrossWeightCaptureDateTime": "2024-11-21T09:30:02.0049639+00:00",
      "TareWeight": 13,
      "TareWeightCaptureDateTime": "2024-11-21T09:30:02.0049639+00:00",
      "NetWeight": 15,
      "GrossUnits": 16.1,
      "DockUnits": 17.1,
      "ShrinkUnits": 18.1,
      "NetUnits": 19.1,
      "Comment": "sample string 20",
      "BinId": "sample string 21",
      "DriverOn": true,
      "VehicleDescription": "sample string 23",
      "Axles": 24,
      "WeighMaster": "sample string 25",
      "WeighMasterLicenseNumber": "sample string 26",
      "FreightVendorId": "sample string 27",
      "FreightVendorName": "sample string 28",
      "BillOfLadingNumber": "sample string 29",
      "ReadyForTransfer": true,
      "MoistureTesterCalibrationNumber": "sample string 32",
      "IsApproximatedTestWeight": true,
      "CommodityVariety": "sample string 34",
      "BolTruckLicenseNum": "sample string 35",
      "BolTrailerLicenseNum": "sample string 36",
      "BolLastHauledCommodityName": "sample string 37",
      "BolLastCleanoutDate": "2024-11-21T09:30:02.0049639+00:00",
      "GradeFactors": [
        {
          "GradeFactorId": "sample string 2",
          "Value": 1.1
        },
        {
          "GradeFactorId": "sample string 2",
          "Value": 1.1
        }
      ],
      "FreightCharges": [
        {
          "FreightVendorId": "sample string 2",
          "FreightVendorName": "sample string 3",
          "Rate": 1.1,
          "UseGrossUnits": true
        },
        {
          "FreightVendorId": "sample string 2",
          "FreightVendorName": "sample string 3",
          "Rate": 1.1,
          "UseGrossUnits": true
        }
      ]
    },
    {
      "Details": [
        {
          "SplitQuantity": 1.1,
          "SalesContractId": "sample string 2",
          "SalesContractLocationId": "sample string 3",
          "Redeposited": true
        },
        {
          "SplitQuantity": 1.1,
          "SalesContractId": "sample string 2",
          "SalesContractLocationId": "sample string 3",
          "Redeposited": true
        }
      ],
      "TicketGUID": "b58995fe-bc51-4db2-92dc-aaa6c8720b24",
      "TicketNum": "sample string 5",
      "LocationId": "sample string 6",
      "CommodityId": "sample string 7",
      "TicketDate": "2024-11-21T09:30:02.0049639+00:00",
      "CustomerId": "sample string 8",
      "CashPrice": 10.1,
      "GrossWeight": 11,
      "GrossWeightCaptureDateTime": "2024-11-21T09:30:02.0049639+00:00",
      "TareWeight": 13,
      "TareWeightCaptureDateTime": "2024-11-21T09:30:02.0049639+00:00",
      "NetWeight": 15,
      "GrossUnits": 16.1,
      "DockUnits": 17.1,
      "ShrinkUnits": 18.1,
      "NetUnits": 19.1,
      "Comment": "sample string 20",
      "BinId": "sample string 21",
      "DriverOn": true,
      "VehicleDescription": "sample string 23",
      "Axles": 24,
      "WeighMaster": "sample string 25",
      "WeighMasterLicenseNumber": "sample string 26",
      "FreightVendorId": "sample string 27",
      "FreightVendorName": "sample string 28",
      "BillOfLadingNumber": "sample string 29",
      "ReadyForTransfer": true,
      "MoistureTesterCalibrationNumber": "sample string 32",
      "IsApproximatedTestWeight": true,
      "CommodityVariety": "sample string 34",
      "BolTruckLicenseNum": "sample string 35",
      "BolTrailerLicenseNum": "sample string 36",
      "BolLastHauledCommodityName": "sample string 37",
      "BolLastCleanoutDate": "2024-11-21T09:30:02.0049639+00:00",
      "GradeFactors": [
        {
          "GradeFactorId": "sample string 2",
          "Value": 1.1
        },
        {
          "GradeFactorId": "sample string 2",
          "Value": 1.1
        }
      ],
      "FreightCharges": [
        {
          "FreightVendorId": "sample string 2",
          "FreightVendorName": "sample string 3",
          "Rate": 1.1,
          "UseGrossUnits": true
        },
        {
          "FreightVendorId": "sample string 2",
          "FreightVendorName": "sample string 3",
          "Rate": 1.1,
          "UseGrossUnits": true
        }
      ]
    }
  ]
}

application/xml

Sample:

text/xml

Sample: