POST api/FreightWareQuickQuote

Returns a FreightWare shipment quote estimate based on shipment information, service type, consignment type, origin and destination routing, parcel dimensions, weights and volumetric calculations. REQUIRED HEADER: X-FreightWare : FreightWare Session Token

Request Information

URI Parameters

None.

Body Parameters

QuickQuoteRequest
NameDescriptionTypeAdditional information
Shipment

Collection of QuickQuoteShipment

None.

Items

Collection of QuickQuoteItem

None.

Request Formats

application/json, text/json

Sample:
{
  "Shipment": [
    {
      "accountReference": "sample string 1",
      "shipmentDate": "sample string 2",
      "serviceType": "sample string 3",
      "consignmentType": "sample string 4",
      "consignorSuburb": "sample string 5",
      "consignorCity": "sample string 6",
      "consignorPostalCode": "sample string 7",
      "consigneeSuburb": "sample string 8",
      "consigneeCity": "sample string 9",
      "consigneePostalCode": "sample string 10"
    },
    {
      "accountReference": "sample string 1",
      "shipmentDate": "sample string 2",
      "serviceType": "sample string 3",
      "consignmentType": "sample string 4",
      "consignorSuburb": "sample string 5",
      "consignorCity": "sample string 6",
      "consignorPostalCode": "sample string 7",
      "consigneeSuburb": "sample string 8",
      "consigneeCity": "sample string 9",
      "consigneePostalCode": "sample string 10"
    }
  ],
  "Items": [
    {
      "lineNumber": 1,
      "quantity": 2,
      "description": "sample string 3",
      "totalWeight": 4.0,
      "length": 5.0,
      "width": 6.0,
      "height": 7.0
    },
    {
      "lineNumber": 1,
      "quantity": 2,
      "description": "sample string 3",
      "totalWeight": 4.0,
      "length": 5.0,
      "width": 6.0,
      "height": 7.0
    }
  ]
}

application/xml, text/xml

Sample:
<QuickQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DCB_API">
  <Items>
    <QuickQuoteItem>
      <description>sample string 3</description>
      <height>7</height>
      <length>5</length>
      <lineNumber>1</lineNumber>
      <quantity>2</quantity>
      <totalWeight>4</totalWeight>
      <width>6</width>
    </QuickQuoteItem>
    <QuickQuoteItem>
      <description>sample string 3</description>
      <height>7</height>
      <length>5</length>
      <lineNumber>1</lineNumber>
      <quantity>2</quantity>
      <totalWeight>4</totalWeight>
      <width>6</width>
    </QuickQuoteItem>
  </Items>
  <Shipment>
    <QuickQuoteShipment>
      <accountReference>sample string 1</accountReference>
      <consigneeCity>sample string 9</consigneeCity>
      <consigneePostalCode>sample string 10</consigneePostalCode>
      <consigneeSuburb>sample string 8</consigneeSuburb>
      <consignmentType>sample string 4</consignmentType>
      <consignorCity>sample string 6</consignorCity>
      <consignorPostalCode>sample string 7</consignorPostalCode>
      <consignorSuburb>sample string 5</consignorSuburb>
      <serviceType>sample string 3</serviceType>
      <shipmentDate>sample string 2</shipmentDate>
    </QuickQuoteShipment>
    <QuickQuoteShipment>
      <accountReference>sample string 1</accountReference>
      <consigneeCity>sample string 9</consigneeCity>
      <consigneePostalCode>sample string 10</consigneePostalCode>
      <consigneeSuburb>sample string 8</consigneeSuburb>
      <consignmentType>sample string 4</consignmentType>
      <consignorCity>sample string 6</consignorCity>
      <consignorPostalCode>sample string 7</consignorPostalCode>
      <consignorSuburb>sample string 5</consignorSuburb>
      <serviceType>sample string 3</serviceType>
      <shipmentDate>sample string 2</shipmentDate>
    </QuickQuoteShipment>
  </Shipment>
</QuickQuoteRequest>

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

Response Information

Resource Description

QuickQuoteResponse
NameDescriptionTypeAdditional information
success

boolean

None.

statusCode

string

None.

requestUrl

string

None.

response

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "statusCode": "sample string 2",
  "requestUrl": "sample string 3",
  "response": {}
}

application/xml, text/xml

Sample:
<QuickQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DCB_API">
  <requestUrl>sample string 3</requestUrl>
  <response />
  <statusCode>sample string 2</statusCode>
  <success>true</success>
</QuickQuoteResponse>