POST Shipment/PostShipment

Creates a shipment

Request Information

URI Parameters

Body Parameters

Name	Description	Type	Additional Information
Shipment	Shipment Number	string	Max length: 10
ScaleTickNum	Scale Ticket Number on the Shipment	string	Max length: 10
ShipDate	Shipment Date for the Shipment	string	Required Format must be MM/dd/yyyy
Commodity	Commodity on the Shipment	string	Required Max length: 6
DirectShip	Marks a Shipment as DirectShip	boolean
FromDPR	How the Shipment will be listed on the DPR	FromDPREnum	Required
Location	Location on the Shipment	string	Required Max length: 6
CustomerID	CustomerID on the Shipment	string	Required Max length: 6
ShippingDestination	Shipping Destination on the Shipment	string	Max length: 6
FreightReference	Freight Reference on the Shipment	string	Max length: 10
FreightRefLocation	Freight Reference Location on the Shipment	string	Max length: 6
BL/CarNumber	BL/Car Number on the Shipment	string	Max length: 15
CarInitials	Car Initials on the Shipment	string	Max length: 10
GrossWeight	Gross Weight on the Shipment	decimal number
TareWeight	Tare Weight on the Shipment	decimal number
EstimatedWeight	Estimated Weight on the Shipment	decimal number
EstimatedUnits	Estimated Units on the Shipment	decimal number
FreightVendor	Freight Vendor on the Shipment	string	Max length: 10
TransportationMethodGUID	Transportation method on the Shipment	globally unique identifier
Axles	Axles on the vehicle on the Shipment	integer
ReleaseNumber	Release Number on the Shipment	string	Max length: 10
LotNumber	Lot Number on the Shipment	string	Max length: 30
Vehicle	Vehicle on the Shipment	string	Max length: 10
Trailer	Trailer on the Shipment	string	Max length: 10
SealNumbers	Seal Numbers on the Shipment	string	Max length: 200
DestinationGrossWeight	Destination Gross Weight on the shipment	integer
DestinationTareWeight	Destination Tare Weight on the shipment	integer
DestinationNetWeight	Destination Net Weight on the shipment	integer
DestinationGrossUnits	Destination Gross Weight on the shipment	decimal number	Max of 4 decimal places
DestinationNetUnits	Destination Net Weight on the shipment	decimal number	Max of 4 decimal places
GRShipFrieghtChargesAdd	Freight Charges on the Shipment	Collection of ClsPostGRShipFreightCharges
GRShipBinsAdd	Bins on the Shipment	Collection of ClsPostGRShipBins
GRShipGradeFactorsAdd	Grade Factors on the Shipment	Collection of ClsPostGRShipGf
GRShipSplitsAdd	Shipment splits on the Shipment	Collection of ClsPostGRShipSplits
GRShipAdvanceAdd	Advances on the Shipment	Collection of ClsPostGRShipAdvances
GRShipCommentsAdd	Comments on the Shipment	Collection of ClsPostGRShipComments

Request Formats

application/json, text/json

Sample:

{
  "Shipment": "sample string 1",
  "ScaleTickNum": "sample string 2",
  "ShipDate": "sample string 3",
  "Commodity": "sample string 4",
  "DirectShip": true,
  "FromDPR": 1,
  "Location": "sample string 6",
  "CustomerID": "sample string 7",
  "ShippingDestination": "sample string 8",
  "FreightReference": "sample string 9",
  "FreightRefLocation": "sample string 10",
  "BL/CarNumber": "sample string 11",
  "CarInitials": "sample string 12",
  "GrossWeight": 1.1,
  "TareWeight": 1.1,
  "EstimatedWeight": 13.1,
  "EstimatedUnits": 14.1,
  "FreightVendor": "sample string 15",
  "TransportationMethodGUID": "9b455697-e4cb-4bd4-9c21-edfe2485620f",
  "Axles": 16,
  "ReleaseNumber": "sample string 17",
  "LotNumber": "sample string 18",
  "Vehicle": "sample string 19",
  "Trailer": "sample string 20",
  "SealNumbers": "sample string 21",
  "DestinationGrossWeight": 1,
  "DestinationTareWeight": 1,
  "DestinationNetWeight": 1,
  "DestinationGrossUnits": 1.1,
  "DestinationNetUnits": 1.1,
  "GRShipFrieghtChargesAdd": [
    {
      "FreightVendor": "sample string 1",
      "Rate": 2.1,
      "Quantity": 3.1
    },
    {
      "FreightVendor": "sample string 1",
      "Rate": 2.1,
      "Quantity": 3.1
    }
  ],
  "GRShipBinsAdd": [
    {
      "BinReference": "sample string 1",
      "Quantity": 2.1
    },
    {
      "BinReference": "sample string 1",
      "Quantity": 2.1
    }
  ],
  "GRShipGradeFactorsAdd": [
    {
      "GradFactorId": "sample string 1",
      "Result": 1.1,
      "DestResult": 1.1
    },
    {
      "GradFactorId": "sample string 1",
      "Result": 1.1,
      "DestResult": 1.1
    }
  ],
  "GRShipSplitsAdd": [
    {
      "Contract": "sample string 1",
      "SalesConLocation": "sample string 2",
      "Quantity": 3.1,
      "Price": 4.1,
      "InTransPrice": 5.1,
      "LIType": "sample string 6",
      "DestNetUnits": 1.1,
      "BasisPrice": 1.1
    },
    {
      "Contract": "sample string 1",
      "SalesConLocation": "sample string 2",
      "Quantity": 3.1,
      "Price": 4.1,
      "InTransPrice": 5.1,
      "LIType": "sample string 6",
      "DestNetUnits": 1.1,
      "BasisPrice": 1.1
    }
  ],
  "GRShipAdvanceAdd": [
    {
      "Advance": "sample string 1",
      "AdvanceLocation": "sample string 2",
      "Amount": 3.1
    },
    {
      "Advance": "sample string 1",
      "AdvanceLocation": "sample string 2",
      "Amount": 3.1
    }
  ],
  "GRShipCommentsAdd": [
    {
      "Comment": "sample string 1"
    },
    {
      "Comment": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<ClsGrShip.ClsGRShipPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
  <Axles>16</Axles>
  <BL_x002F_CarNumber>sample string 11</BL_x002F_CarNumber>
  <CarInitials>sample string 12</CarInitials>
  <Commodity>sample string 4</Commodity>
  <CustomerID>sample string 7</CustomerID>
  <DestinationGrossUnits>1.1</DestinationGrossUnits>
  <DestinationGrossWeight>1</DestinationGrossWeight>
  <DestinationNetUnits>1.1</DestinationNetUnits>
  <DestinationNetWeight>1</DestinationNetWeight>
  <DestinationTareWeight>1</DestinationTareWeight>
  <DirectShip>true</DirectShip>
  <EstimatedUnits>14.1</EstimatedUnits>
  <EstimatedWeight>13.1</EstimatedWeight>
  <FreightRefLocation>sample string 10</FreightRefLocation>
  <FreightReference>sample string 9</FreightReference>
  <FreightVendor>sample string 15</FreightVendor>
  <FromDPR>CompanyOwned</FromDPR>
  <GRShipAdvanceAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipAdvances>
      <Advance>sample string 1</Advance>
      <AdvanceLocation>sample string 2</AdvanceLocation>
      <Amount>3.1</Amount>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipAdvances>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipAdvances>
      <Advance>sample string 1</Advance>
      <AdvanceLocation>sample string 2</AdvanceLocation>
      <Amount>3.1</Amount>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipAdvances>
  </GRShipAdvanceAdd>
  <GRShipBinsAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipBins>
      <BinReference>sample string 1</BinReference>
      <Quantity>2.1</Quantity>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipBins>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipBins>
      <BinReference>sample string 1</BinReference>
      <Quantity>2.1</Quantity>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipBins>
  </GRShipBinsAdd>
  <GRShipCommentsAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipComments>
      <Comment>sample string 1</Comment>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipComments>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipComments>
      <Comment>sample string 1</Comment>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipComments>
  </GRShipCommentsAdd>
  <GRShipFrieghtChargesAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipFreightCharges>
      <FreightVendor>sample string 1</FreightVendor>
      <Quantity>3.1</Quantity>
      <Rate>2.1</Rate>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipFreightCharges>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipFreightCharges>
      <FreightVendor>sample string 1</FreightVendor>
      <Quantity>3.1</Quantity>
      <Rate>2.1</Rate>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipFreightCharges>
  </GRShipFrieghtChargesAdd>
  <GRShipGradeFactorsAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipGf>
      <DestResult>1.1</DestResult>
      <GradFactorId>sample string 1</GradFactorId>
      <Result>1.1</Result>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipGf>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipGf>
      <DestResult>1.1</DestResult>
      <GradFactorId>sample string 1</GradFactorId>
      <Result>1.1</Result>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipGf>
  </GRShipGradeFactorsAdd>
  <GRShipSplitsAdd>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipSplits>
      <BasisPrice>1.1</BasisPrice>
      <Contract>sample string 1</Contract>
      <DestNetUnits>1.1</DestNetUnits>
      <InTransPrice>5.1</InTransPrice>
      <LIType>sample string 6</LIType>
      <Price>4.1</Price>
      <Quantity>3.1</Quantity>
      <SalesConLocation>sample string 2</SalesConLocation>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipSplits>
    <ClsGrShip.ClsGRShipPost.ClsPostGRShipSplits>
      <BasisPrice>1.1</BasisPrice>
      <Contract>sample string 1</Contract>
      <DestNetUnits>1.1</DestNetUnits>
      <InTransPrice>5.1</InTransPrice>
      <LIType>sample string 6</LIType>
      <Price>4.1</Price>
      <Quantity>3.1</Quantity>
      <SalesConLocation>sample string 2</SalesConLocation>
    </ClsGrShip.ClsGRShipPost.ClsPostGRShipSplits>
  </GRShipSplitsAdd>
  <GrossWeight>1.1</GrossWeight>
  <Location>sample string 6</Location>
  <LotNumber>sample string 18</LotNumber>
  <ReleaseNumber>sample string 17</ReleaseNumber>
  <ScaleTickNum>sample string 2</ScaleTickNum>
  <SealNumbers>sample string 21</SealNumbers>
  <ShipDate>sample string 3</ShipDate>
  <Shipment>sample string 1</Shipment>
  <ShippingDestination>sample string 8</ShippingDestination>
  <TareWeight>1.1</TareWeight>
  <Trailer>sample string 20</Trailer>
  <TransportationMethodGUID>9b455697-e4cb-4bd4-9c21-edfe2485620f</TransportationMethodGUID>
  <Vehicle>sample string 19</Vehicle>
</ClsGrShip.ClsGRShipPost>

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

Response Information

Resource Description

Creates 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": "012b8a87-b073-4f5d-a1ea-cc0678da5665"
    },
    {
      "Shipment": "sample string 4",
      "Location": "sample string 5",
      "GRShipGuid": "012b8a87-b073-4f5d-a1ea-cc0678da5665"
    }
  ]
}

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>012b8a87-b073-4f5d-a1ea-cc0678da5665</d2p1:GRShipGuid>
      <d2p1:Location>sample string 5</d2p1:Location>
      <d2p1:Shipment>sample string 4</d2p1:Shipment>
    </d2p1:ClsGrShip>
    <d2p1:ClsGrShip>
      <d2p1:GRShipGuid>012b8a87-b073-4f5d-a1ea-cc0678da5665</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>