PUT Shipment/PatchPutShipment

Updates destination results on a shipment

Request Information

URI Parameters

Body Parameters

Name	Description	Type	Additional Information
GrShipGuid	Guid for the shipment	globally unique identifier	Required
DestinationGrossWeight	Destination Gross Weight on the shipment	decimal number
DestinationTareWeight	Destination Tare Weight on the shipment	decimal number
DestinationNetWeight	Destination Net Weight on the shipment	decimal number
DestinationGrossUnits	Destination Gross Weight on the shipment	decimal number	Max of 5 decimal places
DestinationNetUnits	Destination Net Weight on the shipment	decimal number	Max of 5 decimal places
PatchPutDestShipGf	Destination Grade Factors on the shipment	Collection of ClsGRShipGfPatch
PatchPutShipDt	Shipment splits	Collection of ClsGRShipDtPatch
PatchPutShipFrtChrge	Shipment Freight Charges	Collection of ClsPatchPutGRShipFreightCharge

Request Formats

application/json, text/json

Sample:

{
  "GrShipGuid": "1377c6fe-49bb-4ad5-a198-5f46e82ea643",
  "DestinationGrossWeight": 1.1,
  "DestinationTareWeight": 1.1,
  "DestinationNetWeight": 1.1,
  "DestinationGrossUnits": 1.1,
  "DestinationNetUnits": 1.1,
  "PatchPutDestShipGf": [
    {
      "GradFactorId": "sample string 1",
      "Result": 1.1,
      "DestResult": 1.1
    },
    {
      "GradFactorId": "sample string 1",
      "Result": 1.1,
      "DestResult": 1.1
    }
  ],
  "PatchPutShipDt": [
    {
      "Contract": "sample string 1",
      "SalesConLocation": "sample string 2",
      "Quantity": 3.1,
      "Price": 4.1,
      "InTransPrice": 5.1,
      "SettledQty": 6.1,
      "AdjQty": 7.1,
      "Completed": true,
      "LIType": "sample string 9",
      "DestNetUnits": 1.1,
      "BasisPrice": 1.1
    },
    {
      "Contract": "sample string 1",
      "SalesConLocation": "sample string 2",
      "Quantity": 3.1,
      "Price": 4.1,
      "InTransPrice": 5.1,
      "SettledQty": 6.1,
      "AdjQty": 7.1,
      "Completed": true,
      "LIType": "sample string 9",
      "DestNetUnits": 1.1,
      "BasisPrice": 1.1
    }
  ],
  "PatchPutShipFrtChrge": [
    {
      "FreightVendor": "sample string 1",
      "Quantity": 2.1,
      "Rate": 3.1,
      "ReconYN": true,
      "ReconAmount": 5.1,
      "ReconDate": "sample string 6",
      "APBillGuid": "6d05d922-f6ae-4ec4-a619-66366058b5e4"
    },
    {
      "FreightVendor": "sample string 1",
      "Quantity": 2.1,
      "Rate": 3.1,
      "ReconYN": true,
      "ReconAmount": 5.1,
      "ReconDate": "sample string 6",
      "APBillGuid": "6d05d922-f6ae-4ec4-a619-66366058b5e4"
    }
  ]
}

application/xml, text/xml

Sample:

<ClsGrShip.ClsGRShipPatch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
  <DestinationGrossUnits>1.1</DestinationGrossUnits>
  <DestinationGrossWeight>1.1</DestinationGrossWeight>
  <DestinationNetUnits>1.1</DestinationNetUnits>
  <DestinationNetWeight>1.1</DestinationNetWeight>
  <DestinationTareWeight>1.1</DestinationTareWeight>
  <GrShipGuid>1377c6fe-49bb-4ad5-a198-5f46e82ea643</GrShipGuid>
  <PatchPutDestShipGf>
    <ClsGrShip.ClsGRShipPatch.ClsGRShipGfPatch>
      <DestResult>1.1</DestResult>
      <GradFactorId>sample string 1</GradFactorId>
      <Result>1.1</Result>
    </ClsGrShip.ClsGRShipPatch.ClsGRShipGfPatch>
    <ClsGrShip.ClsGRShipPatch.ClsGRShipGfPatch>
      <DestResult>1.1</DestResult>
      <GradFactorId>sample string 1</GradFactorId>
      <Result>1.1</Result>
    </ClsGrShip.ClsGRShipPatch.ClsGRShipGfPatch>
  </PatchPutDestShipGf>
  <PatchPutShipDt>
    <ClsGrShip.ClsGRShipPatch.ClsGRShipDtPatch>
      <AdjQty>7.1</AdjQty>
      <BasisPrice>1.1</BasisPrice>
      <Completed>true</Completed>
      <Contract>sample string 1</Contract>
      <DestNetUnits>1.1</DestNetUnits>
      <InTransPrice>5.1</InTransPrice>
      <LIType>sample string 9</LIType>
      <Price>4.1</Price>
      <Quantity>3.1</Quantity>
      <SalesConLocation>sample string 2</SalesConLocation>
      <SettledQty>6.1</SettledQty>
    </ClsGrShip.ClsGRShipPatch.ClsGRShipDtPatch>
    <ClsGrShip.ClsGRShipPatch.ClsGRShipDtPatch>
      <AdjQty>7.1</AdjQty>
      <BasisPrice>1.1</BasisPrice>
      <Completed>true</Completed>
      <Contract>sample string 1</Contract>
      <DestNetUnits>1.1</DestNetUnits>
      <InTransPrice>5.1</InTransPrice>
      <LIType>sample string 9</LIType>
      <Price>4.1</Price>
      <Quantity>3.1</Quantity>
      <SalesConLocation>sample string 2</SalesConLocation>
      <SettledQty>6.1</SettledQty>
    </ClsGrShip.ClsGRShipPatch.ClsGRShipDtPatch>
  </PatchPutShipDt>
  <PatchPutShipFrtChrge>
    <ClsGrShip.ClsGRShipPatch.ClsPatchPutGRShipFreightCharge>
      <APBillGuid>6d05d922-f6ae-4ec4-a619-66366058b5e4</APBillGuid>
      <FreightVendor>sample string 1</FreightVendor>
      <Quantity>2.1</Quantity>
      <Rate>3.1</Rate>
      <ReconAmount>5.1</ReconAmount>
      <ReconDate>sample string 6</ReconDate>
      <ReconYN>true</ReconYN>
    </ClsGrShip.ClsGRShipPatch.ClsPatchPutGRShipFreightCharge>
    <ClsGrShip.ClsGRShipPatch.ClsPatchPutGRShipFreightCharge>
      <APBillGuid>6d05d922-f6ae-4ec4-a619-66366058b5e4</APBillGuid>
      <FreightVendor>sample string 1</FreightVendor>
      <Quantity>2.1</Quantity>
      <Rate>3.1</Rate>
      <ReconAmount>5.1</ReconAmount>
      <ReconDate>sample string 6</ReconDate>
      <ReconYN>true</ReconYN>
    </ClsGrShip.ClsGRShipPatch.ClsPatchPutGRShipFreightCharge>
  </PatchPutShipFrtChrge>
</ClsGrShip.ClsGRShipPatch>

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 'ClsGRShipPatch'.

Response Information

Resource Description

Updates destination results on a shipment

AgvShipment

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
ErrorList	List of Error Messages returned by the api	Collection of string
WarningList	List of Warning Messages returned by the api	Collection of string
Count	Count of how many Shipments.	string
Data		Collection of ClsGrShip

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": [
    {
      "Shipment": "sample string 4",
      "Location": "sample string 5",
      "GRShipGuid": "8b119e9e-e34a-4b0e-9843-2f82858aa4f2"
    },
    {
      "Shipment": "sample string 4",
      "Location": "sample string 5",
      "GRShipGuid": "8b119e9e-e34a-4b0e-9843-2f82858aa4f2"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Shipping.Shipment">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
    <d2p1:ClsGrShip>
      <d2p1:GRShipGuid>8b119e9e-e34a-4b0e-9843-2f82858aa4f2</d2p1:GRShipGuid>
      <d2p1:Location>sample string 5</d2p1:Location>
      <d2p1:Shipment>sample string 4</d2p1:Shipment>
    </d2p1:ClsGrShip>
    <d2p1:ClsGrShip>
      <d2p1:GRShipGuid>8b119e9e-e34a-4b0e-9843-2f82858aa4f2</d2p1:GRShipGuid>
      <d2p1:Location>sample string 5</d2p1:Location>
      <d2p1:Shipment>sample string 4</d2p1:Shipment>
    </d2p1:ClsGrShip>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvShipment>